From 66c5602f5818d46f618b4dacaaf8bdc00cfacdd2 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Fri, 31 Jan 2014 14:03:54 -0600 Subject: [PATCH] Move Administrator Guide from User Guide to standalone handbook. --- doc/adminguide/CMakeLists.txt | 9 ++ doc/adminguide/Makefile.am | 3 + .../groupware-kontact.docbook | 4 +- .../index.docbook} | 94 +++++++++++++------ doc/userguide/base-tde-applications.docbook | 2 +- doc/userguide/credits-and-license.docbook | 10 +- doc/userguide/index.docbook | 15 --- doc/userguide/under-the-hood.docbook | 9 +- doc/userguide/your-tde-account.docbook | 3 +- khelpcenter/plugins/CMakeLists.txt | 2 +- khelpcenter/plugins/Makefile.am | 2 +- khelpcenter/plugins/adminguide.desktop | 7 ++ 12 files changed, 104 insertions(+), 56 deletions(-) create mode 100644 doc/adminguide/CMakeLists.txt create mode 100644 doc/adminguide/Makefile.am rename doc/{userguide => adminguide}/groupware-kontact.docbook (99%) rename doc/{userguide/tde-for-admins.docbook => adminguide/index.docbook} (97%) create mode 100644 khelpcenter/plugins/adminguide.desktop 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 similarity index 99% rename from doc/userguide/groupware-kontact.docbook rename to 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: Reference -TDE: http://www.kde.org +KDE: http://www.kde.org &kontact; website: http://www.kontact.org Kroupware project: http://www.kroupware.org -&tde; Community Wiki: http://wiki.kde.org +&kde; Community Wiki: http://wiki.kde.org Wine project: http://www.winehq.org Cygwin/X project http://x.cygwin.com LTSP project: http://www.ltsp.org diff --git a/doc/userguide/tde-for-admins.docbook b/doc/adminguide/index.docbook similarity index 97% rename from doc/userguide/tde-for-admins.docbook rename to doc/adminguide/index.docbook index 815e69d45..9b767ec4a 100644 --- a/doc/userguide/tde-for-admins.docbook +++ b/doc/adminguide/index.docbook @@ -1,13 +1,71 @@ - + + + + + +]> -&tde; for Administrators + + + + +The &tde; (Trinity Desktop Environment) Administrator Guide + + +&tde-team; + + + + +2004-2005 +The &kde; Team + + +&tde-copyright-date; +&tde-team; + - -&tde; Internals + + +&tde-release-date; +&tde-release-version; + + +A general administrator guide to the Trinity Desktop Environment. + + +Please report problems with this document to +trinity-devel@lists.pearsoncomputing.net. + + + + +KDE +TDE +desktop +handbook +tutorial + + + + + +&tde; for Administrators Overview -to be written + +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. + @@ -763,7 +821,7 @@ Auto Save Interval=25 - + &tde; Startup Sequence @@ -1862,7 +1920,7 @@ profile- or system-wide locations. - + &tde; Panel 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. - + &tde; DIY - Building Your Own Tools @@ -2711,22 +2769,4 @@ file=$(kdialog --getexistingdirectory $HOME) &groupware-with-kontact; - - - + 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 @@ A GUI 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 SuperKaramba theme. - In the User Guide and + In the User Guide and The &tde; Administrator Guide Other Documentation: http://developer.kde.org/documentation/library/kdeqt/dcop.html 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 @@ -Wrote the notes which became . +Wrote the notes which became The &tde; +Administrator Guide. @@ -207,7 +208,8 @@ linkend="file-manager"/> and . Wrote . -Marked up parts of . +Marked up parts of The &tde; +Administrator Guide. @@ -270,8 +272,8 @@ linkend="file-manager"/> and . Wrote . -Marked up parts of . +Marked up parts of The &tde; +Administrator Guide. 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 @@ - - @@ -270,16 +268,6 @@ Internet applications. &tde; includes a powerful web browser, This part of the User Guide contains information about configuring these applications. - 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. - @@ -530,8 +518,6 @@ by entering help:/tdm in &konqueror;'s &tde-office; -&tde-for-admins; - More Tools @@ -593,7 +579,6 @@ started. &documentation.index; - 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 if you use sh. Related Information - contains +The &tde; +Administrator Guide contains more information about the directories that &tde; uses. 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