From 1f545ddb0d249634fd78f4eb7bfd95ea98dbea40 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Tue, 3 Jul 2012 22:00:32 -0500 Subject: Update help handbooks. --- doc/khelpcenter/contact.docbook | 5 -- doc/khelpcenter/help.docbook | 123 +++++++++++++++++++------------------- doc/khelpcenter/index.docbook | 5 +- doc/khelpcenter/support.docbook | 10 ++-- doc/khelpcenter/welcome.docbook | 2 +- doc/khelpcenter/whatistde.docbook | 49 ++++++++------- 6 files changed, 93 insertions(+), 101 deletions(-) (limited to 'doc/khelpcenter') diff --git a/doc/khelpcenter/contact.docbook b/doc/khelpcenter/contact.docbook index ea693226d..f3769329e 100644 --- a/doc/khelpcenter/contact.docbook +++ b/doc/khelpcenter/contact.docbook @@ -50,11 +50,6 @@ found in the documentation of their individual application. Other &tde; websites include: - -www.trinitydesktop.org -&tde;'s official website - - www.trinitydesktop.org/wiki The &tde; Wiki 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;). 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 -lauri@kde.org 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 +trinity-devel@lists.pearsoncomputing.net for information. +Experience is not required, just enthusiasm and patience. -If you would like to help translating &tde; 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 Internationalization web -site, and in the Contact section -of this document. - +If you would like to help translate &tde; documentation to your native +language,please contact members of the Trinity development team at +trinity-devel@lists.pearsoncomputing.net for information. Installation @@ -56,7 +51,7 @@ package or will be found in your operating system tdebase package. From the Help menu -The most common will probably be from within an application. Choose +The most common will probably be from within an application. Choose Help Contents to open that application's help file, at the contents page. @@ -65,10 +60,10 @@ application's help file, at the contents page. -From the K menu +From the TDE menu -Choose the big K in your panel, and select +Choose the big T in your panel, and select Help to open &khelpcenter;, starting at the default welcome page. @@ -90,7 +85,7 @@ Again, the default welcome page is displayed. &khelpcenter; may be started using a &URL; to display a -file. &URL;s have been added for +file. &URL;s have been added for info and man pages also. You can use them as follows: @@ -188,7 +183,7 @@ files themselves, on the left and right respectively. The Contents 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. @@ -211,26 +206,28 @@ entries: -Introduction -Welcome to &tde; - an introduction to the Trinity Desktop +Welcome to &tde; +An introduction to the Trinity Desktop Environment. -Introduction to &tde; - - -The &tde; Quickstart guide. Contains a tour of the &tde; +A Visual Guide to &tde; +A visual summary of Trinity +widgets. + + + +The Quickstart Guide +Contains a tour of the &tde; Interface and specific help and tips on how to work smarter with &tde;. -&tde; User's manual - - -The &tde; User's manual is an in-depth exploration of &tde;, including +&tde; User Guide +An in-depth exploration of &tde;, including installation, configuration and customization, and use. @@ -240,7 +237,7 @@ installation, configuration and customization, and use. Application manuals -Native &tde; application documentation. All &tde; applications have +Native &tde; application documentation. &tde; applications have documentation in &XML; format, which are converted to HTML 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. The applications are displayed in a tree structure that echoes the default -structure of the K menu, making it easy to find the +structure of the TDE 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 +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 gcc (the C/C++ compiler), - + The &tde; FAQ -Frequently asked questions about &tde;, and their answers. +Frequently asked questions about &tde; and answers. -&tde; on the web +Contact Information -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. -Contact Information +&tde; on the Web -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. @@ -332,8 +329,8 @@ How to help, and how to get involved. Searching requires you have the ht://Dig -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 HelpIndex, and detailed help is available from this module. @@ -347,7 +344,7 @@ up and configured. 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 -Search. The results display in the viewer pane +Search. The results display in the viewer pane to the right. @@ -358,7 +355,7 @@ to the right. Method -Choose how to search for multiple words. If you choose +Choose how to search for multiple words. If you choose and, results are returned only if all your search terms are included in the page. or returns results if any of the search terms are found, and @@ -372,7 +369,7 @@ searches. Some examples: cat and dog Searches for pages which have both the words -cat and dog in them. Pages with +cat and dog in them. Pages with only one or the other will not be returned. @@ -385,7 +382,7 @@ them. cat or (dog not nose) Searches for pages which contain cat, and for pages which contain dog but don't contain -nose. Pages which contain both +nose. Pages which contain both cat and nose would be returned, pages containing all three words would not. @@ -409,14 +406,14 @@ summary. Sort Sort the results in order of Score (how closely your search terms were matched,) alphabetically by -Title or by Date. Selecting the +Title or by Date. Selecting the Reverse order check box, naturally enough, reverses the sort order of the results. Update index 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. @@ -430,30 +427,30 @@ some time. sections 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 RTFM, the Manual they are referring to is very often the man page. -The man pages are not perfect. They tend to be in depth, but +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. 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. 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. @@ -462,7 +459,7 @@ has an info page, not a man page. Info documents are arranged hierarchically with each page called a node. All info documents have a Top node, -&ie; the opening page. You can return to the +&ie; the opening page. You can return to the Top of an info document by pressing Top. @@ -475,7 +472,7 @@ level in the hierarchy. You may move up the hierarchy by pressing Up. 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. @@ -486,7 +483,7 @@ one page long. 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. @@ -531,7 +528,7 @@ The icons available to you in the toolbar are as follows: Forward -Go forward one page. This icon is only active if you have +Go forward one page. This icon is only active if you have already used the Back icon. @@ -566,7 +563,7 @@ Increase the size of the text in the viewer pane. Decrease Font -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. @@ -679,7 +676,7 @@ View the HTML source of the page you are currently -Change the encoding of the current page. Normally, the default setting +Change the encoding of the current page. Normally, the default setting of Auto 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. At the bottom of the Go 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. diff --git a/doc/khelpcenter/index.docbook b/doc/khelpcenter/index.docbook index 6189eaac2..6d7140a04 100644 --- a/doc/khelpcenter/index.docbook +++ b/doc/khelpcenter/index.docbook @@ -44,10 +44,11 @@ a way round it. (FF) --> &tde-release-version; -&tde; is a graphical desktop environment for &UNIX; workstations. The +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 -the &UNIX; operating system. +&UNIX; operating systems. diff --git a/doc/khelpcenter/support.docbook b/doc/khelpcenter/support.docbook index b02609f69..f35256e87 100644 --- a/doc/khelpcenter/support.docbook +++ b/doc/khelpcenter/support.docbook @@ -10,12 +10,12 @@ Supporting the &tde; Project If you are new to &tde;, the &tde; project might look like big -machinery to you. Undoubtedly, &tde; is no longer a small project, +machinery to you. Undoubtedly, &tde; is not a small project, nevertheless it is very important to realize that it is easy to make a difference in the &tde; world. - There is always a need for dedicated developers, graphic -artists, sound engineers, translators and documentation + 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. @@ -35,7 +35,7 @@ platform. -Subscribe to the &tde; mailing lists +Subscribe to the mailing list that interest you. @@ -56,7 +56,7 @@ Learn to program using the &tde; application framework and join the Supporting financially - The &tde; team is working very hard on providing you with the + 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 diff --git a/doc/khelpcenter/welcome.docbook b/doc/khelpcenter/welcome.docbook index ff18cb5ee..9f351f912 100644 --- a/doc/khelpcenter/welcome.docbook +++ b/doc/khelpcenter/welcome.docbook @@ -11,7 +11,7 @@ Information about &tde; -&tde; is a graphical desktop environment for &UNIX; workstations. The +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. diff --git a/doc/khelpcenter/whatistde.docbook b/doc/khelpcenter/whatistde.docbook index 9da36104a..2ad77c94b 100644 --- a/doc/khelpcenter/whatistde.docbook +++ b/doc/khelpcenter/whatistde.docbook @@ -13,9 +13,9 @@ 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 -philosophy. +flow philosophy. -The Trinity Desktop Environment is a fork of the K Desktop Environment +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 @@ -25,38 +25,38 @@ that empowers the user with easy control of his computer's resources. &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; 95/NT. &tde; meets the requirement +&MacOS; or &Windows;. &tde; meets the requirement of users for an easy to use work environment. Tools used to reach -this end are: enhanced inter-application communication, component +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. Stability, scaleability 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 +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; was the first, and stays the forefront -player in bringing these qualities to &UNIX;, which constituted for +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. -Without &UNIX; the Internet would not exist, or at least would -have a vastly different form. &UNIX; has not, until now, addressed the +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; (&Linux;, FreeBSD, NetBSD, &etc;) are freely available on the Internet, all of which are of exceptional quality and -stability. +stability. &tde; The Desktop Environment -In combination with a free implementation of &UNIX;, &tde; +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. @@ -64,12 +64,12 @@ platform either at home or at work. its source code for anyone to modify. While there will always be room for improvement we believe we -have now delivered a viable alternative to some of the more commonly +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; and &tde; will +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. +professionals world-wide have enjoyed for years. @@ -78,17 +78,17 @@ professionals world-wide have enjoyed for years. &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 +tools. &tde; code contains, and comes with, some of the best development technologies of the modern computing age. -Authoring applications under &UNIX;/X11 used to be an extremely -tedious and labor intensive process. &tde; recognizes the fact that a +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. -&tde; defines new technologies in &DCOP; and KParts, created to -offer a component document model and technology. Together with the +&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; MFC/COM/ActiveX technologies. The @@ -103,17 +103,16 @@ reinventing the wheel. &tde; The Office Application Suite In its current form, &tde; provides, apart from the essential desktop -component applications, a suite of powerful office programs known to the -world by the name &koffice;. +component applications, a suite of office programs known as &koffice;. &koffice; is based on the &tde; &DCOP;/KParts -technologies. It currently contains: a word processor with desktop +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 (&kontour;). Tying things +(&kpresenter;) and a vector drawing program (&karbon14;). Tying things together is the KOffice Workspace, an integrated shell to ease the use of the &koffice; components in -conjunction with each other. Additional components include an email +conjunction with each other. Additional components include an email client, a news reader, and a powerful PIM (Personal Information Manager - an organizer). -- cgit v1.2.1