diff options
author | Darrell Anderson <[email protected]> | 2012-06-24 20:59:48 -0500 |
---|---|---|
committer | Darrell Anderson <[email protected]> | 2012-06-24 20:59:48 -0500 |
commit | 11f3dd1d15b41cb813fe4fcdfc57a75da7adc14a (patch) | |
tree | 48fcfe57b788c7d084459414fa3bb0d76a747915 /doc/khelpcenter | |
parent | 3726b33da55a0a3af923aea90e8b27781b6f5cac (diff) | |
download | tdebase-11f3dd1d15b41cb813fe4fcdfc57a75da7adc14a.tar.gz tdebase-11f3dd1d15b41cb813fe4fcdfc57a75da7adc14a.zip |
Update Help center: Reorganize TOC, rename files; initial update of FAQ,
Welcome, Quick Start guides; numerous revisions.
Diffstat (limited to 'doc/khelpcenter')
-rw-r--r-- | doc/khelpcenter/contact.docbook | 20 | ||||
-rw-r--r-- | doc/khelpcenter/help.docbook | 62 | ||||
-rw-r--r-- | doc/khelpcenter/support.docbook | 11 | ||||
-rw-r--r-- | doc/khelpcenter/welcome.docbook | 13 | ||||
-rw-r--r-- | doc/khelpcenter/whatistde.docbook | 18 |
5 files changed, 57 insertions, 67 deletions
diff --git a/doc/khelpcenter/contact.docbook b/doc/khelpcenter/contact.docbook index 598ebd8d5..ea693226d 100644 --- a/doc/khelpcenter/contact.docbook +++ b/doc/khelpcenter/contact.docbook @@ -1,12 +1,12 @@ <chapter id="contact-the-tde-team"> <chapterinfo> -<date>2012-02-01</date> -<releaseinfo>R14.0.0</releaseinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> </chapterinfo> -<title>Contact the &tde; Team</title> +<title>Contacting the &tde; Community</title> <anchor id="contact"/> -<para>The Trinity team invites you to contact members.</para> +<para>The Trinity team invites you to contact community members.</para> <sect1 id="contact-mailinglists"> <title>Mailing lists</title> @@ -34,15 +34,11 @@ url="http://www.trinitydesktop.org/mailinglist.php">mailing list archive</ulink> </variablelist> -</sect1> - -<sect1 id="contact-developers"> -<title>Contacting the &tde; developers</title> +<sect2 id="useful-links"> +<title>Useful web links</title> <anchor id="links" /> -<para>On this page are links to &tde; related web sites.</para> - -<para>The Trinity Desktop Environment is developed by many people +<para>The Trinity Desktop Environment is developed by people around the world. Our main communication channel is the Internet. For general questions, you will be best served by asking on the mailing lists mentioned in the <link linkend="contact-mailinglists">previous @@ -76,6 +72,7 @@ found in the documentation of their individual application.</para> </variablelist> +</sect2> </sect1> </chapter> <!-- Keep this comment at the end of the file @@ -89,4 +86,3 @@ sgml-always-quote-attributes:t sgml-parent-document:index.docbook End: --> - diff --git a/doc/khelpcenter/help.docbook b/doc/khelpcenter/help.docbook index b42afebe8..ebb67ab30 100644 --- a/doc/khelpcenter/help.docbook +++ b/doc/khelpcenter/help.docbook @@ -1,20 +1,20 @@ <chapter id="help-system-user-manual"> <chapterinfo> -<date>2002-02-03</date> -<releaseinfo>0.08.00</releaseinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> </chapterinfo> <title>&tde; Help System User Manual</title> <anchor id="help"/> <sect1 id="help-introduction"> <title>&tde; Help System</title> - + <para>The &tde; help system is designed to make accessing the common &UNIX; help systems (<application>man</application> and <application>info</application>) simple, as well as the native &tde; -documentation (&XML;). +documentation (&XML;). </para> - + <para> All base &tde; applications come fully documented, thanks to the efforts of the Documentation team. If you would like to help, please write to the Documentation coordinator, Lauri Watts, at @@ -36,10 +36,9 @@ of this document. <title>Installation</title> <para> -&khelpcenter; is an integral part of the &tde; Base installation, and -is installed with every copy of &tde;. It can be found in the tdebase -package, and is available from the &kde-ftp;, or will be found in your -operating system tdebase package. +&khelpcenter; is an integral part of the &tde; base installation and +is installed with every copy of &tde;. It can be found in the tdebase +package or will be found in your operating system tdebase package. </para> </sect2> @@ -52,15 +51,15 @@ operating system tdebase package. &khelpcenter; can be called in several ways: </para> -<variablelist> -<varlistentry> -<term>From the <guimenu>Help</guimenu> menu</term> +<variablelist> +<varlistentry> +<term>From the <guimenu>Help</guimenu> menu</term> <listitem> -<para> +<para> The most common will probably be from within an application. Choose <menuchoice><guimenu>Help</guimenu> <guimenuitem>Contents</guimenuitem></menuchoice> to open that -application's help file, at the contents page. +application's help file, at the contents page. </para> </listitem> </varlistentry> @@ -73,7 +72,7 @@ Choose the big <guiicon>K</guiicon> in your panel, and select <guimenuitem>Help</guimenuitem> to open &khelpcenter;, starting at the default welcome page. </para> -</listitem> +</listitem> </varlistentry> <varlistentry> @@ -83,7 +82,7 @@ default welcome page. By default, the &kicker; panel contains an icon to call &khelpcenter;. Again, the default welcome page is displayed. </para> -</listitem> +</listitem> </varlistentry> <varlistentry> @@ -94,14 +93,14 @@ Again, the default welcome page is displayed. file. &URL;s have been added for <command>info</command> and <command>man</command> pages also. You can use them as follows: -</para> +</para> <variablelist> <varlistentry> <term>An application help file</term> <listitem> <para> -<command>khelpcenter</command> +<command>khelpcenter</command> <option>help:/<replaceable>kedit</replaceable></option> </para> <para> @@ -134,7 +133,7 @@ Opens the &kedit; help file, at the contents page. <term>An Info page</term> <listitem> <para> -<command>khelpcenter</command> +<command>khelpcenter</command> <option>info:/<replaceable>gcc</replaceable></option> </para> </listitem> @@ -177,7 +176,7 @@ different document, and you can use the <guiicon>Back</guiicon> (Left pointing arrow) or <guiicon>Forward</guiicon> (Right pointing arrow) icons on the toolbar to move through the documents you have viewed in this session. -</para> +</para> <para> The two panes display the contents of the help system, and the help @@ -192,7 +191,7 @@ The <guilabel>Contents</guilabel> pane in &khelpcenter; is displayed on the left hand side of the window. As you might expect, you can move the splitter bar, to make sure you can comfortably read the contents of either pane. -</para> +</para> <para> The <guilabel>Contents</guilabel> pane is further divided into two @@ -208,7 +207,7 @@ of terms. <para> The <guilabel>Contents</guilabel> contains the following default entries: -</para> +</para> <variablelist> <varlistentry> @@ -234,7 +233,7 @@ Interface and specific help and tips on how to work smarter with &tde;. The &tde; User's manual is an in-depth exploration of &tde;, including installation, configuration and customization, and use. </para> -</listitem> +</listitem> </varlistentry> <varlistentry> @@ -245,14 +244,14 @@ Native &tde; application documentation. All &tde; applications have documentation in &XML; format, which are converted to <acronym>HTML</acronym> when you view them. This section lists all the &tde; applications with a brief description and a link to the full -application documentation. +application documentation. </para> <para> The applications are displayed in a tree structure that echoes the default structure of the <guimenu>K</guimenu> menu, making it easy to find the application you are looking for. </para> -</listitem> +</listitem> </varlistentry> <varlistentry> @@ -264,7 +263,7 @@ application you are looking for. addition, man pages exist for programming functions and file formats. </para> -</listitem> +</listitem> </varlistentry> <varlistentry> @@ -327,7 +326,7 @@ How to help, and how to get involved. </variablelist> </sect3> -<!-- +<!-- <sect3 id="search"> <title>The <guilabel>Search</guilabel> tab</title> @@ -364,7 +363,7 @@ Choose how to search for multiple words. If you choose terms are included in the page. <guilabel>or</guilabel> returns results if <emphasis>any</emphasis> of the search terms are found, and <guilabel>boolean</guilabel> lets you search using a combination. -</para> +</para> <para> Boolean syntax lets you use the operators <literal>AND</literal>, <literal>OR</literal> and <literal>NOT</literal> to create complex @@ -388,7 +387,7 @@ them.</para></listitem> for pages which contain <userinput>dog</userinput> but don't contain <userinput>nose</userinput>. Pages which contain both <userinput>cat</userinput> and <userinput>nose</userinput> would be returned, -pages containing all three words would not.</para></listitem> +pages containing all three words would not.</para></listitem> </varlistentry> </variablelist> <para>If your searches are not returning the results you expect, check @@ -404,7 +403,7 @@ search.</para></listitem> <term><guilabel>Format</guilabel></term> <listitem><para>Decide if you want just a short link to the page containing your search terms, or do you want a longer -summary.</para></listitem> +summary.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Sort</guilabel></term> @@ -730,7 +729,8 @@ will take you directly back to that page.</para> <para>&khelpcenter;</para> <para>Originally developed by &Matthias.Elter; &Matthias.Elter.mail;</para> -<para>The current maintainer is &Cornelius.Schumacher; &Cornelius.Schumacher.mail;</para> +<para>Maintained for many years by &Cornelius.Schumacher; &Cornelius.Schumacher.mail;</para> +<para>Currently maintained by the Trinity Development Team.</para> &underFDL; &underGPL; diff --git a/doc/khelpcenter/support.docbook b/doc/khelpcenter/support.docbook index dda5d3586..b02609f69 100644 --- a/doc/khelpcenter/support.docbook +++ b/doc/khelpcenter/support.docbook @@ -1,13 +1,13 @@ <chapter id="supporting-tde"> <chapterinfo> -<date>2002-03-04</date> -<releaseinfo>2.02.00</releaseinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> </chapterinfo> -<title>Supporting &tde;</title> +<title>Supporting the &tde; Project</title> <anchor id="support"/> <sect1 id="supporting-tde-introduction"> -<title>Supporting &tde;</title> +<title>Supporting the &tde; Project</title> <para> If you are new to &tde;, the &tde; project might look like big machinery to you. Undoubtedly, &tde; is no longer a small project, @@ -40,7 +40,7 @@ that interest you. </para></listitem> <listitem><para> -Read the <ulink url="[email protected]">&tde; +Read the <ulink url="http://trinity-devel.pearsoncomputing.net/">&tde; developer mailing list</ulink> archives to get a feel for &tde; development. </para></listitem> @@ -77,4 +77,3 @@ actively involved in &tde; development, please consider supporting </sect1> </chapter> - diff --git a/doc/khelpcenter/welcome.docbook b/doc/khelpcenter/welcome.docbook index d77c0033e..ff18cb5ee 100644 --- a/doc/khelpcenter/welcome.docbook +++ b/doc/khelpcenter/welcome.docbook @@ -6,7 +6,7 @@ <title>Welcome to the Trinity Desktop Environment (&tde;)</title> <anchor id="welcome"/> -<para>The Trinity team welcomes you to user-friendly &UNIX;desktop computing.</para> +<para>The Trinity team welcomes you to user-friendly &UNIX; desktop computing.</para> <sect1 id="welcome-information-about-tde"> <title>Information about &tde;</title> @@ -14,16 +14,16 @@ <para>&tde; is a graphical desktop environment for &UNIX; workstations. The Trinity Desktop Environment combines ease of use, contemporary functionality, and professional graphical design along with the technical advantages of -the &UNIX; operating system.</para> +&UNIX; operating systems.</para> + +<para><link linkend="help">TDE Help System User Manual</link></para> <para><link linkend="what-is-tde">What is the Trinity Desktop Environment?</link></para> -<para><link linkend="contact">Contacting the &tde; Project Team Members</link></para> +<para><link linkend="contact">Contacting the &tde; Community</link></para> <para><link linkend="support">Supporting the &tde; Project</link></para> -<para><link linkend="links">Useful links</link></para> - </sect1> <sect1 id="welcome-getting-the-most-out-of-tde"> @@ -43,7 +43,7 @@ the &UNIX; operating system.</para> <sect2 id="welcome-basic-applications"> <title>Basic applications</title> -<para><ulink url="help:/kicker">Desktop Panel</ulink></para> +<para><ulink url="help:/kicker">Desktop Panel (Kicker)</ulink></para> <para><ulink url="help:/kcontrol">Control Center</ulink></para> @@ -52,4 +52,3 @@ the &UNIX; operating system.</para> </sect2> </sect1> </chapter> - diff --git a/doc/khelpcenter/whatistde.docbook b/doc/khelpcenter/whatistde.docbook index 964edc9ee..9da36104a 100644 --- a/doc/khelpcenter/whatistde.docbook +++ b/doc/khelpcenter/whatistde.docbook @@ -1,13 +1,13 @@ <chapter id="what-is-tde"> <chapterinfo> -<date>2002-01-18</date> -<releaseinfo>3.00.00</releaseinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> </chapterinfo> -<title>What is &tde;?</title> +<title>What is the Trinity Desktop Environment?</title> <anchor id="whatistde"/> <sect1 id="what-is-tde-introduction"> -<title>What is &tde;?</title> +<title>What is the Trinity Desktop Environment?</title> <para>&tde; is a desktop environment. In other words, &tde; is a collection of programs, technologies and documentation that attempt to @@ -17,12 +17,9 @@ philosophy.</para> <para>The Trinity Desktop Environment is a fork of the K Desktop Environment version 3.5, originally written by the KDE Team, a world-wide network of -software engineers committed to Free Software development.</para> - -<para>The creators of the K Desktop Environment are a world-wide group of -software engineers. This group's major goal in free software development is to -provide high quality software that empowers the user with easy control of his -computer's resources.</para> +software engineers committed to Free Software development. This group's +major goal in free software development is to provide high quality software +that empowers the user with easy control of his computer's resources.</para> <para>The &tde; developers continue the tradition of KDE 3.5.</para> @@ -122,4 +119,3 @@ Information Manager - an organizer).</para> </sect1> </chapter> - |