From 0b8ca6637be94f7814cafa7d01ad4699672ff336 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Tue, 21 Jan 2014 22:06:48 -0600 Subject: Beautify docbook files --- .../docs/tdebase/khelpcenter/help.docbook | 863 +++++---------------- 1 file changed, 197 insertions(+), 666 deletions(-) (limited to 'tde-i18n-en_GB/docs/tdebase/khelpcenter/help.docbook') diff --git a/tde-i18n-en_GB/docs/tdebase/khelpcenter/help.docbook b/tde-i18n-en_GB/docs/tdebase/khelpcenter/help.docbook index 372573d1e1b..88ff0f7c915 100644 --- a/tde-i18n-en_GB/docs/tdebase/khelpcenter/help.docbook +++ b/tde-i18n-en_GB/docs/tdebase/khelpcenter/help.docbook @@ -1,183 +1,88 @@ -2002-02-03 0.08.00 -&kde; Help System User Manual +2002-02-03 0.08.00 +&kde; Help System User Manual -&kde; Help System +&kde; Help System -The &kde; help system is designed to make accessing the common &UNIX; help systems (man and info) simple, as well as the native &kde; documentation (&XML;). +The &kde; help system is designed to make accessing the common &UNIX; help systems (man and info) simple, as well as the native &kde; documentation (&XML;). -All base &kde; 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 lauri@kde.org for information. No experience is required, just enthusiasm and patience. - -If you would like to help translating &kde; documentation to your native language, the Translation coordinator is Thomas Diehl, thd@kde.org, and he would also welcome the help. More information, including the coordinators for each language team, can be found on the Internationalisation web site, and in the Contact section of this document. +All base &kde; 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 lauri@kde.org for information. No experience is required, just enthusiasm and patience. + +If you would like to help translating &kde; documentation to your native language, the Translation coordinator is Thomas Diehl, thd@kde.org, and he would also welcome the help. More information, including the coordinators for each language team, can be found on the Internationalisation web site, and in the Contact section of this document. -Installation +Installation -&khelpcenter; is an integral part of the &kde; Base installation, and is installed with every copy of &kde;. 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 &kde; Base installation, and is installed with every copy of &kde;. 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. -Invoking Help - -&khelpcenter; can be called in several ways: - - - -From the Help menu - -The most common will probably be from within an application. Choose Help Contents to open that application's help file, at the contents page. +Invoking Help + +&khelpcenter; can be called in several ways: + + + +From the Help menu + +The most common will probably be from within an application. Choose Help Contents to open that application's help file, at the contents page. -From the K menu +From the K menu -Choose the big K in your panel, and select Help to open &khelpcenter;, starting at the default welcome page. - +Choose the big K in your panel, and select Help to open &khelpcenter;, starting at the default welcome page. + -From the panel +From the panel -By default, the &kicker; panel contains an icon to call &khelpcenter;. Again, the default welcome page is displayed. - +By default, the &kicker; panel contains an icon to call &khelpcenter;. Again, the default welcome page is displayed. + -From the command line +From the command line -&khelpcenter; may be started using a &URL; to display a file. &URL;s have been added for info and man pages also. You can use them as follows: +&khelpcenter; may be started using a &URL; to display a file. &URL;s have been added for info and man pages also. You can use them as follows: -An application help file - -khelpcenter -Opens the &kedit; help file, at the contents page. +An application help file + +khelpcenter +Opens the &kedit; help file, at the contents page. -A local &URL; -khelpcenter +A local &URL; +khelpcenter -A Man page +A Man page -khelpcenter +khelpcenter -An Info page +An Info page -khelpcenter +khelpcenter -Invoking khelpcenter with no parameters opens the default welcome page. +Invoking khelpcenter with no parameters opens the default welcome page. @@ -185,200 +90,104 @@ -The &khelpcenter; interface - -The &khelpcenter; interface consists of two panes of information. - -The toolbar and menus are explained further in . - -Documents contain their own navigation tools, enabling you to move either sequentially through a document, using Next, Previous, and Home links, or to move around in a less structured manner, using hyperlinks. - -Links can take you to other parts of the same document, or to a different document, and you can use the Back (Left pointing arrow) or Forward (Right pointing arrow) icons on the toolbar to move through the documents you have viewed in this session. - -The two panes display the contents of the help system, and the help files themselves, on the left and right respectively. +The &khelpcenter; interface + +The &khelpcenter; interface consists of two panes of information. + +The toolbar and menus are explained further in . + +Documents contain their own navigation tools, enabling you to move either sequentially through a document, using Next, Previous, and Home links, or to move around in a less structured manner, using hyperlinks. + +Links can take you to other parts of the same document, or to a different document, and you can use the Back (Left pointing arrow) or Forward (Right pointing arrow) icons on the toolbar to move through the documents you have viewed in this session. + +The two panes display the contents of the help system, and the help files themselves, on the left and right respectively. -The <guilabel ->Contents</guilabel -> pane - -The Contents 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. - -The Contents pane is further divided into two tabs, one containing a menu showing all the help information &khelpcenter; is aware of, and the other contains the &kde; glossary of terms. +The <guilabel>Contents</guilabel> pane + +The Contents 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. + +The Contents pane is further divided into two tabs, one containing a menu showing all the help information &khelpcenter; is aware of, and the other contains the &kde; glossary of terms. -The <guilabel ->Contents</guilabel -> Menu +The <guilabel>Contents</guilabel> Menu -The Contents contains the following default entries: +The Contents contains the following default entries: -Introduction -Welcome to &kde; - an introduction to the K Desktop Environment. +Introduction +Welcome to &kde; - an introduction to the K Desktop Environment. -Introduction to &kde; +Introduction to &kde; -The &kde; Quickstart guide. Contains a tour of the &kde; Interface and specific help and tips on how to work smarter with &kde;. +The &kde; Quickstart guide. Contains a tour of the &kde; Interface and specific help and tips on how to work smarter with &kde;. -&kde; User's manual +&kde; User's manual -The &kde; User's manual is an in-depth exploration of &kde;, including installation, configuration and customisation, and use. - +The &kde; User's manual is an in-depth exploration of &kde;, including installation, configuration and customisation, and use. + -Application manuals +Application manuals -Native &kde; application documentation. All &kde; applications have documentation in &XML; format, which are converted to HTML when you view them. This section lists all the &kde; applications with a brief description and a link to the full application documentation. -The applications are displayed in a tree structure that echoes the default structure of the K menu, making it easy to find the application you are looking for. - +Native &kde; application documentation. All &kde; applications have documentation in &XML; format, which are converted to HTML when you view them. This section lists all the &kde; applications with a brief description and a link to the full application documentation. +The applications are displayed in a tree structure that echoes the default structure of the K menu, making it easy to find the application you are looking for. + -&UNIX; manual pages +&UNIX; manual pages -&UNIX; 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. - +&UNIX; 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. + -Browse info pages +Browse info pages -TeXinfo documentation is used by many &GNU; applications, including gcc (the C/C++ compiler), emacs, and many others. +TeXinfo documentation is used by many &GNU; applications, including gcc (the C/C++ compiler), emacs, and many others. -Tutorials +Tutorials -Short, task based or informational tutorials. +Short, task based or informational tutorials. -The &kde; FAQ +The &kde; FAQ -Frequently asked questions about &kde;, and their answers. +Frequently asked questions about &kde;, and their answers. -&kde; on the web +&kde; on the web -Links to &kde; on the web, both the official &kde; website, and other useful sites. +Links to &kde; on the web, both the official &kde; website, and other useful sites. -Contact Information +Contact Information -Information on how to contact &kde; developers, and how to join the &kde; mailing lists. +Information on how to contact &kde; developers, and how to join the &kde; mailing lists. -Supporting &kde; +Supporting &kde; -How to help, and how to get involved. +How to help, and how to get involved. @@ -386,24 +195,14 @@