diff options
Diffstat (limited to 'doc/khelpcenter/help.docbook')
| -rw-r--r-- | doc/khelpcenter/help.docbook | 123 |
1 files changed, 60 insertions, 63 deletions
diff --git a/doc/khelpcenter/help.docbook b/doc/khelpcenter/help.docbook index ebb67ab30..a2ab707e3 100644 --- a/doc/khelpcenter/help.docbook +++ b/doc/khelpcenter/help.docbook @@ -16,21 +16,16 @@ 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 -<email>lauri@kde.org</email> for information. No experience is -required, just enthusiasm and patience. +the efforts of many people. If you would like to help, +please contact members of the Trinity development team at +<email>trinity-devel@lists.pearsoncomputing.net</email> for information. +Experience is not required, just enthusiasm and patience. </para> <para> -If you would like to help translating &tde; documentation to your native -language, the Translation coordinator is Thomas Diehl, -<email>thd@kde.org</email>, and he would also welcome the help. More -information, including the coordinators for each language team, can be -found on the <ulink url="http://i18n.kde.org">Internationalization web -site</ulink>, and in the <link linkend="contact">Contact</link> section -of this document. -</para> +If you would like to help translate &tde; documentation to your native +language,please contact members of the Trinity development team at +<email>trinity-devel@lists.pearsoncomputing.net</email> for information.</para> <sect2 id="installation"> <title>Installation</title> @@ -56,7 +51,7 @@ package or will be found in your operating system tdebase package. <term>From the <guimenu>Help</guimenu> menu</term> <listitem> <para> -The most common will probably be from within an application. Choose +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. @@ -65,10 +60,10 @@ application's help file, at the contents page. </varlistentry> <varlistentry> -<term>From the <guimenu>K</guimenu> menu</term> +<term>From the <guimenu>TDE</guimenu> menu</term> <listitem> <para> -Choose the big <guiicon>K</guiicon> in your panel, and select +Choose the big <guiicon>T</guiicon> in your panel, and select <guimenuitem>Help</guimenuitem> to open &khelpcenter;, starting at the default welcome page. </para> @@ -90,7 +85,7 @@ Again, the default welcome page is displayed. <listitem> <para> &khelpcenter; may be started using a &URL; to display a -file. &URL;s have been added for +file. &URL;s have been added for <command>info</command> and <command>man</command> pages also. You can use them as follows: </para> @@ -188,7 +183,7 @@ files themselves, on the left and right respectively. <para> The <guilabel>Contents</guilabel> pane in &khelpcenter; is -displayed on the left hand side of the window. As you might expect, you +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> @@ -211,26 +206,28 @@ entries: <variablelist> <varlistentry> -<term><guilabel>Introduction</guilabel></term> -<listitem><para>Welcome to &tde; - an introduction to the Trinity Desktop +<term><guilabel>Welcome to &tde;</guilabel></term> +<listitem><para>An introduction to the Trinity Desktop Environment.</para></listitem> </varlistentry> <varlistentry> -<term><guilabel>Introduction to &tde;</guilabel></term> -<listitem> -<para> -The &tde; Quickstart guide. Contains a tour of the &tde; +<term><guilabel>A Visual Guide to &tde;</guilabel></term> +<listitem><para>A visual summary of Trinity +widgets.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>The Quickstart Guide</guilabel></term> +<listitem><para>Contains a tour of the &tde; Interface and specific help and tips on how to work smarter with &tde;. </para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>&tde; User's manual</guilabel></term> -<listitem> -<para> -The &tde; User's manual is an in-depth exploration of &tde;, including +<term><guilabel>&tde; User Guide</guilabel></term> +<listitem><para>An in-depth exploration of &tde;, including installation, configuration and customization, and use. </para> </listitem> @@ -240,7 +237,7 @@ installation, configuration and customization, and use. <term><guilabel>Application manuals</guilabel></term> <listitem> <para> -Native &tde; application documentation. All &tde; applications have +Native &tde; application documentation. &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 @@ -248,17 +245,17 @@ 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 +structure of the <guimenu>TDE</guimenu> menu, making it easy to find the application you are looking for. </para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>&UNIX; manual pages</guilabel></term> +<term><guilabel>Unix manual pages</guilabel></term> <listitem> <para> -&UNIX; man pages are the traditional on-line documentation format for +Man pages are the traditional on-line documentation format for &UNIX; systems. Most programs on your system will have a man page. In addition, man pages exist for programming functions and file formats. @@ -277,40 +274,40 @@ including <command>gcc</command> (the C/C++ compiler), </listitem> </varlistentry> -<varlistentry> +<!--<varlistentry> <term><guilabel>Tutorials</guilabel></term> <listitem> <para> Short, task based or informational tutorials. </para> </listitem> -</varlistentry> +</varlistentry>--> <varlistentry> <term><guilabel>The &tde; FAQ</guilabel></term> <listitem> <para> -Frequently asked questions about &tde;, and their answers. +Frequently asked questions about &tde; and answers. </para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>&tde; on the web</guilabel></term> +<term><guilabel>Contact Information</guilabel></term> <listitem> <para> -Links to &tde; on the web, both the official &tde; website, and other -useful sites. +Information about contacting &tde; developers, and how to join the +&tde; mailing lists. </para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>Contact Information</guilabel></term> +<term><guilabel>&tde; on the Web</guilabel></term> <listitem> <para> -Information on how to contact &tde; developers, and how to join the -&tde; mailing lists. +Links to &tde; on the web, both the official &tde; website, and other +useful sites. </para> </listitem> </varlistentry> @@ -332,8 +329,8 @@ How to help, and how to get involved. <para> Searching requires you have the <application>ht://Dig</application> -application installed. Information on installing and configuring the -search index is available in the document. Configuration of the search +application installed. Information on installing and configuring the +search index is available in the document. Configuration of the search index is performed in the &kcontrol;, by choosing <menuchoice><guisubmenu>Help</guisubmenu><guimenuitem>Index</guimenuitem></menuchoice>, and detailed help is available from this module. @@ -347,7 +344,7 @@ up and configured. <para> Searching the help files is fairly intuitive, enter the word(s) you wish to search for in the text box, choose your options (if any), and press -<guibutton>Search</guibutton>. The results display in the viewer pane +<guibutton>Search</guibutton>. The results display in the viewer pane to the right. </para> @@ -358,7 +355,7 @@ to the right. <term><guilabel>Method</guilabel></term> <listitem> <para> -Choose how to search for multiple words. If you choose +Choose how to search for multiple words. If you choose <guilabel>and</guilabel>, results are returned only if all your search terms are included in the page. <guilabel>or</guilabel> returns results if <emphasis>any</emphasis> of the search terms are found, and @@ -372,7 +369,7 @@ searches. Some examples:</para> <varlistentry> <term><userinput>cat and dog</userinput></term> <listitem><para>Searches for pages which have both the words -<userinput>cat</userinput> and <userinput>dog</userinput> in them. Pages with +<userinput>cat</userinput> and <userinput>dog</userinput> in them. Pages with only one or the other will not be returned.</para></listitem> </varlistentry> <varlistentry> @@ -385,7 +382,7 @@ them.</para></listitem> <term><userinput>cat or (dog not nose)</userinput></term> <listitem><para>Searches for pages which contain <userinput>cat</userinput>, and for pages which contain <userinput>dog</userinput> but don't contain -<userinput>nose</userinput>. Pages which contain both +<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> </varlistentry> @@ -409,14 +406,14 @@ summary.</para></listitem> <term><guilabel>Sort</guilabel></term> <listitem><para>Sort the results in order of <guilabel>Score</guilabel> (how closely your search terms were matched,) alphabetically by -<guilabel>Title</guilabel> or by <guilabel>Date</guilabel>. Selecting the +<guilabel>Title</guilabel> or by <guilabel>Date</guilabel>. Selecting the <guilabel>Reverse order</guilabel> check box, naturally enough, reverses the sort order of the results.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Update index</guilabel></term> <listitem><para>Update the search index, to incorporate new documents, -or if you think your database is incomplete or damaged. This may take +or if you think your database is incomplete or damaged. This may take some time.</para></listitem> </varlistentry> </variablelist> @@ -430,30 +427,30 @@ some time.</para></listitem> sections</title> <para>Man pages are the standard &UNIX; manual pages, and have been in -use for many years on many operating systems. They are extremely +use for many years on many operating systems. They are extremely thorough, and are the very best place to get information about most -&UNIX; commands and applications. When people say +&UNIX; commands and applications. When people say <quote>RTFM</quote>, the Manual they are referring to is very often the man page.</para> -<para>The man pages are not perfect. They tend to be in depth, but +<para>The man pages are not perfect. They tend to be in depth, but also extremely technical, often written by developers, and for developers. In some cases this makes them somewhat unfriendly, if not -downright impossible for many users to understand. They are, however, +downright impossible for many users to understand. They are, however, the best source of solid information on most command line applications, and very often the only source.</para> <para>If you've ever wondered what the number is when people write things like man(1) it means which section of the manual the item is -in. You will see &khelpcenter; uses the numbers to divide the very many +in. You will see &khelpcenter; uses the numbers to divide the very many man pages into their own sections, making it easier for you to find the information you're looking for, if you're just browsing.</para> <para>Also available are the Info pages, intended to be a replacement -for the man pages. The maintainer of some applications no longer +for the man pages. The maintainer of some applications no longer update the man pages, so if there is both a man page and an info page -available, the info page is probably the most recent. Most -applications have one or the other though. If the application you are +available, the info page is probably the most recent. Most +applications have one or the other though. If the application you are looking for help on is a &GNU; utility, you will most likely find it has an info page, not a man page.</para> @@ -462,7 +459,7 @@ has an info page, not a man page.</para> <para>Info documents are arranged hierarchically with each page called a node. All info documents have a <guilabel>Top</guilabel> node, -&ie; the opening page. You can return to the +&ie; the opening page. You can return to the <guilabel>Top</guilabel> of an info document by pressing <guilabel>Top</guilabel>.</para> @@ -475,7 +472,7 @@ level in the hierarchy. You may move up the hierarchy by pressing <guibutton>Up</guibutton>.</para> <para>Man is treated similarly to info, with the section index being -the Top node and each man page on the level below. Man entries are +the Top node and each man page on the level below. Man entries are one page long.</para> </sect3> @@ -486,7 +483,7 @@ one page long.</para> <para> The glossary provides a quick reference point, where you can look up -the definitions of words that may be unfamiliar to you. These range +the definitions of words that may be unfamiliar to you. These range from &tde; specific applications and technologies, through to general &UNIX; computing terms. </para> @@ -531,7 +528,7 @@ The icons available to you in the toolbar are as follows: <varlistentry> <term><guiicon>Forward</guiicon></term> <listitem> -<para>Go forward one page. This icon is only active if you have +<para>Go forward one page. This icon is only active if you have already used the <guiicon>Back</guiicon> icon.</para></listitem> </varlistentry> @@ -566,7 +563,7 @@ Increase the size of the text in the viewer pane. <term><guiicon>Decrease Font</guiicon></term> <listitem> <para> -Decrease the size of the text in the viewer pane. This icon is only +Decrease the size of the text in the viewer pane. This icon is only enabled if you have previously enlarged the text. </para> </listitem> @@ -679,7 +676,7 @@ View the <acronym>HTML</acronym> source of the page you are currently </term> <listitem> <para> -Change the encoding of the current page. Normally, the default setting +Change the encoding of the current page. Normally, the default setting of <guimenuitem>Auto</guimenuitem> should be sufficient, but if you are having problems viewing pages written in languages other than English, you may need to choose a specific encoding in this menu. @@ -715,7 +712,7 @@ entry.</para> </menuchoice></term> <listitem> <para>At the bottom of the <guimenu>Go</guimenu> menu, you will find a -history list, of the last few pages you have looked at. Selecting one +history list, of the last few pages you have looked at. Selecting one will take you directly back to that page.</para> </listitem></varlistentry></variablelist> |