diff options
Diffstat (limited to 'doc/khelpcenter')
-rw-r--r-- | doc/khelpcenter/CMakeLists.txt | 12 | ||||
-rw-r--r-- | doc/khelpcenter/Makefile.am | 6 | ||||
-rw-r--r-- | doc/khelpcenter/background.png | bin | 0 -> 128431 bytes | |||
-rw-r--r-- | doc/khelpcenter/bgtable.png | bin | 0 -> 25929 bytes | |||
-rw-r--r-- | doc/khelpcenter/contact.docbook | 83 | ||||
-rw-r--r-- | doc/khelpcenter/help.docbook | 782 | ||||
-rw-r--r-- | doc/khelpcenter/index.docbook | 83 | ||||
-rw-r--r-- | doc/khelpcenter/kdelogo2.png | bin | 0 -> 5462 bytes | |||
-rw-r--r-- | doc/khelpcenter/khelpcenter.png | bin | 0 -> 1687 bytes | |||
-rw-r--r-- | doc/khelpcenter/konq.css | 68 | ||||
-rw-r--r-- | doc/khelpcenter/lines.png | bin | 0 -> 259 bytes | |||
-rw-r--r-- | doc/khelpcenter/lines2.png | bin | 0 -> 198 bytes | |||
-rw-r--r-- | doc/khelpcenter/pointers.png | bin | 0 -> 268 bytes | |||
-rw-r--r-- | doc/khelpcenter/shadow1.png | bin | 0 -> 184 bytes | |||
-rw-r--r-- | doc/khelpcenter/support.docbook | 79 | ||||
-rw-r--r-- | doc/khelpcenter/welcome.docbook | 56 | ||||
-rw-r--r-- | doc/khelpcenter/whatistde.docbook | 120 |
17 files changed, 1289 insertions, 0 deletions
diff --git a/doc/khelpcenter/CMakeLists.txt b/doc/khelpcenter/CMakeLists.txt new file mode 100644 index 000000000..279f09d4d --- /dev/null +++ b/doc/khelpcenter/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter ) diff --git a/doc/khelpcenter/Makefile.am b/doc/khelpcenter/Makefile.am new file mode 100644 index 000000000..251280f85 --- /dev/null +++ b/doc/khelpcenter/Makefile.am @@ -0,0 +1,6 @@ + +SUBDIRS = $(AUTODIRS) + +KDE_LANG= en +KDE_DOCS = AUTO + diff --git a/doc/khelpcenter/background.png b/doc/khelpcenter/background.png Binary files differnew file mode 100644 index 000000000..2dda48e23 --- /dev/null +++ b/doc/khelpcenter/background.png diff --git a/doc/khelpcenter/bgtable.png b/doc/khelpcenter/bgtable.png Binary files differnew file mode 100644 index 000000000..b52f2e6f2 --- /dev/null +++ b/doc/khelpcenter/bgtable.png diff --git a/doc/khelpcenter/contact.docbook b/doc/khelpcenter/contact.docbook new file mode 100644 index 000000000..9b9f7d076 --- /dev/null +++ b/doc/khelpcenter/contact.docbook @@ -0,0 +1,83 @@ +<chapter id="contact-the-tde-team"> +<chapterinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> +</chapterinfo> +<title>Contacting the &tde; Community</title> +<anchor id="contact"/> + +<para>The Trinity team invites you to contact community members.</para> + +<sect1 id="contact-mailinglists"> +<title>Mailing lists</title> + +<para> &tde; has some mailing lists. See below for some of the +most useful. Older articles can be found in the <ulink +url="https://www.trinitydesktop.org/mailinglist.php">mailing list archive</ulink>.</para> + +<variablelist> + +<varlistentry> +<term><ulink url="https://www.trinitydesktop.org/mailinglist.php">tde-users</ulink></term> +<listitem><para>For general discussion, users helping each other.</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="https://www.trinitydesktop.org/mailinglist.php">tde-announce</ulink></term> +<listitem><para>Announcements of &tde; news</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="https://www.trinitydesktop.org/mailinglist.php">tde-devel</ulink></term> +<listitem><para>For developers, artists, documentation writers.</para></listitem> +</varlistentry> + +</variablelist> + +<sect2 id="useful-links"> +<title>Useful web links</title> +<anchor id="links" /> + +<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 +section</link>, and contact addresses for individual developers can be +found in the documentation of their individual application.</para> + +<para>More information about &tde; is available at &tde-http;.</para> + +<para>Other &tde; websites include:</para> + +<variablelist> +<varlistentry> +<term><ulink url="https://www.trinitydesktop.org/wiki">www.trinitydesktop.org/wiki</ulink></term> +<listitem><para>The &tde; Wiki</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="http://git.trinitydesktop.org/cgit/">git.trinitydesktop.org/cgit/</ulink></term> +<listitem><para>A web interface to the &tde; GIT repository</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="https://www.trinitydesktop.org/support.php">Internet Relay Chat</ulink></term> +<listitem><para>The freenode &tde; internet relay chat channel is #trinity-desktop.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> +</sect1> +</chapter> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:nil +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-always-quote-attributes:t +sgml-parent-document:index.docbook +End: +--> diff --git a/doc/khelpcenter/help.docbook b/doc/khelpcenter/help.docbook new file mode 100644 index 000000000..fd6e68d34 --- /dev/null +++ b/doc/khelpcenter/help.docbook @@ -0,0 +1,782 @@ +<chapter id="help-system-user-manual"> +<chapterinfo> +<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;). +</para> + +<para> All base &tde; applications come fully documented, thanks to +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 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> + +<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 or will be found in your operating system tdebase package. +</para> + +</sect2> +</sect1> + +<sect1 id="invoking-help"> +<title>Invoking Help</title> + +<para> +&khelpcenter; can be called in several ways: +</para> + +<variablelist> +<varlistentry> +<term>From the <guimenu>Help</guimenu> menu</term> +<listitem> +<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. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>From the <guimenu>TDE</guimenu> menu</term> +<listitem> +<para> +Choose the big <guiicon>T</guiicon> in your panel, and select +<guimenuitem>Help</guimenuitem> to open &khelpcenter;, starting at the +default welcome page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>From the panel</term> +<listitem> +<para> +By default, the &kicker; panel contains an icon to call &khelpcenter;. +Again, the default welcome page is displayed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>From the command line</term> +<listitem> +<para> +&khelpcenter; may be started using a &URL; to display a +file. &URL;s have been added for +<command>info</command> and <command>man</command> pages +also. You can use them as follows: +</para> + +<variablelist> +<varlistentry> +<term>An application help file</term> +<listitem> +<para> +<command>khelpcenter</command> +<option>help:/<replaceable>kedit</replaceable></option> +</para> +<para> +Opens the &kedit; help file, at the contents page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>A local &URL;</term> +<listitem><para> +<command>khelpcenter</command> +<option>file:/ +<replaceable>usr/local/src/qt/html/index.html</replaceable></option> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>A Man page</term> +<listitem> +<para> +<command>khelpcenter</command> +<option>man:/<replaceable>strcpy</replaceable></option> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>An Info page</term> +<listitem> +<para> +<command>khelpcenter</command> +<option>info:/<replaceable>gcc</replaceable></option> +</para> +</listitem> +</varlistentry> +</variablelist> + +<para> +Invoking <command>khelpcenter</command> with no parameters opens the +default welcome page. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="interface-basics"> +<title>The &khelpcenter; interface</title> + +<para> +The &khelpcenter; interface consists of two panes of information. +</para> + +<para> +The toolbar and menus are explained further in <xref + linkend="menu-and-toolbar-ref"/>. +</para> + +<para> +Documents contain their own navigation tools, enabling you to move +either sequentially through a document, using +<guilabel>Next</guilabel>, <guilabel>Previous</guilabel>, and +<guilabel>Home</guilabel> links, or to move around in a less +structured manner, using hyperlinks. +</para> + +<para> +Links can take you to other parts of the same document, or to a +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> +The two panes display the contents of the help system, and the help +files themselves, on the left and right respectively. +</para> + +<sect2 id="contents-pane"> +<title>The <guilabel>Contents</guilabel> pane</title> + +<para> +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> +The <guilabel>Contents</guilabel> pane includes three tabs, the +<guilabel>Contents</guilabel> tab selects the <guilabel>Contents</guilabel> pane, +the <guilabel>Glossary</guilabel> tab opens the &tde; +<link linkend="tde-glossary">glossary</link> of terms, and the <guilabel>Search Options</guilabel> +tab allows searching all help handbooks. +</para> + +<sect3 id="contents-menu"> +<title>The <guilabel>Contents</guilabel> Menu</title> + +<para> +The <guilabel>Contents</guilabel> contains the following default +entries: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Welcome to &tde;</guilabel></term> +<listitem><para>An introduction to the Trinity Desktop +Environment.</para></listitem> +</varlistentry> + +<varlistentry> +<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 Guide</guilabel></term> +<listitem><para>An in-depth exploration of &tde;, including +installation, configuration and customization, and use. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>&tde; Administrator Guide</guilabel></term> +<listitem><para>A reference guide to &tde; features, structure, framework +and configurations useful to administrators. The information also is useful +to single-user systems. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Application Manuals</guilabel></term> +<listitem> +<para> +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 +application documentation. +</para> +<para> +The applications are displayed in a tree structure that echoes the default +structure of the <guimenu>TDE</guimenu> menu, making it easy to find the +application you are looking for. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Applet Manuals</guilabel></term> +<listitem> +<para> +Similar to Application Manuals but for applets that run in the &tde; panel. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Unix manual pages</guilabel></term> +<listitem> +<para> +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. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Browse info pages</guilabel></term> +<listitem> +<para> +TeXinfo documentation is used by many &GNU; applications, +including <command>gcc</command> (the C/C++ compiler), +<command>emacs</command>, and many others. +</para> +</listitem> +</varlistentry> + +<!--<varlistentry> +<term><guilabel>Tutorials</guilabel></term> +<listitem> +<para> +Short, task based or informational tutorials. +</para> +</listitem> +</varlistentry>--> + +<varlistentry> +<term><guilabel>The &tde; FAQ</guilabel></term> +<listitem> +<para> +Frequently asked questions about &tde; and answers. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Contact Information</guilabel></term> +<listitem> +<para> +Information about contacting &tde; developers, and how to join the +&tde; mailing lists. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>&tde; on the Web</guilabel></term> +<listitem> +<para> +Links to &tde; on the web, both the official &tde; website, and other +useful sites. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Supporting &tde;</guilabel></term> +<listitem> +<para> +How to help, and how to get involved. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> +<!-- +<sect3 id="search"> +<title>The <guilabel>Search</guilabel> tab</title> + +<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 +index is performed in the &kcontrol;, by choosing +<menuchoice><guisubmenu>Help</guisubmenu><guimenuitem>Index</guimenuitem></menuchoice>, +and detailed help is available from this module. +</para> + +<para> +For the purposes of this document, we'll assume you already have this set +up and configured. +</para> + +<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 +to the right. +</para> + +<para>The options available are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Method</guilabel></term> +<listitem> +<para> +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 +<guilabel>boolean</guilabel> lets you search using a combination. +</para> +<para> +Boolean syntax lets you use the operators <literal>AND</literal>, +<literal>OR</literal> and <literal>NOT</literal> to create complex +searches. Some examples:</para> +<variablelist> +<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 +only one or the other will not be returned.</para></listitem> +</varlistentry> +<varlistentry> +<term><userinput>cat not dog</userinput></term> +<listitem><para>Searches for pages with <userinput>cat</userinput> in them, but +only returns the ones that don't have the word <userinput>dog</userinput> in +them.</para></listitem> +</varlistentry> +<varlistentry> +<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>cat</userinput> and <userinput>nose</userinput> would be returned, +pages containing all three words would not.</para></listitem> +</varlistentry> +</variablelist> +<para>If your searches are not returning the results you expect, check +carefully you haven't excluded the wrong search term with an errand +<literal>NOT</literal> or a stray brace.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Max. results</guilabel></term> +<listitem><para>Determines the maximum number of results returned from your +search.</para></listitem> +</varlistentry> +<varlistentry> +<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> +</varlistentry> +<varlistentry> +<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>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 +some time.</para></listitem> +</varlistentry> +</variablelist> +</sect3> +--> + +</sect2> + +<sect2 id="tde-glossary"> +<title>The Glossary</title> + +<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 +from &tde; specific applications and technologies, through to general +&UNIX; computing terms. +</para> + +<para> +In the left hand pane you will see a tree view, with two choices: +<guilabel>Alphabetically</guilabel> or <guilabel>By topic</guilabel>. +Both contain the same entries, sorted differently, to allow you to +quickly find the item of interest. +</para> + +<para> +Navigate down the tree views to the left, and items you select will be +displayed on the right. +</para> + +</sect2> + +<sect2 id="tde-search-options"> +<title>Search Options</title> + +<para>&tde; comes with a lot of documentation for applications and +components. While possible to just browse the manuals until you +find that piece of information you're looking for, this may be a very +time-consuming task. To make this easier for you, &tde; offers +full text search using a program called +<application>ht://dig</application>. It works quite similar to search +engines on the web and some search engines might even use +<application>ht://dig</application>.</para> + +<para>To use <application>ht://dig</application>, select the <guilabel>Search +Options</guilabel> tab in the &khelpcenter; <guilabel>Contents</guilabel> pane, +enter the word you are looking for, then select the <guibutton>Search</guibutton>.</para> + +<para>However, to use this feature, <application>ht://dig</application> +must be installed on your system. If you haven't installed +<application>ht://dig</application> and the package wasn't shipped with your +operating system you have to get ht://dig yourself. Use your package manager +to search for the package.</para> + +<para>To build the search index, at the bottom of the <guilabel>Contents</guilabel> pane, +select the <guilabel>Build Search Index button</guilabel>.</para> + +</sect2> + +<sect2 id="man-and-info"> +<title>The <application>Man</application> and <application>Info</application> +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 +thorough, and are the very best place to get information about most +&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 +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, +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 +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 +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 +looking for help on is a &GNU; utility, you will most likely find it +has an info page, not a man page.</para> + +<sect3 id="navigation"> +<title>Navigating inside the <application>Info</application> pages</title> + +<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 +<guilabel>Top</guilabel> of an info document by pressing +<guilabel>Top</guilabel>.</para> + +<para><guibutton>Prev</guibutton> & <guibutton>Next</guibutton> +are used to move to the previous/next page at the current level of the +hierarchy.</para> + +<para>Clicking on a menu item within a document moves you to a lower +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 +one page long.</para> + +</sect3> +</sect2> + +<sect2 id="menu-and-toolbar-ref"> +<title>The menus and toolbar</title> + +<para> +&khelpcenter; has a very minimal interface, allowing you to concentrate +on getting help rather than learning how to use the help browser. +</para> + +<para> +The icons available to you in the toolbar are as follows: +</para> + +<variablelist> +<title>Toolbar Icons</title> + +<varlistentry> + +<term><guiicon>Back</guiicon></term> +<listitem> +<para>Go to the previous page you viewed.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Forward</guiicon></term> +<listitem> +<para>Go forward one page. This icon is only active if you have +already used the <guiicon>Back</guiicon> icon.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Print</guiicon></term> +<listitem> +<para> +Print the contents of the currently visible page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Find</guiicon></term> +<listitem> +<para> +Find a word or words within the currently visible page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Increase Font</guiicon></term> +<listitem> +<para> +Increase the size of the text in the viewer pane. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Decrease Font</guiicon></term> +<listitem> +<para> +Decrease the size of the text in the viewer pane. This icon is only +enabled if you have previously enlarged the text. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para> +The menus contain the following entries: +</para> + +<variablelist> +<varlistentry> +<term><guimenu>File</guimenu></term> +<listitem> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Print the contents of the currently visible page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Close and exit &khelpcenter; +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Edit</guimenu></term> +<listitem> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Select all the text in the current page. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Find a word or words in the currently visible page. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>View</guimenu></term> +<listitem> +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>View Document Source</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the <acronym>HTML</acronym> source of the page you are currently + viewing. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>View</guimenu> +<guisubmenu>Set Encoding</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +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. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Go</guimenu> +<guimenuitem>Back</guimenuitem></menuchoice></term> +<listitem> +<para>Go back to the previous page you were viewing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Go</guimenu> +<guimenuitem>Forward</guimenuitem> +</menuchoice></term> +<listitem> +<para>If you have previously moved back with the back icon or menu +entry, you can work your way forward again with this menu +entry.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Go</guimenu> +<guimenuitem>...</guimenuitem> +</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 +will take you directly back to that page.</para> +</listitem></varlistentry></variablelist> + +</sect2> + +</sect1> + +<sect1 id="credits"> +<title>Credits and Licenses</title> + +<para>&khelpcenter;</para> + +<para>Originally developed by &Matthias.Elter; &Matthias.Elter.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; + +</sect1> +</chapter> + diff --git a/doc/khelpcenter/index.docbook b/doc/khelpcenter/index.docbook new file mode 100644 index 000000000..efd05100a --- /dev/null +++ b/doc/khelpcenter/index.docbook @@ -0,0 +1,83 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY contact SYSTEM "contact.docbook"> + <!ENTITY help SYSTEM "help.docbook"> + <!ENTITY support SYSTEM "support.docbook"> + <!ENTITY whatistde SYSTEM "whatistde.docbook"> + <!ENTITY welcome SYSTEM "welcome.docbook"> + <!ENTITY quickstart SYSTEM "quickstart/index.docbook" NDATA SGML> + <!ENTITY userguide SYSTEM "userguide/index.docbook" NDATA SGML> + <!ENTITY faq SYSTEM "faq/index.docbook" NDATA SGML> + <!ENTITY kpanel SYSTEM "../kpanel/index.html" NDATA SGML> + <!ENTITY kcontrolcenter SYSTEM "../kcontrol/index.html" NDATA SGML> + <!ENTITY kfm SYSTEM "../konqueror/index.html" NDATA SGML> + <!ENTITY kwm SYSTEM "../kwm/index.html" NDATA SGML> + <!ENTITY tde-quickstart-doc SYSTEM "quickstart/index.docbook" NDATA SGML> + <!ENTITY tde-userguide-doc SYSTEM "userguide/index.docbook" NDATA SGML> + <!ENTITY tde-faq-doc SYSTEM "faq/index.docbook" NDATA SGML> + <!-- HTML files will probably only work when they have an olink equivalent +available, unless only references to the top page are needed, which is doubtful. + + To be continued. (FF) --> + <!ENTITY kde-kpanel-doc SYSTEM "../kpanel/index.html" NDATA SGML> + <!ENTITY kde-kcontrol-doc SYSTEM "../kcontrol/index.html" NDATA SGML> + <!ENTITY kde-kfm-doc SYSTEM "../konqueror/index.html" NDATA SGML> + <!ENTITY kde-kwm-doc SYSTEM "../kwm/index.html" NDATA SGML> + <!-- ENTITY man SYSTEM "." NDATA LINESPECIFIC > - to be changed ; should be +the reference to the apropos file in this case, but I cannot really imagine +putting all manual pages into FPIs or system identifiers, so we'll have to find +a way round it. (FF) --> + <!ENTITY kappname "&khelpcenter;"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The Trinity Help Center</title> +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para>The +Trinity Desktop Environment (&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 +&UNIX; operating systems.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>tdebase</keyword> +<keyword>khelpcenter</keyword> +<keyword>kdehelp</keyword> +<keyword>help</keyword> +<keyword>help center</keyword> +<keyword>TDE help center</keyword> +</keywordset> +</bookinfo> + +&welcome; +&help; +&whatistde; +&contact; +&support; + +</book> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:nil +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-always-quote-attributes:t +End: +--> + diff --git a/doc/khelpcenter/kdelogo2.png b/doc/khelpcenter/kdelogo2.png Binary files differnew file mode 100644 index 000000000..08f5a1f1d --- /dev/null +++ b/doc/khelpcenter/kdelogo2.png diff --git a/doc/khelpcenter/khelpcenter.png b/doc/khelpcenter/khelpcenter.png Binary files differnew file mode 100644 index 000000000..e30c35825 --- /dev/null +++ b/doc/khelpcenter/khelpcenter.png diff --git a/doc/khelpcenter/konq.css b/doc/khelpcenter/konq.css new file mode 100644 index 000000000..ee75f658f --- /dev/null +++ b/doc/khelpcenter/konq.css @@ -0,0 +1,68 @@ +body {background-color: #3679AD; + color: #000000; + margin-left: 0; + margin-right: 0; + margin-top: 5; + padding: 0; + background-image: url(background.png); + background-repeat: no-repeat; + background-position: top-center;} + +.caption { + color: black; + font-family: sans-serif; + font-size: 23pt; + font-style: italic; + font-weight: bolder; + margin-left: 3pt; +} + +td.trans {background-image: url(bgtable.png); + background-repeat: no-repeat;} +td.end {background-image: url(lines2.png); + background-repeat: x-repeat;} +td.shadow1 {background-image: url(shadow1.png); + background-repeat: x-repeat;} + +table.vnice { font-family: sans-serif; + font-size: x-small;} + +a:link {background-color: transparent; + color: #191970; + text-decoration:none;} +a:visited {background-color: transparent; + color: #551a8a; + text-decoration:none;} +a:active {background-color: transparent; + color: #fe0000; + text-decoration:none;} +a:hover {background-color: transparent; + color: #1919aa; + text-decoration:underline;} + +tr.menurow {background-color: #505050; + color: #000000; + vertical-align: middle;} + +td.deco {color: #ffffff; + background-color: #505050; + font-family: sans-serif; + font-size: small;} + +td.menuactive {color: #ffcc00; + background-color: #777777; + font-family: sans-serif; + font-size: small;} + +td.menu {color: #ffffff; + background-color: #505050; + font-family: sans-serif; + font-size: small;} + +a.menu {color: #eeeeee; + font-family: sans-serif; + font-size: small;} + +a.menu:hover {color: #ffffff; + text-decoration:none;} + diff --git a/doc/khelpcenter/lines.png b/doc/khelpcenter/lines.png Binary files differnew file mode 100644 index 000000000..498330c38 --- /dev/null +++ b/doc/khelpcenter/lines.png diff --git a/doc/khelpcenter/lines2.png b/doc/khelpcenter/lines2.png Binary files differnew file mode 100644 index 000000000..02a8c05b5 --- /dev/null +++ b/doc/khelpcenter/lines2.png diff --git a/doc/khelpcenter/pointers.png b/doc/khelpcenter/pointers.png Binary files differnew file mode 100644 index 000000000..17bfb2eb8 --- /dev/null +++ b/doc/khelpcenter/pointers.png diff --git a/doc/khelpcenter/shadow1.png b/doc/khelpcenter/shadow1.png Binary files differnew file mode 100644 index 000000000..b57787697 --- /dev/null +++ b/doc/khelpcenter/shadow1.png diff --git a/doc/khelpcenter/support.docbook b/doc/khelpcenter/support.docbook new file mode 100644 index 000000000..59ca40c53 --- /dev/null +++ b/doc/khelpcenter/support.docbook @@ -0,0 +1,79 @@ +<chapter id="supporting-tde"> +<chapterinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> +</chapterinfo> +<title>Supporting the &tde; Project</title> +<anchor id="support"/> + +<sect1 id="supporting-tde-introduction"> +<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 not a small project, +nevertheless it is very important to realize that it is easy to +<quote>make a difference</quote> in the &tde; world.</para> + +<para> There is always a need for developers, graphic +artists, sound engineers, translators, and documentation +writers. Consider jumping aboard this exciting international project +and make yourself a name in the software world.</para> + +<para> Along the way you will make countless friends and acquaintances +all over the world. Also, the satisfaction that stems from doing +actual hands-on work, that will benefit an uncountable number of users +world-wide, and from seeing an unparalleled project grow, is hard to +beat. Please consider joining and supporting &tde; and hop aboard this +exciting journey towards a free and open alternative computing +platform.</para> + +</sect1> + +<sect1 id="supporting-tde-get-started"> +<title>How to get started</title> + +<itemizedlist> + +<listitem><para> +Subscribe to the <ulink url="http://www.trinitydesktop.org/mailinglist.php">mailing list</ulink> +that interest you. +</para></listitem> + +<listitem><para> +Read the <ulink url="http://trinity-devel.pearsoncomputing.net/">&tde; +developer mailing list</ulink> archives to get a feel for &tde; development. +</para></listitem> + +<listitem><para> +Learn to program using the &tde; application framework and join the +&tde; developers' community. +</para></listitem> + +</itemizedlist> + +</sect1> + +<sect1 id="supporting-tde-financial-support"> +<title>Supporting financially</title> + +<para> The &tde; team is working hard on providing you with the +best desktop available for the &UNIX; operating system. &tde; is +available for free and will always be available for free, including +each and every line of its source code, for everyone to modify and +distribute. If you enjoy and use &tde; please consider supporting the +&tde; Project financially. &tde; is in constant need of funds in +order to finance its operations.</para> + +<para> If your busy schedule or skills do not permit you to be +actively involved in &tde; development, please consider supporting +&tde; financially by sending a donation to:</para> + +<para><ulink url="http://www.trinitydesktop.org/donate.php">Support</ulink> +</para> + +<para>Please contact the Trinity team if you have questions.</para> + +<para>Your contribution is appreciated. Thank you!</para> + +</sect1> +</chapter> diff --git a/doc/khelpcenter/welcome.docbook b/doc/khelpcenter/welcome.docbook new file mode 100644 index 000000000..b408e625d --- /dev/null +++ b/doc/khelpcenter/welcome.docbook @@ -0,0 +1,56 @@ +<chapter id="welcome-to-tde"> +<chapterinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> +</chapterinfo> +<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> + +<sect1 id="welcome-information-about-tde"> +<title>Information about &tde;</title> + +<para>The Trinity Desktop Environment (&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 +&UNIX; operating systems.</para> + +<para><ulink url="help:/khelpcenter/releasenotes">&tde; Release Notes</ulink></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; Community</link></para> + +<para><link linkend="support">Supporting the &tde; Project</link></para> + +</sect1> + +<sect1 id="welcome-getting-the-most-out-of-tde"> +<title>Getting the most out of &tde;</title> + +<sect2 id="welcome-general-documentation"> +<title>General documentation</title> + +<para><ulink url="help:/khelpcenter/quickstart">A Quick Start Guide to &tde;</ulink></para> + +<para><ulink url="help:/khelpcenter/userguide">&tde; User's Guide</ulink></para> + +<para><ulink url="help:/khelpcenter/faq">Frequently Asked Questions</ulink></para> + +</sect2> + +<sect2 id="welcome-basic-applications"> +<title>Basic applications</title> + +<para><ulink url="help:/kicker">Desktop Panel (Kicker)</ulink></para> + +<para><ulink url="help:/kcontrol">Control Center</ulink></para> + +<para><ulink url="help:/konqueror">File Manager</ulink></para> + +</sect2> +</sect1> +</chapter> diff --git a/doc/khelpcenter/whatistde.docbook b/doc/khelpcenter/whatistde.docbook new file mode 100644 index 000000000..b93bab5dd --- /dev/null +++ b/doc/khelpcenter/whatistde.docbook @@ -0,0 +1,120 @@ +<chapter id="what-is-tde"> +<chapterinfo> +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> +</chapterinfo> +<title>What is the Trinity Desktop Environment?</title> +<anchor id="whatistde"/> + +<sect1 id="what-is-tde-introduction"> +<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 +make life easier for computer users. &tde; is targeted at &UNIX; +workstations. &tde; features network transparency and a contemporary work +flow philosophy.</para> + +<para>Historically, 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. 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> + +<para>&tde; seeks to fill the need for an easy to use desktop for +&UNIX; workstations, similar to the desktop environments found under +&MacOS; or &Windows;. &tde; meets the requirement +of users for an easy to use work environment. Tools used to reach +this goal are: enhanced inter-application communication, component +reuse, generalized drag and drop, uniform look and feel and many +more. Thus, &tde; offers much more than the traditional &UNIX; window +managers.</para> + +<para>Stability, scalability and openness are qualities which have +made &UNIX; the undisputed choice for the information technology +professional for many years. &tde; builds on top of this excellent +base framework and brings new, much needed qualities: usability, user +friendliness and beauty! &tde; remains as a forefront +player in bringing these qualities to &UNIX; systems, which constituted for +years, the premier platform for server computers and scientific +institutions, but wasn't very attractive for desktop users.</para> + +<para>Without Unix the Internet would not exist, or at least would +have a vastly different form. Unix has not, until recent years, addressed the +needs of the average computer user. This fact is particularly +unfortunate, since a number of implementations of &UNIX; systems (<ulink +url="http://www.linux.org">&Linux;</ulink>, <ulink +url="http://www.freebsd.org">FreeBSD</ulink>, <ulink +url="http://www.netbsd.org">NetBSD</ulink>, &etc;) are freely +available on the Internet, all of which are of exceptional quality and +stability.</para> + +</sect1> + +<sect1 id="what-is-tde-the-desktop"> +<title>&tde; The Desktop Environment</title> + +<para>In combination with a free implementation of &UNIX; systems, &tde; +provides to the world an open and completely free desktop computing +platform either at home or at work.</para> + +<para> This platform is available to anyone free of charge including +its source code for anyone to modify.</para> + +<para>While there will always be room for improvement we believe we +provide a viable alternative to some of the more commonly +found and commercial operating systems/desktops combinations available +today. It is our hope that the combination of &UNIX; systems and &tde; will +finally bring the same open, reliable, stable, and monopoly free +computing to the average computer user that scientists and computing +professionals world-wide have enjoyed for years.</para> + +</sect1> + +<sect1 id="what-is-tde-the-development-framework"> +<title>&tde; The Application Development Framework</title> + +<para>&tde; focuses on the user's needs, but it's obvious that this +focus is more easily achieved by also giving developers the best +tools. &tde; code contains, and comes with, some of the best +development technologies of the modern computing age.</para> + +<para>Authoring applications under &UNIX;/X11 systems used to be an extremely +tedious and labor intensive process. &tde; developers recognize the fact that a +computing platform is only as good as the number of first class +applications available to the users of that particular +platform.</para> + +<para>&tde; includes technologies such as &DCOP; and KParts, created to +offer a component document model and technology. Together with the +complete &tde; libraries programming interface, &DCOP;/KParts are set +in direct competition with other similar technologies like &Microsoft; +<abbrev>MFC</abbrev>/<abbrev>COM</abbrev>/ActiveX technologies. The +excellent quality and the high level of refinement of &tde;'s +application programming interface (<acronym>API</acronym>) enables +developers to focus on original and interesting issues and avoid +reinventing the wheel.</para> + +</sect1> + +<sect1 id="what-is-tde-the-office-suite"> +<title>&tde; The Office Application Suite</title> + +<para>In its current form, &tde; provides, apart from the essential desktop +component applications, a suite of office programs known as &koffice;.</para> + +<para>&koffice; is based on the &tde; &DCOP;/KParts +technologies. It contains: a word processor with desktop +publishing capabilities (&kword;), a spreadsheet application (&kspread;) +and accompanying charting program (&kchart;), a presentation program +(&kpresenter;) and a vector drawing program (&karbon14;). Tying things +together is the <application>KOffice Workspace</application>, an +integrated shell to ease the use of the &koffice; components in +conjunction with each other. Additional components include an email +client, a news reader, and a powerful <abbrev>PIM</abbrev> (Personal +Information Manager - an organizer).</para> + +</sect1> +</chapter> |