diff options
author | Darrell Anderson <[email protected]> | 2014-01-31 14:03:54 -0600 |
---|---|---|
committer | Darrell Anderson <[email protected]> | 2014-01-31 14:03:54 -0600 |
commit | 66c5602f5818d46f618b4dacaaf8bdc00cfacdd2 (patch) | |
tree | d328f069b0126cb94bd0feb91bfc9d85cae58fda | |
parent | a0e3f4ae50bd8ef9c006738541e0af9e0d5d1ecf (diff) | |
download | tdebase-66c5602f5818d46f618b4dacaaf8bdc00cfacdd2.tar.gz tdebase-66c5602f5818d46f618b4dacaaf8bdc00cfacdd2.zip |
Move Administrator Guide from User Guide to standalone handbook.
-rw-r--r-- | doc/adminguide/CMakeLists.txt | 9 | ||||
-rw-r--r-- | doc/adminguide/Makefile.am | 3 | ||||
-rw-r--r-- | doc/adminguide/groupware-kontact.docbook (renamed from doc/userguide/groupware-kontact.docbook) | 4 | ||||
-rw-r--r-- | doc/adminguide/index.docbook (renamed from doc/userguide/tde-for-admins.docbook) | 94 | ||||
-rw-r--r-- | doc/userguide/base-tde-applications.docbook | 2 | ||||
-rw-r--r-- | doc/userguide/credits-and-license.docbook | 10 | ||||
-rw-r--r-- | doc/userguide/index.docbook | 15 | ||||
-rw-r--r-- | doc/userguide/under-the-hood.docbook | 9 | ||||
-rw-r--r-- | doc/userguide/your-tde-account.docbook | 3 | ||||
-rw-r--r-- | khelpcenter/plugins/CMakeLists.txt | 2 | ||||
-rw-r--r-- | khelpcenter/plugins/Makefile.am | 2 | ||||
-rw-r--r-- | khelpcenter/plugins/adminguide.desktop | 7 |
12 files changed, 104 insertions, 56 deletions
diff --git a/doc/adminguide/CMakeLists.txt b/doc/adminguide/CMakeLists.txt new file mode 100644 index 000000000..ec8d87dac --- /dev/null +++ b/doc/adminguide/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/adminguide ) diff --git a/doc/adminguide/Makefile.am b/doc/adminguide/Makefile.am new file mode 100644 index 000000000..86108a74b --- /dev/null +++ b/doc/adminguide/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = khelpcenter/adminguide + diff --git a/doc/userguide/groupware-kontact.docbook b/doc/adminguide/groupware-kontact.docbook index 66de1113a..b18313931 100644 --- a/doc/userguide/groupware-kontact.docbook +++ b/doc/adminguide/groupware-kontact.docbook @@ -582,10 +582,10 @@ in #cyrus channel:</para> <itemizedlist> <title>Reference</title> -<listitem><para>TDE: <ulink url="http://www.kde.org">http://www.kde.org</ulink></para></listitem> +<listitem><para>KDE: <ulink url="http://www.kde.org">http://www.kde.org</ulink></para></listitem> <listitem><para>&kontact; website: <ulink url="http://www.kontact.org">http://www.kontact.org</ulink></para></listitem> <listitem><para>Kroupware project: <ulink url="http://www.kroupware.org">http://www.kroupware.org</ulink></para></listitem> -<listitem><para>&tde; Community Wiki: <ulink url="http://wiki.kde.org">http://wiki.kde.org</ulink></para></listitem> +<listitem><para>&kde; Community Wiki: <ulink url="http://wiki.kde.org">http://wiki.kde.org</ulink></para></listitem> <listitem><para>Wine project: <ulink url="http://www.winehq.org">http://www.winehq.org</ulink></para></listitem> <listitem><para>Cygwin/X project <ulink url="http://x.cygwin.com">http://x.cygwin.com</ulink></para></listitem> <listitem><para>LTSP project: <ulink url="http://www.ltsp.org">http://www.ltsp.org</ulink></para></listitem> diff --git a/doc/userguide/tde-for-admins.docbook b/doc/adminguide/index.docbook index 815e69d45..9b767ec4a 100644 --- a/doc/userguide/tde-for-admins.docbook +++ b/doc/adminguide/index.docbook @@ -1,13 +1,71 @@ -<part id="tde-for-administrators"> +<?xml version="1.0" ?> + <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % imageobjectco.module "INCLUDE"> + <!ENTITY groupware-with-kontact SYSTEM "groupware-kontact.docbook"> + <!ENTITY % English "INCLUDE"> +]> -<title>&tde; for Administrators</title> +<book lang="&language;"> + +<bookinfo> + +<title>The &tde; (Trinity Desktop Environment) Administrator Guide</title> + +<authorgroup> +<corpauthor>&tde-team;</corpauthor> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2004-2005</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> -<chapter id="kde-internals"> -<title>&tde; Internals</title> +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para>A general administrator guide to the Trinity Desktop Environment. +</para> + +<para>Please report problems with this document to +<email>[email protected]</email>. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>desktop</keyword> +<keyword>handbook</keyword> +<keyword>tutorial</keyword> +</keywordset> + +</bookinfo> + +<chapter id="tde-for-admins-introduction"> +<title>&tde; for Administrators</title> <sect1 id="tde-for-admins-overview"> <title>Overview</title> -<para>to be written</para> + +<para>This handbook is a reference guide to +some &tde; features that are useful to administrators configuring +multi-user systems. This part also has information that might be useful +to &tde; users with single-user systems: where configuration files are +stored, what environment variables affect &tde;, and so on. The KIOSK +framework is the &tde; system which allows administrators to limit +what users can do in &tde;. That framework is potentially useful in many +situations, but especially for running single-function kiosks with, +for example, only a web browser, hence the name.</para> + </sect1> <sect1 id="directory-layout"> @@ -763,7 +821,7 @@ Auto Save Interval=25 </sect1> -<sect1 id="kde-startup-sequence"> +<sect1 id="tde-startup-sequence"> <title>&tde; Startup Sequence</title> <sect2 id="tdm"> @@ -1862,7 +1920,7 @@ profile- or system-wide locations. </sect1> <!-- This section might be redundant. If it isn't, it needs some screenies --> -<sect1 id="kde-panel"> +<sect1 id="tde-panel"> <title>&tde; Panel</title> <para>The &tde; panel is also known as &kicker;. It is modular and @@ -2422,7 +2480,7 @@ appear to ask for confirmation by the current user.</para> </sect1> -<sect1 id="kde-diy"> +<sect1 id="tde-diy"> <title>&tde; DIY - Building Your Own Tools</title> <sect2 id="dcop"> @@ -2711,22 +2769,4 @@ file=$(kdialog --getexistingdirectory $HOME)</screen> &groupware-with-kontact; -</part> - -<!-- Keep this comment at the end of the file -Local variables: -mode: xml -sgml-omittag:nil -sgml-shorttag:nil -sgml-namecase-general:nil -sgml-general-insert-case:lower -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:0 -sgml-indent-data:true -sgml-parent-document:("index.docbook" "book" "part") -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> +</book> diff --git a/doc/userguide/base-tde-applications.docbook b/doc/userguide/base-tde-applications.docbook index 2a5ef53c9..2a5ccb1c1 100644 --- a/doc/userguide/base-tde-applications.docbook +++ b/doc/userguide/base-tde-applications.docbook @@ -83,7 +83,7 @@ <listitem><para>A <acronym>GUI</acronym> front-end to the powerful &DCOP; (Desktop COmmunications Protocol). &DCOP; provides a comprehensive protocol for interprocess communication between &tde; applications. While this is increasingly useful to &tde; programmers, it is also beneficial to the ordinary user who would want to create a script, or, say, a <application>SuperKaramba</application> theme.</para> <itemizedlist> - <listitem><para>In the User Guide <xref linkend="scripting-the-desktop"/> and <xref linkend="kdialog"/></para></listitem> + <listitem><para>In the User Guide <xref linkend="scripting-the-desktop"/> and <ulink url="help:/khelpcenter/adminguide#kdialog">The &tde; Administrator Guide</ulink></para></listitem> <listitem><para>Other Documentation: <ulink url="http://developer.kde.org/documentation/library/kdeqt/dcop.html">http://developer.kde.org/documentation/library/kdeqt/dcop.html</ulink></para></listitem> diff --git a/doc/userguide/credits-and-license.docbook b/doc/userguide/credits-and-license.docbook index 14fe777bb..c88ba4873 100644 --- a/doc/userguide/credits-and-license.docbook +++ b/doc/userguide/credits-and-license.docbook @@ -24,7 +24,8 @@ <listitem> <itemizedlist> -<listitem><para>Wrote the notes which became <xref linkend="tde-for-administrators"/>.</para> +<listitem><para>Wrote the notes which became <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> </listitem> </itemizedlist> @@ -207,7 +208,8 @@ linkend="file-manager"/> and <xref linkend="accessibility"/>.</para> </listitem> <listitem><para>Wrote <xref linkend="menus"/>.</para> </listitem> -<listitem><para>Marked up parts of <xref linkend="tde-for-administrators"/>.</para> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> </listitem> </itemizedlist> @@ -270,8 +272,8 @@ linkend="file-manager"/> and <xref linkend="accessibility"/>.</para> </listitem> <listitem><para>Wrote <xref linkend="getting-help"/>.</para> </listitem> -<listitem><para>Marked up parts of <xref -linkend="tde-for-administrators"/>.</para> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> </listitem> </itemizedlist> diff --git a/doc/userguide/index.docbook b/doc/userguide/index.docbook index 2583798d6..45551271d 100644 --- a/doc/userguide/index.docbook +++ b/doc/userguide/index.docbook @@ -42,13 +42,11 @@ <!ENTITY usenet SYSTEM "usenet.docbook"> <!ENTITY messaging-intro SYSTEM "messaging-intro.docbook"> <!ENTITY tde-office SYSTEM "tde-office.docbook"> - <!ENTITY tde-for-admins SYSTEM "tde-for-admins.docbook"> <!ENTITY migrator-dictionary SYSTEM "migrator-dictionary.docbook"> <!ENTITY glossary SYSTEM "glossary.docbook"> <!ENTITY standard-menu-entries SYSTEM "standard-menu-entries.docbook"> <!ENTITY where-next SYSTEM "where-next.docbook"> <!ENTITY credits-and-license SYSTEM "credits-and-license.docbook"> - <!ENTITY groupware-with-kontact SYSTEM "groupware-kontact.docbook"> <!ENTITY extragear-applications SYSTEM "extragear-applications.docbook"> <!ENTITY migrator-applications SYSTEM "migrator-applications.docbook"> <!ENTITY % English "INCLUDE"> @@ -270,16 +268,6 @@ Internet applications. &tde; includes a powerful web browser, This part of the User Guide contains information about configuring these applications.</para> -<para><xref linkend="tde-for-administrators"/> is a reference guide to -some &tde; features that are useful to administrators configuring -multi-user systems. This part also has information that might be useful -to &tde; users with single-user systems: where configuration files are -stored, what environment variables affect &tde;, and so on. The KIOSK -framework is the &tde; system which allows administrators to limit -what users can do in &tde;. That framework is potentially useful in many -situations, but especially for running single-function kiosks with, -for example, only a web browser, hence the name.</para> - </sect1> </chapter> </part> @@ -530,8 +518,6 @@ by entering <userinput>help:/tdm</userinput> in &konqueror;'s &tde-office; -&tde-for-admins; - <part id="more"> <title>More Tools</title> @@ -593,7 +579,6 @@ started.</para> &documentation.index; - </book> <!-- Keep this comment at the end of the file diff --git a/doc/userguide/under-the-hood.docbook b/doc/userguide/under-the-hood.docbook index 6757cc8d9..331f41ce0 100644 --- a/doc/userguide/under-the-hood.docbook +++ b/doc/userguide/under-the-hood.docbook @@ -84,16 +84,17 @@ is as <acronym>UTF-8</acronym> again).</para> correctly anymore, close the application and restore the backup of the configuration file.</para> -<itemizedlist> +<!--<itemizedlist> <title>Related Information</title> -<listitem><para><xref linkend="tde-for-administrators"/> has more -information about &tde;'s directory structure, to help you find the +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> has more +information about the &tde; directory structure, to help you find the file you need to edit.</para> </listitem> -</itemizedlist> +</itemizedlist>--> </sect2> diff --git a/doc/userguide/your-tde-account.docbook b/doc/userguide/your-tde-account.docbook index 2a03ab214..6b351b208 100644 --- a/doc/userguide/your-tde-account.docbook +++ b/doc/userguide/your-tde-account.docbook @@ -52,7 +52,8 @@ TDEDIR=/usr/local/kde,/home/phil/kde</userinput> if you use sh. <!-- Add links to "further reading" here --> <itemizedlist> <title>Related Information</title> -<listitem><para><xref linkend="tde-for-administrators" /> contains +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> contains more information about the directories that &tde; uses.</para> </listitem> </itemizedlist> diff --git a/khelpcenter/plugins/CMakeLists.txt b/khelpcenter/plugins/CMakeLists.txt index eee6a6637..6146d50f0 100644 --- a/khelpcenter/plugins/CMakeLists.txt +++ b/khelpcenter/plugins/CMakeLists.txt @@ -18,5 +18,5 @@ install( FILES applets.desktop contact.desktop faq.desktop info.desktop links.desktop support.desktop userguide.desktop welcome.desktop hardwaremodules.desktop kcontrolmodules.desktop konqplugins.desktop - tdeioslaves.desktop quickstart.desktop visualdict.desktop + tdeioslaves.desktop quickstart.desktop visualdict.desktop adminguide.desktop DESTINATION ${DATA_INSTALL_DIR}/khelpcenter/plugins ) diff --git a/khelpcenter/plugins/Makefile.am b/khelpcenter/plugins/Makefile.am index d244d8b91..f15d537d4 100644 --- a/khelpcenter/plugins/Makefile.am +++ b/khelpcenter/plugins/Makefile.am @@ -5,6 +5,6 @@ SUBDIRS = Applications Manpages plugin_DATA = applets.desktop contact.desktop faq.desktop info.desktop \ links.desktop support.desktop userguide.desktop welcome.desktop \ kicmodules.desktop kcontrolmodules.desktop konqplugins.desktop \ - tdeioslaves.desktop quickstart.desktop visualdict.desktop + tdeioslaves.desktop quickstart.desktop visualdict.desktop adminguide.desktop plugindir = $(kde_datadir)/khelpcenter/plugins diff --git a/khelpcenter/plugins/adminguide.desktop b/khelpcenter/plugins/adminguide.desktop new file mode 100644 index 000000000..bf3c41814 --- /dev/null +++ b/khelpcenter/plugins/adminguide.desktop @@ -0,0 +1,7 @@ +[Desktop Entry] +DocPath=help:/khelpcenter/adminguide/index.html + +Name=TDE Admininstrator Guide + +X-DOC-Weight=-1400 +Icon=kmenu |