diff options
Diffstat (limited to 'doc/khelpcenter/userguide')
83 files changed, 8568 insertions, 0 deletions
diff --git a/doc/khelpcenter/userguide/CMakeLists.txt b/doc/khelpcenter/userguide/CMakeLists.txt new file mode 100644 index 000000000..50fb573cd --- /dev/null +++ b/doc/khelpcenter/userguide/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/userguide ) diff --git a/doc/khelpcenter/userguide/Makefile.am b/doc/khelpcenter/userguide/Makefile.am new file mode 100644 index 000000000..488634323 --- /dev/null +++ b/doc/khelpcenter/userguide/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/userguide + diff --git a/doc/khelpcenter/userguide/a-window.png b/doc/khelpcenter/userguide/a-window.png Binary files differnew file mode 100644 index 000000000..cfd93ddb4 --- /dev/null +++ b/doc/khelpcenter/userguide/a-window.png diff --git a/doc/khelpcenter/userguide/accessibility.docbook b/doc/khelpcenter/userguide/accessibility.docbook new file mode 100644 index 000000000..d5ac064eb --- /dev/null +++ b/doc/khelpcenter/userguide/accessibility.docbook @@ -0,0 +1,150 @@ + +<chapter id="accessibility"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Gary</firstname> +<surname>Cramblitt </surname> +</author> +</authorgroup> +</chapterinfo> + +<title>Accessibility</title> + +<indexterm><primary>Accessibility</primary></indexterm> + +<para><acronym>KDEAP</acronym> (the &tde; Accessibility Project) aims to ensure that &tde;, as a desktop environment, is accessible to all users, including those of us with physical disabilities. In addition to the accessibility aids in the <link linkend="kcontrol-regional-and-accessibility">Control Center</link>, &tde; has several other accessibility tools, which are available in the &tde;-Accessibility package. This package may not be installed on your computer; if it is not, you can download it from here:</para> + +<para><itemizedlist> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.tar.gz">tdeaccessibility-1.0.0.tar.gz</ulink>, or +<ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.tar.bz2">tdeaccessibility-1.0.0.tar.bz2</ulink></para></listitem> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.md5">MD5</ulink></para></listitem> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.lsm">lsm file</ulink></para></listitem> +</itemizedlist></para> + +<para>For more information on the project, visit the <ulink url="http://accessibility.kde.org/">&tde; Accessibility Home Page</ulink>.</para> + +<sect1 id="kmousetool"> +<title><application>KMouseTool</application></title> + +<indexterm><primary>Mouse</primary><secondary>clicking +automatically</secondary></indexterm> + +<para> + <application>KMouseTool</application> is a &tde; program, which clicks the mouse for you, so you + do not have to. <application>KMouseTool</application> works with any mouse or pointing device. +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmousetool.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>KMouseTool</phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para><application>MouseTool</application> Website: <ulink url="http://mousetool.com/">http://mousetool.com</ulink></para></listitem> + <listitem><para><ulink url="help:/kmousetool"><application>KMouseTool</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="kmagnifier"> +<title>KMagnifier</title> + +<indexterm><primary>Magnifier</primary></indexterm> + +<para>KMagnifier (or <command>kmag</command>, to use its &UNIX; name) is a small utility for Linux to magnify + a part of the screen. It magnifies the area of the screen around the + mouse pointer or, optionally, a user-defined area. Additionally, it can save + a magnified screenshot to disk. +</para> + +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmag.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>KMag</phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://kmag.sourceforge.net/">http://kmag.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kmag"><application>KMag</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="kmouth"> +<title><application>KMouth</application></title> + +<indexterm><primary>Speech</primary></indexterm> + +<para><application>KMouth</application> is a TDE program which enables people who cannot speak to let their + computer speak, ⪚ mutal people or people who have lost their voice. + It has a text-input field and speaks the sentences that you enter. It also has + support for user-defined phrasebooks. +</para> + +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>First screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Second screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth3.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Third screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://www.schmi-dt.de/kmouth/index.en.html">http://www.schmi-dt.de/kmouth/index.en.html</ulink></para></listitem> + <listitem><para><ulink url="help:/kmouth"><application>KMouth</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="ktts"> +<title><application>KTTS</application> - Text-to-Speech</title> + +<para><application>KTTS</application> is a &tde; application for the conversion of text into audible speech. Currently, since &kde; 3.4, you can use <application>KTTS</application> to speak any text from the &klipper;, the &tde; clipboard, any text from a plain text file (using &kate; or otherwise), speak any portion of text from a &HTML; page in &konqueror;, and much more.</para> + +<para>To get <application>KTTS</application> up-and-running you will need to start by running <command>kttsmgr</command>, the &tde; Text-to-Speech manager.</para> + +<!-- Insert Screeny here --> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://accessibility.kde.org/developer/kttsd/">http://accessibility.kde.org/developer/kttsd/</ulink></para></listitem> + <listitem><para><ulink url="help:/kttsd"><application>KTTSD</application> Handbook</ulink></para></listitem> + +</itemizedlist> + +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/amarok-icon.png b/doc/khelpcenter/userguide/amarok-icon.png Binary files differnew file mode 100644 index 000000000..3a4191fe3 --- /dev/null +++ b/doc/khelpcenter/userguide/amarok-icon.png diff --git a/doc/khelpcenter/userguide/amarok.png b/doc/khelpcenter/userguide/amarok.png Binary files differnew file mode 100644 index 000000000..1affe7f29 --- /dev/null +++ b/doc/khelpcenter/userguide/amarok.png diff --git a/doc/khelpcenter/userguide/base-tde-applications.docbook b/doc/khelpcenter/userguide/base-tde-applications.docbook new file mode 100644 index 000000000..dc3074b81 --- /dev/null +++ b/doc/khelpcenter/userguide/base-tde-applications.docbook @@ -0,0 +1,423 @@ +<chapter id="basic-applications"> + +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>The Base &tde; Applications</title> + +<para>What follows is a brief description of a few of the base &tde; applications. For more information on any of the applications you should check the links recommended with each respective entry.</para> + +<!-- What are they?? (Phil) --> +<!-- Included a few here; may be a good idea to add to this in future --> + +<sect1 id="base-applications-fundamental"> + +<title>Fundamentals</title> + +<variablelist> +<varlistentry> +<term>&konqueror;</term> + <listitem><para>&tde;'s file manager, web browser, <acronym>FTP</acronym> client and much more. &konqueror; is the canvas for all the latest &tde; technology, from TDEIO slaves (which provide mechanisms for file access) to component embedding, allowing it to be a universal viewing application, capable of displaying various image files as well as documents.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konqueror.org">http://konqueror.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/konqueror</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kate;</term> + <listitem><para>&tde;'s advanced multi-view text editor. &kate; is excellent for things such as viewing the &HTML; source of a webpage to handling advanced coding in <acronym>C++</acronym>, <acronym>PHP</acronym> and <acronym>XML</acronym> with its powerful syntax highlighting engine and code folding capabilities. &kate; is a very speedy application, being capable of opening huge text files in a matter of seconds, as well as allowing you to view a hefty amount of multiple views in order to see more instances of the same document and/or more documents at any particular time.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kate.kde.org">http://kate.kde.org</ulink></para></listitem> + <listitem><para><ulink + url="help:/kate">&kate; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Insert Screeny --> + +</varlistentry> + +<varlistentry> +<term>&konsole;</term> + <listitem><para>The X terminal emulator for &tde;. &konsole;, like many &tde; applications, is extremely customizable; while you can create your own user sessions, you can also of course open &Linux; console sessions, shell sessions, as well as standard <systemitem class="username">root</systemitem> and sudo sessions.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konsole.kde.org">http://konsole.kde.org</ulink></para></listitem> + <listitem><para><ulink + url="help:/konsole">&konsole; Handbook</ulink></para></listitem> + <listitem><para>User Guide <xref linkend="konsole-intro" /></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kicker;</term> + <listitem><para>The &tde; Panel, used for handling your currently running applications, a pager allowing you to switch between desktops, quick launch buttons to act as application launchers and much more.</para> + + <itemizedlist> + <listitem><para>See <xref linkend="panel-and-desktop"/> for altering some of its settings.</para></listitem> + <listitem><para><ulink + url="help:/kicker">&kicker; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>kdcop</application></term> +<!-- Mainly mentioned to raise awareness, for DCOP --> + <listitem><para>A <acronym>GUI</acronym> front-end to the powerful &DCOP; (Desktop COmmunications Protocol). &DCOP; provides a comprehensive protocol for interprocess communication between &tde; applications. While this is increasingly useful to &tde; programmers, it is also beneficial to the ordinary user who would want to create a script, or, say, a <application>SuperKaramba</application> theme.</para> + + <itemizedlist> + <listitem><para>In the User Guide <xref linkend="scripting-the-desktop"/> and <ulink url="help:/khelpcenter/adminguide#kdialog">The &tde; Administrator Guide</ulink></para></listitem> + <listitem><para>Other Documentation: <ulink + url="http://developer.kde.org/documentation/library/kdetqt/dcop.html">http://developer.kde.org/documentation/library/kdetqt/dcop.html</ulink></para></listitem> + + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kcontrol;</term> + <listitem><para>The control center for the Trinity Desktop Environment. You can alter a myriad of different things, ranging from themes, fonts and screensavers, to Internet, security and system administration.</para> + + <itemizedlist> + <listitem><para>See <xref linkend="control-center"/>.</para></listitem> + <listitem><para><ulink + url="help:/kcontrol">&kcontrol; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&khelpcenter;</term> + <listitem><para>The &tde; help system is used to provide access to the base &UNIX; help pages (man or info) as well as the native &tde; documentation provided by the &tde; documentation team or the application authors. You should be able to access all of the &tde; application handbooks from here.</para> + + <itemizedlist> + <listitem><para><ulink + url="help:/khelpcenter">&khelpcenter; Handbook</ulink></para></listitem> + <listitem><para>For information on the &tde; Documentation team, how to possibly join and help &tde;, see: <ulink url="http://kde.org/documentation">http://kde.org/documentation</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + </variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para><ulink url="http://kde-apps.org">http://kde-apps.org</ulink> -- mdash; The largest directory of third-party &tde; applications.</para></listitem> + <listitem><para>As you may have noticed, a wealth of information is accessible from the respective handbooks themselves, which can be accessed either by using the help TDEIO slave in &konqueror; (that is, type <userinput>help:/<replaceable>application</replaceable></userinput> in the Location toolbar), or by selecting it in the &khelpcenter;.</para></listitem> + <listitem><para>You can also likely find out quite a bit of information from the &tde; website, itself, at <ulink url="http://kde.org">http://kde.org</ulink>.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="base-applications-tdepim"> +<sect1info> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</sect1info> + +<title>Personal Information Management</title> + +<para>&tde; <acronym>PIM</acronym> (Personal Information Manager) is a sub-project of &tde;, and it aims to provide an application suite to manage personal information. It has several components, but these can all be brought under one application -- mdash; &kontact;, which is the personal information manager. Below is an overview of a few of its popular components; that is, a few of the applications that integrate into it.</para> + +<variablelist> +<varlistentry> +<term>&kontact;</term> + <listitem><para>This serves as the medium by which the rest of the applications in &tde; <acronym>PIM</acronym> can integrate with one another. All of the applications in &tde; <acronym>PIM</acronym> can be displayed inside here, and you can easily choose which ones to display. It also contains a Summary page by which you can get a brief overview of events and information in the other components.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kontact.kde.org">http://kontact.kde.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/kontact</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kmail;</term> + <listitem><para>The mail component. &kmail; comes with full <acronym>IMAP</acronym>, <acronym>POP3</acronym> and <acronym>SMTP</acronym> support. Signing and encrypting of emails is permitted, and there are many comprehensive anti-spam functions available. A spell check can easily be used, &HTML; emails can be viewed appropriately, and there is an advanced search feature.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kmail.kde.org">http://kmail.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kmail">&kmail; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&korganizer;</term> + <listitem><para>A fully customizable organizer which constitutes as the calender component. &korganizer; provides management of events and tasks, alarm notification, web export, network transparent handling of data, group scheduling, import and export of calendar files, and much more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://korganizer.kde.org">http://korganizer.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/korganizer">&korganizer; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kaddressbook;</term> + <listitem><para>The contacts component. &kaddressbook; enables you to manage your contacts efficiently and comfortably; contacts can be easily exported and imported from a plethora of different address book standards, and it can be efficiently integrated with &kopete;, &tde;'s multi-protocol instant messenger. Other features include support for all international character sets and advanced search functions.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://pim.kde.org/components/kaddressbook.php">http://pim.kde.org/components/kaddressbook.php</ulink></para></listitem> + <listitem><para><ulink url="help:/kaddressbook">&kaddressbook; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&knotes;</term> + <listitem><para>A handy component which can serve to handle all your digital sticky notes. You can have them displayed on your desktop, they can be <quote>dragged n' dropped</quote> into emails, printed, or even be displayed after &kontact; is closed down.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://pim.kde.org/components/knotes.php">http://pim.kde.org/components/knotes.php</ulink></para></listitem> + <listitem><para><ulink url="help:/knotes">&knotes; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&knode;</term> + <listitem><para>The newsreader component. It is <acronym>GNSKA</acronym> (The Good Net-Keeping Seal of Approval) compliant, has support for <acronym>MIME</acronym> and multiple servers.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://knode.sourceforge.net/">http://knode.sourceforge.net/</ulink></para></listitem> + <listitem><para><ulink url="help:/knode">&knode; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&akregator;</term> + <listitem><para>A lightweight and fast program to display news items provided by feeds, supporting all commonly used versions of <acronym>RSS</acronym> and <acronym>Atom</acronym> feeds. Useful features include searching in article titles, management of feeds in folders and setting archiving preferences.</para> + <itemizedlist> + <listitem><para>Website: <ulink url="http://akregator.sourceforge.net">http://akregator.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/akregator">&akregator; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>See <ulink url="http://kontact.kde.org">http://kontact.kde.org</ulink> and <ulink url="http://tdepim.kde.org">http://tdepim.kde.org</ulink> for more information.</para></listitem> + <listitem><para><ulink url="help:kontact">&kontact; Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="network-applications"> + +<title>Network</title> + +<para>There are several network-related applications in &tde;. Below is a description of a few of these.</para> + +<variablelist> +<varlistentry> +<term>&kopete;</term> + <listitem><para>A fully-featured and advanced <acronym>IM</acronym> (Instant Messaging) client, which has a number of protocols including <trademark class="registered">MSN</trademark>, <trademark class="registered">Yahoo</trademark>, and <trademark class="registered">AIM</trademark>. &kopete; can fetch display pictures, set aliases for particular persons, as well as run multiple <acronym>IM</acronym> sessions at any particular time. &kopete; is quite extensible, and has a comprehensive plugin system which comes with a searchable History of previous chats, statistics on a user's status, as well as a note system allowing you to create notes for each contact.</para> + <itemizedlist> + <listitem><para>Website: <ulink url="http://kopete.kde.org">http://kopete.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kopete">&kopete; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kdict;</term> + <listitem><para>A &GUI; front-end to the <acronym>DICT</acronym> protocol. It enables you to search through dictionary databases for a word or phrase, then displays suitable definitions.</para> + <itemizedlist> + <listitem><para><ulink url="help:/kdict">&kdict; Handbook</ulink></para></listitem> + <listitem><para>The <acronym>DICT</acronym> Development Group: <ulink url="http://www.dict.org/bin/Dict">http://www.dict.org/bin/Dict</ulink>.</para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kget;</term> + <listitem><para>A manager for your downloads which integrates with &konqueror;. &kget; allows you to group your downloads, pause and resume them, as well as several other things.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kget.sourceforge.net/">http://kget.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kget">&kget; Handbook</ulink></para></listitem> + + </itemizedlist> + </listitem> +</varlistentry> +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more &tde; network applications can be found in the &tde; Extragear; see <xref linkend="extragear-network"/>, under <xref linkend="extragear-components"/>.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="office-applications"> + +<title>Office</title> + +<para>This includes all applications in the &koffice; suite. See <xref linkend="tde-office-components" /> for a summary of the components.</para> + +</sect1> + +<sect1 id="graphics-applications"> + +<title>Graphics</title> + +<para>&tde; has several graphics-related applications, ranging from <acronym>PDF</acronym> viewers to applications enabling you to take screenshots. Below is a delineation, as well as some related links, for a few of them.</para> + +<variablelist> + +<varlistentry> +<term><application>KColorEdit</application></term> + <listitem><para>A small and handy application for editing color palettes, as well as color choosing and naming. Colors can be chosen by giving the <acronym>RGB</acronym> hex code, by choosing the color from a myriad of different colors in the program, or even by grabbing the precise color of any particular thing on your screen.</para> + + <itemizedlist> + <listitem><para><ulink url="help:/kcoloredit"><application>KColorEdit</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KPDF</application></term> + <listitem><para>An advanced <acronym>PDF</acronym> viewer, based on <application>xpdf</application>, for &tde;. <application>KPDF</application> contains a number of ways to search through the document (standard find dialog, thumbnail filter, etc.) and has other features such as hands-free reading.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kpdf.kde.org">http://kpdf.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kpdf"><application>KPDF</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KView</application></term> + <listitem><para>An image viewer program which supports a number of different image filetypes including <acronym>JPEG</acronym>, <acronym>GIF</acronym>, <acronym>PNG</acronym>, <acronym>TIFF</acronym> and many others. <application>Kview</application> has full integration with &tde; and it can be embedded into &konqueror; for viewing image files on your diskdrive as well as your <acronym>FTP</acronym> site or webserver, using its &URL; open support. Other features include a few image manipulations such as zoom, rotate, grayscale and flip.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.ph.unimelb.edu.au/~ssk/kde/kview/">http://www.ph.unimelb.edu.au/~ssk/kde/kview/</ulink></para></listitem> + <listitem><para><ulink url="help:/kview"><application>KView</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&ksnapshot;</term> + <listitem><para>An application for taking screenshots. It is capable of capturing images of the whole desktop, a single window, or a selected region. The images can then be saved in a variety of formats, including <acronym>JPG</acronym> and <acronym>PNG</acronym>.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.ipso-facto.demon.co.uk/ksnapshot/">http://www.ipso-facto.demon.co.uk/ksnapshot/</ulink></para></listitem> + <listitem><para><ulink url="help:/ksnapshot">&ksnapshot; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kolourpaint;</term> + <listitem><para>A simple and easy-to-use paint program, with features such as basic painting (drawing diagrams and finger painting), image manipulation and icon editing.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kolourpaint.sourceforge.net">http://kolourpaint.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kolourpaint">&kolourpaint; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kooka;</term> + <listitem><para>An intuitive raster image scan program. &kooka; helps you to handle the most important scan parameters, find the correct image file format to save and manage your scanned images.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kooka.kde.org">http://kooka.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kooka">&kooka; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more advanced &tde; graphics applications can be found in the &tde; Extragear; under the <xref linkend="extragear-components"/>, see <xref linkend="extragear-graphics"/> for a list of a few of them.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="multimedia-applications"> +<title>Multimedia</title> + +<para>A brief overview of a few of the multimedia-related applications below.</para> + +<variablelist> +<varlistentry> +<term>&juk;</term> + <listitem><para>An easy-to-use music player for &tde;. &juk; is playlist and meta-data focused, allowing you to quickly search through the dynamic playlist provided. Some of the features include &CD; cover-art fetching from <trademark class="registered">Google</trademark> images, <application>MusicBrainz</application> integration for file identification over the Internet, and multiple audio backends, including &arts;, <application>GStreamer</application> and <application>aKode</application>.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://developer.kde.org/~wheeler/juk.html">http://developer.kde.org/~wheeler/juk.html</ulink></para></listitem> + <listitem><para><ulink url="help:/juk">&juk; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kmix;</term> + <listitem><para>An application that allows you to change the volume of your sound card, and it supports several sound drivers. Each mixer device is represented by a volume slider, and you have basic options such as to mute that particular mixer device.</para> + + <itemizedlist> + <listitem><para><ulink url="help:/kmix">&kmix; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&noatun;</term> + <listitem><para>A media player capable of playing <acronym>WAV</acronym>, <application>Ogg Vorbis</application>, as well as DivX encoded <acronym>AVI</acronym>s and other media formats. &noatun; features audio effects, a six-band graphic equalizer, a full plugin architecture, network transparency, and various look and feels.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://noatun.kde.org">http://noatun.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/noatun">&noatun; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more advanced &tde; multimedia applications can be found in the &tde; Extragear; under the <xref linkend="extragear-components"/>, see <xref linkend="extragear-multimedia"/> for a list of a few of them.</para></listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/browser-fine-tuning.docbook b/doc/khelpcenter/userguide/browser-fine-tuning.docbook new file mode 100644 index 000000000..34a45e606 --- /dev/null +++ b/doc/khelpcenter/userguide/browser-fine-tuning.docbook @@ -0,0 +1,53 @@ +<sect1 id="customizing-konqueror"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Fine Tuning your Browsing Experience</title> + +<example> +<title>Using your own style for webpages</title> + +<para>Webpages come in every possible set of colors and fonts, and +sometimes this doesn't give the best result. For example, if you have +visual difficulties, it may be impossible to read certain combinations +of background and text colors. &konqueror; provides a way to choose +your own colors and apply them to all webpages. Here's how:</para> + +<orderedlist> +<listitem><para>Open &konqueror; and go to +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Konqueror...</guimenuitem></menuchoice>.</para> +</listitem> +<listitem><para>In the configuration dialog that appears, select the +<guilabel>Stylesheets</guilabel> page on the left hand side.</para> +</listitem> +<listitem><para>On this page, choose <guilabel>Use accessibility +stylesheet defined in "Customize" tab</guilabel>, then go to the +<guilabel>Customize</guilabel> tab, and choose the settings you prefer.</para> +</listitem> +<listitem><para>Close all &konqueror; windows (you may need to restart +&tde; to be sure) and when you re-open them, your settings should be applied.</para> +</listitem> +</orderedlist> + +</example> + + +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> diff --git a/doc/khelpcenter/userguide/burning-cds.docbook b/doc/khelpcenter/userguide/burning-cds.docbook new file mode 100644 index 000000000..21f5214fd --- /dev/null +++ b/doc/khelpcenter/userguide/burning-cds.docbook @@ -0,0 +1,20 @@ +<sect1 id="burning"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Burning CDs and DVDs</title> + +<para>Brief overview of k3b</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/control-center.docbook b/doc/khelpcenter/userguide/control-center.docbook new file mode 100644 index 000000000..5446cd0b0 --- /dev/null +++ b/doc/khelpcenter/userguide/control-center.docbook @@ -0,0 +1,903 @@ +<chapter id="control-center"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup>Here you can set up different profiles for your Wireless card, +to be able to quickly switch settings if you connect to multiple +networks. You can select a profile to be loaded on TDE startup. +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>The &kcontrolcenter;</title> + +<indexterm><primary>&kcontrolcenter;</primary></indexterm> +<indexterm><primary>&kcontrol;</primary></indexterm> +<indexterm><primary>Configuration</primary></indexterm> +<indexterm><primary>Customization</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="kcontrol.png" format="PNG" /> +</imageobject> +<textobject><phrase>The &kcontrolcenter;</phrase></textobject> +<caption><para>The &kcontrolcenter;</para></caption> +</mediaobject> + +<para>The &kcontrolcenter; is the place to go to change any settings that +affect the whole of your &tde; environment. You can open it using the +<guimenuitem>Control Center</guimenuitem> item in the &kmenu;, or with its +command-line name, <filename>kcontrol</filename>.</para> + +<para>The settings are divided into several major categories, which each +contain several pages of settings. To display a settings page, expand the +major category by clicking on the <guilabel>+</guilabel> button next to it, +and then click on the name of the page you want. The settings page then +appears on the right, and you can change settings to your heart's +content. No changes take effect until you click on the +<guibutton>Apply</guibutton> button. If you decide, after making some +changes, that you want to leave the settings as they were, just click on +<guibutton>Reset</guibutton>.</para> + +<para>If you need more help with a page, visit that page, then click on the +<guilabel>Help</guilabel> tab. You might also want to look at the +&kcontrolcenter; Handbook, which you can open with the +<menuchoice><guimenu>Help</guimenu><guimenuitem>&kcontrolcenter; +Handbook</guimenuitem></menuchoice>.</para> + + +<sect1 id="kcontrol-appearance-and-themes"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Appearance & Themes</title> + +<para>Here you will find settings that change the way your &tde; desktop and +applications look.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem> +<para>This section controls the color or image that is set as your desktop +background. These settings can be applied to all virtual workspaces, or to +only a specific one. There are a range of background wallpapers that come +with &tde; or you can supply your own.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Colors</guilabel></term> +<listitem> +<para>This is where you can modify the colors for your kde applications. +There are a variety of color schemes installed with &tde; by default, and +you can find others at kde-look.org. You can also create your own. Here you +can also modify the contrast and choose whether you want your &tde; colors +to be applied to non-TDE applications, for a more consistant overall +appearance.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Fonts</guilabel></term> +<listitem> +<para>Here you can control the various font settings for &tde; applications. +You can also modify here anti-aliasing settings, including what range of +fonts to exclude from anti-aliasing settings.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Icons</guilabel></term> +<listitem> +<para>This section is where you can manage your icon themes and other +settings related to icons. New icon themes can be downloaded from +kde-look.org, and installed here. Conversely, you can remove icon themes by +highlighting them in the list and clicking remove. You can also set icon +sizes for various uses in &tde; and effects to apply to icons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Launch Feedback</guilabel></term> +<listitem> +<para>This is where you can modify what kind of cursor and/or taskbar +feedback you'd like for launching applications. You can also set the +duration of this feedback here. For example, the default setting is for a +bouncing cursor with a duration of 30 seconds, or when the application has +loaded.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Screen Saver</guilabel></term> +<listitem> +<para>Here you can configure options about your screensaver. You can +configure the timeout before it starts, and whether it requires a password +to unlock the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Splash Screen</guilabel></term> +<listitem> +<para>This is where you can install, remove and test the splash screens that +display on &tde; startup. More splash screens can be downloaded from +<ulink +url="http://www.kde-look.org"> + +http://www.kde-look.org</ulink>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Style</guilabel></term> +<listitem> +<para>This section allows you to modify your widget style. A variety of +styles come with &tde;, and more can be downloaded from <ulink url="http://www.kde-look.org">http://www.kde-look.org</ulink>. This is also +where you would enable or disable interface options such as transparent +menus, showing icons on buttons and tooltips. Some styles have more +configuration options than others.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Theme Manager</guilabel></term> +<listitem> +<para>This is where you can create and manage themes that are made up of +personalized settings. They are a combination of desktop background, colors, &tde; widget styles, icons, fonts and what Screensaver you'd like to display . This allows you to save your favorite +<quote>looks</quote> and apply them with the click of a mouse button.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window Decorations</guilabel></term> +<listitem> +<para>Here you can configure your window decorations. You can modify the +style as well as place the buttons in custom positions. Some window +decorations will have more configuration options than others.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> <listitem><para>If &kcontrolcenter; +doesn't have the setting you want, you may need to edit a configuration file +manually. See <xref linkend="hand-editing-config-files" /> for more +information about how to do this.</para> +</listitem> + +<listitem><para>If you enjoy modifying the appearance of your &tde; desktop, +you can find plenty of themes and styles at <ulink url="http://kde-look.org">kde-look.org</ulink>.</para> +</listitem> + +</itemizedlist> + + +</sect1> + +<sect1 id="kcontrol-desktop"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Desktop</title> + +<para>This is where you will find settings to configure the appearance and +behavior of your &tde; desktop.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Behavior</guilabel></term> +<listitem> +<para>Here you can configure the behavior of your desktop. This is where +you would go to configure options such as showing or hiding desktop icons, +showing tooltips and icon layout. You can also specify if you would like to +see previews of particular filetypes on the desktop, and which devices you'd +like to see icons for.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Multiple Desktops</guilabel></term> +<listitem> +<para>This is where you would configure the number of virtual desktops or +workspaces you would like to have, and what you would like them to be +called. By default &tde; has 4 virtual desktops, and you can configure up to +20. You can also enable switching between virtual desktops using the scroll +button on your mouse.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Panels</guilabel></term> +<listitem> +<para>Here you can modify options to do with &kicker; and other &tde; +panels. Among the options are size, position, length and hiding. You can +also modify the appearance of the panel with transparency, background images +and icon zooming. This is also where you would configure various menu +options including what applications you'd like to show in your +&kmenu;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Taskbar</guilabel></term> +<listitem> +<para>The Taskbar module allows you to configure options related to your +taskbar. You can configure whether to show windows from all desktops, +grouping of similar tasks and what actions you would like to assign to your +mouse buttons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window Behavior</guilabel></term> +<listitem> +<para>This is where you would configure options related to the behavior of +&tde;'s window manager, &twin;. &twin; is extremely configurable and has +advanced features such as focus stealing prevention and different focus +policies such as focus follows mouse. You can also configure what actions +you would like to bind to certain keys and mouse events.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window-Specific Settings</guilabel></term> +<listitem> +<para>This is an advanced configuration dialog where you can set options for +the behavior of specific windows. There are many options here for the fine +tuning of your window layout, including what position on the screen you +would like certain windows to open to, and whether they should be shown on +the taskbar or pager. You can select windows by application, or even by +their specific role within an application.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-internet-and-network"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Internet & Network</title> + +<para>This section is where you would configure settings to do with internet +and networking under &tde;.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Connection Preferences</guilabel></term> +<listitem> +<para>Here you can set advanced networking options such as timeout values +for server connects. Usually you would leave these options at the defaults +unless you really knew what you were doing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Desktop Sharing</guilabel></term> +<listitem> +<para>Desktop Sharing allows you to invite someone to share your session +with you, or can enable you to log in remotely to your machine from another +location. You would then use a VNC client like &tde;'s Remote Desktop +Connection application to control your desktop over the network. This is +extremely useful if you want someone to help you perform a task.</para> + +<para>Here you can create and manage invitations as well as set your +security policy for uninvited connections. You can also configure whether to +show a background image and which port for the service to 'listen' +on.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>File Sharing</guilabel></term> +<listitem> +<para>File sharing allows you to configure Samba (&Microsoft; &Windows;) and +<acronym>NFS</acronym> (&UNIX;) file sharing. To make changes in this module +you need to have the root or administrator password. This is where you would +set up whether users are allowed to share files without knowing the root +password, and which users are allowed to do so. You can also configure which +folders you're like to be shared, using which type of sharing and who is +allowed to view these shares.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Local Network Browsing</guilabel></term> +<listitem> +<para>Here you can configure options related to browsing network shares in +&konqueror;. &konqueror; is able to browse a variety of network shares and +manipulate remote files as though they were on your local machine. You can +configure it to remember your preferred username and password for connecting +to &Windows; shares (Samba). You can also set what types of network shares +you would like to be able to browse, including &FTP;, <acronym>NFS</acronym> +and <acronym>SMB</acronym>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Local Network Chat</guilabel></term> +<listitem> +<para>This module allows you to configure options relating to the &UNIX; +<command>talk</command> daemon. It is a very simple network chat program +that runs in a terminal, designed for chatting over a local area +network. Some of it's features are being able to set up an 'answering +machine' that will email to you messages left for you, and being able to +forward messages to another location.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Proxy</guilabel></term> +<listitem> +<para>This is where you would configure &tde; to connect to a proxy server +rather than directly to the internet. Once again you would generally leave +these options at their defaults unless you really knew what you were +doing. If you do use a proxy server your network administrator will be able +to tell you what details to fill in here.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Samba</guilabel></term> +<listitem> +<para>The Samba Configuration module requires the +<systemitem class="username">root</systemitem> or administrator password. It is +an advanced configuration tool that allows you to control Samba's security, +shares, users and printers in an intuitive graphical interface. This is a +very powerful tool with support for configuring everything from simple file +and printer sharing, to using your Samba server as a &Windows; NT Domain +Controller.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Service Discovery</guilabel></term> +<listitem> +<para>You can set up services browsing with ZeroConf. You can for example browse +your local network using multicast DNS.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Web Browser</guilabel></term> +<listitem> +<para>This module is where you would configure options relating to +&konqueror; as a web browser. The usual options you would expect from a +web browser, such as cookie configuration, cache and history can be found +here as well as sections to modify keyboard shortcuts, plugins and +fonts.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Wireless Network</guilabel></term> +<listitem> +<para>Here you can set up different profiles for your Wireless card, to be +able to quickly switch settings if you connect to multiple networks. You can +select a profile to be loaded on &tde; startup.</para> +</listitem> +</varlistentry> +</variablelist> + + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> + +<sect1 id="kcontrol-kde-components"> + + +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>&tde; Components</title> + +<para>This section is where you can modify advanced &tde; options such as +file associations and default applications.</para> + +<variablelist> + +<varlistentry><term><guilabel>Default Applications</guilabel></term> + +<listitem><para>This module allows you to select the default +applications you would like to use for various services. Here you can define +what Email Client, Embedded Text Editor, Instant Messenger, Terminal +Emulator and Web Browser to use. If you prefer to use +<application>Xterm</application>, <application>Vim</application> or +<application>Mozilla</application>, this is the place to specify those +preferences.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>File Associations</guilabel></term> + +<listitem><para>This is where you configure everything to do with file +associations. Here you can select a filetype, and choose what applications +you would like to be able to open it with. You can also select which icon +you would like to represent each filetype, and whether to show it in an +embedded or a separate viewer.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>File Manager</guilabel></term> + +<listitem><para>Here you can configure the behavior of &konqueror; in file +manager mode. Among the options are fonts and font sizes, previews over +various network protocols and context menus. &konqueror; is an extremely +powerful and configurable file management tool with a plethora of +options. For more information, consult the &konqueror; handbook.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Performance</guilabel></term> + +<listitem><para>Here are settings related to the memory usage of +&konqueror;. <guilabel>Minimize Memory Usage</guilabel> allows you to +control whether separate instances of &konqueror; will open or whether all +new &konqueror; windows connect to the same instance. This has the effect of +reducing memory usage. You can also select whether to pre-load &konqueror; +after &tde; startup, to reduce start times.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Resources Configuration</guilabel></term> + +<listitem><para><remark>To be written</remark></para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Service Manager</guilabel></term> + +<listitem><para>The Service Manager module displays a static list of +services that are started on demand, and a second list of services that can +be manipulated by the user. The services in the first list cannot be +modified or changed. The services in the second list you can enable or +disable a service loading at start up, and manually start and stop +services.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Session Manager</guilabel></term> + +<listitem><para>Here you can configure how you would like &tde; to handle +sessions. You can configure &tde; to remember your previous session and +restore the applications you were using the next time you log in. You can +also specify individual applications to exclude from being restored, or +disable restoring sessions on login entirely.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Spell Checker</guilabel></term> + +<listitem><para>This module allows you to configure the &tde; Spell +checker. It allows you to modify what spell checker to use, what types of +error to check for and also what default dictionary to use. &tde; supports +the use of both <application>ASpell</application> and +<application>ISpell.</application></para> +</listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Vim Component Configuration</guilabel></term> + +<listitem><para>This module allows you to configure the use of +<application>Vim</application> as an embeddable component. You need to have +a recent version of <application>Gvim</application> or +<application>Kvim</application> installed for this. You can configure the +appearance of the editor as well as which <command>vim</command> binary to +use.</para> +</listitem> +</varlistentry> + +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-peripherals"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Peripherals</title> + +<para>This section is where you would change settings related to peripheral +devices such as keyboards and joysticks.</para> + +<variablelist> +<varlistentry><term><guilabel>Display</guilabel></term> + +<listitem><para>Here you can modify settings to do with the size, +orientation and refresh rate of your display, and whether you would like +these settings to be applied on &tde; startup. On the <guilabel>Power +Control</guilabel> tab, you can configure your power management options for +this screen such as blanking.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Joystick</guilabel></term> + +<listitem><para>This section allows you to configure your joystick and test +that it is working properly. You can also calibrate your joystick here, and +manually specify the joystick device if it is not autodetected correctly. +</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard</guilabel></term> + +<listitem><para>This module allows you to configure basic keyboard settings. +These include keyboard repeat delay and rate, and what state you would +prefer numlock to be on TDE startup.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Mouse</guilabel></term> + +<listitem><para>Here is where you can configure settings to do with your +mouse device. You can switch the button order, reverse the scroll direction +or modify the behaviour of clickable icons. You may also preview, install +and select cursor themes. The <guilabel>Advanced</guilabel> tab allows you +to fine tune your mouse settings further.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Printers</guilabel></term> + +<listitem><para> This dialog allows you to configure printers using a +variety of print systems. You can add local and remote printers, check +current jobs and look at printer properties.</para> +</listitem> +</varlistentry> + +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-power-control"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Power Control</title> + +<para>This section has a single module, <guilabel>Laptop Battery</guilabel>. +Here you can configure the appearance and behaviour of the <application>Klaptopdaemon</application> +battery monitor. You can select battery icons to represent different power states, and set up +notification of certain events. In the case that your battery runs down to a critical level, you can +configure the daemon to suspend or shutdown your laptop, to save you from losing data. +</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + +</sect1> + +<sect1 id="kcontrol-regional-and-accessibility"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Regional & Accessibility</title> +<para>This section is where you can configure options to do with region +and locale, and also acessibility related options for disabled +persons.</para> + +<variablelist> + +<varlistentry><term><guilabel>Accessibility</guilabel></term> + +<listitem><para>Here is where you can configure options for users who have +difficulty hearing system sounds or using a keyboard. You can configure the +system bell to use a visual signal, such as flashing the screen or inverting +screen colors. You can also configure keyboard accessibility options such +as sticky keys and slow keys.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Country/Region & Language</guilabel></term> + +<listitem><para>This module allows you to configure options that are +specific to your location such as language, currency and date format. To +make available more languages, install the tde-i18n packages for your +distribution.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Input Actions</guilabel></term> + +<listitem><para>Here is where you would configure input actions, such as +mouse gestures and keyboard shotcuts for launching applications and running +commands.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard Layout</guilabel></term> + +<listitem><para>This module is where you would configure +<application>Kxkb</application>, a keyboard layout switching utility that +uses the &X-Window; xkb extension. It allows you to switch between different +layouts using a tray indicator or a keyboard shortcut. You can +enable/disable keyboard layouts through this dialog, and add more. Some of +the more powerful features are the ability to configure switching of layouts +globally, per application or per window.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard Shortcuts</guilabel></term> + +<listitem><para>Here you can configure global &tde; keyboard +shortcuts. There are several predefined shortcut schemes you can use if you +are more used to another windowing environment, like &Windows; or +&MacOS;. If you prefer, you can customise your own scheme and modifier keys. +</para></listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-security-and-privacy"> +<sect1info> +<authorgroup> +<author> +&Anne-Marie.Mahfouf; +&Anne-Marie.Mahfouf.mail; +</author> +<author> +<firstname>Javier</firstname> +<surname>Martín Diez</surname> +</author> +<othercredit role="reviewer"> +<personname><firstname>Rocco</firstname> <surname>Stanzione</surname> +</personname> +</othercredit> +</authorgroup> +</sect1info> +<title>Security & Privacy</title> + +<para>This section is where you can configure options related to +security and privacy such as the use of cryptography, enabling the TDE +wallet, setting your identity and managing caches.</para> + +<variablelist> +<varlistentry><term><guilabel>Crypto</guilabel></term> +<listitem><para>This module allows you to configure SSl for use with most +TDE applications, as well as manage your personal certificates +and the known certificate authorities.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Wallet</guilabel></term> +<listitem><para> +Here you can change your TDE Wallet Manager settings.</para> + +<para>TDE Wallet aims to provide secure storage for passwords and web form data. +You can group different passwords in different wallets, and each one will only +be opened with a master password (which you should never forget!). The +default wallet is named "kdewallet", and you can either create a new wallet +for your local passwords or accept the default wallet for all data in +the "Automatic Wallet Selection" section.</para> + +<para>TDE programs like Konqueror, Kmail and Kopete are fully compatible with +the TDE Wallet Manager. All of them will ask at least once for permission to +access to actual wallet. You can give different access levels, such as "always +allow", "allow once", etc. If you want to change that access level, you can do +it from the "Access Control" tab by deleting the program entry and selecting a +new preference the next time that application requests access to the +wallet.</para> + + <variablelist> + + <varlistentry><term><guilabel>Wallet Preferences</guilabel></term> + + <listitem><para>To enable the TDE wallet subsystem, check the <guilabel> +Enable the TDE wallet subsystem</guilabel> box. +Unchecking this box will disable the TDE Wallet on your system.</para> + +<para>By default, TDE Wallet Manager is kept opened until the +user session is closed, but you can change that in the <guilabel>Close +Wallet</guilabel> section to close it when unused for a time, when a screen +saver starts or when the last application stops using it.</para> + +<para>As you can have several wallets, <guilabel>Automatic Wallet +Selection</guilabel> allows you start TDE with a given wallet.</para> + +<para>TDE Wallet will appear in your system tray by default, but you can hide +it. Uncheck <guilabel>Show manager in the system tray</guilabel> to keep it +always hidden, or check <guilabel>Hide system tray icon when last wallet +closes</guilabel> to hide it only when all wallets are closed. These items are +in the <guilabel>Wallet Manager</guilabel> section.</para></listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Access Control</guilabel></term> + +<listitem><para>You can set here what policy you want for your +TDE applications, regarding to the wallet use.</para></listitem> +</varlistentry> +</variablelist> + +</listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Password & User Account</guilabel></term> +<listitem><para>You can change here your personal information +which will be used in mail programs and word processors. You +can change your login password by clicking the <guibutton>Change +Password...</guibutton> button.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Privacy</guilabel></term> +<listitem><para>This module allows you to erase traces which +TDE leaves on your system such as command histories or +browser caches.</para></listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<!-- <sect1 id="kcontrol-sound-and-multimedia"> +<title>Sound & Multimedia</title> +<para>to be written</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para></para> +</listitem> +</itemizedlist> + +</sect1> --> + +<sect1 id="kcontrol-system-administration"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>System Administration</title> +<para>This module allows you to configure aspects of your system such as +the bootloader, the kernel and helps you perform essential system tasks. Most of these +sections will require the root or Administrator password to effect changes.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Boot Manager (LILO)</guilabel></term> +<listitem><para>If you use the popular bootloader +<acronym>LILO</acronym> this section will allow you to configure it. +You can configure the location to install the bootloader to, set the timeout +on the <acronym>LILO</acronym> boot screen as well as add or modify +kernel images for the boot list.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Date & Time</guilabel></term> +<listitem><para>This configuration module allows you to configure the system date and time +settings. You can set the date, time, and also the current time zone. These settings will be applied system-wide.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Font Installer</guilabel></term> +<listitem><para>Here is where you would configure both personal and system-wide fonts. +This dialog allows you to install new fonts, delete old ones and preview the fonts you +have installed. By default, it displays personal fonts. To modify system-wide fonts click the <guibutton>Administrator Mode</guibutton> button.</para> </listitem> +</varlistentry> +<varlistentry> +<term><guilabel>IBM Thinkpad Laptop</guilabel></term> +<listitem><para>This configuration module allows you to configure the special keys on an IBM thinkpad + laptop. You will need the <quote>nvram</quote> module to use these features.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Linux Kernel</guilabel></term> +<listitem><para>If you run &tde; on &Linux; there is a &kcontrol; module to create or modify +configuration files for a &Linux; kernel. This configurator is compatible with kernels previous to 2.5.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Login Manager</guilabel></term> +<listitem><para>This module allows you to configure the &tde; login manager, &tdm;. &tdm; is +a powerful login manager with a large range of options. It supports user switching, remote graphical logins and has a fully customizable appearance. For more information, see the &tdm; handbook.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Paths</guilabel></term> +<listitem><para>This dialog allows you to configure the default locations where certain +important files are kept. The <guilabel>Desktop</guilabel> directory contains all the files on your desktop. The <guilabel>Autostart</guilabel> directory contains files or links to files that you want run when &tde; starts, and the <guilabel>Documents</guilabel> directory is the default location &tde; applications will open or save documents to.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Sony Vaio Laptop</guilabel></term> +<listitem><para>This configuration module allows you to configure features specific to +Sony Vaio laptops. If you have a Sony Vaio, you will have to install the <quote>sonypi</quote> +driver to use this section.</para></listitem> +</varlistentry> +</variablelist> +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/creating-graphics.docbook b/doc/khelpcenter/userguide/creating-graphics.docbook new file mode 100644 index 000000000..61c9b545a --- /dev/null +++ b/doc/khelpcenter/userguide/creating-graphics.docbook @@ -0,0 +1,30 @@ +<sect1 id="graphics"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Creating Graphics</title> + +<para>How to create graphics with &tde; apps.. (ok, maybe not)</para> + +<!-- Add links to "further reading" here - in this case, for the whole --> +<!-- chapter. --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/credits-and-license.docbook b/doc/khelpcenter/userguide/credits-and-license.docbook new file mode 100644 index 000000000..9ca864aff --- /dev/null +++ b/doc/khelpcenter/userguide/credits-and-license.docbook @@ -0,0 +1,299 @@ +<sect1 id="credits"> +<title>Credits</title> +<para> +&tde-team; thanks and acknowledges the original &kde; contributors of this guide. +</para> + +<para>Individual credits: +<variablelist> + +<varlistentry> +<term>Tom Albers</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="integrated-messaging" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Waldo Bastian</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the notes which became <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Gardner Bell</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="networking-with-windows"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="konsole-intro" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Gary Cramblitt</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="accessibility" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>David Faure</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="adding-extra-keys" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Nicolas Goutte</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="hand-editing-config-files" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Francis.Giannaros;</term> +<listitem> + +<itemizedlist> + <listitem><para>Proofreading and update on various parts.</para></listitem> + <listitem><para>Wrote <xref linkend="root" />.</para></listitem> + <listitem><para>Wrote <xref linkend="ktts" />.</para></listitem> + <listitem><para>Wrote <xref linkend="basic-applications" />.</para></listitem> + <listitem><para>Wrote <xref linkend="extragear-applications" />.</para></listitem> + <listitem><para>Re-wrote <xref linkend="tde-edutainment" />.</para></listitem> + <listitem><para>Wrote <xref linkend="migrator-applications" />.</para></listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Adriaan de Groot</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="configuring-toolbars"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="tdedebugdialog" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>J Hall</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="kcontrol-appearance-and-themes" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-desktop" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-internet-and-network" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-kde-components" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-peripherals" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-power-control" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-regional-and-accessibility" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="troubleshooting-network-x" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Anne-Marie.Mahfouf;</term> +<listitem> + +<itemizedlist> + <listitem><para>Proofreading and update on various parts.</para></listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Richard.J.Moore;</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the <application>kstart</application> and +<application>ksystraycmd</application> sections.</para> + +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Peter Nuttall</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="messaging" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Steven Robson</term> +<listitem> + +<itemizedlist> +<listitem><para>Took the screenshots for <xref +linkend="playing-music"/>, <xref linkend="audio-cd"/>, <xref +linkend="file-manager"/> and <xref linkend="accessibility"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>&Philip.Rodrigues;</term> +<listitem> + +<itemizedlist> +<listitem><para>Reviewing and proofreading.</para> +</listitem> +<listitem><para>Wrote <xref linkend="windows-how-to-work"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="panel-and-desktop"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="logging-in"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="using-the-clipboard"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="configuring-programs"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="menus"/>.</para> +</listitem> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Deepak Sarda</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="audio-cd"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Robert Stoffers</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="programs-launching" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Juan Carlos Torres</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="customizing-desktop" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Simon Vermeersch</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="fonts"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>&Lauri.Watts;</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the outline.</para> +</listitem> +<listitem><para>Wrote <xref linkend="getting-help"/>.</para> +</listitem> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>Christian Weickhmann</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="file-manager" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="switching-sessions" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +</variablelist> +</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/customizing-desktop.docbook b/doc/khelpcenter/userguide/customizing-desktop.docbook new file mode 100644 index 000000000..a8ed7cb42 --- /dev/null +++ b/doc/khelpcenter/userguide/customizing-desktop.docbook @@ -0,0 +1,347 @@ +<chapter id="customizing-desktop"> +<chapterinfo> +<authorgroup> +<author> +<firstname>Juan Carlos</firstname> +<surname>Torres</surname> +</author> +</authorgroup> +</chapterinfo> + +<title>Customizing the Appearance of your &tde; Desktop</title> + +<para>Changing the appearance of your &tde; desktop can be done quite easily and +flexibly by either individually controlling different parts of the visual +appearance or by using a predefined theme. This guide explains the various +customizable parts of &tde; and how to control their appearance.</para> + +<sect1 id="background"> +<title>Background</title> +<para>The desktop background, more commonly known as the wallpaper, allows you +to display certain images on your desktop. The settings for the background are +found in the &kcontrolcenter;, or by <mousebutton>right</mousebutton>-clicking +on the desktop and selecting <guilabel>Configure Desktop...</guilabel>.</para> + +<para>In &tde;, you have the option to use no picture, a single picture, or a +slideshow of images. If <guilabel>No picture</guilabel> is chosen to be the +desktop background, the <guilabel>Colors</guilabel> options are used instead. +You can also choose whether to use a single +background on all virtual desktops or to apply a different background for each +desktop. This is done by selecting <guilabel>All desktops</guilabel> or the +specific desktop name from the drop-down menu.</para> + +<para>Other background images can be downloaded using the +<guibutton>Get New Wallpapers</guibutton> button on the right or you can visit +the <ulink url="http://www.kde-look.org/index.php?xcontentmode=1x2x3x4x5x6x7"> +Wallpapers section</ulink> of the kde-look.org website.</para> +</sect1> + +<sect1 id="colors"> +<title>Colors</title> +<para>The <guilabel>Colors</guilabel> settings of the &kcontrolcenter; allow you to control the +colors that are used for various window elements, such as window titlebars, +window backgrounds, text, and buttons. You can change the color of each window +element by selecting the element from the drop down list and choosing a color +for it. You can then save your changes by clicking on +<guibutton>Save Scheme...</guibutton>. This will save your settings in a Color +Scheme file. Color schemes are text files, with a <literal +role="extension">.kcsrc</literal> extension, that contain +entries for each window widget and its color, in RGB format. It is also very +easy to add color schemes that you have downloaded by clicking on +<guibutton>Import Scheme...</guibutton> and pointing to the <literal +role="extension">.kcsrc</literal> file. With color schemes, you can save the +changes you have done in one convenient file or easily change to a predefined +color setting, without having to change each window element separately.</para> + +<para>Additional color schemes can be downloaded from <ulink +url="http://www.kde-look.org/index.php?xcontentmode=28">the Color Schemes +section</ulink> of kde-look.org.</para> +</sect1> + +<sect1 id="icons"> +<title>Icons</title> +<para>An icon theme contains the images used to represent actions, files, +devices, and applications. Managing icon themes is easily done through the Icons +module in the &kcontrolcenter;. Simply select the icon theme you want to use and +click on <guibutton>Apply</guibutton> to switch to the new theme. To install new +icon themes, all you need to do is to click on <guibutton>Install New +Theme...</guibutton> and browse to the location of the icon theme archive. There +is no need to extract the contents of the archive into a directory. In fact, the +Icons module only accepts archived icon themes. To remove an icon theme, simply +select the theme from the list and click on <guibutton>Remove Theme</guibutton>. +Note that you cannot remove the icon theme that you are currently using. You +need to switch to some other theme before the current one will become removable. +You also cannot remove icon themes that were installed by the administrator +(<systemitem class="username">root</systemitem>) or by your distribution's +package manager.</para> +<para>Other icon themes can be found in <ulink +url="http://www.kde-look.org/index.php?xcontentmode=27">the Icon Themes +subsection</ulink> of kde-look.org.</para> +</sect1> + +<sect1 id="splash-screen"> +<title>Splash Screen</title> + +<mediaobject> +<imageobject> +<imagedata fileref="splash-screen.png" format="PNG" /> +</imageobject> +<textobject><phrase>The default &tde; splash screen</phrase></textobject> +<caption><para>The default &tde; splash screen</para></caption> +</mediaobject> + +<para>The splash screen is the animated image or screen that is displayed while +&tde; loads after you log in. Each user can have a different splash screen. +Changing the splash screen for the current user can be done in the Splash +Screen module of the &kcontrolcenter;. Select the splash screen you want to +use and click on <guibutton>Apply</guibutton>. You can also test what a splash +screen will look like by selecting the splash screen and clicking on +<guibutton>Test</guibutton>. Installing a new splash theme is very easy. Just +click on <guibutton>Add...</guibutton> and browse to the splash screen archive you +want to add. There is no need to extract the contents of the archive. Removing +splash screens is also easily done by selecting the splash screen and clicking +on <guibutton>Remove</guibutton>. Note that you cannot remove splash screens +installed by the administrator (<systemitem class="username">root</systemitem>) +or by your distribution's package manager.</para> + +<para>Splash screen themes can be found on kde-look.org, in <ulink +url="http://www.kde-look.org/index.php?xcontentmode=35">the Splash Screens +section</ulink>. Take note that some splash screens require a specific &ksplash; +engine to be installed.</para> +</sect1> + +<sect1 id="win-deco"> +<title>Window Decorations</title> +<para>You can change the appearance of window borders, titlebars and buttons in +&tde; using window decorations. Some window decorations even have the capability +to apply effects such as translucency. Window decorations must be able to do all +these without sacrificing speed and performance. This is the reason why window +decorations come in source code that must be compiled, or as binary packages +that must be installed. Basically, Window decorations are plugins or small +programs that instruct &twin;, &tde;'s Window Manager, +how to display window frames.</para> + +<para>In order to add a new window decoration, you need to compile it from +source code. If a binary package for your distribution or system is provided, +you simply need to install it using your distribution's package manager. Please +refer to your distribution's manual for instructions on how to do this. Once the +window decoration has been installed, it can be accessed in the Window +Decorations settings in the &kcontrolcenter;. In the +<guilabel>Window Decoration</guilabel> tab, +a list of installed window decorations can be seen in the drop down box. Simply +select the decoration you want to use and click on <guibutton>Apply</guibutton>. +Different window decorations have different capabilities and settings. Play +around with the different options available. The <guilabel>Buttons</guilabel> tab allows you to +control the buttons on the window titlebar. Enable the <guilabel>Use custom +titlebar button positions</guilabel> check box in order to rearrange, remove, or +add buttons. To add buttons to the titlebar, drag an item from the list to the +titlebar preview above it. To remove a button, drag the button from the titlebar +preview to the item list. Simply drag buttons in the titlebar preview to +rearrange them.</para> + +<para>While all window decorations need to be compiled from source code, some +window decorations can load pixmap-based theme files that do not need to be +compiled. &tde; ships with a pixmap-based window decoration called the IceWM +window decoration. Another pixmap-based window decoration is <ulink +url="http://www.kde-look.org/content/show.php?content=31447">deKorator</ulink>, +which can be found on kde-look.org. Please refer to your distribution's +documentation on how to install these. The advantage of using pixmap-based +window decorations is it is relatively easy to make themes for them, by using +images and editing a configuration file. The tradeoff is a slight loss of performance, +while this may be unnoticeable on very fast systems.</para> + +<para>To add an IceWM theme, select IceWM as the window decoration and click on +the <guilabel>Open &tde;'s IceWM theme folder</guilabel> link in the window +decoration description area. This will open a &konqueror; window +to <filename>$<envar>TDEHOME</envar>/share/apps/twin/icewm-themes</filename>. +Extract your IceWM theme to this folder. The theme will then be added to +the list of IceWM themes. Select the theme you want to use and click on +<guibutton>Apply</guibutton>.</para> + +<para>To add a deKorator theme after you've installed deKorator, select +deKorator from the window decorations list and go to the <guilabel>Themes</guilabel> +tab. Click on <guibutton>Install New Theme</guibutton> and locate +your deKorator theme archive. Make sure that the version of the deKorator theme +matches the deKorator version installed on your system. Once the theme has been +added, select the theme you want to use and click on <guibutton>Set Theme +Paths</guibutton>. Click on <guibutton>Apply</guibutton> for the changes to +take effect.</para> + +<para>Some more window decorations are available at kde-look.org under <ulink +url="http://www.kde-look.org/index.php?xcontentmode=17">the +Native &tde; 3.x</ulink> and <ulink +url="http://www.kde-look.org/index.php?xcontentmode=20">the +Native &tde; 3.2+</ulink> subsections. Themes for the <ulink +url="http://www.kde-look.org/index.php?xcontentmode=18">IceWM</ulink> and +<ulink +url="http://www.kde-look.org/index.php?xcontentmode=21">deKorator</ulink> window +decorations have their own subsections under the Window Decorations +category.</para> +</sect1> + +<sect1 id="style"> +<title>Style</title> +<para>Widgets are the basic elements of a graphical user interface, such as +buttons, scrollbars, tabs, and menus. A widget style is a plugin or a small +program that instructs &tde; how widgets are displayed. Since widgets are the +very basic parts of an interface, they are frequently accessed and must be able +to respond very quickly. This is why widget styles must come as source code to +be compiled or as binary packages to be installed, just like window decorations. +Please refer to your distribution's documentation on how to compile from source +or install binary packages.</para> + +<para>Once a widget style has been installed, it will be added to the list of +available styles in the <guilabel>Style</guilabel> module in the &kcontrolcenter;. +The <guilabel>Style</guilabel> tab allows +you to select a widget style from the list and to configure it if the style has +a <guibutton>Configure...</guibutton> feature. Different styles have different options. A preview of the +selected style is available at the lower portion of the tab. The +<guilabel>Effects</guilabel> tab +controls different visual effects for some widgets like comboboxes and tooltips. +The <guilabel>Toolbar</guilabel> tab gives some options on the general appearance of toolbars.</para> + +<para>Additional widget styles can be found in <ulink +url="http://www.kde-look.org/index.php?xcontentmode= +8x9x10x11x12x13x14x15x16">the different &tde; subsections of the +Themes/Styles</ulink> of kde-look.org. Take note that styles come in source +code or binary package forms. They are not &tde; theme files.</para> +</sect1> + +<sect1 id="kde-theme"> +<title>&tde; Theme</title> +<para>&tde; allows you to save the different changes you made to your desktop's +appearance in one file, using the Theme Manager in &kcontrolcenter;. Once you +have set up your desktop the way you want, click on <guibutton>Create New +Theme...</guibutton>. Enter the details you want to give your theme, such as theme +name, author, version, &etc;, then click <guibutton>OK</guibutton> when done. +This will add your theme to the list of available themes and save your settings +in a &tde; theme. A &tde; theme (<literal role="extension">.kth</literal> file) +instructs &tde; on what window decoration, style, or color scheme to use for +that particular theme. To add a &tde; theme from an outside source, click on +<guibutton>Install New Theme...</guibutton> and locate the &tde; theme file. +Removing a theme is easily done by clicking on <guibutton>Remove +Theme</guibutton>. If you made changes to your theme, you have to either create +a new theme name for it, or remove the previous version first to be able to use +the same theme name.</para> + +<para>The following are the settings that are saved and indicated in a &tde; +Theme:</para> + +<itemizedlist> +<listitem><para> +Background</para> +</listitem> +<listitem> +<para> +Screen Saver</para> +</listitem> +<listitem> +<para> +Icon Theme</para> +</listitem> +<listitem> +<para> +System Notifications</para> +</listitem> +<listitem> +<para> +Color Scheme</para> +</listitem> +<listitem> +<para> +Cursor Theme</para> +</listitem> +<listitem> +<para> +Window Decoration</para> +</listitem> +<listitem> +<para> +&konqueror; background (File Management)</para> +</listitem> +<listitem> +<para> +Panel background</para> +</listitem> +<listitem> +<para> +Style</para> +</listitem> +<listitem> +<para> +Fonts</para> +</listitem> +</itemizedlist> + +<para>One very important thing to consider when using or installing a &tde; +Theme is that it only indicates what settings to use for the above. A &tde; +Theme includes only system notifications, desktop background, panel background, +&konqueror; background, and the color scheme in its package. The other +components must be installed separately if they do not already come with +&tde;.</para> + +<para>&tde; Themes can be downloaded from the <ulink +url="http://www.kde-look.org/index.php?xcontentmode=8">Theme-Manager +subsection</ulink> of +kde-look.org, under the Themes/Styles section.</para> +</sect1> + +<sect1 id="desktop-glossary"> +<title>Glossary</title> + +<glosslist> +<glossentry id="gloss-background"> +<glossterm>Background</glossterm> +<glossdef><para>Background/wallpaper image or color for the +desktop</para></glossdef> +</glossentry> + +<glossentry id="gloss-color-scheme"> +<glossterm>Color Scheme</glossterm> +<glossdef><para>(<literal role="extension">.kcsrc</literal>) +Configuration file that indicates what colors to use +for certain widgets</para></glossdef> +</glossentry> + +<glossentry id="gloss-icons"> +<glossterm>Icons</glossterm> +<glossdef><para>Images representing applications, files, +devices, &etc;</para></glossdef> +</glossentry> + +<glossentry id="gloss-splash-screen"> +<glossterm>Splash Screen</glossterm> +<glossdef><para>Animated image or screen that displays while &tde; +loads after logging in</para></glossdef> +</glossentry> + +<glossentry id="gloss-win-deco"> +<glossterm>Window Decoration</glossterm> +<glossdef><para>Plugins or small programs that instruct the window +manager how to display window frames</para></glossdef> +</glossentry> + +<glossentry id="gloss-style"> +<glossterm>Style</glossterm> +<glossdef><para>Plugin or a small program that instructs &tde; +how widgets are displayed</para></glossdef> +</glossentry> + +<glossentry id="gloss-kde-theme"> +<glossterm>&tde; Theme</glossterm> +<glossdef><para>(<literal role="extension">.kth</literal>) +A file that contains instructions on what settings to use for +different GUI components</para></glossdef> +</glossentry> + +<glossentry id="gloss-widgets"> +<glossterm>Widgets</glossterm> +<glossdef><para>Basic elements that build up a graphical user +interface: buttons, scrollbars, menus, tabs, &etc;</para></glossdef> +</glossentry> + +</glosslist> +</sect1> + + +</chapter> diff --git a/doc/khelpcenter/userguide/desktop.png b/doc/khelpcenter/userguide/desktop.png Binary files differnew file mode 100644 index 000000000..c9e03af97 --- /dev/null +++ b/doc/khelpcenter/userguide/desktop.png diff --git a/doc/khelpcenter/userguide/email.docbook b/doc/khelpcenter/userguide/email.docbook new file mode 100644 index 000000000..8f69e5e6e --- /dev/null +++ b/doc/khelpcenter/userguide/email.docbook @@ -0,0 +1,236 @@ +<chapter id="email"> + +<chapterinfo> +<authorgroup> +<author> +&Daniel.Naber; +</author> +<author> +&David.Rugge; +</author> +</authorgroup> +</chapterinfo> + +<!-- Stolen and modified by Phil from the KMail manual --> +<!-- TODO: Screenies! --> +<title>Getting Started with Email</title> + +<indexterm><primary>Email</primary><secondary>getting +started</secondary></indexterm> + +<indexterm><primary>&kmail;</primary></indexterm> + +<para>&tde; features a powerful and easy-to-use email client called +&kmail;, which allows you to send, receive, and organize your email +quickly and efficiently. Let us look at how to set it up. If you have +any problems with this procedure, refer to the full &kmail; manual.</para> + +<sect1 id="email-information-needed"> +<title>Information you will need before you start</title> + +<para>Many email settings can vary greatly depending on the setup of +your system, your ISP's configuration, or your local network +setup. You will need to find out some information before you can start +setting up your email: +<variablelist> + +<varlistentry> +<term>Your email address</term> +<listitem><para>This should be provided by your ISP or system administrator.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Your username and password for your email account</term> +<listitem><para>The username is often the same as the part before the +<quote>@</quote> symbol in your email address, but not always: check +with your <acronym>ISP</acronym>.</para></listitem> +</varlistentry> + +<varlistentry> + + +<term> +<indexterm><primary>Email</primary><secondary>SMTP +server</secondary></indexterm> +Your outgoing email (<acronym>SMTP</acronym>) server name and +details</term> +<listitem><para>Again, your ISP should have provided +you with this information. If not, you can try the form <systemitem +class="systemname">smtp.<replaceable>your-isp-name</replaceable>.com</systemitem>.</para></listitem> +</varlistentry> + +<varlistentry> + +<term> +<indexterm><primary>Email</primary><secondary>IMAP +server</secondary></indexterm> + +<indexterm><primary>Email</primary><secondary>POP3 +server</secondary></indexterm> + +Your incoming email (<acronym>IMAP</acronym> or +<acronym>POP</acronym>) server name and details</term> +<listitem><para>If you do not have this information to hand, you can +try <systemitem +class="systemname">imap.<replaceable>your-isp-name</replaceable>.com</systemitem> +for <acronym>IMAP</acronym> or <systemitem +class="systemname">pop.<replaceable>your-isp-name</replaceable>.com</systemitem> +if you use <acronym>POP3</acronym>.</para></listitem> +</varlistentry> +</variablelist> +</para> + +<para>Once you have that information, you are ready to start setting +up &kmail;. Open &kmail; from the <guimenu>TDE</guimenu> menu (you can +find it in the <guisubmenu>Internet</guisubmenu> submenu, or use one +of the methods described in <xref linkend="programs-launching"/>.) Once +&kmail; has opened, select the menu entry +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KMail...</guimenuitem> +</menuchoice>. The next sections describe how to use the dialog that +appears to set up &kmail;.</para> +</sect1> + + +<sect1 id="email-setting-your-identity"> +<title>Setting your Identity</title> + +<para> +The settings in the <guilabel>Identities</guilabel> page are fairly +straightforward. Select the <guilabel>default</guilabel> identity and +click <guibutton>Modify...</guibutton>. Fill in the <guilabel>Your +name</guilabel> field with your full name (⪚ <userinput>John +Doe</userinput>) and, optionally, the +<guilabel>Organization</guilabel> field with the appropriate +information. +</para> +<para> +Next, fill in the <guilabel>Email address</guilabel> field with +your email address (⪚ <userinput>john@example.net</userinput>). +</para> + +<para>That is all for this dialog unless you want to use the more +advanced features (cryptography, a signature, &etc;). You can find +more information about these features in the full &kmail; +manual. Click on the <guibutton>OK</guibutton> button to close this +dialog, and move on to the next configuration page...</para> + +</sect1> + +<sect1 id="email-setting-up-your-account"> +<title>Setting up your Account</title> + +<para>Click on the <guilabel>Network</guilabel> icon to move to the +network configuration page. It contains the settings that +tell &kmail; how to send and receive your email messages. You will see +two tabs on the right-hand side: <guilabel>Sending</guilabel> and +<guilabel>Receiving</guilabel>. You need to set up both, so let us look +at them each in turn:</para> + +<sect2 id="sending-mail"> +<title>Sending Messages</title> + +<indexterm><primary>Email</primary><secondary>sending</secondary></indexterm> + +<para>The <guilabel>Sending</guilabel> tab provides a list of +ways to send messages. The first item in the list is the default +way to send messages. Using the <guibutton>Add...</guibutton> +button you can choose between two different ways of sending messages: +<guilabel>SMTP</guilabel> and +<guilabel>Sendmail</guilabel>. &Sendmail; here +means a local software installation — this has a +reputation of being difficult to set up, so if you do not already have a +working &Sendmail; configuration, choose +<guilabel>SMTP</guilabel> and fill in the <guilabel>Name</guilabel> +field with a descriptive name +(⪚ <userinput>My Mail Account</userinput>) +and the <guilabel>Host</guilabel> +field with the name and domain of your mail server +(⪚ <userinput>smtp.provider.com</userinput>). You will probably +not need to change the <guilabel>Port</guilabel> setting (the default is +<userinput>25</userinput>).</para> + +<para>A description of the other options can be found +in the full &kmail; manual. Click on <guibutton>OK</guibutton> to +close this dialog, and then click on the +<guilabel>Receiving</guilabel> tab.</para> + +</sect2> + +<sect2 id="receiving-mail"> +<title>Receiving Messages</title> + +<para>To set up an account so you can receive mail, press the +<guibutton>Add...</guibutton> button in the +<guilabel>Receiving</guilabel> tab. You will then be prompted for the +type of your email account; most users should select +<guilabel>POP3</guilabel> or <guilabel>IMAP</guilabel>. If you wish to +use a different system, consult the &kmail; manual.</para> + +<para>You will then be presented with +the <guilabel>Add account</guilabel> window. First, fill in the +<guilabel>Name</guilabel> field to name your account. You can choose any name +you like. <guilabel>Login</guilabel>, <guilabel>Password</guilabel>, and +<guilabel>Host</guilabel> should be filled in with the information you +gathered earlier. You should not usually need to change the <guilabel>Port</guilabel> setting.</para> + +<para>You are now ready to send and receive mail. For +<acronym>IMAP</acronym>, just open your folders in the +folder tree in &kmail;'s main window. &kmail; then connects to your +server and displays the messages it finds. For POP3 use +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>.</para> + +</sect2> + +</sect1> + +<sect1 id="email-testing-your-setup"> +<title>Testing your Setup</title> + +<indexterm><primary>Email</primary><secondary>testing</secondary></indexterm> + +<para>First, you should send yourself a message to test your +configuration. To send a message, either hit <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo>, select the +<guiicon>New Message</guiicon> icon or select +the <menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message...</guimenuitem></menuchoice> menu item. The +composer window will appear. Fill in the +<guilabel>To:</guilabel> field with your email address and type +something in the <guilabel>Subject</guilabel> field. Send the message by +selecting <menuchoice><guimenu>Message</guimenu> <guimenuitem>Send</guimenuitem> +</menuchoice>.</para> + +<para>To check your email, select +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>. In the lower-right corner of the main +window, a progress bar will indicate how many messages are being +downloaded. If you receive the message you just sent, then +congratulations! If, however, you receive any error messages while +testing your setup, make sure that your network connection is working +and recheck your settings at +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice>.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>The &kmail; Handbook has full descriptions of advanced +email settings and so on. You can read it in the &khelpcenter; or by +entering <userinput>help:/kmail</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +<listitem><para>The &kmail; website at <ulink +url="http://kmail.kde.org">http://kmail.kde.org</ulink> contains +latest news, tips and tricks, and plenty more.</para> +</listitem> + +</itemizedlist> + + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/extragear-applications.docbook b/doc/khelpcenter/userguide/extragear-applications.docbook new file mode 100644 index 000000000..5d0d2671b --- /dev/null +++ b/doc/khelpcenter/userguide/extragear-applications.docbook @@ -0,0 +1,199 @@ +<chapter id="extragear-applications"> + +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>&tde; Extragear Applications</title> + +<para>These are applications that are directly associated with &tde;, the project, but do not appear and are not shipped with the main &tde; distribution. This can be down to a number of reasons, but a common case is either down to a duplication of functionality, or because they're simply too specialised. Perhaps the most popular occurence however is that the developers themselves may not want it to appear in the main &tde; distribution; choosing, rather, to handle their own release schedules. Nevertheless, the applications in Extragear are distinguished by &tde;, and many are increasingly popular.</para> + +<sect1 id="extragear-components"> +<title>Available in the &tde; Extragear</title> + +<!-- Begin Multimedia --> +<sect2 id="extragear-multimedia"> +<title>Multimedia</title> + +<variablelist> +<varlistentry> +<term>&amarok;</term> + <listitem><para>An advanced and comprehensive music player with the capability to play <acronym>MP3</acronym>, <acronym>WAV</acronym>, and <acronym>OGG</acronym> audio filetypes and others. There is not room here to mention all of &amarok;'s features, but by default, &amarok; can automatically fetch cover art, embed song lyrics, and display aesthetically pleasing visualizations. &amarok; remains, as much of &tde; does, highly customizable; it contains a powerful scripting interface, and the context browser can be stylised easily using &CSS;. &amarok; also supports several backends, including <application>GStreamer</application>, <application>xine</application>, <acronym>NMM</acronym>, <acronym>MAS</acronym>, <application>aKode</application> and &arts;.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://amarok.kde.org">http://amarok.kde.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/amarok</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;; if you do not already have &amarok; installed (and hence do not have the handbook), then you can view it online <ulink url="http://amarok.kde.org/component/option,com_staticxt/staticfile,index.html/Itemid,49/">here</ulink>.</para></listitem> + </itemizedlist> + + </listitem> + +<!-- Insert Screeny --> + +</varlistentry> + +<varlistentry> +<term><application>K3b</application></term> + <listitem><para>The definitive &CD;/<acronym>DVD</acronym> burning application for &tde;. With <application>K3b</application> you can create data, video, and audio (it comes with plugins for <acronym>WAV</acronym>, <acronym>MP3</acronym>, <acronym>FLAC</acronym>, and <application>Ogg Vorbis</application>) &CD;s. Projects can be saved and loaded, &CD;-ripping is supported, and you can appropriately make &CD;/<acronym>DVD</acronym> copies.</para> + + <itemizedlist> + <listitem><para>Extragear Summary: <ulink url="http://extragear.kde.org/apps/k3b/">http://extragear.kde.org/apps/k3b/</ulink></para></listitem> + <listitem><para>Website: <ulink url="http://k3b.org">http://k3b.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-multimedia/k3b/index.html"><application>K3b</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +<!-- End Multimedia --> +</sect2> + +<!-- Begin Graphics --> +<sect2 id="extragear-graphics"> +<title>Graphics</title> +<variablelist> +<varlistentry> +<term>&digikam;</term> + <listitem><para>A photo management application which can conveniently organize and import digital photos. Features include complete tagging functionality, a plugin system, and a fully-featured comment system. &digikam; also makes use of <acronym>KIPI</acronym> (&tde; Image Plugin Interface), therefore contributing to the initiative to create a common plugin infrastructure, which allows development of image plugins that can be shared among graphical applications in &tde; (others include <application>Gwenview</application>, <application>ShowImg</application> and <application>KimDaBa</application>).</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://digikam.org">http://digikam.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/digikam/index.html">&digikam; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>Gwenview</application></term> + <listitem><para>Another advanced image viewer which can load and save all image formats supported by &tde;, as well as being able to display the <application>GIMP</application> (*.<acronym>xcf</acronym>) image filetype. <application>Gwenview</application> can perform a few graphical manipulations (rotate, mirroring) and has full support for TDEIO slaves (allowing you to use it via &FTP;). Other features also include file management operations, such as copy, paste, move and delete.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://gwenview.sourceforge.net/">http://gwenview.sourceforge.net/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/gwenview/index.html"><application>Gwenview</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term><application>ShowImg</application></term> + <listitem><para>A feature-rich image viewer, written for &tde;, which can display numerous formats, including <acronym>JPEG</acronym>, <acronym>PNG</acronym>, [animated] <acronym>GIF</acronym> and <acronym>MNG</acronym>. It consists of a tree-view frame, a directory/preview frame, and a view frame. The (larger) view frame can be exchanged with the (smaller) directory/preview frame. It can preview and display images from multiple directories and search for identical images. <application>ShowImg</application> also features a full-screen mode, zooming, sorting, drag and drop with &konqueror;, and support for images in compressed archives.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.jalix.org/projects/showimg/">http://www.jalix.org/projects/showimg/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/showimg/index.html"><application>ShowImg</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KimDaBa</application></term> + <listitem><para><application>KimDaBa</application> (&tde; Image Database) attempts to provide an efficient solution for the organization of hundreds (or even thousands) of images. Having been highly optimized for annotating images, <application>KimDaBa</application> can help you locate an image in a matter of seconds.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://ktown.kde.org/kimdaba/">http://ktown.kde.org/kimdaba/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/kimdaba/index.html"><application>KimDaBa</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Graphics --> + +<!-- Begin Network --> + +<sect2 id="extragear-network"> +<title>Network</title> +<variablelist> +<varlistentry> +<term>&konversation;</term> + <listitem><para>A fully-featured <acronym>IRC</acronym> client which supports per channel encoding, downloading and resuming file transfers, nick completion and highlighting, as well as tight integration with &kontact; and the rest of &tde;.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konversation.kde.org">http://konversation.kde.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-network/konversation/index.html">&konversation; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KMldonkey</application></term> + <listitem><para>A &tde; frontend for <application>MLDonkey</application>, a powerful <acronym>P2P</acronym> file-sharing tool. Highly configurable, real-time graphical bandwidth and network statistics, and much more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kmldonkey.org/">http://kmldonkey.org/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-network/kmldonkey/index.html"><application>KMldonkey</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KNemo</application></term> + <listitem><para>Displays for every network interface an icon in the systray. Tooltips and an info dialog provide further information about the interface. Passive popups inform about interface changes and a traffic plotter is also integrated.</para> + + <itemizedlist> + <listitem><para><ulink url="http://kde-apps.org">&tde;-apps</ulink> entry: <ulink url="http://kmldonkey.org/">http://www.kde-apps.org/content/show.php?content=12956</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Network --> + +<!-- Beging Utilities --> + +<sect2 id="extragear-utilities"> +<title>Utilities</title> +<variablelist> +<varlistentry> +<term><application>Filelight</application></term> + <listitem><para>A simple, yet ideal, application for graphically displaying where your diskpace is being used. <application>Filelight</application> displays this information by representing your filesystem as a set of concentric segmented-rings.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.methylblue.com/filelight/">http://www.methylblue.com/filelight/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-utils/filelight/index.html"><application>Filelight</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +<!-- Insert Screeny here --> +</varlistentry> + +<varlistentry> +<term><application>Krecipes</application></term> + <listitem><para>A &tde; recipe tool that can manage a recipe database with an easy-to-use interface. Full support for creating and removing ingredients as well as units; helps with diets, can calculate the amount of calories, vitamins, carbohydrates etc. Other advantages are its flexilibity and potential to extend further.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://krecipes.sourceforge.net">http://http://krecipes.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-utils/krecipes/index.html"><application>Krecipes</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Utilities --> + +</sect1> + +<sect1 id="extragear-related-information"> +<title>Related Information</title> +<itemizedlist> +<title>Related Information and Links</title> + <listitem><para>It should be stressed that the above is but a preview of what is available in the &tde; extragear. To view all of the applications and utilities available there visit <ulink url="http://extragear.kde.org">http://extragear.kde.org</ulink>, where a briefer summary of each application is provided.</para></listitem> + <listitem><para>The handbooks for the majority of applications in extragear can be viewed from <ulink url="http://docs.kde.org">http://docs.kde.org</ulink>.</para></listitem> + <listitem><para>Once again, you can find a plethora of other [third-party] &tde; applications at the popular <ulink url="http://kde-apps.org">http://kde-apps.org</ulink>.</para></listitem> +</itemizedlist> +</sect1> + +</chapter>
\ No newline at end of file diff --git a/doc/khelpcenter/userguide/file-sharing.docbook b/doc/khelpcenter/userguide/file-sharing.docbook new file mode 100644 index 000000000..1ab5c4f61 --- /dev/null +++ b/doc/khelpcenter/userguide/file-sharing.docbook @@ -0,0 +1,91 @@ +<sect1 id="file-sharing"> + +<sect1info> +<authorgroup> +<author> +&Lauri.Watts; +</author> +</authorgroup> +</sect1info> + + +<title>File Sharing</title> +<sect2 id="file-sharing-kpf"> +<title>How to share files with &kpf;</title> + +<indexterm><primary>File sharing</primary></indexterm> +<indexterm><primary>Shared Folders</primary></indexterm> + +<para>&kpf; provides simple file sharing using &HTTP; (the Hyper Text +Transfer Protocol,) which is the same protocol used by web sites to provide +data to your web browser. &kpf; is strictly a public fileserver, which means +that there are no access restrictions to shared files: whatever you select +for sharing is available to anyone.</para> + +<para>&kpf; is designed to be used for sharing files with friends, not to +act like a fully-fledged web server such as +<application>Apache</application>. &kpf; was primarily conceived as an easy +way to share files with others while chatting on <acronym>IRC</acronym> +(Internet Relay Chat, or <quote>chat rooms</quote>.)</para> + +<para>&kpf; runs as an applet inside &kicker;. This means that it takes up +little space on your screen and its status is always visible. To start the +&kpf; applet, <mousebutton>right</mousebutton> click on &kicker; and choose +<guimenu>Add Applet to Panel...</guimenu> to open the <guilabel>Add +Applet</guilabel> dialog. Select <guilabel>Public File Server</guilabel> and +click the <guibutton>Add to Panel</guibutton> button.</para> + +<para>&kpf; employs the concept of shared folders. You may choose one or +more folders to make public, and all files in that folder (and any +subfolders) will be shared.</para> + +<note><para>Please be extremely careful about which folders you share. Remember +that all files in the folder and its subfolders, including +<quote>hidden</quote> files (<quote>dotfiles</quote> to the techies) will be +made available to the world, so be careful not to share sensitive +information, such as passwords, cryptographic keys, your addressbook, +documents private to your organization, &etc;.</para></note> + +<para>Once &kpf; is running, you will see a square applet with a thin sunken +bevel and an icon depicting an <guiicon>hot air balloon</guiicon>. The +balloon is visible when no folders are being shared.</para> + +<para>To share a folder, <mousebutton>right</mousebutton> click on the +balloon icon and a pop-up menu will appear, containing only one item, +<guimenuitem>New Server...</guimenuitem>. Selecting this entry will cause a +<quote>wizard</quote> to appear, which will ask you a few simple +questions. Completing the questions will set up a folder for sharing.</para> + +<para>There is an alternative to using the applet directly when you want to +share a folder. &kpf; is integrated with &konqueror;.</para> + +<para>With &konqueror; open and displaying a folder, +<mousebutton>right</mousebutton> click on the background and bring up the +<quote>Properties</quote> dialog. On install, &kpf; added a +<guilabel>Sharing</guilabel> tab to this dialog. You will be offered the +option of starting &kpf; if it is not running. Choosing +<guibutton>Ok</guibutton> will send a signal to the &kpf; applet, asking it +to add a new share.</para> + +<para>For more detailed information, such as how to share different +directories to different people, see the <ulink +url="help:/kpf">&kpf;</ulink> handbook.</para> + +</sect2> + +<!-- <sect2 id="file-sharing-other-strategies"> +<title>Other strategies</title> + +Samba, local cgi? nfs devices +--> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> + + +</sect2>--> +</sect1> diff --git a/doc/khelpcenter/userguide/font-installation.docbook b/doc/khelpcenter/userguide/font-installation.docbook new file mode 100644 index 000000000..1248f660c --- /dev/null +++ b/doc/khelpcenter/userguide/font-installation.docbook @@ -0,0 +1,61 @@ +<sect1 id="fonts"> + +<sect1info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>titeuf@ph34rus.org</email> +</author> +</authorgroup> +</sect1info> + +<title>Fonts - Installing and Configuring</title> + +<indexterm><primary>Fonts</primary></indexterm> + +<para>Fonts are really easy to configure in &tde;. Open up the Control +Center (with <menuchoice><guimenu>TDE Menu</guimenu><guimenuitem>Control +Center</guimenuitem></menuchoice>) and choose +<guilabel>Font Installer</guilabel> in <guilabel>System +Administration</guilabel>in the tree view.</para> + +<para>There are two kinds of fonts: Personal and Global fonts. +Personal fonts are only accessible to your user, whereas global fonts are +accessible to everyone. When you open the <application>Font +Installer</application>, you're in Personal mode (you can see this in +the <guilabel>Location</guilabel> bar). When you click on the <guibutton>Administrator Mode</guibutton> +button, and put the <systemitem class="username">root</systemitem> password, +you can access global mode, where you can change the fonts for every user on +this computer.</para> + +<para>For the rest, there is no difference between those two kind of fonts.</para> + +<indexterm><primary>Fonts</primary><secondary>previewing</secondary></indexterm> + +<para>There is a list of fonts in the center. Click on a font to see a preview. +In the toolbar on the top you have buttons to access the top directory, +refresh and change the view.</para> + +<para>If you want to, you can organise your fonts in multiple directories, so that +you can easily find them later.</para> + +<indexterm><primary>Fonts</primary><secondary>installing</secondary></indexterm> + +<para>To install a font, click on the <guibutton>Add +Fonts...</guibutton> button. A file open dialog will appear where you can +choose your font.</para> + +<para>Alternatively, you can drag fonts from &konqueror; to the +list. To remove a font, <mousebutton>right</mousebutton> click on it and +choose <guibutton>Delete</guibutton>.</para> + + + +<para>Configuration (anti-aliasing)</para> + +<para>tdefontinst and tdefontview should probably get a mention too, since +they don't seem to have any existing docs.</para> +</sect1> diff --git a/doc/khelpcenter/userguide/getting-help.docbook b/doc/khelpcenter/userguide/getting-help.docbook new file mode 100644 index 000000000..facea078d --- /dev/null +++ b/doc/khelpcenter/userguide/getting-help.docbook @@ -0,0 +1,155 @@ +<sect1 id="getting-help"> + +<title>Getting Help</title> + +<sect2 id="user-manuals"> +<title>User Manuals</title> + +<indexterm><primary>User Manual</primary></indexterm> +<para>Most applications come with a user manual<indexterm><primary>User Manual</primary><secondary>Handbook +</secondary></indexterm>, which can be reached in various ways:</para> + +<itemizedlist> +<listitem> +<para>By pressing <keycap>F1</keycap> while inside the application.</para> +</listitem> +<listitem> +<para>From the menu bar: +<menuchoice><guimenu>Help</guimenu><guimenuitem><replaceable>Application name +</replaceable></guimenuitem></menuchoice>.</para> +</listitem> +<listitem> +<para>By browsing in &khelpcenter;<indexterm><primary>&khelpcenter;</primary></indexterm>.</para> +</listitem> +<listitem> +<para>By using the help KIOslave in &konqueror;. For example, in the Location bar, type <userinput>help:/<replaceable>Application name</replaceable></userinput>, where <replaceable>Application name</replaceable> is the name of the application. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2 id="context-help"> +<title>Context and <quote>What's This</quote> Help</title> + +<para>Many applications also provide context help in two forms: +Tooltips and <quote>What's This</quote> help.</para> + +<sect3 id="tooltips"> +<title>Tooltips</title> + +<indexterm><primary>Tooltips</primary></indexterm> +<para>Tooltips are small informational windows or balloons that appear when +hovering the mouse pointer over an item.</para> + +<para>&tde; uses tooltips in many places to provide brief help or +information on the screen about an item. For instance, most toolbar buttons +inside applications will display their name in a tooltip when resting or hovering +the mouse pointer over them.</para> + +<para>Tooltips have another function, which is not specifically tied to +help. In the &konqueror; file manager and on the Desktop, tooltips can +provide information about files. This information is commonly referred to as +<quote>meta information.</quote></para> + +<para>Learn more about meta-information tooltips in the section +about <link linkend="file-manager">the &konqueror; file manager</link>.</para> + +</sect3> + +<sect3 id="whats-this-help"> +<title><quote>What's This?</quote></title> + +<indexterm><primary>What's This?</primary></indexterm> + +<para><quote>What's This?</quote> help usually is more detailed than tooltips. +Access <quote>What's This?</quote> help in two ways:</para> + +<itemizedlist> +<listitem> +<para>By selecting the <guibutton>?</guibutton> button in the titlebar of the +window.</para> +</listitem> +<listitem> +<para>By pressing the key combination +<keycombo>&Shift;<keycap>F1</keycap></keycombo>.</para> +</listitem> +</itemizedlist> + +<para>The mouse pointer will change to a pointer with a question mark. +Select an item to learn more, and a small window will +pop up displaying information.</para> + +</sect3> +</sect2> + +<sect2 id="mailing-lists-newsgroups-and-irc"> +<title>Mailing Lists, Newsgroups, and <acronym>IRC</acronym></title> + +<sect3 id="mailing-lists"> +<title>Mailing Lists</title> + +<indexterm><primary>Mailing Lists</primary></indexterm> +<para>&tde-team; provides some mailing lists to provide help +and guidance with using and configuring &tde;:</para> + +<variablelist> +<varlistentry> +<term>The &tde; User List +<indexterm><primary>&tde; User Mailing List</primary></indexterm></term> +<listitem> +<para>This mailing list focuses specifically on questions +and discussions about using &tde;. For example, +the question <quote>How do I change the margin size for KWord +documents</quote> is appropriate for this list.</para> +<para>Subscribe to this list at <ulink +url="http://www.trinitydesktop.org/mailinglist.php">http://www.trinitydesktop.org/mailinglist.php</ulink>.</para> +<para>Find list archives at <ulink +url="http://trinity-users.pearsoncomputing.net/">http://trinity-users.pearsoncomputing.net/</ulink>.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect3> + +<sect3> +<title>IRC</title> + +<para>There is a #trinity channel on Freenode (irc.freenode.net) for support and other general talk about &tde;. +Access this channel by using any of &tde;'s popular IRC clients, which include <application>Konversation</application>, +&ksirc; and &kopete;. For more information, check the <xref linkend="irc"/> section.</para> + +</sect3> +</sect2> + + +<sect2 id="more-resources"> +<title>More Resources</title> + +<para>Other resources that might prove useful:</para> + +<variablelist> +<varlistentry> +<term>trinitydesktop.org/rss.php (RSS Feed) +<indexterm><primary>&tde; News Resource</primary></indexterm></term> +<listitem> +<para>The RSS feed news resource to stay informed about &tde;.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><ulink +url="http://www.trinitydesktop.org/wiki">http://www.trinitydesktop.org/wiki</ulink> +<indexterm><primary>The &tde; Wiki</primary></indexterm></term> +<listitem> +<para>The &tde; Wiki. The wiki should not be used as a substitute for the +respective application's handbook or official &tde; documentation.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/userguide/glossary.docbook b/doc/khelpcenter/userguide/glossary.docbook new file mode 100644 index 000000000..dda9f666f --- /dev/null +++ b/doc/khelpcenter/userguide/glossary.docbook @@ -0,0 +1,20 @@ +<chapter id="glossary"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Glossary of Terms</title> + +<para>TDE/GUI/UNIX terms that are worth explaining.</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/index.docbook b/doc/khelpcenter/userguide/index.docbook new file mode 100644 index 000000000..2ffdc84f5 --- /dev/null +++ b/doc/khelpcenter/userguide/index.docbook @@ -0,0 +1,582 @@ +<?xml version="1.0" ?> + <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "<replaceable>KApp</replaceable>"> + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % imageobjectco.module "INCLUDE"> + <!ENTITY getting-help SYSTEM "getting-help.docbook"> + <!ENTITY programs-controlling SYSTEM "programs-controlling.docbook"> + <!ENTITY troubleshooting-no-open SYSTEM "troubleshooting-no-open.docbook"> + <!ENTITY troubleshooting-network-x SYSTEM "troubleshooting-network-x.docbook"> + <!ENTITY windows-how-to SYSTEM "windows-how-to.docbook"> + <!ENTITY the-filemanager SYSTEM "the-filemanager.docbook"> + <!ENTITY panel-and-desktop SYSTEM "panel-and-desktop.docbook"> + <!ENTITY programs-and-documents SYSTEM "programs-and-documents.docbook"> + <!ENTITY control-center SYSTEM "control-center.docbook"> + <!ENTITY customizing-desktop SYSTEM "customizing-desktop.docbook"> + <!ENTITY base-tde-applications SYSTEM "base-tde-applications.docbook"> + <!ENTITY removable-disks SYSTEM "removable-disks.docbook"> + <!ENTITY burning-cds SYSTEM "burning-cds.docbook"> + <!ENTITY playing-music SYSTEM "playing-music.docbook"> + <!ENTITY playing-audiocds SYSTEM "playing-audiocds.docbook"> + <!ENTITY playing-movies SYSTEM "playing-movies.docbook"> + <!ENTITY your-tde-account SYSTEM "your-tde-account.docbook"> + <!ENTITY tde-as-root SYSTEM "tde-as-root.docbook"> + <!ENTITY switching-sessions SYSTEM "switching-sessions.docbook"> + <!ENTITY file-sharing SYSTEM "file-sharing.docbook"> + <!ENTITY networking-with-windows SYSTEM "networking-with-windows.docbook"> + <!ENTITY shared-sessions SYSTEM "shared-sessions.docbook"> + <!ENTITY printer-setup SYSTEM "printer-setup.docbook"> + <!ENTITY printing-from-apps SYSTEM "printing-from-apps.docbook"> + <!ENTITY pdf-files SYSTEM "pdf-files.docbook"> + <!ENTITY font-installation SYSTEM "font-installation.docbook"> + <!ENTITY creating-graphics SYSTEM "creating-graphics.docbook"> + <!ENTITY screen-captures SYSTEM "screen-captures.docbook"> + <!ENTITY konsole-intro SYSTEM "konsole-intro.docbook"> + <!ENTITY tde-edutainment SYSTEM "tde-edutainment.docbook"> + <!ENTITY accessibility SYSTEM "accessibility.docbook"> + <!ENTITY under-the-hood SYSTEM "under-the-hood.docbook"> + <!ENTITY net-connection-setup SYSTEM "net-connection-setup.docbook"> + <!ENTITY email SYSTEM "email.docbook"> + <!ENTITY internet-shortcuts SYSTEM "internet-shortcuts.docbook"> + <!ENTITY browser-fine-tuning SYSTEM "browser-fine-tuning.docbook"> + <!ENTITY usenet SYSTEM "usenet.docbook"> + <!ENTITY messaging-intro SYSTEM "messaging-intro.docbook"> + <!ENTITY tde-office SYSTEM "tde-office.docbook"> + <!ENTITY migrator-dictionary SYSTEM "migrator-dictionary.docbook"> + <!ENTITY glossary SYSTEM "glossary.docbook"> + <!ENTITY standard-menu-entries SYSTEM "standard-menu-entries.docbook"> + <!ENTITY where-next SYSTEM "where-next.docbook"> + <!ENTITY credits-and-license SYSTEM "credits-and-license.docbook"> + <!ENTITY extragear-applications SYSTEM "extragear-applications.docbook"> + <!ENTITY migrator-applications SYSTEM "migrator-applications.docbook"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>The &tde; (Trinity Desktop Environment) User Guide</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2004-2005</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para>A general user guide to the Trinity Desktop Environment. +</para> + +<para>Please report problems with this document to +<email>trinity-devel@lists.pearsoncomputing.net</email>. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>desktop</keyword> +<keyword>handbook</keyword> +<keyword>tutorial</keyword> +</keywordset> + +</bookinfo> + +<part id="introduction"> +<title>Introduction</title> + +<chapter id="welcome"> +<title>Welcome to the &tde; User Guide</title> + +<para>This User Guide provides an overview of &tde;. Use this +guide after installing &tde; and accompanying packages. This guide should be +a first point of reference for basic &tde; configuration questions, or +to learn to perform common tasks.</para> + +<sect1 id="what-the-ug-is"> +<title>What this guide aims to be</title> + +<para>The first place to look and a one-stop location for questions +regarding &tde;.</para> + +<para>A quick guide to commonly performed tasks. In most cases, learning +basic functions does not require configuring every option in an application. +Provided in this guide is information that works +for most common situations, along with links to sources of +further information.</para> + +<para>There are also some tips and tricks showing useful features +of &tde; and ways to save time and effort.</para> + +</sect1> + +<sect1 id="what-the-ug-is-not"> +<title>What this book is not</title> + +<para>This guide is not intended to replace the individual application +handbook help manuals. Use the appropriate handbook to help with specific program +configuration and troubleshooting issues not covered in this guide. Where to find +additional information is provided when answers are outside the scope of this guide.</para> + +<para>Several applications provided outside the main &tde; suite +are mentioned in this guide, but mostly this guide covers only the +applications provided as part of the main suite.</para> + +<para>The user guide is not specific to a distribution and covers a default &tde; +installation. Local installations might be customized by +distribution providers, or end-users. Therefore advice provided in this guide is +generic. For example, file paths used to run files might be different than +described in this guide.</para> +</sect1> + +<sect1 id="typographic-conventions"> +<title>Conventions used in this book</title> + +<para>The following formatting conventions are used: +<informaltable> +<tgroup cols="3"> + +<thead> +<row> +<entry>Type of Text</entry> +<entry>Style</entry> +<entry>Example</entry> +</row> +</thead> +<tbody> + +<row> +<entry>Text appearing in the &GUI; (on buttons, &etc;)</entry> +<entry>Light gray background</entry> +<entry><guilabel>Settings</guilabel></entry> +</row> + +<row> +<entry>Names of keys</entry> +<entry>Bold font</entry> +<entry>&Ctrl;</entry> +</row> + +<row> +<entry>Menu entries</entry> +<entry><quote>Menu Name</quote>-><quote>Menu Item</quote></entry> +<entry><menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem> +</menuchoice></entry> +</row> + +<row> +<entry>Key combinations (pressed simultaneously)</entry> +<entry><quote>Modifier Key</quote>+<quote>Action Key</quote></entry> +<entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap> +</keycombo></entry> +</row> + +<row> +<entry>Text you should enter</entry> +<entry>Bold, fixed width font</entry> +<entry><userinput>ls -al tde/</userinput></entry> +</row> + +<row> +<entry>Text you should replace as appropriate</entry> +<entry>Italic green font</entry> +<entry><replaceable>user</replaceable></entry> +</row> + +</tbody> +</tgroup> +</informaltable> +</para> + +<para>Mouse buttons often are referred to as the left mouse button and right mouse button. +Traditionally, the left mouse button is used the primary button to select items and the right +mouse button is used as the secondary button to open popup context menus. Within that context, +terms such as "left-click" and "right-click" have become common. Unfortunately, that terminology +describes the buttons from a right-handed perspective. For people using a mouse configured +for left-handed use, the roles of the buttons are reversed. That is, the right mouse button +becomes the primary button and the left mouse button becomes the secondary button. To avoid +confusion in this guide, that traditional terminology will be used as little as possible. +Although this guide is revised periodically, those traditional terms might still be used.</para> + +</sect1> + +<sect1 id="system-locations"> +<title>System Locations</title> + +<para>The following system location information might be useful: + +<variablelist> + +<varlistentry> +<term>&tde; prefix</term> +<listitem><para>&tde; installs into its own folder tree, which is found by +running the command <userinput><command>tde-config</command> <option>--prefix</option></userinput>. This folder is referred to +by the environment variable $<envar>TDEDIR</envar> and possibly +$<envar>TDEDIRS</envar>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>&tde; user-specific settings</term> +<listitem><para>The environment variable $<envar>TDEHOME</envar> +points to the folder where &tde; should find user-specific settings. +The default location is <filename class="directory">$HOME/.trinity</filename>.</para> +</listitem> +</varlistentry> + +</variablelist> + +</para> +</sect1> + +<sect1 id="overview"> +<title>Overview, or <quote>Where to look in the User Guide</quote></title> + +<para>Here's an overview of what's in the User Guide:</para> + +<para><xref linkend="desktop"/> contains an introduction to the basic +use of &tde;, such as <xref linkend="windows-how-to-work"/>, and the tools +used in all &tde; applications, like <xref +linkend="programs-save-open" />. Those users new to &tde; or +computers in general, will find this section helpful.</para> + +<para><xref linkend="components"/> explains some important components +of a &tde; installation and how they fit together. &tde;'s multimedia +and networking capabilities are extensive and not covered thoroughly +here, but there's a taster of both of them in this part of the User +Guide. At the end of this part are suggestions for tweaking &tde; +in <xref linkend="tinkering-under-the-hood"/>.</para> + +<para><xref linkend="tde-online"/> highlights &tde;'s suite of +Internet applications. &tde; includes a powerful web browser, +&konqueror;, a full-featured email client, &kmail;, a news reader, +&knode;, and many more applications to use the Internet. +This part of the User Guide contains +information about configuring these applications.</para> + +</sect1> +</chapter> +</part> + +<part id="desktop"> +<title>The Desktop</title> + +<chapter id="basics"> +<title>The Basics</title> +<para>The <quote>desktop</quote><indexterm><primary>Desktop</primary> +</indexterm> is the name for the layout of +the screen when starting &tde;. The desktop might look slightly different, +but the main features should be the same as the following image.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="desktop.png" format="PNG"/> +</imageobject> +<textobject><phrase>A default desktop layout</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>Let us look at the most important parts: +<itemizedlist> +<listitem><para>Most of the screen is +occupied by the background<indexterm><primary>Background</primary></indexterm>. With some distributions, +there might be a picture for the background. This picture is referred to as the +<quote>wallpaper,</quote><indexterm><primary>Wallpaper</primary></indexterm> and can be changed by every user.</para> +</listitem> + +<listitem><para>In the left-hand side are two icons: +<guiicon>Trash</guiicon> and <guiicon>Home</guiicon>. Selecting +these will open the <filename>Trash</filename> folder and Home +folder, respectively. Add more icons to the desktop as desired +to open favorite programs, or access removable media.</para> +</listitem> + +<listitem><para>At the bottom is the &tde; Panel<indexterm><primary>Panel</primary></indexterm>, also known as +<quote>&kicker;</quote>. The Panel contains several useful ways of +interacting with &tde;. The Panel houses the &kmenu; button, from where +any &tde; application can be started. The Panel can be configured to show all the +programs that are running, as well as the date and time, and more. +Read <xref linkend="panel-and-desktop"/> for more +information about the &tde; Panel.</para> +</listitem> +</itemizedlist></para> + +<!-- Put this somewhere else +At the far left is the &kmenu; +button. Selecting this button will open the main &tde; menu, which +has links to all the installed &tde; applications, and some useful +commands, like <guilabel>Find Files</guilabel> and <guilabel>Log +Out</guilabel>. Start an application from the +&kmenu;. Like the other things on the desktop, +the &kmenu; can be changed.</para> +</listitem> +--> + +<!-- Put this in the Panel section +<listitem><para>Next to the &kmenu; button are icons which will +start some commonly-used &tde; applications. These icons are similar +to the ones on the desktop, but only links to programs +(and not links to removable media, like CDs).</para> +</listitem> + +--> + +<sect1 id="logging-in"> + +<title>Logging In and Logging Out</title> +<para>There are two ways to log into &tde;: graphically and via the +command line.</para> + +<sect2 id="logging-in-graphically"> +<title>Logging in Graphically</title> +<indexterm><primary>login</primary></indexterm> +<indexterm><primary>&tdm;</primary></indexterm> + +<para>A screen similar to the one shown below means +the computer is ready for logging in graphically.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="tdm.png" format="PNG"/> +</imageobject> +<textobject><phrase>A typical TDM display</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> Enter a username in the +<guilabel>Username</guilabel> text box and password in the +<guilabel>Password</guilabel> text box. The password will not be shown +while typing, instead displaying as asterisks or dots. When finished, +select the <guibutton>Login</guibutton> button, or press the Enter key, +and &tde; will start. A &tde; splash image will appear, +and provide &tde; startup information. When done +&tde; will be ready to use.</para> +</sect2> + +<sect2 id="logging-in-via-cmdline"> +<title>Logging in at the Command Line</title> +<indexterm><primary><command>starttde</command></primary></indexterm> +<indexterm><primary><command>startx</command></primary></indexterm> + +<para>For those preferring the command line, log in to &tde; +with the <command>startx</command> command. If necessary then in the +system or user <filename>.xinitrc</filename> file, add the line +<userinput>exec starttde</userinput>. &tde; should start the same way as +when logging in graphically.</para> +</sect2> + +<sect2 id="logging-out"> +<title>Logging Out</title> +<indexterm><primary>logout</primary></indexterm> + +<para>When finished using &tde; for the moment, then +log out until next time. The easiest way to do this is to +select the &kmenu; button +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="../common/kmenu.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</guiicon> +at the bottom left of the screen, and then +select the <guimenuitem>Log Out...</guimenuitem> item.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <ulink url="help:/tdm">&tdm; Handbook</ulink> has information about using and configuring +the &tde; graphical login manager. Read more in &khelpcenter; or +by entering <userinput>help:/tdm</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> +</itemizedlist> + +</sect2> +</sect1> + +&getting-help; +&windows-how-to; + +&the-filemanager; + + +</chapter> + +&panel-and-desktop; + +&programs-and-documents; + +</part> + +<part id="components"> +<title>&tde; Components</title> + +&control-center; + +&base-tde-applications; + +&extragear-applications; + +<chapter id="multimedia"> +<title>Multimedia With &tde;</title> + +&removable-disks; + +&playing-music; + +&playing-audiocds; + +&playing-movies; + +</chapter> + +<chapter id="multiuser-kde"> +<title>&tde; the Multiuser Desktop</title> + +&your-tde-account; + +&tde-as-root; + +&switching-sessions; +</chapter> + +<chapter id="networking"> +<title>Networking with &tde;</title> + +&file-sharing; + +&networking-with-windows; + +&shared-sessions; +</chapter> + +<chapter id="graphics-printing-and-fonts"> +<title>Graphics, Printing, and Fonts</title> + +&printer-setup; + +&printing-from-apps; + +&pdf-files; + +&font-installation; + +&creating-graphics; + +</chapter> +&customizing-desktop; + +&konsole-intro; + +&tde-edutainment; + +&accessibility; + +&under-the-hood; +</part> + +<part id="tde-online"> +<title>&tde; and the Internet</title> + +&net-connection-setup; + +&email; + +<chapter id="browser"> +<title>&konqueror;</title> + +<para>Intro to the browser</para> + +&internet-shortcuts; + +&browser-fine-tuning; +</chapter> + +&usenet; + +&messaging-intro; + +</part> + +&tde-office; + +<part id="more"> +<title>More Tools</title> + +&migrator-applications; + +&migrator-dictionary; + +&standard-menu-entries; + +&glossary; + +<chapter id="troubleshooting"> +<title>Troubleshooting Problems</title> + +<para>Problems that aren't</para> + +<para>Frozen apps (how to kill them)</para> + +<para>Things won't open</para> + +<para>That scary crash dialog</para> + +<para>Reporting Bugs</para> + +<para>More Resources</para> + +&troubleshooting-network-x; + +&troubleshooting-no-open; + +</chapter> + +<chapter id="contributing"> +<title>Contributing to &tde;</title> + +<para>Some basic information to get encourage people to contribute to +&tde;, information about what's available, and how to get +started.</para> + +</chapter> + +</part> + + +<appendix id="appendix-credits"> +<title>Credits and Licenses</title> + +&credits-and-license; + +<sect1 id="license"> +<title>License</title> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +</sect1> + +</appendix> + +&documentation.index; + +</book> diff --git a/doc/khelpcenter/userguide/internet-shortcuts.docbook b/doc/khelpcenter/userguide/internet-shortcuts.docbook new file mode 100644 index 000000000..a4cfa1e68 --- /dev/null +++ b/doc/khelpcenter/userguide/internet-shortcuts.docbook @@ -0,0 +1,62 @@ +<sect1 id="internet-keywords"> +<sect1info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>titeuf@ph34rus.org</email> +</author> +</authorgroup> +</sect1info> + +<title>Internet Shortcuts</title> + +<indexterm><primary>Web shortcuts</primary></indexterm> +<indexterm><primary>Internet Shortcuts</primary></indexterm> +<indexterm><primary>gg:</primary></indexterm> + +<para>Internet shortcuts are a really useful feature of &konqueror;: +once you get used to them, you'll wonder how you ever lived without them.</para> + +<para>To see what internet shortcuts are, open up &konqueror; and type +<userinput>gg:kde</userinput> in the <guilabel>Location</guilabel> +bar.</para> + +<para>You will go to Google, searching for &tde;.</para> + +<para>They are many such shortcuts like <userinput>ggl:</userinput> (Google +I'm feeling lucky), <userinput>bug:</userinput> (bugs.trinitydesktop.org) and so +on.</para> + +<para>To get a full list, click on <guimenu>Settings</guimenu> in the +&konqueror; menu, and select <guilabel>Web Shortcuts</guilabel>. Here you will find a full list of all the shortcuts. You can create +new ones, change existing ones, or delete unused shortcuts. You can also +disable web shortcuts if you don't like them. If you set the <guilabel>Default +search engine</guilabel>, you don't have to type the shortcut anymore. For +instance if you set it to Google, you can just type +<userinput>kde</userinput> in the <guilabel>Location</guilabel> bar, +and it will search Google for <quote>&tde;</quote>.</para> + +<para>In <guilabel>Keyword delimiter</guilabel> you can choose if you want +to separate a shortcut with a colon (<userinput>gg: kde</userinput>) or a +space (<userinput>gg kde</userinput>).</para> + +<para>A nice tip with Internet shortcuts is that you can use them from the +<guilabel>Run Command</guilabel> dialog. Just open it (through the &kmenu; +or with <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>) and +type your shortcut, ⪚ <userinput>gg: kde</userinput>, and press +&Enter;. It will automatically open &konqueror; with a Google +search for &tde;.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/juk-icon.png b/doc/khelpcenter/userguide/juk-icon.png Binary files differnew file mode 100644 index 000000000..a9b9150aa --- /dev/null +++ b/doc/khelpcenter/userguide/juk-icon.png diff --git a/doc/khelpcenter/userguide/juk.png b/doc/khelpcenter/userguide/juk.png Binary files differnew file mode 100644 index 000000000..3c5517cb8 --- /dev/null +++ b/doc/khelpcenter/userguide/juk.png diff --git a/doc/khelpcenter/userguide/kaboodle-icon.png b/doc/khelpcenter/userguide/kaboodle-icon.png Binary files differnew file mode 100644 index 000000000..7737031df --- /dev/null +++ b/doc/khelpcenter/userguide/kaboodle-icon.png diff --git a/doc/khelpcenter/userguide/kaboodle.png b/doc/khelpcenter/userguide/kaboodle.png Binary files differnew file mode 100644 index 000000000..ca64fee01 --- /dev/null +++ b/doc/khelpcenter/userguide/kaboodle.png diff --git a/doc/khelpcenter/userguide/kcalc-systray.png b/doc/khelpcenter/userguide/kcalc-systray.png Binary files differnew file mode 100644 index 000000000..c36073d3c --- /dev/null +++ b/doc/khelpcenter/userguide/kcalc-systray.png diff --git a/doc/khelpcenter/userguide/kcontrol.png b/doc/khelpcenter/userguide/kcontrol.png Binary files differnew file mode 100644 index 000000000..d09af9aef --- /dev/null +++ b/doc/khelpcenter/userguide/kcontrol.png diff --git a/doc/khelpcenter/userguide/kmag.png b/doc/khelpcenter/userguide/kmag.png Binary files differnew file mode 100644 index 000000000..0b9de2399 --- /dev/null +++ b/doc/khelpcenter/userguide/kmag.png diff --git a/doc/khelpcenter/userguide/kmousetool.png b/doc/khelpcenter/userguide/kmousetool.png Binary files differnew file mode 100644 index 000000000..fe5dfb6a2 --- /dev/null +++ b/doc/khelpcenter/userguide/kmousetool.png diff --git a/doc/khelpcenter/userguide/kmouth.png b/doc/khelpcenter/userguide/kmouth.png Binary files differnew file mode 100644 index 000000000..ebc59d291 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth.png diff --git a/doc/khelpcenter/userguide/kmouth2.png b/doc/khelpcenter/userguide/kmouth2.png Binary files differnew file mode 100644 index 000000000..3e435b772 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth2.png diff --git a/doc/khelpcenter/userguide/kmouth3.png b/doc/khelpcenter/userguide/kmouth3.png Binary files differnew file mode 100644 index 000000000..63a52ef65 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth3.png diff --git a/doc/khelpcenter/userguide/knode-identity.png b/doc/khelpcenter/userguide/knode-identity.png Binary files differnew file mode 100644 index 000000000..7039f440a --- /dev/null +++ b/doc/khelpcenter/userguide/knode-identity.png diff --git a/doc/khelpcenter/userguide/knode-mail-account.png b/doc/khelpcenter/userguide/knode-mail-account.png Binary files differnew file mode 100644 index 000000000..d8dc560a2 --- /dev/null +++ b/doc/khelpcenter/userguide/knode-mail-account.png diff --git a/doc/khelpcenter/userguide/knode-news-account.png b/doc/khelpcenter/userguide/knode-news-account.png Binary files differnew file mode 100644 index 000000000..66eb4adec --- /dev/null +++ b/doc/khelpcenter/userguide/knode-news-account.png diff --git a/doc/khelpcenter/userguide/knode-start.png b/doc/khelpcenter/userguide/knode-start.png Binary files differnew file mode 100644 index 000000000..709978a9c --- /dev/null +++ b/doc/khelpcenter/userguide/knode-start.png diff --git a/doc/khelpcenter/userguide/konq-sidebar.png b/doc/khelpcenter/userguide/konq-sidebar.png Binary files differnew file mode 100644 index 000000000..d58cdda3b --- /dev/null +++ b/doc/khelpcenter/userguide/konq-sidebar.png diff --git a/doc/khelpcenter/userguide/konq-simple.png b/doc/khelpcenter/userguide/konq-simple.png Binary files differnew file mode 100644 index 000000000..b2f40fda8 --- /dev/null +++ b/doc/khelpcenter/userguide/konq-simple.png diff --git a/doc/khelpcenter/userguide/konsole-intro.docbook b/doc/khelpcenter/userguide/konsole-intro.docbook new file mode 100644 index 000000000..35c49519b --- /dev/null +++ b/doc/khelpcenter/userguide/konsole-intro.docbook @@ -0,0 +1,108 @@ +<chapter id="konsole-intro"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +</author> +</authorgroup> +</chapterinfo> + + +<title>&konsole; Introduction</title> + +<para>Extremely brief intro to managing in a shell</para> + +<para>Emergency procedures: killing wild apps, etc</para> + +<para>SSH, sessions, envars, other fun things</para> + +<para>Some tips and tricks</para> + + +<!-- Some Content borrowed from the konsole handbook --> + +<para>&konsole; is a terminal emulator for the X Window System. It is +essentially based on the <ulink url="http://vt100.net">DEC's VT100</ulink> +and many of its succesors. &konsole; – also referred to as a +shell – is an +essential tool on &Linux; and &UNIX; based machines for fast and productive +work.</para> + +<para>Emergency Procedures:</para> + +<para>On &Linux; and &UNIX;-based systems every process runs independently in its own memory +space so it can't accidentally overwrite any other processes memory, unless +of course it has <systemitem class="username">root</systemitem> privileges. +If a process in &tde; crashes due to a bug one should not need to worry +about it accessing any other active process.</para> + +<para>To keep track of all system processes use the <command>top</command> +command or <command>ps</command> in &konsole;. Using these utilities will +make it much easier to find and kill off rogue programs.</para> + +<para>An example of using signals in &konsole;, &konqueror; has crashed +leaving behind a running process of +<application>nspluginviewer</application> which is taking up 12% of your +memory and 10% of your cpu cycles. In <command>top</command> use the <keycap>k</keycap> +command switch to kill the task. You will be prompted for the PID and then +the signal to send to kill it. For more on info on what signals you can +send to a running process see the full manual on signals (type +<command>man signal</command> in a &konsole; or go to +<userinput>#signal</userinput> in &konqueror;).</para> + +<para>SSH, sessions, envars, other fun things.</para> + +<para>If you are using &konsole; for remote administration consider using +&konsole;'s <quote>Session</quote> feature. To use this click on the menu +entry +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &konsole;</guimenuitem></menuchoice>. +From here choose the <guimenuitem>Sessions</guimenuitem> tab and fill in the +name for your new session. This will now become your default session when +you start &konsole;.</para> + +<para>When &konsole; is invoked <application>bash</application> specific +commands and &tde; specific variables are read and executed from +<filename>~/.bashrc</filename> or <filename>~/.bash_profile</filename>. +The preferred configuration file for user environments is +<filename>~/.bash_profile</filename>, the commands +<command>printenv</command> or <command>env</command> can be used to +display all currently set variables. To set a variable in the shell use +<command>VARNAME=<replaceable>value</replaceable></command>. For a full +list of variables that can be set in &tde; see the <ulink +url="http://wiki.kde.org/tiki-index.php?page=Environment+Variables">wiki +</ulink>.</para> + +<para>Some tips and tricks</para> + +<para>To rename &konsole;'s session use <keycombo +action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> and enter the new +name.</para> + +<para>If you find the need to run any &tde; program with <systemitem +class="username">root</systemitem> privileges, you can use the &tdesu; command with the <option>-c</option> switch +from the command line like this: <userinput><command>tdesu</command> +<option>-c -n <replaceable>PROGRAM</replaceable></option></userinput>, using +the <option>-n</option> switch will prevent &tde; from remembering your +passwords.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + + +<listitem><para>The &konsole; +Handbook has much more information about the features available in +&konsole;. You can read it in &khelpcenter; or by entering +<userinput>help:/konsole</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +</itemizedlist> + + + + + +</chapter> diff --git a/doc/khelpcenter/userguide/kopete.png b/doc/khelpcenter/userguide/kopete.png Binary files differnew file mode 100644 index 000000000..6d1fb850b --- /dev/null +++ b/doc/khelpcenter/userguide/kopete.png diff --git a/doc/khelpcenter/userguide/kppp-dialer-tab.png b/doc/khelpcenter/userguide/kppp-dialer-tab.png Binary files differnew file mode 100644 index 000000000..174248710 --- /dev/null +++ b/doc/khelpcenter/userguide/kppp-dialer-tab.png diff --git a/doc/khelpcenter/userguide/kppp-wizard.png b/doc/khelpcenter/userguide/kppp-wizard.png Binary files differnew file mode 100644 index 000000000..5e720df9a --- /dev/null +++ b/doc/khelpcenter/userguide/kppp-wizard.png diff --git a/doc/khelpcenter/userguide/messaging-intro.docbook b/doc/khelpcenter/userguide/messaging-intro.docbook new file mode 100644 index 000000000..f5e26e222 --- /dev/null +++ b/doc/khelpcenter/userguide/messaging-intro.docbook @@ -0,0 +1,170 @@ +<chapter id="messaging"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Peter</firstname> +<surname>Nuttall</surname> +</author> + +<author> +<firstname>Tom</firstname> +<surname>Albers</surname> +</author> + +</authorgroup> + +</chapterinfo> + + +<title>Introduction to messaging</title> + + +<para>The default way to send instant messages in &tde; is to use the <acronym>IM</acronym> +client, &kopete;. This is a multi-protocol <acronym>IM</acronym> client, meaning that it +handles several different protocols including <acronym>MSN</acronym>, +Jabber, <acronym>AOL</acronym> and <acronym>IRC</acronym>. It also has +useful features including support for &kaddressbook;, meta-contacts, +encryption support and lots more.</para> + +<screenshot> +<screeninfo>&kopete;, the &tde; IM client.</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kopete.png" format="PNG"/> </imageobject> +<textobject> +<phrase>&kopete;, the &tde; IM client.</phrase> +</textobject> +<caption> +<para>&kopete;, the &tde; IM client.</para> +</caption> +</mediaobject> +</screenshot> + +<sect1 id="messaging-getting-started"> +<title>How to get started</title> + +<para>Start up &kopete; from the menu (it can normally be found in the +Internet folder) When it starts up you should see a window with &kopete; +at the top, menus and a tool bar below, and then your contacts below. +You should add some accounts by clicking on the +<guimenu>Settings</guimenu> menu and selecting the <guimenuitem>Configure +Kopete</guimenuitem> option. By selecting the <guilabel>Accounts</guilabel> +option you should see a list of your accounts (initially empty) and +options to add new accounts and to edit or remove existing accounts. +By clicking on the <guibutton>add new account</guibutton> button, you can +add a new account using the wizard. When you have added an account, you can +connect to this account by clicking on the relevant icon at the bottom of +your main &kopete; window. This should make your contacts appear in the +contacts window.</para> + +</sect1> + +<sect1 id="meta-contacts"> +<title>Meta-contacts</title> + +<para>Meta contacts are one of the features of &kopete; that make sense +once you figure out what they are. Until you do, they annoy you. They are +basically a way of taking a contact on one network (such as +<acronym>MSN</acronym>) and linking it to another contact on a different +network. This is useful for when people have accounts on different networks +as you can chat to them without needing to know which account they are +signed on to. This also lets you assign names to your meta-contacts that +don't change when people change their names on their account, this is useful +if you have contacts who insist upon setting their +<acronym>MSN</acronym> nick to something like +<quote>=EF=81=8A</quote>.</para> + +<para>You can do other useful things with meta-contacts like link them to +entries in your address book. See <xref +linkend="integrated-messaging"/></para> + +</sect1> + +<sect1 id="irc"> +<title><acronym>IRC</acronym></title> + +<para>Internet Relay Chat (<acronym>IRC</acronym>) has been around far longer than most <acronym>IM</acronym> +systems, and is still widely used. It is mainly designed for group (many-to-many) communication in discussion forums called channels, but also allows one-to-one communication.</para> + +<para>The #kde channel is under Freenode, the <acronym>IRC</acronym> server, which provides an interactive environment for coordination and support of peer-directed projects, including -- mdash; and placing particular stress upon -- mdash; those relating to free software and open source projects, such as &tde;.</para> + + +<para>While &kopete; has a <acronym>IRC</acronym> plugin, and handles both channels and nicks well, +long time <acronym>IRC</acronym> users might prefer a client designed just +for that role, which is what <application>Konversation</application> is. It supports features such +as granting and taking op status, banning, easy nick changing, special +channel support for passwords and invites, and other things that the power +<acronym>IRC</acronym> users expect. It also is far better at handling +large channels such as #debian. If you have used another +power-<acronym>IRC</acronym> client before, you should have no trouble using +<application>Konversation</application>.</para> + + +</sect1> + +<sect1 id="integrated-messaging"> +<title>Linking email and messaging</title> + +<para>Did it happen to you? You received an email and the first thing +you would like to do is to give a reaction on it, but not by +email. So you switch to your instant messaging client and/or IRC +client and look if that person is online via MSN, Jabber or IRC. Well +&tde; 3.3 has made that a lot easier. A step-by-step manual:</para> + +<para>The requirements are &kmail;, &kaddressbook; and &kopete; +(<application>Konversation</application> should do as well). Make sure &kmail; is configured and +fully functional for email, and Kopete is well configured for IRC, +Jabber and/or MSN and/or any other protocol.</para> + +<para>If an email comes in from a contact you know, the first thing +you have to do is to add it to your address book. This can be achieved +by right clicking the address and choosing the entry <guibutton>Add to Address +Book</guibutton>.</para> + +<para>If you know the nickname which the user uses on, for example, IRC, +go to &kopete;. Go to +<menuchoice><guimenu>File</guimenu><guimenuitem>Add +contact</guimenuitem> </menuchoice>. In the wizard, select the +checkbox at the bottom called <guilabel>Use the TDE address book for +this contact</guilabel> and choose <guibutton>Next</guibutton>. Select +the right Address Book entry for that contact and press +<guibutton>Next</guibutton>. Now you can set the display name and the +group it belongs to for &kopete;. In the next screen select which +protocol should be used if you have set up more then one protocol. You +can select more than one protocol. After that, depending on the +protocol, there will be some other questions, which you can answer as +you like.</para> + +<para>Although we did specify to choose from the address book, +&kopete; has not automatically linked your contact to the address +book. So select the contact and choose +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Properties</guimenuitem> +</menuchoice>. On the <guilabel>General</guilabel> tab check the box +labeled <guilabel>Has address book entry</guilabel>. Press +<guilabel>...</guilabel> and select the contact. Close these two +windows.</para> + +<para>Now go to your addressbook, if you select the contact you will +see that it shows an extra field <guilabel>Presence</guilabel>, followed by the current +status. This status will automatically update as soon as the contact +goes away, offline, online, and so on. Now go to &kmail;, select another email and return to the original email (in other words: reload +the current email). You can now see behind the email address the +current state of your contact.</para> + +<para>If you want to chat with this person, just right click the +address in &kmail; and choose <guilabel>Chat With...</guilabel>. Your +Instant Messenger will start a conversation with the contact.</para> + +<!-- Add links to "further reading" here --> +<!--<itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/migrator-applications.docbook b/doc/khelpcenter/userguide/migrator-applications.docbook new file mode 100644 index 000000000..8e511861e --- /dev/null +++ b/doc/khelpcenter/userguide/migrator-applications.docbook @@ -0,0 +1,266 @@ +<chapter id="migrator-applications"> +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; &Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>Application Guide for Migrates</title> + +<!-- Section needs a +lot+ of work. I couldn't do any of the Mac equivalents, as I haven't used it before. More entries could be put in, too. --> + +<para>&tde; has many applications, often prefixed with (or containing) the letter k. The names are generally self-explanatory, but it can still be difficult sometimes to find the appropriate packages. Migrates from operating systems such as <trademark class="registered">Microsoft Windows</trademark> or <trademark class="registered">Apple Macintosh</trademark> might have some difficulty in locating an application for a particular job. Below is a table with an expansion on the &kmenu; and the respective Win/Mac equivalent.</para> + +<table><title>Sample Table</title> +<tgroup cols='6' align='left' colsep='1' rowsep='1'> +<colspec colname='c1'/> +<colspec colname='c2'/> +<colspec colname='c3'/> +<colspec colname='c5'/> +<colspec colnum='6' colname='c6' /> +<thead> +<row> + <entry namest="c1" nameend="c2" align="center"><para>&kmenu; Location</para></entry> + <entry><para>&tde; Application</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Equivalent</para></entry> + <entry><para><trademark class="registered">Macintosh</trademark> Equivalent</para></entry> + <entry><para>Notes</para></entry> +</row> +</thead> +<!--<tfoot> +<row> + <entry><para>f1</para></entry> + <entry><para>f2</para></entry> + <entry><para>f3</para></entry> + <entry><para>f4</para></entry> + <entry><para>f5</para></entry> +</row> +</tfoot>--> +<tbody> +<row> + <entry align="center" namest="c1" nameend="c2"><para>File Manager</para></entry> + <entry align="center"><para>&konqueror; (Home Folder)</para></entry> + <entry align="center"><para>Windows Explorer</para></entry> + <entry align="center"><para>Integrated file manager, content +viewer/player and web browser</para></entry> +</row> +<row> + <entry namest="c1" nameend="c2"><para>System and User Settings</para></entry> + <entry><para>&kcontrol;</para></entry> + <entry><para>Control Center</para></entry> +</row> +<row> + <entry morerows='1' valign='middle'><para>Office</para></entry> + <entry><para>Office Suite: + <orderedlist> + <listitem><para>Word Processing</para></listitem> + <listitem><para>Spreadsheets</para></listitem> + <listitem><para>Slide Presentations</para></listitem> + <listitem><para>Flowchart & Diagram Editing</para></listitem> + <listitem><para>Scalable Graphics</para></listitem> + <listitem><para>Image Manipulation</para></listitem> + <listitem><para>Report Generator</para></listitem> + <listitem><para>Chart</para></listitem> + <listitem><para>Database Creation</para></listitem> + <listitem><para>Formula Editor</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para> + <orderedlist> + <listitem><para>&kword;</para></listitem> + <listitem><para>&kspread;</para></listitem> + <listitem><para>&kpresenter;</para></listitem> + <listitem><para>&kivio;</para></listitem> + <listitem><para>&karbon14;</para></listitem> + <listitem><para>&chalk;</para></listitem> + <listitem><para>&kugar;</para></listitem> + <listitem><para>&kchart;</para></listitem> + <listitem><para>&kexi;</para></listitem> + <listitem><para>&kformula;</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para> + <orderedlist> + <listitem><para><application><acronym>MS</acronym> Word</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Excel</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Powerpoint</application></para></listitem> + <listitem><para><application>Adobe Illustrator</application></para></listitem> + <listitem><para><application>Adobe Photoshop</application></para></listitem> + <listitem><para><application>Report Generator</application></para></listitem> + <listitem><para><application>Chart</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Access</application></para></listitem> + </orderedlist> + + + +</para></entry> + +<!--Fill in Mac equivalents + <entry><para>Office Suite: +<orderedlist> + <listitem><para>Word Processing</para></listitem> + <listitem><para>Spreadsheets</para></listitem> + <listitem><para>Slide Presentations</para></listitem> + <listitem><para>Flowchart & Diagram Editing</para></listitem> + <listitem><para>Scalable Graphics</para></listitem> + <listitem><para>Image Manipulation</para></listitem> + <listitem><para>Report Generator</para></listitem> + <listitem><para>Chart</para></listitem> + <listitem><para>Database Creation</para></listitem> + <listitem><para>Formula Editor</para></listitem> +</orderedlist> + +</para></entry>--> + +</row> + +<row> + <entry><para>Personal Information Management: + <orderedlist> + <listitem><para>Mail</para></listitem> + <listitem><para>Address Book</para></listitem> + <listitem><para>Personal Organizer</para></listitem> + <listitem><para>News Reader</para></listitem> + <listitem><para>Pop-up Notes</para></listitem> + <listitem><para><acronym>RSS</acronym> Reader</para></listitem> + </orderedlist> + + </para></entry> + <entry><para> + <orderedlist> + <listitem><para>&kmail;</para></listitem> + <listitem><para>&kaddressbook;</para></listitem> + <listitem><para>&korganizer;</para></listitem> + <listitem><para>&knode;</para></listitem> + <listitem><para>&knotes;</para></listitem> + <listitem><para>&akregator;</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para><application><acronym>MS</acronym> Outlook</application></para></entry> + + <entry><para>The Personal Information Manager is &kontact;; all other &tde; <acronym>PIM</acronym> applications integrate into it.</para></entry> + +</row> + +<row> + <entry morerows='2' valign='middle'><para>Internet</para></entry> + <entry><para>Web Browser</para></entry> + <entry><para>&konqueror;</para></entry> + <entry><para><acronym>MS</acronym> Internet Explorer</para></entry> + <entry><para><application>Safari</application></para></entry> + <entry><para>Integrated file manager, web browser, <acronym>FTP</acronym> manager, and univerval viewing application.</para></entry> + + +</row> + +<row> + <entry><para>Instant Messaging</para></entry> + <entry><para>&kopete; + <itemizedlist> + <listitem><para><acronym>AIM</acronym></para></listitem> + <listitem><para><acronym>MSN</acronym></para></listitem> + <listitem><para><acronym>ICQ</acronym></para></listitem> + <listitem><para>Jabber</para></listitem> + <listitem><para>Novell GroupWise</para></listitem> + <listitem><para>Yahoo</para></listitem> + <listitem><para><acronym>IRC</acronym></para></listitem> + <listitem><para><acronym>SMS</acronym></para></listitem> + </itemizedlist> + +</para></entry> + <entry><para><acronym>MSN</acronym> Messenger</para></entry> + <entry><para>Comprehensive multi-network compatible instant messaging software</para></entry> +</row> + +<row> + <entry><para>Chat (<acronym>IRC</acronym>)</para></entry> + <entry><para>&ksirc;</para></entry> + <entry><para><application>mIRC</application></para></entry> +</row> + +<row> + <entry morerows='4' align="center"><para>Multimedia</para></entry> + <entry><para>Music/Audio</para></entry> + <entry><para>&juk;</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Media Player</para></entry> +</row> + +<row> + <entry><para>&CD;/<acronym>DVD</acronym> Burner</para></entry> + <entry><para><application>K3b</application></para></entry> + <entry><para>Nero</para></entry> +</row> + +<row> + <entry><para>Video Player</para></entry> + <entry><para>&noatun;</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Media Player</para></entry> +</row> + +<row> + <entry><para>Audio &CD; Ripper</para></entry> + <entry><para><application>KAudioCreator</application></para></entry> +</row> + +<row> + <entry><para>Sound Controls</para></entry> + <entry><para>&kmix;</para></entry> +</row> + +<row> + <entry><para>Terminal</para></entry> + <entry><para>&konsole;</para></entry> + <entry><para><application>CMD</application></para></entry> +</row> + +<row> + <entry><para>User Manager</para></entry> + <entry><para>&kuser;</para></entry> + <entry><para>User Manager</para></entry> +</row> + +<row> + <entry><para>Package Manager</para></entry> + <entry><para>&kpackage;</para></entry> + <entry><para><application>Add/Remove Programs</application></para></entry> +</row> + +<row> + <entry morerows='2' align="center"><para>Utilities</para></entry> + <entry><para>Archiver</para></entry> + <entry><para>&ark;</para></entry> + <entry><para><application>WinZip</application></para></entry> +</row> + +<row> + <entry><para>Password Manager</para></entry> + <entry><para><application>TDEWallet</application></para></entry> +</row> + +<row> + <entry><para>Text Editor</para></entry> + <entry><para>&kate;</para></entry> + <entry><para>Notepad</para></entry> +</row> + + +</tbody> +</tgroup> + +</table> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>Many more &tde; applications are available from the &tde; extragear (see <xref linkend="extragear-applications" /> for more information) or from <ulink url="http://kde-apps.org">http://kde-apps.org</ulink>.</para></listitem> +<listitem><para>Reference: <ulink url="http://kudos.berlios.de/kf/kf1.html#pkgtablestock">http://kudos.berlios.de/kf/kf1.html#pkgtablestock</ulink></para></listitem> +</itemizedlist> + +</chapter>
\ No newline at end of file diff --git a/doc/khelpcenter/userguide/migrator-dictionary.docbook b/doc/khelpcenter/userguide/migrator-dictionary.docbook new file mode 100644 index 000000000..d92c328c9 --- /dev/null +++ b/doc/khelpcenter/userguide/migrator-dictionary.docbook @@ -0,0 +1,20 @@ +<chapter id="migration-dictionary"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Dictionary for Migrators</title> + +<para>Tables of terminology differences</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/net-connection-setup.docbook b/doc/khelpcenter/userguide/net-connection-setup.docbook new file mode 100644 index 000000000..4e59dab48 --- /dev/null +++ b/doc/khelpcenter/userguide/net-connection-setup.docbook @@ -0,0 +1,218 @@ +<chapter id="setup"> + +<chapterinfo> +<authorgroup> +<author> +&Lauri.Watts; +</author> +</authorgroup> +</chapterinfo> + + +<title>Setting up an Internet Connection</title> +<!-- Contents shamelessly stolen from the KPPP manual, written by --> +<!-- Lauri --> + +<para>&tde; offers a complete Internet experience, with all the +programs you'll need to make the most of the Web, email, Usenet and +many other Internet technologies. But before you can enjoy &tde;'s +advanced features, you'll need to get online. Here's how:</para> + +<para>If you're using <quote>dialup</quote> (that is, connecting to +the Internet with a modem connected to a telephone line), you'll want +to set up the &tde; dialing program, &kppp;. If that sounds +complicated, don't worry: &kppp; has an advanced configuration wizard, +which will usually take the pain out of setting up your dialup +connection. Take a look at the next two sections for more +details.</para> + +<para>If you're using a broadband connection, or connecting via a +local network, things are easier (from the point of view of +&tde;). Once you've set up the connection with the tools provided by +your &Linux; or &UNIX; distribution, &tde; will use the connection +automatically.</para> + +<sect1 id="getting-online"> +<title>Getting online the easy way</title> + +<sect2 id="things-to-prepare"> +<title>A few things you should have ready before you start</title> + +<para>If you have a fairly modern &Linux; distribution, you might find the rest +of this document superfluous. &kppp; comes with a clever little wizard that in +many cases can have you up and running with an internet connection in just a few +minutes.</para> + +<para>Whether using the wizard or not, you should know the following information +before you begin:</para> + +<itemizedlist> +<listitem><para>Your <acronym>ISP</acronym> modem pool phone +number.</para></listitem> +<listitem><para>Your username and password for your +<acronym>ISP</acronym>.</para></listitem> +<listitem><para>Your <acronym>ISP</acronym>'s <acronym>DNS</acronym> servers +(one is sufficient, but two is better).</para></listitem> +</itemizedlist> + +<para>Other optional information you should find out to fully access your +<acronym>ISP</acronym>'s services are:</para> + +<itemizedlist> +<listitem><para>The incoming mail server address (often <systemitem +class="systemname">pop.yourisp.com</systemitem> or <systemitem +class="systemname">mail.yourisp.com</systemitem>).</para><para>Also find out if +your <acronym>ISP</acronym> uses the POP3 protocol or IMAP.</para></listitem> +<listitem><para>The outgoing (<acronym>SMTP</acronym>) mail server address (it +could be the same as the incoming mail server, or it is often called something +like <systemitem +class="systemname">smtp.yourisp.com</systemitem>).</para></listitem> +<listitem><para>The Usenet News (<acronym>NNTP</acronym>) server address (possibly +<systemitem class="systemname">news.yourisp.com</systemitem> or <systemitem +class="systemname">nntp.yourisp.com</systemitem>).</para></listitem> +<listitem><para>Any proxy servers your <acronym>ISP</acronym> has set +up.</para></listitem> +</itemizedlist> + +<para>All this information is probably available on any paperwork you received +from your <acronym>ISP</acronym> when you signed up with them, or you can find +it out from your <acronym>ISP</acronym>'s support telephone line.</para> + +<para>Armed with the above, and a fairly recent default installation +of &Linux;, you may well find that setting up an internet connection +is as simple as running the &kppp; wizard.</para> + + +</sect2> + +</sect1> + +<sect1 id="wizard"> +<title>The &kppp; wizard</title> + +<sect2 id="starting-the-wizard"> +<title>Starting the Wizard.</title> + +<para>You can start the wizard from &kppp;'s initial screen. Start &kppp; from +your <guimenu>TDE</guimenu> menu, where you will find its entry in the +<guisubmenu>Internet</guisubmenu> as <guimenuitem>&kppp; (Internet Dial-Up +Tool</guimenuitem>.</para> + +<para>The following dialog will appear:</para> + +<screenshot> +<screeninfo>The &kppp; dialer startup dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kppp-dialer-tab.png" format="PNG"/> +</imageobject> +<textobject><phrase>The &kppp; dialer startup dialog</phrase> +</textobject> +<caption><para>The &kppp; dialer startup dialog</para></caption> +</mediaobject> +</screenshot> + +<para>It will probably not have any entries to begin with, and that's +what we're about to do now.</para> + +<para>Click the <guibutton>Configure...</guibutton> button to begin setting up a new +Internet connection.</para> +<!-- the following is outdated and has to be rewritten 27.06.2006 lueck--> +<para>The wizard will offer you three choices, <guibutton>Wizard</guibutton>, +<guibutton>Dialog Setup</guibutton> and <guibutton>Cancel</guibutton></para> + +<screenshot> +<screeninfo>The wizard asks you what you want to do...</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kppp-wizard.png" format="PNG"/> +</imageobject> +<textobject><phrase>The wizard asks you what you want to +do...</phrase></textobject> +<caption><para>The wizard asks you what you want to do</para></caption> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem><para>Choose this if you really don't want to be setting up a new +account right now. The message box will go away, and you will be left with the +dialer window as before.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Wizard</guibutton></term> +<listitem><para>If you have a fairly standard modem, and use one of the larger +ISP's for your country, the wizard will probably be able to set you up +immediately with a working Internet Connection. Try this first, before you try +to set up the connection manually.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Dialog Setup</guibutton></term> +<listitem><para>If you don't succeed with the Wizard, or you just want to do +things yourself, choose this. The wizard currently is only useful for a small +subset of countries and Internet Providers.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>For the purposes of this chapter, we'll assume you are choosing +<guibutton>Wizard</guibutton>, and the dialog based setup will be +described in a later chapter.</para> + +</sect2> + +<sect2 id="finishing-the-wizard"> +<title>The Rest of the Wizard</title> + +<para>The first window you see contains just introductory text, explaining the +things you read about in the first section of this chapter. Click +<guibutton>Next</guibutton> to move on.</para> + +<para>The second window asks you to choose the country you live in. Not all +countries are represented here, and if the country you live in is not listed, +you will have to click <guibutton>Cancel</guibutton>, in which case the Dialog-based setup will start for you to continue +with.</para> + +<para>On the next window, you will be given a choice of Internet +Providers that &kppp; knows about, based on your choice of location in +the previous window. Again, if your <acronym>ISP</acronym> is not +listed here, you will have to click <guibutton>Cancel</guibutton> and +do your setup in the Dialog-based setup</para> + +<para>You will now be asked to enter your username and password for your +internet connection. Please note, that for some <acronym>ISP</acronym>s this +differs from your mail account user name and password, so make sure you use the +right one. Choose <guibutton>Next</guibutton> to continue.</para> + +<para>On the next window, you have a chance to enter any special dial prefixes +you might have - for example, if you must dial <quote>0</quote> for an outside +line, or if you have a prefix you can dial to turn off call waiting. Choose +<guibutton>Next</guibutton> to continue.</para> + +<para>And that's all! If you want to revisit any of your choices, you can use +the <guibutton>Back</guibutton> and <guibutton>Next</guibutton> buttons to move +back and forth through the dialogs. When you're done with your settings, click the +<guibutton>Finish</guibutton> button, and you're all done.</para> + +<para>If you need more details, you can read the full &kppp; +manual in the &tde; Help Center, or by typing +<userinput>help:/kppp</userinput> in the <guilabel>Location</guilabel> +bar in &konqueror;.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect2> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/networking-with-windows.docbook b/doc/khelpcenter/userguide/networking-with-windows.docbook new file mode 100644 index 000000000..08d57e81e --- /dev/null +++ b/doc/khelpcenter/userguide/networking-with-windows.docbook @@ -0,0 +1,110 @@ +<sect1 id="networking-with-windows"> +<sect1info> +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +</author> +</authorgroup> +</sect1info> + + +<title>Networking With Windows</title> + +<para> This section is borrowed and modified from Alexander Neundorf's +README file on LISa.</para> + +<para>&tde; features two powerful servers called the Lan Information +Server (<application>LISa</application>) and Restricted Lan +Information Server (<application>resLISa</application>) which are used +to identify CIFS and other servers on your local network providing a +function similar to <quote>Network Neighbourhood</quote> in +&Microsoft; &Windows;.</para> + +<sect2 id="How-It-Works"> +<title>How It Works</title> + +<para>&lisa; only depends on the TCP/IP stack so samba configuration is not +required to make it work but the <ulink +url="http://www.samba.org">samba</ulink> package is a dependency. To find +hosts on your local network you set a range of IP-Addresses in your +configuration file that &lisa; will check. When you start the &lisa; daemon +it will send a <ulink url="http://www.ietf.org/rfc/rfc792.txt">ICMP</ulink>, +echo request message to all the IP addresses given in the configuration file +and await a response.</para> + +<note><para>The &lisa; daemon requires root privileges to open the socket, +but once the socket has been established root privileges are immediately +dropped.</para></note> + +<para>You can also execute &lisa; using <command>nmblookup +<option>"*"</option></command>.<note><para>If you do not have the +<command>nmblookup</command> program it can be found at <ulink +url="http://www.samba.org">http://www.samba.org</ulink> or through packages +provided by your distribution</para></note>. The samba command +<command>nmblookup <option>"*"</option></command> will send a broadcast +message to the attached network and any host that is running the +smb-services will send a reply stating that it is accepting +connections.</para> +</sect2> + +<sect2 id="resLISa"> +<title><application>resLISa</application></title> + +<para>If your company network has very strict guidelines governing what +ports can and cannot be opened you will have to use &reslisa; to communicate +with other hosts on your network. Because &reslisa; cannot ping entire +networks or address ranges you will have to add each host by name to your +confiuration file. Currently you are able to add up to 64 hosts, and these +addresses are pingable.</para> + +<note><para>&reslisa; will only provide the information over a &UNIX; domain +socket, &ie; not over the network. The name of the socket is +<filename>/tmp/resLISa-<replaceable>YourLoginName</replaceable></filename>, +so &reslisa; can be safely run on the same machine by more than one +user.</para></note> +</sect2> + +<sect2 id="configuration"> +<title>Configuration</title> + +<para>At startup &lisa; first parses the configuration file in the users +home directory under <filename>$<envar>HOME</envar>/.lisarc</filename>. If +this file does not exist &lisa; will then look for a system wide +confiuration located at <filename>/etc/lisarc</filename>. Now for a sample +example configuration file:</para> + +<programlisting> +PingAddresses = 192.168.100.0/255.255.255.0;192.168.100.10-192.168.199.19;192.168.200.1; +PingNames = my_host1;my_host2 #Hosts by name (required for <application>resLISa</application>) +AllowedAddresses = 192.168.0.0/255.255.0.0 +BroadcastNetwork = 192.168.100.0/255.255.255.0 +SearchUsingNmblookup = 1 #also try nmblookup +FirstWait = 30 #30 one-hundredth's of a second +SecondWait = -1 #Only try once +#SecondWait = 60 #Try twice and wait 0.6 seconds +UpdatePeriod = 300 #Update every 300 sec's +DeliverUnnamedHosts = 0 #Don't publish unnamed hosts +MaxPingsAtOnce = 256 #Send up to 256 ICMP echo requests at once +</programlisting> + +<para>&lisa; can also be configured graphically in the +<menuchoice><guimenuitem>&kcontrolcenter;</guimenuitem><guisubmenu>Internet +& Network</guisubmenu><guimenuitem>Local Network Browsing</guimenuitem> +</menuchoice> item in the &kmenu;. However, to use this option &lisa; must +be started with the <option>-K</option> command line switch.</para> + +<!--TODO add a section explaining graphical configuration? --> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>For a full list of command line switches and further +examples see the entire &lisa; manual by entering +<userinput>help:/lisa</userinput> in &konqueror;.</para> +</listitem> +</itemizedlist> + + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/noatun-icon.png b/doc/khelpcenter/userguide/noatun-icon.png Binary files differnew file mode 100644 index 000000000..15131ce39 --- /dev/null +++ b/doc/khelpcenter/userguide/noatun-icon.png diff --git a/doc/khelpcenter/userguide/noatun.png b/doc/khelpcenter/userguide/noatun.png Binary files differnew file mode 100644 index 000000000..9d0d2d764 --- /dev/null +++ b/doc/khelpcenter/userguide/noatun.png diff --git a/doc/khelpcenter/userguide/oggfolder.png b/doc/khelpcenter/userguide/oggfolder.png Binary files differnew file mode 100644 index 000000000..130fc63b7 --- /dev/null +++ b/doc/khelpcenter/userguide/oggfolder.png diff --git a/doc/khelpcenter/userguide/open-file-dialog.png b/doc/khelpcenter/userguide/open-file-dialog.png Binary files differnew file mode 100644 index 000000000..2ebd2b254 --- /dev/null +++ b/doc/khelpcenter/userguide/open-file-dialog.png diff --git a/doc/khelpcenter/userguide/panel-and-desktop.docbook b/doc/khelpcenter/userguide/panel-and-desktop.docbook new file mode 100644 index 000000000..c89a2539b --- /dev/null +++ b/doc/khelpcenter/userguide/panel-and-desktop.docbook @@ -0,0 +1,298 @@ +<chapter id="panel-and-desktop"> + +<title>The Panel and the Desktop</title> + +<sect1 id="kicker-panel"> +<title>&kicker;, the &tde; Panel</title> + +<indexterm +significance="preferred"><primary>Panel</primary></indexterm> +<indexterm +significance="preferred"><primary>&kicker;</primary></indexterm> + +<para>&kicker; is the application launcher panel of the Trinity Desktop +Environment. By default, it appears along the bottom of the screen, +and takes up the whole of the width of the screen, but this is +configurable. &kicker; is something of a one-stop shop for (almost!) +everything that you might want quick access to. Besides the &ticon; +Menu, where you can start applications, &kicker; is also capable of +running docked applets like the pager, the taskbar or the clock, and +extensions, such as child panels. With all these options, you will +probably want to configure &kicker; so that it works best for you. The +next section describes some common ways to customize the panel.</para> +<!-- TODO: steal screenies from kicker manual --> +</sect1> + +<!-- FIXME: Titles and id's in this section should be more consistent --> +<sect1 id="kicker-configuring"> +<title>Configuring &kicker;</title> + + +<sect2 id="customize-panel-icons"> +<title>Customizing the icons on the panel</title> + +<para>When you first start &tde;, kicker displays some icons next to +the <guimenu>TDE</guimenu> menu. These can be used to start the +applications that they represent. To see which application is launched + by each icon, hold the mouse cursor over the icon until a tooltip (a +small popup label) appears telling you the name of the application.</para> + +<para>These default icons might not represent the applications you use +most often, so you can remove the ones you do not want and add icons +for other applications that you use. To remove an icon, &RMB;-click on +the icon, and select <guilabel>Remove <replaceable>application +name</replaceable> Button</guilabel> in the popup menu that +appears. To add a new icon, &RMB;-click on an empty space on the +panel, and follow the menu entry <guisubmenu>Add Application to Panel +</guisubmenu>. This leads you to a copy of the +<guimenu>TDE</guimenu> menu, where you can find all of the &tde; +applications. For example, to add an icon for the &juk; music player, +follow through the menus to <menuchoice><guisubmenu>Add Application +to Panel</guisubmenu><guisubmenu>Multimedia</guisubmenu><guimenuitem>&juk; (Music +Player)</guimenuitem></menuchoice>. The icon will appear on the +panel in the space that you <mousebutton>right</mousebutton>-clicked on.</para> + +</sect2> + + +<sect2 id="adding-extras-and-applets"> +<title>Adding extras and applets</title> + +<indexterm><primary>Applets</primary></indexterm> + +<para>&kicker; can add many types of items as well as application +launch icons. You can find these items using the same menu as before, +but this time selecting +<guisubmenu>Add Applet to Panel...</guisubmenu> +or +<guisubmenu>Add New Panel</guisubmenu>. +The items in the <guilabel>Add Applet</guilabel> window are small +programs that can reside on the panel. An example of an applet is the +<guilabel>Desktop Preview & Pager</guilabel><indexterm><primary>Pager</primary></indexterm>, which shows a small image of each of your virtual +desktops. (For more information about virtual desktops, see <xref +linkend="using-multiple-desktops" />). You can switch to a different +virtual desktop by clicking on its image in the desktop pager. +<!-- TODO: screenie --></para> +<para>You can find information about the other applets available for +&kicker; in the &kicker; manual. Just enter +<userinput>help:/kicker</userinput> in the +<guilabel>Location</guilabel> bar in &konqueror;.</para> +</sect2> + +<sect2 id="the-system-tray"> +<sect2info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>titeuf@ph34rus.org</email> +</author> +</authorgroup> +</sect2info> + +<title>The System Tray</title> + +<!-- Simon Vermeersch --> +<para>The system tray is where programs that are run, but not directly needed are +kept. Some programs (like music players) are shown there, because you +probably want to keep them open, but so that it does not take too much space on +your screen, it will put an icon in the system tray.</para> + +<para>When you <mousebutton>right</mousebutton> click on such an icon, a +popup menu will appear where you can see some options of the program (like +play, pause, stop, ... in a music player).</para> +<para>When you <mousebutton>left</mousebutton> click on it, the main window +of the program will appear. If you hover your mouse above the icon, a tool +tip will appear with some information (in the music player case information +like the current song). Programs that normally support system tray icons are +music players, IRC clients, organizers, ...</para> + +<para>In most of these programs you can configure if you want an icon to be +shown or not. For other tricks and tips with the system tray see the section on <xref linkend="system-tray" />.</para> + +</sect2> + +<sect2 id="removing-panel-items"> +<title>Removing Panel Items</title> + +<!-- TODO: Need a screenie to show the handles, since they're not very --> +<!-- easy to describe (and also very small - possible --> +<!-- accessibility/usability issue? --> +<para>You can remove applets and other special items from the panel +using the arrow on its handle on the applet's left. Right click on the +arrow, and choose <guimenuitem>Remove <replaceable>applet +name</replaceable></guimenuitem>.</para> +</sect2> + +</sect1> + +<sect1 id="kicker-taskbar"> +<title>The Taskbar</title> +<!-- TODO: Screenie (again), write more about why taskbar is useful --> +<para>The taskbar is an item on the panel which displays an entry for +each window that you have opened. You can use the taskbar to switch +between windows by clicking on the entry of the window you want to +activate. The taskbar has entries for windows on each virtual desktop, +including windows which have been minimized.</para> + +</sect1> + +<sect1 id="using-the-clipboard"> +<sect1info> +<authorgroup> +<author>&Philip.Rodrigues; +</author> +</authorgroup> +</sect1info> + +<title>Using the Clipboard</title> + +<indexterm><primary>Clipboard</primary></indexterm> + +<para>Very often, it's useful to move some text, or an object in a +program, from one place to another. It's also very common to need to +duplicate some text, for example, if you're typing the same thing +several times. The system used for doing this is known as the +<firstterm>clipboard</firstterm>. There are two slightly different ways to use this system, +known technically as the <quote>selection</quote> and the +<quote><glossterm>clipboard</glossterm></quote>. We'll look at them separately: +</para> + +<!-- TODO: Describe how to select text --> + +<sect2 id="the-selection"> +<title>The Selection</title> +<indexterm><primary>Selection</primary></indexterm> + +<para>This method uses the mouse to copy text from one place to +another. The method is: +<orderedlist> + +<listitem><para>Select the text you want to copy.</para> +</listitem> + +<listitem><para>Click the &MMB; at the place you want the text to be +copied to. This can be in the same program as you copied the text +from, or in another program entirely.</para> +</listitem> +</orderedlist> +If you have three buttons on your mouse, this is easy, but if not, all +is not lost! If you have only two buttons, try clicking them both at +the same time instead of the &MMB;. +<!-- Should we mention Emulate3Buttons in XF86Config here? --> +</para> +</sect2> + +<sect2 id="the-clipboard-proper"> +<title>The Clipboard</title> +<indexterm><primary>Cut</primary></indexterm> +<indexterm><primary>Paste</primary></indexterm> +<para>With this method, you can copy text, or <quote>cut</quote> it +(that is, remove it from one place and move it to another). You can +use either the mouse and the menu entries, or the keyboard with this +method. I'll list both ways, with the menu entry to use, followed by +the keyboard shortcut which will do the same thing, like this:</para> +<para> +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem> +</menuchoice> </para> +<para> +<orderedlist> +<title>Moving (<quote>Cutting</quote>) Text</title> +<listitem><para>Select the text you want to cut.</para> +</listitem> +<listitem><para>From the menu, select +<menuchoice><shortcut><keycombo + action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem> +</menuchoice>, and the text will be removed from its current location.</para> +</listitem> +<listitem><para>Position the text cursor at the point you want to +insert the text. This can be in the same application you got the text +from, or another application entirely. Select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem> +</menuchoice>, and the text will appear at the point where you placed +the cursor.</para> +</listitem> +</orderedlist> +</para> + +<para> +Copying text from one place to another is very similar: +<orderedlist> +<title>Copying Text</title> +<listitem><para>Select the text you want to copy.</para> +</listitem> +<listitem><para>From the menu, select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem> +</menuchoice>, and the text will be copied in the clipboard.</para> +</listitem> +<listitem><para>Position the text cursor at the point you want to +insert the text. This can be in the same application you got the text +from, or another application entirely. Select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem> +</menuchoice></para> +</listitem> +</orderedlist> +</para> + + +</sect2> +<sect2 id="klipper"> +<title>More Advanced Clipboard Use</title> +<indexterm><primary>&klipper;</primary></indexterm> +<indexterm><primary>Clipboard</primary><secondary>History</secondary></indexterm> +<!-- Should we describe this advanced use, or just point to it? --> +<para>The instructions above describe the default <glossterm>clipboard</glossterm> +behavior. The &klipper; application, which you can add as an applet in +the panel (see <xref linkend="kicker-configuring"/> for instructions +on how to do this), provides some useful clipboard-related features, +like a clipboard history, and the ability to change the behavior of +the clipboard and selection. Take a look at the &klipper; Handbook for +more information.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>You can find more information about &kicker;, the +&tde; Panel, in &khelpcenter; or by entering +<userinput>help:/kicker</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +<listitem><para>The &klipper; +Handbook has information about the advanced clipboard management +features in &tde;. You can read it in &khelpcenter; or by entering +<userinput>help:/klipper</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +</itemizedlist> + + +</sect2> + +</sect1> + +<sect1 id="kicker-related-information"> +<title>Related Information</title> +<itemizedlist> +<title>Related Information</title> +<listitem><para>Though some information has been presented here, there is a lot more information on &kicker; tips, options, tricks and hacks, in the &kicker; handbook. You can access it via the &khelpcenter; or by simply entering <userinput>help:/kicker</userinput> in the &konqueror; Location toolbar.</para> +</listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/pdf-files.docbook b/doc/khelpcenter/userguide/pdf-files.docbook new file mode 100644 index 000000000..73d951e18 --- /dev/null +++ b/doc/khelpcenter/userguide/pdf-files.docbook @@ -0,0 +1,22 @@ +<sect1 id="pdfs"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>PDF Files</title> + +<para>How to print to a pdf file</para> + +<para>Viewing pdf files</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/playing-audiocds.docbook b/doc/khelpcenter/userguide/playing-audiocds.docbook new file mode 100644 index 000000000..26e7e494c --- /dev/null +++ b/doc/khelpcenter/userguide/playing-audiocds.docbook @@ -0,0 +1,124 @@ +<sect1 id="audio-cd"> +<sect1info> +<author> +<personname> +<firstname>Deepak</firstname> +<surname>Sarda</surname> +</personname> +<email>antrix@gmail.com</email> +</author> +</sect1info> + +<title>Audio CD Ripping in &tde;</title> + +<para>The conventional way of ripping Audio CDs to MP3 or Ogg files is to +use a standalone program such as <trademark class="registered"><application>iTunes</application></trademark>, Winamp or &tde;'s own +<application>KAudioCreator</application>. But if we stick to conventions, +where's the fun?! So in this article, I am going to show you how to feel +elite by ripping your CDs in the, umm.. elite way. ;-) </para> + +<sect2 id="audio-cd-ingredients"> +<title>Ingredients</title> + +<para>What do we need to be cool? Vanilla &tde;, without any extra +ingredients, will be able to rip your CDs. But to encode them, you'll need +to install the relevant codecs. At the moment, Ogg Vorbis, MP3 and FLAC formats +are supported. To enable encoding to these formats, you'll have to install +libogg, lame and flac respectively. How exactly you install these depends on +your distribution: take a look at their documentation to find out how.</para> + +<para>Once you have your favourite codec(s) installed, open &kcontrolcenter; and navigate your way to <menuchoice><guimenu>Sound & +Multimedia</guimenu><guimenuitem>Audio CDs</guimenuitem></menuchoice> +and configure the settings on the various tabs to your liking. You can leave +everything in the default state if you so wish, but it's helpful to take a +look so you at least know what's on offer. Again, take a look at +<menuchoice><guimenu>Sound & Multimedia</guimenu><guimenuitem>CDDB +Retrieval</guimenuitem></menuchoice> and change anything that's not to your +liking. <acronym>CDDB</acronym>, in case you didn't know, stands for CD DataBase (or Compact +Disc DataBase in it's more free flowing form). This functionality enables +&tde; to retrieve the Artist/Album/Track information about your CDs from the +Internet. This metadata is also used to write tags to the MP3 or Ogg files +that you'll be encoding your CDs to anytime now.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="ripsettings.png"/> +</imageobject> +</mediaobject> + +</sect2> + +<sect2 id="audio-cd-recipe"> +<title>Recipe</title> + +<para>Without further delay, let's get down to the business of being cool. +First, pop in the CD you want to rip (obviously!). Next, fire up a +&konqueror; window and open the <guilabel>Services</guilabel> tab on the Navigation panel. The +Navigation panel sits on the left side of the window, as shown in the +screenshot below. If it's not visible, you can produce it out of thin air by +pressing the magic <keycap>F9</keycap> key.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="services.png"/> +</imageobject> +</mediaobject> + + +<para>Now click on Audio CD Browser and in a few seconds, you'll see a lot +of folders which you can start browsing. If it's taking some time to show +anything, it's because it's trying to fetch information about the CD from +the CDDB database you configured earlier.</para> + +<para>In the screenshot below, you can see the contents of the Ogg Vorbis +folder. It shows all the songs in the Ogg format; it even shows their file +size! But, you and I both know that audio CDs don't contain Ogg tracks. So +what exactly is happening here?</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="oggfolder.png"/> +</imageobject> +</mediaobject> + + +<para>All the folders you see under Audio CD Browser are virtual folders. +They show contents of the CD through different filters, so to speak. When +you open the Ogg Vorbis folder, you are actually seeing the contents of the +CD <emphasis>as if</emphasis> it were stored in the Ogg format. You can go through the other +folders and you'll find MP3, flac and wav representations of the CD's +contents. You can even see the approximate file sizes when encoded in the +various formats.</para> + + +<para>So how do we rip and encode the CD? I think you can guess the answer +by now. Just decide which format you wish to rip to, open that folder, and +copy and paste those files in your target folder. That's it! &tde; will start +ripping and encoding the files on the fly! If you copy any of the files in +the <guilabel>Full CD</guilabel> folder, you'll be ripping the entire CD as +one continuous stream.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="rip.png"/> +</imageobject> +</mediaobject> + + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <application>amaroK</application> website at +<ulink url="http://amarok.sf.net">http://amarok.sf.net</ulink> has the +latest news and information about <application>amaroK</application>.</para> +</listitem> +</itemizedlist> + +<!-- TODO: Add a link to the full audiocd documentation as soon as --> +<!-- it's fixed :-) --> +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/playing-movies.docbook b/doc/khelpcenter/userguide/playing-movies.docbook new file mode 100644 index 000000000..135289a02 --- /dev/null +++ b/doc/khelpcenter/userguide/playing-movies.docbook @@ -0,0 +1,30 @@ +<sect1 id="playing-movies"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Playing Movies</title> + +<para>Intro to xine plugin to aRts</para> + +<para>Alternatives (kaffeine, kmplayer)</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> diff --git a/doc/khelpcenter/userguide/playing-music.docbook b/doc/khelpcenter/userguide/playing-music.docbook new file mode 100644 index 000000000..2b8c529eb --- /dev/null +++ b/doc/khelpcenter/userguide/playing-music.docbook @@ -0,0 +1,132 @@ +<sect1 id="playing-music"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<sect1info> +<authorgroup> +<author>&Lauri.Watts;</author> +</authorgroup> +</sect1info> + +<title>Playing Music</title> +<indexterm><primary>Music</primary></indexterm> +<indexterm><primary>Sound</primary></indexterm> +<indexterm><primary>Audio</primary></indexterm> +<indexterm><primary>&arts;</primary></indexterm> + +<para>Intro to &arts;</para> + +<para>Performance tuning, sharing devices</para> + +<sect2 id="music-media-players"> +<title>Music Players</title> + +<para>There are several &tde; music players with somewhat overlapping +feature sets, however, each is quite different in style.</para> + +<variablelist> +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="noatun-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&noatun; +<indexterm><primary>&noatun;</primary></indexterm> +</term> +<listitem> +<para>Noatun is the default &tde; music player. It features a highly +configurable interface, including several styles of playlist manager, and +many plugins to provide different &GUI;s, visualizations, and other +features.</para> +<para>&noatun; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="noatun.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="juk-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&juk; +<indexterm><primary>&juk;</primary></indexterm></term> +<listitem> +<para>&juk; is a media manager, playlist manager, and metadata tagger. It is a +highly efficient way to manage all your music files, make and maintain +playlists, and maintain the metadata tags in your music.</para> +<para>It is equally useful as your primary music player, or managing +playlists and files for use in another application.</para> +<para>&juk; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="juk.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="kaboodle-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&kaboodle; +<indexterm><primary>&kaboodle;</primary></indexterm></term> +<listitem> +<para>&kaboodle; is a one shot player. That means, it will run, play a file, +and stop. &kaboodle; is useful for instance if you want to quickly listen +to a single file without interupting your current playlist from another +media player.</para> +<para>&kaboodle; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="kaboodle.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="amarok-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +<application>amaroK</application></term> +<listitem> +<para><application>amaroK</application> is a popular third party application. You should be able to +find packages from your normal distribution source.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="amarok.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> +</variablelist> + +<para>Most of the &tde; based movie players such as +<application>Kaffeine</application> and <application>kmplayer</application> +also make useful music players.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/printer-setup.docbook b/doc/khelpcenter/userguide/printer-setup.docbook new file mode 100644 index 000000000..216c9e819 --- /dev/null +++ b/doc/khelpcenter/userguide/printer-setup.docbook @@ -0,0 +1,29 @@ +<sect1 id="printing"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Setting Up a Printer</title> + +<para>Assume everything is pre-configured, how to set up a printer, refer to +big manual if there is trouble</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> diff --git a/doc/khelpcenter/userguide/printing-from-apps.docbook b/doc/khelpcenter/userguide/printing-from-apps.docbook new file mode 100644 index 000000000..964431189 --- /dev/null +++ b/doc/khelpcenter/userguide/printing-from-apps.docbook @@ -0,0 +1,22 @@ +<sect1 id="printing-from-apps"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Printing From Applications</title> + +<para>Printing from &tde; apps</para> + +<para>Printing from non-TDE apps</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/programs-and-documents.docbook b/doc/khelpcenter/userguide/programs-and-documents.docbook new file mode 100644 index 000000000..b56f486b4 --- /dev/null +++ b/doc/khelpcenter/userguide/programs-and-documents.docbook @@ -0,0 +1,522 @@ +<chapter id="programs-and-documents"> + +<title>Programs and Documents</title> + +<sect1 id="programs-launching"> + +<title>Launching Programs</title> + +<para>&tde; offers a varying number of ways to launch programs. You may:</para> + <itemizedlist> + <listitem> + <para>Simply select the relevant item in the &kmenu;.</para> + </listitem> + <listitem> + <para>Run the program from &konsole;, or by clicking the &kmenu; and choosing <guimenuitem>Run Command...</guimenuitem> (while you still might prefer the quick keyboard shortcut, which is simply <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>).</para> + </listitem> + <listitem> + <para>Create a shortcut on the desktop or use &kicker;'s quick launcher.</para> + </listitem> +</itemizedlist> + +<para>The &kmenu; functions much like the Start menu of &Windows;, however +it breaks programs up by what they do. Programs on the &kmenu; are broken +into category menus, such as <guisubmenu>Multimedia</guisubmenu> and +<guisubmenu>Office</guisubmenu>. Under these category menus there are +subcategory menus, such as <guisubmenu>Sound</guisubmenu>, +<guisubmenu>Video</guisubmenu> and <guisubmenu>Graphics</guisubmenu>. Under +the subcategory menus lie program launchers, which, when clicked on, launch +the associated application.</para> + +<para>Depending on the program, there may not be a launcher in the &kmenu;. +To search your hard drive for more applications, click the &kmenu;, choose +<guimenuitem>Run Command</guimenuitem> and type +<userinput><command>kappfinder</command></userinput>. In +&kappfinder;, click <guibutton>Scan</guibutton>, and the hard drive will be +searched for programs. Click the checkbox next to each program to be added +to the &kmenu;, and click <guibutton>Apply</guibutton> and +<guibutton>Close</guibutton>. The &kmenu; now will have new program +launchers under the relevant category menus.</para> + +<para>Launchers to programs may also be placed on the desktop. To create a +new launcher, <mousebutton>right</mousebutton> click on the desktop, and +choose <menuchoice><guimenu>Create +New</guimenu><guimenuitem>Link to +Application</guimenuitem></menuchoice>. On the &kdesktop; properties dialog +box, type in the name of the program on the <guilabel>General</guilabel> +tab. You may also wish to choose a custom icon by clicking on the gear icon. +Click the <guilabel>Application</guilabel> tab and type a short sentence +about the program in the <guilabel>Description</guilabel> textbox. In the +<guilabel>Command</guilabel> textbox, type the name of the program (case +sensitive), and any command line options you wish to use. Choose +<guibutton>OK</guibutton>, and your new program launcher will be created on +your desktop. Simply click on the new launcher on the desktop and the + associated program will run.</para> + +<para>To launch a program using &konsole;, click the &kmenu; and choose +<menuchoice><guisubmenu>System</guisubmenu><guisubmenu>Terminals +</guisubmenu><guimenuitem>Konsole</guimenuitem></menuchoice>. Once &konsole; +appears on the screen, simply type the name of the program you wish to +launch (remembering that <application>bash</application>, the command language interpreter that &konsole; uses by default, is case-sensitive) and press +<keycap>Enter</keycap>. If you are unsure about the name of a program, type +the first few letters then press the 	 key on your keyboard. By pressing +	, <application>bash</application> (through &konsole;) will try to guess the name of the program you wish to +launch. If it finds more then one matching program, a list of + matching programs will be printed on the screen. Type the name of the + program from the list and press <keycap>Enter</keycap> to launch.</para> + +<para>Whichever way you choose, launching a program is a simple affair with +&tde;. From the &kmenu;, to &konsole;, all your programs are just a few +clicks or key-presses away.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>Check the &kicker; handbook for more information on enabling or disabling the &kmenu;, adding applications to the quick launch, or on organizing the categorization of the applications in the &kmenu;. You can view the &kicker; handbook either via the &khelpcenter; or by using &konqueror;'s KIOslave by typing <userinput>help:/kicker</userinput> in the Location toolbar.</para> +</listitem> +</itemizedlist> + + + +</sect1> + +&programs-controlling; + +<sect1 id="programs-save-open"> + +<title>Opening and Saving Files</title> +<!-- TODO: Convert this whole thing to an image with callouts. It --> +<!-- should be much nicer that way. --> + + +<para>&tde; provides a unified way to open or save files via the file +dialog. In almost every &tde; program you will find a +<menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem> +</menuchoice> and <menuchoice><guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem></menuchoice> (and/or <guimenuitem>Save +As...</guimenuitem>) entry.</para> + +<sect2 id="file-dialog"> +<title>The File Dialog</title> + +<!-- +<screenshot> +<screeninfo>The &tde; <quote>Open File</quote> dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="open-file-dialog.png" format="PNG"/> </imageobject> +<textobject> +<phrase>The &tde; <quote>Open File</quote> dialog</phrase> +</textobject> +<caption> +<para>The &tde; <quote>Open File</quote> dialog</para> +</caption> +</mediaobject> +</screenshot> +--> +<screenshot> +<mediaobjectco> +<imageobjectco> +<areaspec units="calspair"> +<area id="navigation-area-co" coords="1 1"/> +<area id="icon-view-co" coords="1 1"/> +<area id="bottom-area-co" coords="1 1"/> +<area id="quick-access-co" coords="1 1"/> +<area id="preview-area-co" coords="1 1"/> +</areaspec> +<imageobject> +<imagedata fileref="open-file-dialog.png" format="PNG"/> +</imageobject> +</imageobjectco> +</mediaobjectco> +</screenshot> + +<!-- ====================================================================== + +<calloutlist> + +<callout arearefs="pt-first-channel-1"><para>This is called the <interface>Input Line</interface>. To send a message to everyone in the channel, type the message here and press &Enter;. + Your message, as well as everyone else's messages appear in the channel scroll above. + Each message is preceded by the time and user's &nickname;.</para></callout> + + +</calloutlist> + + + ====================================================================== --> +<para>This dialog consists of between three and five areas. The +top area is where you find the navigation and configuration functions. The +main area (in the middle) is where all your files are being displayed as +icons. This is called an icon view. The bottom area is where you can edit +filename or filter expressions and say <guibutton>Save</guibutton> or +<guibutton>Open</guibutton>.</para> + +<para>In addition to that you can add two even more sophisticated areas: +the <link linkend="quick-access">Quick Access Navigation Panel</link> and +the <link linkend="preview-area">Preview Panel</link>.</para> + +<calloutlist> + +<callout arearefs="navigation-area-co"> + +<para>Next to the three navigation buttons (one directory +<guiicon>up</guiicon>, <guiicon>back</guiicon> and +<guiicon>forward</guiicon>) and the <guiicon>new folder</guiicon> button +there is the <guiicon>bookmarks</guiicon> menu. Here you can mark any folder +you visit often to find it quickly. The <guiicon>wrench</guiicon> icon holds +the different functions to sort your files by name, date or size and to +enable the two extra panels mentioned above. Next to it you can type the +directory and choose (on the very right side) the encoding.</para> +</callout> + + +<callout arearefs="icon-view-co"> + +<para>You'll find the icon view in the middle of the dialog. You will find +most of the navigation functions in the context menu by clicking on the +items or the background with the <mousebutton>right</mousebutton> mouse +button.</para> + +</callout> + +<callout arearefs="bottom-area-co"> + + +<para>The bottom of the dialog consists of the address field holding the +file name you chose or typed in and the maybe most powerful tool: The +filter. Here you can make the icon view display only items that match the +criteria you define. Try filtering files whose names contain +<quote>air</quote> by typing <userinput>*air*</userinput> into the filter +field.</para> + +</callout> + +<callout arearefs="quick-access-co"> + +<anchor id="quick-access"/> + +<para>The Quick Access Panel (activate it by typing the +<keycap>F9</keycap> key on your keyboard or through the wrench icon on top +of the dialog) provides configurable shortcuts to frequently used +locations on your hard drive or even on the Internet. There are several +preconfigured locations such as your home directory. Try right clicking on +any item to configure it or to empty space to add a new entry. You will be +shown a context menu. Here you can choose the icon size and to add, modify +or rename any entry. Choose <guimenuitem>Add Entry</guimenuitem> and you +will see a window containing anything you need: Type your description, enter +the location (or choose it via the dialog opening by clicking on the +folder symbol), choose a symbol from a vast variety in the symbol dialog +opening when you click on the predefined icon (usually a simple folder +symbol).</para> + +</callout> + +<callout arearefs="preview-area-co"> + +<anchor id="preview-area"/> +<para>The Preview area (activate it by typing the <keycap>F11</keycap> +key on your keyboard or via the wrench icon on top of the dialog) +makes it easy to preview almost any file on your filesystem. Images +will be displayed as thumbnails. Usually also sound files (such as +MP3, Ogg or Wave-Files), text files (among them raw text, PDF and +&HTML;) and even video files (MPG, AVI and so on) will be +previewed.</para> + +<note><para>Note that large files might take a long time to be previewed +(⪚ scaled down if they are large images). You can disable automatic +previews by unselecting <guilabel>Automatic Preview</guilabel> below the +preview. You can still preview individual files: just click <guibutton>Preview</guibutton>. You can also disable previews for files above a certain +size. Go to &kcontrolcenter;, choose <menuchoice><guilabel>TDE +components</guilabel><guilabel>File manager</guilabel></menuchoice>, go to +the <guilabel>Preview and Metafiles</guilabel> tab and change the +<guilabel>Maximum Filesize</guilabel> value.</para></note> + +</callout> +</calloutlist> + +<!-- Add links to "further reading" here --> +<!--<itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + </sect2> + + +</sect1> + +<sect1 id="configuring-programs"> + +<title>Configuring Programs</title> + +<sect2 id="configure-kapp"> +<title>Application Configuration</title> +<!-- FIXME: Make a more friendly title --> +<indexterm><primary>Configuration</primary></indexterm> +<indexterm><primary>Customization</primary></indexterm> + +<para>&tde; applications are intended to be as useful and usable as +possible <quote>out of the box</quote>, but they also offer a wide +range of options which you can change to make &tde; work for you. As +well as the settings which affect the whole of &tde; (see <xref +linkend="control-center"/>), each application has a set of +configuration options, which you can access using the menu option +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +<replaceable>Application</replaceable></guimenuitem> +</menuchoice>. This is the same for all &tde; applications, which +makes it easy to find the configuration dialog for an +application.</para> + +<!-- TODO: Screenie of a typical config dialog --> + +<para>On the left of the configuration dialog is a list of +sections. Clicking on one of these sections displays the configuration +page for that section on the right-hand side of the dialog. You can +change these options to fit your preferences.</para> + +<para>When you have made the changes you want, you can click on +<guibutton>OK</guibutton> to save your changes and close the +configuration dialog. If you want to see the effect of your changes, +but not close the configuration dialog, click on the +<guibutton>Apply</guibutton> button. This is useful if you aren't sure +about the change you've made, and might want to change back, because +the dialog is still open, ready for you to do so.</para> + +<para>If you decide that you don't want to keep the changes you've +made, just click <guibutton>Cancel</guibutton> to close the dialog +without saving your changes.</para> + +</sect2> + +<sect2 id="configure-shortcuts"> +<title>Configuring Keyboard Shortcuts</title> + +<indexterm><primary>Shortcuts</primary></indexterm> +<indexterm><primary>Keybindings</primary></indexterm> + +<para>Most &tde; applications offer keyboard shortcuts for the main +actions in the application. If you find that you don't like the +default keyboard shortcuts, or that they conflict with the shortcuts +of another application (maybe one that's not part of &tde;), you can +change them with the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem> +</menuchoice> menu entry. This brings up the +<guilabel>Configure Shortcuts</guilabel> dialog for the +application. As an example of how to use this dialog, let's add a +shortcut for the <guimenuitem>Send Link Address...</guimenuitem> action to +&konqueror;, so that we can email the locations of interesting pages +to friends just by hitting a key (or two): </para> +<procedure> +<step><para>Open the <guilabel>Configure Shortcuts</guilabel> +dialog in &konqueror;, as described above.</para> +</step> +<step><para>Click on the <guilabel>Send Link Address...</guilabel> item +in the main listbox (it's near the bottom, in the +<guilabel>Konqueror</guilabel> section).</para> +</step> +<step><para>In the <guilabel>Shortcut for Selected +Action</guilabel> panel, select <guilabel>Custom</guilabel>, since we +are going to give this action a keyboard shortcut that we have chosen.</para> +</step> +<step><para>A small shortcut entry dialog pops up. Just hit +<keycombo action="simul">&Ctrl;<keycap>E</keycap> +</keycombo> (or whatever you want to change the shortcut to), and the +dialog disappears. The <quote>key</quote> icon in the +<guilabel>Configure Shortcuts</guilabel> dialog now shows the new +shortcut.</para> +</step> +<step><para>If you made a mistake, or change your mind about what +to use as the shortcut, just click on the key icon showing the current +shortcut. The shortcut entry dialog reappears, and you can press the +key combination for the shortcut you want.</para> +</step> +</procedure> + +<!-- TODO: Screenie --> + +</sect2> + +<sect2 id="configure-notifications"> +<title>Configuring Notifications</title> + +<indexterm><primary>Notifications</primary></indexterm> +<indexterm><primary>Sounds</primary></indexterm> + +<para>Something about +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice>.</para> +</sect2> + + +<sect2 id="configuring-toolbars"> +<sect2info> +<author> +<firstname>Adriaan</firstname> +<surname>de Groot</surname> +</author> +</sect2info> +<title>Configuring Toolbars</title> + +<para>Nearly every &tde; application has one or more toolbars at the top of +the application window, underneath the menu. The toolbar contains icons +(toolbar buttons) that represent commonly used actions and configuration +settings. The &kmail; window, for instance, has a toolbar that contains +buttons for <guiicon>New Message</guiicon>, <guiicon>Check Mail</guiicon> +and several others. Each of these actions is something you do often, so +that's why they have toolbar buttons as well as menu entries (<guiicon>New +Message</guiicon> is under +<menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message</guimenuitem></menuchoice>, <guiicon>Check Mail</guiicon> is +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>).</para> + +<para>Not everybody agrees on what actions are commonly used, though, (I +never use the <guiicon>New Message</guiicon> toolbar button or the menu +item, I use the keyboard shortcut <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo>). To ensure that your +screen isn't cluttered with things you don't need, each toolbar can be +customized. Additionally, you can usually customize which toolbars are +displayed and how, as well.</para> + +<sect3 id="customizing-toolbar-displays"> +<title>Customizing Toolbar Displays</title> + +<para>The easiest thing to customize with the toolbars of any given +application is whether they are displayed at all. Most applications have a +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Toolbars</guisubmenu> +</menuchoice> menu where you can select which toolbars are displayed and +which are not. &konqueror; has four toolbars, <interface>Main</interface>, +<interface>Extra</interface>, <interface>Location</interface> and +<interface>Bookmark</interface>. It can be convenient to turn off the +<interface>Bookmark</interface> toolbar to save +screen space. To do so, click on the <guimenu>Settings</guimenu> menu, +choose <guisubmenu>Toolbars</guisubmenu>, and then uncheck the +<guimenuitem>Bookmark Toolbar</guimenuitem> entry (do this just by clicking +on the menu item).</para> + +<para>If there is no <guimenu>Settings</guimenu> menu, you can also +<mousebutton>right</mousebutton> click on the toolbar itself, and choose the +<guisubmenu>Toolbars</guisubmenu> sub-menu from the resulting context +menu.</para> + +<para>The same <guimenu>Toolbar</guimenu> context menu, accessed by +<mousebutton>right</mousebutton> clicking on the toolbar, allows you to +customize other properties of the toolbar:</para> + +<itemizedlist> +<listitem> +<para>Its orientation, so that instead of appearing at the top of the +window under the menu bar you can place it on the left, right or bottom of +the window.</para> +</listitem> +<listitem> +<para>Its orientation, so that the toolbar <quote>floats</quote> as a +separate window which you can move independently.</para> +</listitem> +<listitem> +<para>Its orientation, so that the toolbar is squashed into a little flat +grip that you can re-open by double-clicking on it (this is subtly +different from making the toolbar vanish completely, since it it easier to +cause it to re-appear).</para> +</listitem> +<listitem> +<para>The appearance of text alongside, underneath, or instead of the icons +on the toolbar.</para> +</listitem> +<listitem> +<para>The size of the icons (if they are not supplanted by +text).</para> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="customizing-icons-on-toolbar"> +<title>Customizing the Icons on the Toolbar</title> + +<para>The toolbar is intended for actions that you perform often, so what do +you do if there is some useless icon there, like <guiicon>Cut</guiicon>? Or +what if you really want a <guiicon>cut</guiicon> button on the toolbar, but +the application doesn't give you one? This is where the customize toolbars +dialog comes in — it give you complete control over the actions that +are available on each toolbar.</para> + +<para>Choose <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Toolbars</guimenuitem></menuchoice> from the application's menu, or +<guimenuitem>Configure Toolbars</guimenuitem> from the context menu of the +toolbar itself. This displays the configure toolbars dialog, which consists +of a combobox <!-- drop-down box? --> with which you can select +<emphasis>which</emphasis> toolbar to customize, and two lists of items +— one of the available actions, and one of the actions that are +already in use on the toolbar.</para> + +<para>Often there are many many more actions available ( <guiicon>activate +tab #12</guiicon>, for instance) than you would ever want on the toolbar, or +even that you know exist in the application. The customize toolbar dialog +can be a learning experience. You can drag actions from one list box to the +other, rearrange the items on the toolbar <!-- in the list box on the right +..... not sure if I should be LTR-centric -->, or change the icon for a +selected action. This allows you to drag the actions you don't want off of +the toolbar and into the list of available actions; similarly, the actions +you do want can be dragged into the toolbar. Clicking +<guibutton>OK</guibutton> in the dialog immediately updates the toolbar with +your new preferred actions.</para> + +<para>There are a few special items that can end up in the listbox for the +current toolbar:</para> + +<itemizedlist> +<listitem> +<para>separators, which exist in two flavors: +<itemizedlist> +<listitem><para><guilabel>line separator</guilabel> appears as a line +between two action icons</para> +</listitem> +<listitem><para><guilabel>separator</guilabel> appears as a larger +space between two action icons</para> +</listitem> +</itemizedlist> +</para> +</listitem> +<listitem> +<para><guilabel><Merge></guilabel>, which is a special item that +allows plugins and other loadable components of the application to insert +their actions into the toolbar as well. It is generally not a good idea to +remove this, since you cannot get it back.</para> +</listitem> +<listitem> +<para><guilabel>ActionList:</guilabel>, these appear in various flavors +(there is a viewmode_toolbar one in &konqueror;) and again these +represent lists of actions that might be inserted by +plugins.</para> +</listitem> +</itemizedlist> + +<para>Whenever you click on an action in the list of current actions, a +description of it is shown in the dialog. This description will warn you if +it is a bad idea to remove the action.</para> + +<para>If you do not like to drag things around, there are four buttons in +the middle of the dialog which allow you to move the selected action from +one list to the other, and to move a selected current action up or down in +the list. There must be a way to restore the default toolbars in an +application, in order to recover from accidentally deleting an important +action like <guilabel><Merge></guilabel>, but I don't know what it +is.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect3> +</sect2> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/programs-controlling.docbook b/doc/khelpcenter/userguide/programs-controlling.docbook new file mode 100644 index 000000000..5d170f3a0 --- /dev/null +++ b/doc/khelpcenter/userguide/programs-controlling.docbook @@ -0,0 +1,22 @@ +<sect1 id="programs-controlling"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Controlling Programs</title> + +<para>Standard Toolbar layout</para> + +<para>Keybindings</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/removable-disks.docbook b/doc/khelpcenter/userguide/removable-disks.docbook new file mode 100644 index 000000000..92929dcbe --- /dev/null +++ b/doc/khelpcenter/userguide/removable-disks.docbook @@ -0,0 +1,122 @@ +<sect1 id="removable-disks"> + +<sect1info> +<authorgroup> +<author> +<firstname>Edward</firstname> +<surname>Haven</surname> +<email>edward.haven@gmail.com</email> +</author> +</authorgroup> +</sect1info> + +<title>Removable Disks</title> + +<para>For &tde; to use any device, removable or not, the device must +first be mounted. When a device is mounted, &tde; gets all the needed +information about the device: how to read it, how to write information to +it, and much more.</para> + +<para>The use of a device is controlled by the operating +system and it is important your operating system has tools for managing +these devices. &tde; can also auto mount devices, working with +<acronym>HAL</acronym> (Hardware Abstraction Layer). Your distribution +should have set up <acronym>HAL</acronym> automatically; if not, +consult the documentation provided by your distribution.</para> +<para>There are several ways to find the list of media devices: use +whichever one suits you best:</para> + +<itemizedlist> +<listitem> +<para>Enter <userinput>media:/</userinput> or +<userinput>system:/media</userinput> into the &konqueror; location bar.</para> +</listitem> + +<listitem> +<para>Navigate to it by clicking on the <guilabel>Services</guilabel> +tab in &konqueror;'s Navigation Panel, then selecting <guilabel>Storage +Media</guilabel>.</para> +</listitem> + +<listitem> +<para>Select <menuchoice><guimenu>Go</guimenu><guimenuitem>Storage Media</guimenuitem> +</menuchoice> from the &konqueror; menus.</para> +</listitem> + +<listitem> +<para>Click the <guilabel>System</guilabel> desktop icon, then from +the window that appears, click on <guilabel>Storage +Media</guilabel>.</para> +</listitem> + +</itemizedlist> + + +<para>The <guilabel>Storage Media</guilabel> location (also known as +the media:/ protocol) will show all devices which are recognized by +&tde;, including the hard drive and &CD; and <acronym>DVD</acronym> +drives, as well as <acronym>USB</acronym> and Firewire devices, +provided that your distribution is set up correctly to tell &tde; +about them.</para> + + + <para>You can also setup &tde; to display a device icon +on the desktop. To start or configure this feature in the &kcontrolcenter; go +to +<menuchoice><guilabel>Desktop</guilabel><guilabel>Behavior</guilabel></menuchoice> +and select the <guilabel>Device Icons</guilabel> Tab. The device icon action +can be used to show both mounted and unmounted devices, or to only create an +icon when media is detected and automounted (only if automount is properly +configured), by not checking the unmounted boxes.</para> + +<sect2 id="automounting"> +<title>Automount</title> + +<para>With &tde; 3.5 and newer, devices can be automounted, meaning one only +has to insert the removable disk. &tde; will then open an automount prompt +asking the user <quote>What do you want to do?</quote> with the media. To +configure the list of options prompted for devices open the &kcontrolcenter; and +navigate to <menuchoice><guilabel>Peripherals</guilabel><guilabel>Storage +Media</guilabel></menuchoice>. Here you can add and remove programs from the +list of devices.</para> + +<para>The automount feature will only work if +<application>dbus</application>, <application>hal</application> and +<application>udev</application> are installed and the kernel is properly +configured. To find out if they are running on your system check the +<guilabel>Process Table</guilabel> in &ksysguard; for: +<command>hald</command>, <command>dbus-deamon</command>, and +<command>udevd</command>. &tde; does not provide any of these +components. You must check with you distribution.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="http://wiki.kde.org/tiki-index.php?page=DBUS">HOWTO: setting up D-BUS and HAL with TDE's media ioslave +edit</ulink> (A community maintained HOWTO on the &tde; wiki)</para></listitem> +<listitem><para><ulink url="http://www.freedesktop.org/wiki/Software/dbus">The DBus page</ulink></para></listitem> +<listitem><para><ulink url="http://www.freedesktop.org/wiki/Software/hal"></ulink>HAL - Hardware Abstraction Layer</para></listitem> +</itemizedlist> + +</sect2> + +<sect2 id="mounting-removable-disks"> +<title>Mounting</title> + +<para>If your system does not automount, &tde; is configured to mount and +unmount devices which the current user has permission to mount. If a device +is mounted as the root partition (&ie; <literal>/</literal>), and you log in +to &tde; as a user, &tde; can not mount or unmount it without being given a +higher permission. To check a devices mount permission see the +<filename>/etc/fstab</filename> file.</para> + +<para>To mount and unmount devices manually in &tde; one only has to &RMB; +click the device icon in media:/ or on the desktop and select +<guimenuitem>Mount</guimenuitem> or <guimenuitem>Unmount</guimenuitem>, for +removable devices one can also unmount with <guimenuitem>Safely Remove</guimenuitem>. &tde; still requires the device to be setup in +/etc/fstab.</para> +</sect2> + + + + +</sect1> diff --git a/doc/khelpcenter/userguide/rip.png b/doc/khelpcenter/userguide/rip.png Binary files differnew file mode 100644 index 000000000..b1461a979 --- /dev/null +++ b/doc/khelpcenter/userguide/rip.png diff --git a/doc/khelpcenter/userguide/ripsettings.png b/doc/khelpcenter/userguide/ripsettings.png Binary files differnew file mode 100644 index 000000000..e4e50addb --- /dev/null +++ b/doc/khelpcenter/userguide/ripsettings.png diff --git a/doc/khelpcenter/userguide/screen-captures.docbook b/doc/khelpcenter/userguide/screen-captures.docbook new file mode 100644 index 000000000..b6ea1da1f --- /dev/null +++ b/doc/khelpcenter/userguide/screen-captures.docbook @@ -0,0 +1,20 @@ +<sect1 id="screen-captures"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Screen Captures</title> + +<para>Grabbing screen caps</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/services.png b/doc/khelpcenter/userguide/services.png Binary files differnew file mode 100644 index 000000000..7ccd315d4 --- /dev/null +++ b/doc/khelpcenter/userguide/services.png diff --git a/doc/khelpcenter/userguide/shared-sessions.docbook b/doc/khelpcenter/userguide/shared-sessions.docbook new file mode 100644 index 000000000..5712bf817 --- /dev/null +++ b/doc/khelpcenter/userguide/shared-sessions.docbook @@ -0,0 +1,28 @@ +<sect1 id="shared-sessions"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Shared Sessions</title> + +<para>Sharing your desktop with krfb and pals</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> diff --git a/doc/khelpcenter/userguide/splash-screen.png b/doc/khelpcenter/userguide/splash-screen.png Binary files differnew file mode 100644 index 000000000..cd11c5d35 --- /dev/null +++ b/doc/khelpcenter/userguide/splash-screen.png diff --git a/doc/khelpcenter/userguide/standard-menu-entries.docbook b/doc/khelpcenter/userguide/standard-menu-entries.docbook new file mode 100644 index 000000000..379b0fa0a --- /dev/null +++ b/doc/khelpcenter/userguide/standard-menu-entries.docbook @@ -0,0 +1,301 @@ +<chapter id="menus"> +<chapterinfo> +<authorgroup> +<author> +&Philip.Rodrigues; +</author> +</authorgroup> +</chapterinfo> + + +<title>The Standard Menu Entries</title> + +<!-- FIXME: The text is immensely repetitive. Fix that. --> + +<para>One of the main ways that you'll control programs in &tde; is +via the program's menus. They provide access to nearly everything +you'll need to do with that program. So that you can more easily +remember where things are in the menus, and to help you learn new +programs more easily, the menus have a standard layout. This means +that once you know how to open a file in one program, you know how to +open a file in any &tde; program. Let's take a look at the standard +menus:</para> <!-- TODO: Note that programs have other menu entries as well--> + +<!-- Probably a good place for a screenie, but we'd need one showing +*only* the standard entries --> + +<variablelist> +<title>The <guimenu>File</guimenu> Menu</title> +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap> +</keycombo> +</shortcut><guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para>This entry will start a new, blank document that's +appropriate to the program you're using. For example, in &kate; (the +&tde; Advanced Text Editor) this entry creates a new text file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap> +</keycombo> +</shortcut><guimenuitem>Open...</guimenuitem> +</menuchoice></term> +<listitem><para>The <guimenuitem>Open...</guimenuitem> menu entry +displays the &tde; <quote>Open File</quote> dialog box, where you can +choose a file to open in the program you're using. The <quote>Open +File</quote> dialog is also standardized, so it's the same for all +&tde; programs. You can find out more about using this dialog +somewhere else in this guide <!-- FIXME: real link -->.</para> +<para>You probably noticed that this menu entry had an ellipsis (...) +after the name of the entry. This means that clicking on the entry +will open a dialog box of some kind. If you make any changes in the +dialog box that appears, they won't take effect until you click on the +<guibutton>OK</guibutton> button in the dialog. You can always ignore +any changes you made, and close the dialog, by clicking on the +<guibutton>Cancel</guibutton> button.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap> +</keycombo> +</shortcut><guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry will save any changes you've made to +the file that you are currently working on. If this is the first time +that you've saved the file, the &tde; <quote>Save File</quote> dialog +will appear, and ask you for a name and location for the file. <!-- TODO: Point to another section for more info --></para> +</listitem> +</varlistentry> + + + +<varlistentry> +<term><menuchoice><guimenuitem>Save As...</guimenuitem> +</menuchoice></term> +<listitem><para>The <guimenuitem>Save As...</guimenuitem> menu entry +will save the file you're working on with a different name. The +<quote>Save File</quote> dialog appears, and you can choose a name and +location as usual. Note that after you save the file with +<guimenuitem>Save As..</guimenuitem>, you will be working on the +<emphasis>new</emphasis> file. If you save changes, they will be saved +under the new filename. To make this a bit clearer, let's take an +example: + +<orderedlist> +<listitem><para>You are working on a file called +<filename>hello.txt</filename> that contains the text <quote>Hello +World!</quote> </para> +</listitem> + +<listitem><para>You use the <guimenuitem>Save As...</guimenuitem> menu +entry to save the file with the new name +<filename>newhello.txt</filename>.</para> +</listitem> + +<listitem><para>You add the text <quote>Nice to see you!</quote> to +the file, and use the <guimenuitem>Save</guimenuitem> menu entry to +save these changes.</para> +</listitem> +</orderedlist> + + + +Now, the file <filename>newhello.txt</filename> contains the text +<quote>Hello World! Nice to see you!</quote>, while the file +<filename>hello.txt</filename> contains only the text <quote>Hello +World!</quote>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap> +</keycombo> +</shortcut><guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry displays the &tde; +<quote>Print</quote> dialog, read to print the current +document. Youcan find more information about the options available in +this dialog in <xref linkend="printing-from-apps"/>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>W</keycap> +</keycombo> +</shortcut><guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry closes the current document. If you +have made any changes since you last saved the document, you will be +asked whether you want to save those changes. You can choose to +<guibutton>Save</guibutton> or <guibutton>Discard</guibutton> those +changes. If you didn't really want to close the file, just click +<guibutton>Cancel</guibutton>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap> +</keycombo> +</shortcut><guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para>Use this entry to close the program you're using. If +you have unsaved changes in any files, you will be asked whether you +want to +save them.</para> +</listitem> +</varlistentry> + + + +</variablelist> + +<variablelist> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap> +</keycombo> +</shortcut><guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para>Use this entry to remove the effect of the last +action you performed in the application. For example, if you deleted a +line of text, the <guimenuitem>Undo</guimenuitem> menu entry will +replace that line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap> +</keycombo> +</shortcut><guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para>Use this menu entry to perform the last action that +you removed with the <guimenuitem>Undo</guimenuitem> menu entry. For +example, if, as in the example above, you had replaced a deleted line +of text with <guimenuitem>Undo</guimenuitem>, the +<guimenuitem>Redo</guimenuitem> entry would redo the action of +deleting the line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry cuts the contents of the current +selection to the clipboard. See <xref linkend="using-the-clipboard"/> +for more information. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap> +</keycombo> +</shortcut><guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry copies the contents of the current +selection to the clipboard. See <xref linkend="using-the-clipboard"/> +for more information. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry inserts the contents of the clipboard +in the current document. The clipboard contents are inserted where the +cursor is currently positioned.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap> +</keycombo> +</shortcut><guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem><para>Use this item to select the whole of the current +document.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap> +</keycombo> +</shortcut><guimenuitem>Find...</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry displays the <guilabel>Find +Text</guilabel> dialog, which you can use to search for a particular +word or phrase in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"><keycap>F3</keycap> +</keycombo> +</shortcut><guimenuitem>Find Next</guimenuitem> +</menuchoice></term> +<listitem><para>Use this item to find the next occurrence of the most +recent text you searched for using <guimenuitem>Find...</guimenuitem>. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<variablelist> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change the keyboard shortcuts used by the application. See <xref +linkend="configure-shortcuts"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure +Toolbars...</guimenuitem></menuchoice></term> + +<listitem><para>In the dialog displayed by this menu entry, you can +change which buttons appear on the application's toolbars. See <xref +linkend="configuring-toolbars"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure Notifications...</guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change the notifications (sounds, error messages, &etc;) used by the +application. See <xref +linkend="configure-notifications"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure <replaceable>Application</replaceable></guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change settings relating to how the application works in general. +</para> +</listitem> +</varlistentry> + +</variablelist> + + +&help.menu.documentation; + +</chapter> diff --git a/doc/khelpcenter/userguide/switching-sessions.docbook b/doc/khelpcenter/userguide/switching-sessions.docbook new file mode 100644 index 000000000..0c15df8e1 --- /dev/null +++ b/doc/khelpcenter/userguide/switching-sessions.docbook @@ -0,0 +1,63 @@ +<sect1 id="switching-sessions"> + +<title>Switching Sessions</title> + +<para>From version 3.3 onwards, &tde; provides a session management +system which allows you to switch between different user account on +one computer. You can stay logged in and ⪚ let your sister, +brother, wife, neigbour or whoever read her or his emails just for a +moment. Before you had to log off (therefore ⪚ close programs or +save documents) and let her or him log in.</para> + +<para>Now it's almost as easy as switching to another virtual desktop.</para> + +<variablelist> +<title>Switching Sessions: How it works</title> + +<varlistentry> +<term>The <guimenuitem>Switch User</guimenuitem> Menu</term> +<listitem> +<para>The &kmenu; now bears a new entry. Rather at the bottom of the menu +you will find a <guisubmenu>Switch User</guisubmenu> submenu. It contains +the command to lock the current and start a new session which means that +your desktop will start the screensaver and after a few seconds can log in +with TDM as always. The <guimenuitem>Start New Session</guimenuitem> entry +skips the activation of your screensaver.</para> + +<para>Once you have running more than one session you can either choose to +press <keycombo action="simul">&Ctrl;&Alt;<keycap>F7</keycap></keycombo> + or <keycap>F8</keycap> and so on (what is usually configured by default) or +— even more comfortable — choose from the list of active +sessions at the bottom of the <guisubmenu>Switch User</guisubmenu> +submenu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Switch User with the screensaver</term> +<listitem><para>If you have activated your screensaver and another user +wants to log in she or he can simply press the <guibutton>Switch +User...</guibutton> button and log into another session.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Switch Session in &tdm;</term> +<listitem><para>If you are in &tdm; and want to switch to another active +session you can press the <guibutton>Menu</guibutton> button and choose +<guisubmenu>Switch User</guisubmenu> which is mainly the same as described +above.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/tde-as-root.docbook b/doc/khelpcenter/userguide/tde-as-root.docbook new file mode 100644 index 000000000..c7e9b966e --- /dev/null +++ b/doc/khelpcenter/userguide/tde-as-root.docbook @@ -0,0 +1,34 @@ +<sect1 id="root"> + +<sect1info> +<authorgroup> +<author> +&Francis.Giannaros; &Francis.Giannaros.mail; +</author> +</authorgroup> +</sect1info> + + +<title>Using &tde; as Root</title> + +<para>For &UNIX; operating systems there are often different users, which in turn might have different privileges. The conventional method is to have an ordinary user account, whose files are generally stored in <filename>/home/username</filename>, and then to also have a <systemitem class="username">root</systemitem> account. The <systemitem class="username">root</systemitem>, or Super User, account has system-wide privileges, being able to modify any file on the system.</para> + +<para>Although this means that it is easy to perform administrative tasks without hassle, it also means that there are no security restrictions imposed upon it. Thus, a small typographical error or other mistake can result in irrevocable damage.</para> + +<para>Some of the operating systems that run &tde; come with a graphical <systemitem class="username">root</systemitem> login enabled. Despite this, you should never log in to &tde; as <systemitem class="username">root</systemitem>, and you should never need to. Your system is far more open to attack, particularly if you are browsing the Internet as <systemitem class="username">root</systemitem>, and you dramatically increase your chances of damaging your system.</para> + +<para>Some &Linux; distributions have tried to stress this point so much that they have disabled the <systemitem class="username">root</systemitem> account altogether, and instead use the <command>sudo</command> model. Nevertheless, the basic security model in <command>sudo</command> is the same as <command>su</command>, and thus they share the same security strengths and weaknesses, essentially.</para> + +<para>If you should ever need to run a program with Super User privileges, then it is always recommend that you use &tdesu;. From &konsole; or from hitting <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>, enter <userinput>tdesu <replaceable>application</replaceable></userinput>, and the application will be run with the appropriate Super User privileges.</para> + +<para>Even if you have set up your system to use <command>sudo</command>, or you are on a distribution that uses <command>sudo</command>, such as &kubuntu;, you should still use &tdesu;. The program will be appropriately modified by the developers to use the correct settings. You should not, however, ever use <command>sudo <replaceable>application</replaceable></command> to run an application with <systemitem class="username">root</systemitem> permissions; it can derange permissions of certain configuration files for a program. Running a graphical applications as <systemitem class="username">root</systemitem> in general is not a good idea, but using &tdesu; will always be your safest bet with it.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="help:tdesu">&tdesu; Handbook</ulink></para> +</listitem> +</itemizedlist> + + +</sect1> diff --git a/doc/khelpcenter/userguide/tde-edutainment.docbook b/doc/khelpcenter/userguide/tde-edutainment.docbook new file mode 100644 index 000000000..0cafe8f04 --- /dev/null +++ b/doc/khelpcenter/userguide/tde-edutainment.docbook @@ -0,0 +1,324 @@ +<chapter id="tde-edutainment"> +<!-- Uncomment this and add your name in order to be credited for +writing this section +<chapterinfo> +<authorgroup> +<author> +Your name here +</author> +</authorgroup> +</chapterinfo> +--> + +<title>&tde; Edutainment</title> + +<para>The &tde; Edutainment Project offers children, families, and teachers some +educational programs. You can find applications to help you improve +your language skills and train your vocabulary, like &kvoctrain; and +&kwordquiz;; or Scientific programs, like the +very advanced &kstars; (a planetarium) and &kig; (interactive +geometry), which will bring you to the edge of knowledge. Have fun learning +touch-typing with &ktouch;. Teachers will find an easy way to make +their lessons with &keduca;. You can find a complete list of &tde; +educational software on <ulink url="http://edu.kde.org">the TDE-Edu +website</ulink>. What follows is an overview of a few of them. +</para> +<para>View the handbook of each application by typing <userinput>help:/<appname></userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para> + +<sect1 id="languages"> +<title>Improve your language skills</title> + +<variablelist> +<varlistentry> +<term>&khangman;</term> + <listitem><para>An easy-to-use application which implements the classical hangman game. You can choose for the words to be from a particular topic and even choose from a selection of difficulty levels. The program comes in twenty-four languages, and is therefore quite ideal for learning the spelling of basic nouns in other languages.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/khangman">http://edu.kde.org/khangman</ulink></para></listitem> + <listitem><para><ulink + url="help:/khangman">&khangman; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&klettres;</term> + <listitem><para>An application specially designed to help the user learn the alphabet of a new language and then to learn to read simple syllables. Ideal for children, or any person attempting to learn and familiarize themselves with a foreign language's alphabet. A number of alphabets are currently supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/klettres">http://edu.kde.org/klettres</ulink></para></listitem> + <listitem><para><ulink + url="help:/klettres">&klettres; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kanagram;</term> + <listitem><para>A simple mind-training game, in which you have to figure out the word that has been given in the program. The letters from the word are disordered, and from the given words you have to solve which word the letters might make, if rearranged. Similar to the popular Countdown game as seen on Television.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kanagram">http://edu.kde.org/kanagram</ulink></para></listitem> + <listitem><para><ulink + url="help:/kanagram">&kanagram; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kverbos;</term> + <listitem><para>A simple way to learn and study Spanish verb forms. The program suggests a verb and a tense and the user enters the different forms. The program corrects the user input and gives feedback. The user can edit the list of the verbs that can be studied and the program can build regular verb forms, and the forms of the most important verb groups, by itself. Irregular verb forms can be entered by the user.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kverbos">http://edu.kde.org/kverbos</ulink></para></listitem> + <listitem><para><ulink + url="help:/kverbos">&kverbos; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kvoctrain;</term> + <listitem><para>Another advanced vocabulary training application, using the flash card approach. <ulink url="http://edu.kde.org/contrib/kvtml.php">Vocabulary files</ulink> and be downloaded and loaded into the application.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kvoctrain">http://edu.kde.org/kvoctrain</ulink></para></listitem> + <listitem><para><ulink + url="help:/kvoctrain">&kvoctrain; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kiten;</term> + <listitem><para>A Japanese reference and learning tool. Words from both English and Japanese can be looked up, and filtered, using the <application>Edict</application> and <application>Kanjidic</application> dictionary protocols. Other features in &kiten; include a few comprehensive search functions, a history of searches, and a learning section which contains various different learning modes.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kiten">http://edu.kde.org/kiten</ulink></para></listitem> + <listitem><para><ulink + url="help:/kiten">&kiten; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&klatin;</term> + <listitem><para>A program to help revise Latin. There are vocabulary, grammar, and verb testing sections. In addition there is a set of revision notes that can be used for self-guided revision.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/klatin">http://edu.kde.org/klatin</ulink></para></listitem> + <listitem><para><ulink + url="help:/klatin">&klatin; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="mathematics"> +<title>Mathematics</title> + +<para>Several applications to help you with Mathematics and Geometry.</para> + +<variablelist> +<varlistentry> +<term>&kbruch;</term> + <listitem><para>An application with several exercise types in order to enhance your calculating with fractions. Different tasks include exercises to find the sum of two fractions, the conversion of fractions into the respective decimal, the comparison (with less than, more than) of fractions, and more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kbruch">http://edu.kde.org/kbruch</ulink></para></listitem> + <listitem><para><ulink + url="help:/kbruch">&kbruch; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kig;</term> + <listitem><para>A great application with interactive geometry. Ideal for teachers attempting to draw a graph on the computer, or students who wish to find out more and investigate with graphs and curves. Currently many things are supported, and you can very easily construct several things from parabolas and hyperbolas, to ellipses.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kig">http://edu.kde.org/kig</ulink></para></listitem> + <listitem><para><ulink + url="help:/kig">&kig; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kpercentage;</term> + <listitem><para>Essentially an application to help you improve your skills in calculating percentages. Different exercises are included, and there are varying difficulty levels to target persons with varying abilities.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kpercentage">http://edu.kde.org/kpercentage</ulink></para></listitem> + <listitem><para><ulink + url="help:/kpercentage">&kpercentage; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> +<term>&kmplot;</term> + <listitem><para>A mathematical function plotter. It has built in a powerful parser. You can plot different functions simultaneously and combine their function terms to build new functions. &kmplot; supports functions with parameters and functions in polar coordinates. Several grid modes are possible and plots may be printed with high precision in correct scale.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kmplot">http://edu.kde.org/kmplot</ulink></para></listitem> + <listitem><para><ulink + url="help:/kmplot">&kmplot; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + + +</sect1> +<sect1 id="science"> +<title>Science</title> + +<variablelist> +<varlistentry> +<term>&kstars;</term> + <listitem><para>A desktop Planetarium for &tde;. It provides an accurate graphical simulation of the night sky, from any location on Earth, at any date and time. The display includes 130,000 stars, 13,000 deep-sky objects,all 8 planets, the Sun and Moon, and thousands of comets and asteroids.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kstars">http://edu.kde.org/kstars</ulink></para></listitem> + <listitem><para><ulink + url="help:/kstars">&kstars; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> + <term>&kalzium;</term> + <listitem><para>A fully-featured periodic table, with the full list of all elements, and extended information about each individual element is accessible. As well as being able to view a basic overview, other features include being able to view its chemical data, atomic model, energies, as well as a picture of the element.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kalzium">http://edu.kde.org/kalzium</ulink></para></listitem> + <listitem><para><ulink url="help:/kalzium">&kalzium; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="teaching_tools"> +<title>Teaching Tools</title> +<variablelist> +<varlistentry> + <term>&keduca;</term> + <listitem><para>A flash card application, which allows you to make interactive form-based tests. It also currently comes with support to add servers from which you can fetch tests from. Several languages supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/keduca">http://edu.kde.org/keduca</ulink></para></listitem> + <listitem><para><ulink url="help:/keduca">&keduca; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="miscellaneous"> +<title>Miscellaneous</title> +<variablelist> +<varlistentry> + <term>&ktouch;</term> + <listitem><para>An application for learning touch-typing. &ktouch; displays the keyboard on the screen, and the color of the keys changes when they need to be depressed. Text appears on the screen, and the user is asked to type it out. A few default lectures are contained in the program by default, with various different difficulty levels.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/ktouch">http://edu.kde.org/ktouch</ulink></para></listitem> + <listitem><para><ulink url="help:/ktouch">&ktouch; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> + +<varlistentry> + <term>&kwordquiz;</term> + <listitem><para>A flash card application, which allows you to make interactive form-based tests. It also currently comes with support to add servers from which you can fetch tests from. Several languages supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kwordquiz">http://edu.kde.org/kwordquiz</ulink></para></listitem> + <listitem><para><ulink url="help:/kwordquiz">&kwordquiz; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term>&kturtle;</term> + <listitem><para>An educational programming environment using the Logo programming language, with several languages currently supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kturtle">http://edu.kde.org/kturtle</ulink></para></listitem> + <listitem><para><ulink url="help:/kturtle">&kturtle; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term><application>&kgeography;</application></term> + <listitem><para>&kgeography; is a geography learning tool for &tde;. You can browse the maps by clicking in a map division to see its name and you can also answer several types of questions where the program shows you a map division or a capital for example and you have to guess its name.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kgeography.berlios.de/">http://kgeography.berlios.de/</ulink> and <ulink url="http://edu.kde.org/kgeography">http://edu.kde.org/kgeography</ulink></para></listitem> + <listitem><para><ulink url="help:/kgeography"><application>&kgeography;</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term><application>&blinken;</application></term> + <listitem><para>&blinken; is a Simon Says game for &tde;. The player should remember the sequence of lights in the correct order and is then presented with an identical sequence with one extra step.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/blinken">http://edu.kde.org/blinken</ulink></para></listitem> + <listitem><para><ulink url="help:/blinken"><application>&blinken;</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="edu-related"> +<title>Related Information</title> +<itemizedlist> +<listitem><para>The &tde;-Edu website at <ulink +url="http://edu.kde.org">http://edu.kde.org</ulink> has news and +information about all the &tde; Edutainment applications.</para> +</listitem> +</itemizedlist> +</sect1> + + +</chapter> diff --git a/doc/khelpcenter/userguide/tde-office.docbook b/doc/khelpcenter/userguide/tde-office.docbook new file mode 100644 index 000000000..f8df13365 --- /dev/null +++ b/doc/khelpcenter/userguide/tde-office.docbook @@ -0,0 +1,321 @@ +<part id="tde-office"> +<partinfo> +<authorgroup> +<author> +<personname> +<firstname>Raphael</firstname> +<surname>Langerhorst</surname> +</personname> +<email>raphael.langerhorst@kdemail.net</email> +</author> +<!-- +<othercredit role="reviewer"> +</othercredit> +--> +</authorgroup> +</partinfo> + +<!-- keep a copy of the desired structure here: +* TDE Office + * Introduction to KOffice + * Overview + * Features + * OASIS OpenDocument file format + * Document embedding + * KParts and KOffice + * Example document + * KOffice components overview + * ... [a short intro to all components] + * Further information + * Application manuals + * Internet resources + * Plugin development +--> + +<title>Office</title> + +<chapter id="tde-office-introduction"> +<title>Introduction to KOffice</title> + +<sect1 id="tde-office-overview"> +<title>Overview</title> +<para> +The &tde; project has also created a fully featured office suite +called &koffice; which adheres to standards and fits very well into +the &tde; desktop. This section was written with version 1.4 of +&koffice; in mind. +</para> +<para> +&koffice; is a highly integrated office suite that builds directly on the +TDE technology. This has many advantages in terms of integration, features, +performance, familiar look and feel and so on. All technologies like &DCOP;, +TDEIO, KParts are directly available. +</para> +<para> +In particular the KParts technology is extended for the &koffice; +components to allow very flexible embedding of documents inside documents. +</para> +<para> +Because much technology is already present inside &tde; itself, &koffice; is +a very lightweight office suite, which results in fast application startup +and low memory consumption. This makes &koffice; a very suitable office suite +for older hardware as well, which can save lots of costs in some cases. +</para> +<para> +&koffice; is also a very feature complete office suite. It is not limited to +word processing, spreadsheets or presentations, but has also components for +image manipulation, flow charts, business report generation, database +management and project management. Because of the flexible component +integration smaller utilities like the diagram and chart engine as well +as the formula editor are available as stand alone tools. +</para> +<para> +As you can see &koffice; brings a lot of features that can enrich your +office experience. Its straight forward and &tde; like approach in look +and feel as well as familiar usability makes &koffice; quite useful for +daily office work. +</para> +<!-- include this para at the end in further information +<para> +You can always take a look at the &koffice; +<ulink url="http://www.koffice.org">website</ulink> to check on the latest +state of the application. +</para> +--> +</sect1> + +<sect1 id="tde-office-features"> +<title>Features</title> +<para> +This list gives a general outline of the &koffice; features. +The &koffice; office suite is too large to list every detail. +</para> +<itemizedlist> +<title>&koffice; features:</title> +<listitem><para>Fully builds on &tde; which makes these technologies available at low costs.</para></listitem> +<listitem><para>Fully integrates into &tde; which is vital for business environments.</para></listitem> +<listitem><para>&tde; technologies include document location abstraction, DCOP scripting, parts and plugins,...</para></listitem> +<listitem><para>Full Component embedding.</para></listitem> +<listitem><para>Low memory footprint, fast startup, lightweight.</para></listitem> +<listitem><para>Feature complete: many components are offered.</para></listitem> +<listitem><para>Intuitive, good looking and easy to learn user interface.</para></listitem> +<listitem><para>Adheres to standards: OASIS OpenDocument file format.</para></listitem> +</itemizedlist> +</sect1> + +<sect1 id="tde-office-fileformat"> +<title>OASIS OpenDocument file format</title> +<para> +It is important for an office suite to use standards where possible, +especially for the file format. The OASIS OpenDocument file format +specification is an open standard for office applications. This +format is spreading more and more, it is also the same file format +OpenOffice.org uses, which means that file exchange with any +user of this office suite is easily possible. +</para> +<para> +Adhering to official standards is always a good thing. For business +environments it is even vital to exactly know about their documents. +</para> +<para> +&koffice; has more components to offer than what is covered by the +OASIS specification. Still, all components covered by the specifications +actually use the OASIS OpenDocument file format. +</para> +</sect1> +</chapter> + +<!-- comment out for final commit before freeze +<chapter id="tde-office-embedding"> +<title>Component Embedding</title> +<sect1 id="tde-office-tdeparts"> +<title>KParts and &koffice;</title> +<para>To be written</para> +</sect1> + +<sect1 id="tde-office-example"> +<title>Example</title> +<para>To be written</para> +</sect1> +</chapter> +--> + +<chapter id="tde-office-components"> +<title>&koffice; Components Overview</title> + +<para>Keep in mind that all these components can integrate very well into each other. So basically a spreadsheet can contain anything from charts to presentations, reports and even text documents. Likewise almost any component can contain almost any other.</para> + +<variablelist> + +<varlistentry> +<term>&kword;</term> + <listitem><para>The textprocessing component, but it includes many aspects of a desktop publishing application. This creates a rather unique mixture of features that makes interesting layouts easily possible.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kword/">http://www.koffice.org/kword/</ulink></para></listitem> + <listitem><para><ulink url="help:/kword">&kword; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kspread;</term> + <listitem><para>The spreadsheet component. &kspread; is a scriptable spreadsheet program which provides both table-oriented sheets and support for complex mathematical formulas and statistics. Features include Hyperlinks, cell data validity checking with configurable warnings/actions, scripting and specific cell customization.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kspread/">http://www.koffice.org/kspread/</ulink></para></listitem> + <listitem><para><ulink url="help:/kspread">&kspread; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kpresenter;</term> + <listitem><para>The presentation component. It can be used to create on-screen presentations or to design and print transparencies. Features include embedding images and clip-art, easy working with objects, and the ability to make &HTML; or &XML; slideshows.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kpresenter/">http://www.koffice.org/kpresenter/</ulink></para></listitem> + <listitem><para><ulink url="help:/kpresenter">&kpresenter; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kivio;</term> + <listitem><para>The flowcharting and diagramming component. Additional stencil sets can be used for custom needs, there is a plugin framework for additional functionality, and even <acronym>UML</acronym> diagrams are possible.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kivio/">http://www.koffice.org/kivio/</ulink></para></listitem> + <listitem><para><ulink url="help:/kivio">&kivio; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&karbon14;</term> + <listitem><para>A vector-drawing application.</para></listitem> +</varlistentry> + +<varlistentry> +<term>&chalk;</term> + <listitem><para>The painting and image manipulation component. &chalk; contains both ease-of-use, fun features like guided painting, as well as high-end features like support for 16-bit images, <acronym>CMYK</acronym> and even OpenEXR <acronym>HDR</acronym> images.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/krita/">http://www.koffice.org/krita/</ulink></para></listitem> + <listitem><para><ulink url="help:/chalk">&chalk; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kugar;</term> + <listitem><para>The appropriate component for creating business reports, which is accomplished with an advanced designer that it has. Features include report printing in postscript, full control of fonts, colors, text alignment and wrapping, as well as open report definition files (with the layout stored as &XML;).</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kugar/">http://www.koffice.org/kugar/</ulink></para></listitem> + <listitem><para><ulink url="help:/kugar">&kugar; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KPlato</application></term> + <listitem><para>The component for project management, allowing for the planning and scheduling of various projects.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kplato/">http://www.koffice.org/kplato/</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kexi;</term> + <listitem><para>The data management component. It can be used for creating database schemas, inserting data, performing queries, and processing data. Forms can be created to provide a custom interface to your data. All database objects -- mdash; tables, queries and forms -- mdash; are stored in the database, making it easy to share data and database design.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kexi/">http://www.koffice.org/kexi/</ulink> and <ulink url="http://kexi-project.org">http://kexi-project.org</ulink>.</para></listitem> + <listitem><para><ulink url="help:/kexi">&kexi; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kchart;</term> + <listitem><para>The chart drawing component; it is used to embed charts into one of the other &koffice; components. It's easy to use, highly customizable allowing all of the parameters to be changed, and has a flexible layout.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kchart/">http://www.koffice.org/kchart/</ulink></para></listitem> + <listitem><para><ulink url="help:/kchart">&kchart; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kformula;</term> + <listitem><para> A formula editor which provides the basic input facilities and support functionality that appears in other &koffice; applications. Some of its features include intelligent cursor management, multi-level undo support and advanced syntax highlighting.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kformula/">http://www.koffice.org/kformula/</ulink></para></listitem> + <listitem><para><ulink url="help:/kformula">&kformula; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Main website: <ulink url="http://www.koffice.org">http://www.koffice.org</ulink>.</para></listitem> + <listitem><para><ulink url="help:/koffice">&koffice; Handbook</ulink></para></listitem> +</itemizedlist> + +</chapter> + +<chapter id="tde-office-furtherinfo"> + +<title>Further Information</title> +<sect1 id="tde-office-manuals"> +<title>Application Manuals</title> +<para>Each Koffice component comes with its own manual. +These manuals offer all the latest information about the +various components &koffice; has to offer and should be +read to learn more about &koffice;. The application manuals can be accessed by using the documentation TDEIO Slave in &konqueror; (that is, typing <userinput>help:/<replaceable>application</replaceable></userinput> into the Location toolbar) or by selecting the respective handbook from the &khelpcenter;. The website is +also a good place to find out more; it is at <ulink url="http://www.koffice.org">http://www.koffice.org</ulink>.</para> +</sect1> + +<sect1 id="tde-office-internet"> +<title>Internet Resources</title> +<para>The primary site on the internet is +<ulink url="http://www.koffice.org">http://www.koffice.org</ulink></para> +<para>You will also find information about the user and developer +mailing lists as well as additional developer resources.</para> +<para>The Kexi project has even an additional website, which can be +found at <ulink url="http://www.kexi-project.org">http://www.kexi-project.org +</ulink></para> +</sect1> + +<sect1 id="tde-office-plugininfo"> +<title>Plugin development</title> +<para>&koffice; can easily be extended with plugins. Plugin development is +not very difficult and can be used to optimize your everyday workflow. Such +capabilities are probably very interesting in business environments to +make &koffice; meet individual requirements. You can either take a look +at existing plugins or read a general introduction at +<ulink url="http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html"> +the developer's site</ulink>. The general TDE developers website is available +at <ulink url="http://developer.kde.org/">http://developer.kde.org</ulink>. +</para> +</sect1> + +</chapter> +</part> diff --git a/doc/khelpcenter/userguide/tdm.png b/doc/khelpcenter/userguide/tdm.png Binary files differnew file mode 100644 index 000000000..1ad4fcce0 --- /dev/null +++ b/doc/khelpcenter/userguide/tdm.png diff --git a/doc/khelpcenter/userguide/the-filemanager.docbook b/doc/khelpcenter/userguide/the-filemanager.docbook new file mode 100644 index 000000000..20e4dedfe --- /dev/null +++ b/doc/khelpcenter/userguide/the-filemanager.docbook @@ -0,0 +1,256 @@ +<sect1 id="file-manager"> + +<title>The File Manager</title> +<indexterm><primary>&konqueror;</primary><secondary>File +Management</secondary></indexterm> +<indexterm><primary>File Management</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="konq-simple.png" format="PNG" /> +</imageobject> +<caption><para>&konqueror; with simple settings</para></caption> +</mediaobject> + +<sect2 id="filemanager-intro"> +<title>Introduction</title> + +<para>&tde; includes a versatile and powerful file manager called +&konqueror; that allows you to do everything you want with the files +stored on your computer, your network, and even the Internet. There +are too many features of &konqueror; to describe here, so we will just +take an overview. For more details about what &konqueror; can +do, refer to the <ulink url="help:/konqueror">&konqueror; Handbook</ulink>.</para> +</sect2> + +<sect2 id="folder-structure"> +<title>Folders</title> + +<para>When you first open &konqueror; in file management mode, you can +see two panes: on the right is the folder view; on the left is the +sidebar. The folder view contains icons for +each item inside the current folder. These items can be +folders or files. Many file types can be <quote>previewed</quote> +without opening a new application to edit them in.<indexterm><primary>Previews</primary></indexterm> To preview a file, +hold the mouse cursor over the name of the file for about a second: a +popup window will appear, showing the contents of the file and other some +useful information, like file's size and which user owns the file.</para> + +<para>You can open any item by clicking on the icon for the +file. Folders will be opened in the same window; files will either be +opened in the appropriate program, or the file manager will ask you +what program to use. For instance, if do not have a word-processor set up to +open &Microsoft; Word documents, the file manager will +ask you what to do.</para> + +<para>You can go back to the last-opened folder by clicking on the +<guiicon>Back</guiicon><!--screenie --> button or go up one folder by clicking +the <guiicon>Up</guiicon><!--screenie --> button.</para> +</sect2> + +<sect2 id="the-navigation-panel"> +<title>The Navigation Panel (aka <quote>The Sidebar</quote>)</title> + +<indexterm><primary>Navigation Panel</primary></indexterm> +<indexterm><primary>Sidebar</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="konq-sidebar.png" format="PNG" /> +</imageobject> +<caption><para>The &konqueror; sidebar</para></caption> +</mediaobject> + +<para>Navigating through the folders by using +the folder view can become impractical. The sidebar provides +shortcuts and special functions that make it easier to +find what you are searching for.</para> + +<para>On the left edge of the sidebar be several buttons, each + with a different icon, such as the following:</para> + +<!-- TODO: Add screenies of what each of these buttons looks like --> +<variablelist> + +<varlistentry> +<term><guilabel>Bookmarks</guilabel></term> + +<listitem> +<para>As &konqueror; (the file manager) also serves as a very powerful +web browser, it also has a bookmark functionality. Here you will find the +same structure as in your <guimenu>Bookmarks</guimenu> menu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Devices</guilabel></term> + +<listitem> +<para>Next the sidebar provides a list of all known devices +on your computer. These devices can be either physical drives — +such as your hard disk, &CD-ROM; drive, or floppy disk drive — +or virtual <quote>drives</quote> — such as remote shares or hard disk partitions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>History</guilabel></term> + +<listitem> +<para>&konqueror; will remember the web pages you have visited and list them +either by date or alphabetically in a tree structure. You can select the +behavior by right clicking on the <guilabel>History</guilabel> item and +selecting <guimenu>Sort by</guimenu>. Left click on an item (⪚ +<guilabel>www.kde.org</guilabel>) and &konqueror; will show you the documents you have visited. Left +clicking on a document (⪚ <guilabel>index.html</guilabel>) will open +the web site in the folder view.</para> +<para>Right clicking on a history item, like <menuchoice><guimenu>www.kde.org</guimenu><guimenuitem>index.html</guimenuitem> +</menuchoice>, opens a slightly different popup menu: you will also find the +item <guimenuitem>New Window</guimenuitem>, which makes &konqueror; open the +site in a new window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Home Directory</guilabel></term> + +<listitem> +<para>The <guilabel>Home Directory</guilabel> item is in the sidebar's navigation +panel. You will find your home directory as the first entry. Below you will +find all folders of your home directory. Left clicking on any +folder in this view opens the folder in the folder view. Alternatively, you can also +work with the folders' context menus, create subfolders, and so on.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Sidebar Media Player</guilabel></term> + +<listitem> +<!-- TODO: think of a better solution for marking up the file --> +<!-- formats. It should probably involve entities --> +<para>Try dragging a music file (like <acronym>MP3</acronym>, Ogg, or +<literal role="extension">.wav</literal> files) +on the sidebar. The file will immediately be played.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Newsticker</guilabel></term> +<!-- I don't have this button. Ought to check what it depends on --> +<listitem> +<para>Newsticker will display a customisable list of news sources. Right-click +either on the <guilabel>Configure button</guilabel> or on one of the +newssource buttons (e.g. TDE News, which is usually predefined) to add a new +newsticker source.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Network</guilabel></term> + +<listitem> +<para>Here you can browse the services provided by other computers on +the network. The &lisa;-Daemon has to be started in order to work +correctly. The network browser allows you to see a variety of services +provided by a computer. You can easily browse <acronym>SMB</acronym> +shares, &HTTP; sites, or transfer files via the secure FISH +layer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Root Directory</guilabel></term> + +<listitem> +<para>Everything on a &UNIX;-based system is organized in a file +system tree. This tree must have a root and here it is. The +<guilabel>Root Directory</guilabel> function is like the +<guilabel>Home Directory</guilabel> function. The only difference is +that every folder is being displayed, not only your home +directory.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Services</guilabel></term> + +<listitem> +<para>This is somehow the "rest". Try browsing through the different +items. If an Audio &CD; is in your &CD; or <acronym>DVD</acronym> +drive you will be able to find everything on it and even more in the +<guilabel>Audio CD Browser</guilabel> item (you can even compress +audio files and save them on your hard drive with this +function).</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="filemanager-icons"> +<title>Icons</title> + +<para> +To select only one icon hold down the &Ctrl; key and click on the icon +you want to select. If you want to select more than one icon, hold +down &Ctrl; while you click on each of the items you want to select. +Once one or more icons are selected you can do what you want with +them. If you want to move or copy items, select them and then drag them +(with the left mouse button down) to the desired location. When +you release the mouse button a menu will come up offering you to +<guimenuitem>Move</guimenuitem><indexterm><primary>Moving +Files</primary></indexterm>, +<guimenuitem>Copy</guimenuitem><indexterm><primary>Copying +Files</primary></indexterm>, or <guimenuitem>Link</guimenuitem> the +selected items. You can also <guimenuitem>Cancel</guimenuitem> your +action. +</para> + +<para>Many other actions can be applied to the selected items by +right-clicking on one of the selected items, and choosing the action +from the menu which appears. (The exact contents of this menu depend on the +type of files selected, so it is called a <quote>context menu</quote>).</para> +</sect2> + +<sect2 id="links"> +<title>Links and Shortcuts</title> + +<para> +As already mentioned above you can link files or folders anywhere. It means +that the linked folder will appear and behave just like the original in +another location without consuming additional space on your harddrive. +So if you, for example, have a number of documents, and only a few are used +regularly, you can easily group them in a folder and create links in it. +</para> + +</sect2> + +<sect2 id="trash"> +<title>The Trash</title> + +<indexterm><primary>Trash</primary></indexterm> +<indexterm><primary><quote>Recycle Bin</quote></primary></indexterm> + +<para>Before a file is deleted in the &tde; file manager it will be +moved to the <filename>Trash</filename> folder to give you the +possibility of getting it back if you deleted it by accident. The +trash bin will show all deleted items. You can select the one to be +recovered and move it to its original place as described in <xref +linkend="filemanager-icons" />. If you right click on the trash bin and select +<guimenuitem>Empty trash bin</guimenuitem> the files in it will be +deleted permanently.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>The <ulink url="help:/konqueror">&konqueror; Handbook</ulink> +has much more information about the features available in +&konqueror;.</para> +</listitem> + +</itemizedlist> + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/titlebar-menu.png b/doc/khelpcenter/userguide/titlebar-menu.png Binary files differnew file mode 100644 index 000000000..d772e7995 --- /dev/null +++ b/doc/khelpcenter/userguide/titlebar-menu.png diff --git a/doc/khelpcenter/userguide/troubleshooting-network-x.docbook b/doc/khelpcenter/userguide/troubleshooting-network-x.docbook new file mode 100644 index 000000000..fd4610f2a --- /dev/null +++ b/doc/khelpcenter/userguide/troubleshooting-network-x.docbook @@ -0,0 +1,41 @@ +<sect1 id="troubleshooting-network-x"> +<sect1info> +<authorgroup> +<author>&J.Hall;</author> +</authorgroup> +</sect1info> +<title>Networking and X</title> +<para> +Misconfigured networking can often be the cause of &tde; applications launching slowly, or in the worst case not launching at all. Your &X-Server; has a very powerful client/server interface and is very network aware. +</para> +<para> + X uses the hostname to create both a unique key for authorization, and to figure out where (via $<envar>DISPLAY</envar>) to send + the actual windows it's drawing on screen. If your computer doesn't know it's own name, it will spend inordinate amounts of time + trying to look itself up, a fate you can avoid by simply teaching your computer what it's own name is. +</para> +<para> +Check your <filename>/etc/hosts</filename> file and ensure there is an entry for localhost that looks +something like this at the top of the file (after any comments). +</para> +<screen> +127.0.0.1 localhost +</screen> +<para> +You also should add your computers fully qualified domain name, short name, and it's usual ip address if it has a static ip. If your ip address is assigned dynamically using <acronym>DHCP</acronym> you can simply use the address for the loopback device. +</para> +<screen> +127.0.0.1 hal.btl hal (for dhcp) +192.168.0.1 hal.btl hal (static) +</screen> +<para> +Make sure that your firewall is not so restrictive that it stops packets to the loopback device. For example in iptables if the default rule on the <parameter>INPUT</parameter> chain for this device is set to anything other than <parameter>>ACCEPT</parameter> this will cause performance problems in X. To check this, you can type in: +</para> +<screen> +<prompt>%</prompt><userinput><command>iptables-save</command> <literal>|</literal> <command>grep</command> <option>lo</option></userinput> +<computeroutput><option>-A</option> <parameter>INPUT</parameter> <option>-i</option> <parameter>lo</parameter> <option>-j</option> <parameter>ACCEPT</parameter> +</computeroutput> +</screen> +<para> +The rule <computeroutput><option>-A</option> <parameter>INPUT</parameter> <option>-i</option> <parameter>lo</parameter> <option>-j</option> <parameter>ACCEPT</parameter></computeroutput> should always work, unless there are other misconfigured rules (Such as a <parameter>DROP</parameter> on the <parameter>OUTPUT</parameter> chain) +</para> +</sect1> diff --git a/doc/khelpcenter/userguide/troubleshooting-no-open.docbook b/doc/khelpcenter/userguide/troubleshooting-no-open.docbook new file mode 100644 index 000000000..80046478d --- /dev/null +++ b/doc/khelpcenter/userguide/troubleshooting-no-open.docbook @@ -0,0 +1,31 @@ +<sect1 id="troubleshooting-not-opening"> +<sect1info> +<authorgroup> +<author>&Lauri.Watts;</author> +</authorgroup> +</sect1info> +<title>When An Application Will Not Open</title> + +<para>Sometimes when you start an application, it does not open the expected +window. Here are some questions to answer and steps to help you figure out +what is wrong.</para> + +<variablelist> +<varlistentry> +<term>Did the application ever start, when launched in the same +manner?</term> +<listitem><para>If it did, for instance you have clicked an icon on your +desktop that previously worked, then it is unlikely to be a problem with the +launcher itself.</para> +<para>If, however, you normally start your application from an icon on +&kicker; and this time started it with a desktop icon, then it could simply +be that the launcher itself is wrong.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>But I can see the launch notification spinning cursor and taskbar entry. +</term> +<listitem><para>Foo</para></listitem> +</varlistentry> +</variablelist> +</sect1> diff --git a/doc/khelpcenter/userguide/under-the-hood.docbook b/doc/khelpcenter/userguide/under-the-hood.docbook new file mode 100644 index 000000000..0f7dbe111 --- /dev/null +++ b/doc/khelpcenter/userguide/under-the-hood.docbook @@ -0,0 +1,470 @@ +<chapter id="tinkering-under-the-hood"> + +<title>Tinkering Under the Hood of &tde;</title> + +<sect1 id="hand-editing-config-files"> + +<title>Hand-Editing Configuration Files</title> + +<sect2 id="hand-editing-intro"> +<title>Introduction</title> +<para>In &tde;, the configuration files are easy to edit with a simple +editor like &kate; as the configuration files are text files.</para> + +<para>An example of a text file:</para> + +<programlisting>[General] +AutoSave=1 +LastFile=/var/tmp/test.txt</programlisting> + +<para>The user-specific configuration files are stored in <filename +class="directory">.kde/share/config</filename> (replace +<filename>.kde</filename> with your $<envar>TDEHOME</envar> setting) and +the global ones are in the <filename +class="directory">share/config</filename> sub-directory of &tde;'s +installation path. (You can find this path by running the command +<command>tde-config --prefix</command>.) Their filenames typically +end in rc (without an initial period), for example <filename>kopeterc</filename>.</para> + +<warning><para> +Editing configuration files by hand can risk the stability of your +&tde; installation. Applications usually do not check what they read from the +configuration files. This means that they can be disturbed by what they +get as configuration and might even +crash.</para></warning> + +</sect2> + +<sect2 id="hand-editing-backups"> +<title>Backups</title> + +<para>So the first rule is to make a backup of your file before modifying +it. The backup is better stored outside any +<filename class="directory">.kde</filename> subdirectory +(or the corresponding $<envar>TDEHOME</envar> directory). Backups are anyway +a good idea in case of a major failure of &tde; that would +destroy important configuration files (for example your &kmail; settings, +which are in in the file <filename>kmailrc</filename>). +(Such a major failure should not happen but it still can happen.)</para> +</sect2> + +<sect2 id="hand-editing"> +<title>Editing</title> + +<para>So why would you want to touch the configuration files at all? Well, first you need it +when you want to enforce the KIOSK mode. Perhaps a developer has asked you +to add an entry to help him to solve a problem with the application. Perhaps you want to recover from +a problem without having to remove all the <filename +class="directory">.kde</filename> directory. Perhaps you want to learn more +about the depths of &tde;.</para> + +<para>Anyway, whatever your reason, you want to modify by hand a +configuration file.</para> + +<para>When planning to edit such a file, make sure that the application +using it is not running. If it is one of the basic configuration files, +consider editing the file while &tde; is not running at all.</para> + +<para>Ready? So make a backup of the file (Did I tell you this already?), +start you favorite editor (let us assume it is &kate;), load the file +(Be careful to load as UTF-8, &kate; displays it as +<quote>utf8</quote>).</para> + +<para>Now you have a file like:</para> + +<programlisting>[Group] +Key1=Value1 +Key2=Value2 +Key3=Value3</programlisting> + +<para>You can now modify it (with care!) and then save it (Be sure that it +is as <acronym>UTF-8</acronym> again).</para> + +<para>Now you can test the application and if the application does not run +correctly anymore, close the application and restore the backup of the +configuration file.</para> + +<!--<itemizedlist> +<title>Related Information</title> + + +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> has more +information about the &tde; directory structure, to help you find the +file you need to edit.</para> +</listitem> + +</itemizedlist>--> + +</sect2> + +</sect1> + +<sect1 id="scripting-the-desktop"> +<title>Scripting the Desktop</title> + +<para>&tde; provides a powerful interprocess communication system in +&DCOP;, the Desktop COmmunication Protocol. Using &DCOP;, you can +control a wide range of functions in &tde; from the command line or +from a script written in your favorite scripting language. You can +also get information out of &tde; applications: for example, several +&tde; media players provide methods to query the player for +information about the currently-playing track.</para> + +<para>Broadly speaking, each &tde; application provides one or more +&DCOP; <firstterm>interfaces</firstterm>, which in turn provide +methods (or, if you prefer, functions) that another application can +call. So, the first step in using &DCOP; is to find the appropriate +method for the task. The easiest way to do this is using the +<application>kdcop</application> frontend to the available &DCOP; +methods.</para> + +<para>Run <application>kdcop</application> from a &konsole; or the +mini-<acronym>CLI</acronym> (the window which pops up on <keycombo +action="simul">&Alt;<keycap>F2</keycap> </keycombo>). The +<application>kdcop</application> window shows the applications +currently running which provide &DCOP; interfaces, using a tree +view. +<!-- TODO: Describe the search lineedit thingy --> +In general, finding the correct method requires a little bit of +searching through the tree view, but a useful hint is that the +interface marked <quote>(default)</quote> usually contains the most +frequently-used functions.</para> + + + +<para>To test that the function does what we expect, double-click on +the <guilabel>setColor</guilabel> entry. To set the color +<varname>c</varname>, click on the color selector button, and choose a +color. Set whether the color should be color A with the +checkbox. Click <guilabel>OK</guilabel> and the background color is +set.</para> + +<para>To access the &DCOP; method from your favorite scripting +language, you can either use &DCOP; bindings, if available in the +tdebindings module, or call the <command>dcop</command> command-line +application. For simple usage, calling the +<command>dcop</command> command-line application is sufficient. To +call a &DCOP; method on the command line, we need to specify the +application and interface owning the method, the method itself, and +the arguments, in a form suitable for the shell.</para> + +<para>We specify the application, interface and method in that order, +followed by the arguments in the same order that they are shown in +<application>kdcop</application>. <command>dcop</command> +has plenty of other options: take a look at the output of +<userinput><command>dcop</command> +<option>--help</option></userinput>.</para> + +<para>That's enough theory: time for an example:</para> + +<example> +<title>A Background Color Changing Script with &DCOP;</title> + +<para>With the <command>dcop</command> command-line application and a +little bit of Perl, we're going to make a simple script which slowly +cycles the desktop background through the spectrum.</para> + +<para>Firstly, we look for the appropriate method with +<application>kdcop</application>. For this example, we'll short +circuit the searching, and go straight to it: the method we want is +<menuchoice><guimenu>kdesktop</guimenu><guisubmenu>KBackgroundIface</guisubmenu><guimenuitem>setColor</guimenuitem> +</menuchoice>. The arguments and return type of the function are shown +in the style of the C++ language. For +<methodname>setColor</methodname>, the arguments are a color, +<varname>c</varname>, which specifies the new background color, and a +boolean (true or false) value, <varname>isColorA</varname>, which +specifies whether the color is the first or second (this is useful for +setting gradients and so on).</para> + +<para>To use our <methodname>setColor</methodname> method on the +command line, we use the following: + +<screen> +<prompt>%</prompt> <userinput><command>dcop</command> kdesktop KBackgroundIface setColor '#ffffff' false</userinput> +</screen> +</para> + +<para>To specify the color, we used the +hexadecimal RGB value, as used in &HTML;. Note that it is enclosed in +single quotes to protect the <token>#</token> from the shell.</para> + +<para>To find the hexadecimal RGB value of a color, open any +color chooser dialog in a &tde; application (for example, in +&kcontrolcenter;, <menuchoice><guimenu>Appearance & Themes</guimenu><guimenuitem>Colors</guimenuitem> +</menuchoice>), select the color you want, and use the value given in +the <guilabel>HTML</guilabel> text box.</para> + + +<para>So, that's all we need from &DCOP;; now it's just a case of +writing a script around it. Here's a (very!) rough implementation: + +<programlisting> +<![CDATA[ +$min=49; # Minimum value of R, G, or B colour +$max=174; # Maximum value of R, G, or B colour +$step=5; # Amount to step colour by on each step +$sleeptime=15; # Interval in seconds between each step + +@start = ($max, $min, $min); +@colour = @start; + +while (1) { + foreach (0..5) { + my $which = $_ % 3; # Which colour (R, G or B) to change + my $updown = $_ % 2; # Whether to increase or decrease the colour value + do { + if ($updown == 0) { $colour[$which]+=$step; } + if ($updown == 1) { $colour[$which]-=$step; } + my $dcopcall=sprintf "dcop kdesktop KBackgroundIface setColor '#%x%x%x' true\n", @colour; + system($dcopcall); + sleep $sleeptime; + } while (($colour[$which] >= $min) and ($colour[$which] <= $max)); + } +} +]]> +</programlisting> +</para> + +<para>Just run the script with no arguments, and it will cycle the +background colour through a slightly muted spectrum until it is +killed. <foreignphrase>Voilà</foreignphrase>!</para> + +</example> + +<para>Of course, Perl isn't the only language you can use to write +scripts with &DCOP;—if you prefer shell scripting, that's +available too:</para> + +<example> +<title>Setting a background from the Internet</title> + +<para>The following script gets the main image from the <quote>User +Friendly</quote> comic strip and sets it as the desktop wallpaper, +using commonly available tools and a little bit of &DCOP;:</para> + +<programlisting> +<![CDATA[ +#!/bin/sh +COMICURL=`wget -qO - http://www.userfriendly.org/static/index.html | \ + grep Latest | sed -e "s,.*SRC=\",," -e "s,\">.*,,"` +TMPFILE=`mktemp /tmp/$0.XXXXXX` || exit 1 +wget -q -O $TMPFILE $COMICURL +dcop kdesktop KBackgroundIface setWallpaper $TMPFILE 1 +]]> +</programlisting> + +<para>The first line after the #!/bin/sh uses <command>wget</command> and some regular +expression magic to extract the image location from the main page's +&HTML; source. The second and third lines download the image, and +finally, <command>dcop</command> sets the downloaded image as +wallpaper.</para> + +</example> + + +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + + +<sect1 id="adding-extra-keys"> +<title>Adding Extra Keybindings to &tde;</title> + +<para>Many modern keyboards contain extra keys that are not by default +assigned to any action.</para> + +<para><quote>Multimedia</quote> keys often generate a signal, and can simply +be chosen as a keybinding within an application just like choosing any other +key. Some keys however, are not detected and pressing them in a +<guilabel>Configure Shortcuts</guilabel> has no effect.</para> + +<para>Some IBM laptops, for instance, have extra keys about the left and right +arrows, which look like <guiicon>page left</guiicon> and <guiicon>page +right</guiicon>.</para> + +<procedure> +<step><para>Use <command>xev</command> to find the code of the keys. In +this case, they are 233 and 234 <!-- TODO: Very briefly how to use xev here --> +</para></step> +<step><para>Choose key symbols. There are quite a range of these that are not +used by default, so many are free. You can find the list in +<filename>/usr/X11R6/include/X11/keysymdef.h</filename> (or its equivalent +on your system).</para></step> +<step><para>Create a file in your home directory called +<filename>.Xmodmap</filename>, and add to it the following:</para> +<screen>keycode 233 = Next_Virtual_Screen +keycode 234 = Prev_Virtual_Screen</screen> +</step> +<step><para>Run the command <userinput><command>xmodmap</command> +<filename>~/.Xmodmap</filename></userinput></para></step> +</procedure> + +<para>At this point, you should be able to run <command>xev</command> again +and see that the keys now generate the keysym that you assigned. You can now +simply assign them to any action as normal.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <command>xev</command> manpage. You can see this by typing +<userinput>man:/xev</userinput> into a &konqueror; window or by typing +<userinput><command>man</command> xev</userinput> into a terminal.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="keys-for-scripts"> +<title>Adding Keybindings for New Actions</title> + +<para>Most actions in either the desktop or in applications are readily +available to assign a keybinding to. If the action you want a +shortcut for is something you wrote yourself, or is otherwise not available, +you can still assign a shortcut.</para> + +<para>To bring together the two previous sections, perhaps you want to +assign an otherwise unused key on your keyboard to a script or dcop +command. Our example here will be to assign the two keys we added +in <xref linkend="adding-extra-keys"/> to go to the previous or +next virtual desktop, two functions for which you will need DCOP (as discussed in +<xref linkend="scripting-the-desktop"/>).</para> + +<para>This can be achieved easily using the following method:</para> + +<procedure> +<step> +<para>Open &kcontrol;, and in the <guilabel>Regional & Accessibility</guilabel> +section, select <guilabel>Input Action</guilabel></para> +</step> +<step> +<para>Choose <guibutton>New Action</guibutton></para> +</step> +<step> +<para>Name the new action, ⪚ <userinput>Next Virtual +Screen</userinput></para> +</step> +<step> +<para>Select <guilabel>Keyboard shortcut -> Command/URL (simple)</guilabel> +for the <guilabel>Action type:</guilabel></para> +</step> +<step> +<para>In the <guilabel>Keyboard Shortcut</guilabel> tab, click the button +you wish to use to trigger the command. For this example, you would press +the one with the <guiicon>Next Page</guiicon> picture on it. +<keysym>Next_Virtual_Screen</keysym> will appear in the key image.</para> +</step> +<step> +<para>In the <guilabel>Command/URL Settings</guilabel> tab, enter the +command to run in the field: <userinput><command>dcop twin default +nextDesktop</command></userinput></para> +</step> +</procedure> + +<para>Repeat the above with the <keysym>Prev_Virtual_Screen</keysym> key and +<userinput><command>dcop twin default +previousDesktop</command></userinput>.</para> + +<para>Now pressing the <keysym>Prev_Virtual_Screen</keysym> or +<keysym>Next_Virtual_Screen</keysym> will switch you to the previous or next +virtual desktop, respectively.</para> + +<para>Obviously you can assign any free key to any action.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>See the <application>KHotKeys</application> documentation by +looking it up in &khelpcenter;, or typing +<userinput>help:/khotkeys</userinput> in a &konqueror; +window.</para></listitem> +<listitem><para><xref linkend="adding-extra-keys"/></para></listitem> +<listitem><para><xref linkend="scripting-the-desktop"/></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="tdedebugdialog"> + +<title>&tdedebugdialog; - Controlling &tde;'s Debugging Output</title> + +<sect2 id="tdedebugdialog-basic-usage"> +<title>Basic Usage</title> + +<para>&tdedebugdialog; is not in the &kmenu; by default. You will need to run +it from the shell or from the mini-CLI <!-- link to CLI, for sure --> with +the command <userinput><command>tdedebugdialog</command></userinput>. +&tdedebugdialog; pops up a window with a long list of debugging areas. Each +area has a checkbox that you can check or uncheck <!-- perhaps +select/deselect --> in order to enable or disable debugging output for +that part of &tde;.</para> + +<para>The list of debugging areas is sorted numerically, not alphabetically, +so tdeio (127) comes before artskde (400). The numbers go up to 200000 or so, +but there are really only 400 areas. You don't have to scroll through the +entire list to find the area you need, though. There is a line edit <!-- +text-entry ? --> box at the top of the dialog where you can enter a part of +the name of the area you want. The list of entries that is displayed is +filtered to include only those debug areas that contain the text you have +entered. ⪚ entering <userinput>k</userinput> does not filter very much at +all, but entering <userinput>kont</userinput> <!-- that's "butt" in dutch, +haha --> will show you just the &kontact; debugging areas. As an even +quicker way of enabling or disabling debugging output, there are also +<guibutton>select all</guibutton> and <guibutton>deselect all</guibutton> +buttons which will cause &tde; to produce a mountain of debugging output, or +very little.</para> +</sect2> + +<sect2 id="tdedebugdialog-fullmode"> +<title>TDEDebugDialog in full mode</title> + +<!-- this text partly taken from the tdedebugdialog handbook --> + +<para>In full mode, which is what you get when you start tdedebugdialog as +<userinput><command>tdedebugdialog</command> +<option>--fullmode</option></userinput>, the same list of debugging areas +as in plain mode is available, but you can select only one at a time from a +drop-down <!-- combo? --> box. You may then independently set the output +for various types of messages: Information, Warning, Error and Fatal Error. +For each of these types, you can choose where the messages are sent. The +choices are:</para> + +<para>File, in which case you can enter a filename. This file is written into your +$<envar>HOME</envar> directory.</para> + +<para>Message Box. Each debugging message is displayed in an information dialog, +which you must <guibutton>OK</guibutton> to continue with the +application.</para> + +<para>Shell, the default entry. Messages are printed to stderr, and will appear + either in the shell window where the application was started, or +in <filename>.xsession-errors</filename>.</para> + +<para>Syslog. This sends each debugging message to the system's syslog facility, +which can perform its own processing of the message.</para> + +<para>None. This suppresses the output of this type of message.</para> + +<para>For messages generated by fatal errors, it is generally a bad idea to choose +None or Syslog, since in both cases you most likely will not see the message +and the application that encounters the fatal error will vanish without +leaving a clue as to why it vanishes. Whether or not the application will +vanish on fatal errors can be controlled by the checkbox <guilabel>abort on +fatal errors</guilabel>, which is checked by default — but you might +expect an application to crash (in a messy fashion) if a fatal error is +encountered anyway.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect2> +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/usenet.docbook b/doc/khelpcenter/userguide/usenet.docbook new file mode 100644 index 000000000..a307e45f3 --- /dev/null +++ b/doc/khelpcenter/userguide/usenet.docbook @@ -0,0 +1,233 @@ +<chapter id="usenet"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Usenet News</title> + +<para>Usenet newsgroups are forums in which you can post messages to discuss +various topics: almost any subject you like (and many you don't!) can +be found there. Although usenet has become less popular than it once +was, because of the increasing use of web forums, &etc;, it is still a +useful tool. &tde; provides a powerful usenet news reader called &knode;.</para> + +<para>You can find &knode; in the <guimenu>TDE</guimenu> Menu under the +<guisubmenu>Internet</guisubmenu> entry: the menu entry +<guimenuitem>&knode; (News Reader)</guimenuitem> launches the program.</para> + + +<para>The main window of &knode; should now be displayed on your +desktop as shown; on the first start, the settings dialog will be +invoked.</para> + +<screenshot> +<screeninfo>Setting up &knode;</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-start.png" format="PNG"/> </imageobject> +<textobject> +<phrase>&knode; after first start</phrase> +</textobject> +<caption> +<para>&knode; after first start</para> +</caption> +</mediaobject> +</screenshot> + +<sect1 id="knode-setting-your-identity"> +<title>Personal settings</title> + +<para>The first page of the settings dialog is for personal settings: </para> +<screenshot> +<screeninfo>Dialog for entering personal information</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-identity.png" format="PNG"/> </imageobject> +<textobject> +<phrase>Entering personal information</phrase> +</textobject> +<caption> +<para>Entering personal information</para></caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term> +<guilabel>Name</guilabel></term> +<listitem> +<para>In the field <guilabel>Name</guilabel>, enter your name. This +name will later appear in the newsgroups as sender, and can be seen by +anyone.</para> + +<para>Filling out the field <guilabel>Name</guilabel> is +mandatory.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<guilabel>Email address</guilabel></term> +<listitem> +<para>The email address you enter here will be used as sender in news +articles, &ie; as actual address of the author, in conjunction with +the real name (set in the field <guilabel>Name</guilabel>).</para> + +<para>Filling out the <guilabel>Email Address</guilabel> field is +mandatory.</para> + +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="knode-setting-the-news-account"> +<title>Configuring the news account</title> + + +<para>Now we must tell &knode; about where we get the news from or +where to send the articles to later on. In the list on the +right, there is an <guilabel>Accounts</guilabel> entry; click on it and choose the +<guilabel>Newsgroup servers</guilabel> tab, because we first want to configure +the news account: the list of accounts is still empty.</para> + +<para>To create a new account click on <guibutton>Add...</guibutton>. The +following dialog appears:</para> + +<screenshot> +<screeninfo>The <guilabel>New Account</guilabel> dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-news-account.png" format="PNG"/> </imageobject> +<textobject> +<phrase>The <guilabel>New Account</guilabel> dialog</phrase> +</textobject> +<caption> +<para>The <guilabel>New Account</guilabel> dialog</para> +</caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Name</guilabel></term> +<listitem> +<para>The <guilabel>Name</guilabel> field can be filled in as you +like; the text you enter will later be visible in the folder view. You +could, for example, enter the name of your Internet Provider; for our example we +enter the name <userinput>My News Account</userinput>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server</guilabel></term> +<listitem> + +<para>The next field is labelled <guilabel>Server</guilabel>. Unlike +the field <guilabel>Name</guilabel>, what you enter here is important. +The name of the news server is fixed and you should be able to get it +from your Internet service provider; if you do not know the name of +the news server, you should get it now: without this information you +cannot read any news. If your Internet service provider doesn't own a +news server you can use a public one (universities often provide +public news servers.)</para> + +<para>For our example configuration we enter the name +<userinput><systemitem +class="systemname">news.server.com</systemitem></userinput>; you will, +of course, enter the real name of your news server.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> +<para>You probably will not need to change this from the default in most +cases.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="knode-setting-the-mail-account"> +<title>Setting up the mail account</title> + +<para>Sometimes you need to answer to the author of an article +directly, without posting to the newsgroup; for example, when you want +to make a very personal comment or want to correct an error. If you +want to do this, select the <guilabel>Mail Server (SMTP)</guilabel> tab. The +following dialog box appears:</para> + +<screenshot> +<screeninfo>Dialog Box for setting up the mail account</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-mail-account.png" format="PNG"/> </imageobject> +<textobject> +<phrase>Setting up the mail account</phrase> +</textobject> +<caption> +<para>Setting up the mail account</para> +</caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Server</guilabel></term> +<listitem> +<para>The name (address) of your mail server as provided by your +Internet service provider or system administrator; all you have to do +here is enter the mail server's name in the +<guilabel>Server</guilabel> field.</para> + +<para>In our example we enter <userinput><systemitem +class="systemname">mail.server.com</systemitem></userinput></para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> + +<para>Again, you probably will not need to change the +<guilabel>Port</guilabel> setting.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>The comp.windows.x.kde newsgroup is the main user +support group for &tde; on usenet. You can find other resources for +getting help with &tde; in <xref linkend="getting-help"/>.</para> +</listitem> +<listitem><para><ulink url="http://gmane.org">Gmane</ulink> provides a +usenet frontend to many mailing lists, including most of the &tde; +lists, so you can read them with &knode;.</para> +</listitem> +</itemizedlist> + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/where-next.docbook b/doc/khelpcenter/userguide/where-next.docbook new file mode 100644 index 000000000..840bf3084 --- /dev/null +++ b/doc/khelpcenter/userguide/where-next.docbook @@ -0,0 +1,22 @@ +<chapter id="where-next"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Where To Next?</title> + +<para>Web Sites</para> + +<para>Books</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/windows-how-to.docbook b/doc/khelpcenter/userguide/windows-how-to.docbook new file mode 100644 index 000000000..25dc3ba80 --- /dev/null +++ b/doc/khelpcenter/userguide/windows-how-to.docbook @@ -0,0 +1,500 @@ +<sect1 id="windows-how-to-work"> + +<title>Windows, How To Work Them</title> + +<sect2 id="basic-window-management"> +<title>Basic Window Management</title> +<indexterm><primary>Window Management</primary></indexterm> + +<para>In computer terminology, a window is a rectangular area containing information +that can be moved around the desktop. +Each application running in &tde; uses at least one window and some +applications use more than one window. These windows are manipulated or controlled +in many ways to make the desktop useful. Here is a +typical window: +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="a-window.png" format="PNG"/> +</imageobject> +<textobject><phrase>A normal window</phrase> +</textobject> +</mediaobject> +</screenshot> +</para> + +<sect3 id="switching-between-windows"> +<title>Switching Between Windows</title> +<indexterm><primary>Focus (windows)</primary></indexterm> + +<para>A window must be active or receive the focus to be used. When first starting +an application the main window immediately receives the focus and is ready to use. +Only one window can be active at a time. The active window is the one that responds +to user actions and can be distinguished from other windows by the different colored +titlebar.</para> + +<para>The titlebar is the top bar of a window that displays the name and description +of the window. The default titlebar also contains the Minimize, Maximize, and Close buttons +on the far right side.</para> + +<para>With the &tde; default theme, the active window has a +<replaceable>light blue</replaceable> titlebar, and the inactive +windows have <replaceable>gray</replaceable> titlebars.</para> + +<para> +<indexterm><primary>Raising Windows</primary></indexterm> +To work in a different window requires activating that window. +There are two ways to do this: +<itemizedlist> + +<listitem> +<para>Use the mouse pointer to select a window. When selected the window receives the focus +and becomes active and will be raised to the foreground above other windows.</para> +</listitem> + +<listitem> +<para><indexterm><primary><keycombo +action="simul">&Alt;	</keycombo></primary></indexterm> +With the keyboard, press and hold either &Alt; key and press the 	 key. +A popup dialog appears with a list of available windows. The currently active window that +has the focus will be selected automatically in the list. While pressing the &Alt; key, +select a different window by again pressing the 	 key to scroll through the list. +Release the &Alt; key and the window that is selected in the list receives the focus +and becomes the active window.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<sect3 id="moving-windows"> +<title>Moving Windows</title> +<indexterm><primary>Moving Windows</primary></indexterm> + +<para>One way to organize the windows on a desktop is to move +them. There are three ways to move a window: +<itemizedlist> +<listitem> +<para>Select the window titlebar using the &LMB; and continue holding the &LMB;. When +selected in this manner, moving the mouse pointer moves the window. Release the mouse +button and the window remains at that position.</para> +</listitem> + +<listitem> +<para>Select the window titlebar using the &RMB;, which causes a popup menu to appear +as displayed in the following image. From the popup menu select <guimenuitem>Move</guimenuitem>. +The mouse pointer moves to the center of the window. Move the mouse pointer +to move the window. After moving the window to the desired +position, use the &LMB; to release the window.</para> +<indexterm><primary>Window Menu</primary></indexterm> + +<screenshot> +<screeninfo>The Window Menu</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="titlebar-menu.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>The Window Menu</phrase> +</textobject> +</mediaobject> +</screenshot> +</listitem> + +<listitem> +<para>Place the mouse pointer over the window to move. Press and hold either &Alt; key +and the &LMB;. The mouse pointer changes to a +compass. Moving the mouse then moves the window. Release the mouse +button to release the window. This method is +useful when the window titlebar has moved off the +screen and the previous methods cannot be used.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<sect3 id="resizing-windows"> +<title>Resizing Windows</title> + +<indexterm><primary>Resizing Windows</primary></indexterm> + +<para>The window size can be changed: bigger, smaller, wider, or taller. There +are two ways to resize a window. +Use either method: +<itemizedlist> +<listitem> +<para>Move the mouse pointer over one of the side borders of the window. The mouse pointer changes +into a horizontal double-headed arrow. Press and hold the &LMB; and drag the window border, +making the window bigger or smaller. Similarly, selecting the top or bottom +borders of the window will change the height of the window. +To concurrently change both width and height of a window, +move the mouse pointer over the corner of the +window. When the pointer becomes a diagonal double-headed arrow, select the border corner +and drag.</para> +</listitem> +<listitem> +<para>Use the left-most button on the window titlebar to display the +window menu. Choose the <guimenuitem>Resize</guimenuitem> entry, and +the mouse pointer will become a double-headed arrow. Move the mouse +pointer around to resize, and use the &LMB; to release the window.</para> +</listitem> +<listitem> +<para>When the window border or the button for the window menu are not visible, +usethe &Alt; key and &RMB;: Press and hold the &Alt; key and drag with +the &RMB;. The window will resize. Release the &RMB; when finsihed resizing.</para> +</listitem> +</itemizedlist> +</para> + +<para>Windows may be maximized in size to use the entire screen. Use the +<guibutton>Maximize<indexterm><primary>Maximizing +Windows</primary></indexterm></guibutton> button, which is located on the window titlebar, +the second button from the right. Selecting that button with the mouse +will force the window to resize as large as the screen allows in both +directions. Alternately, selecting that button with the &MMB;<indexterm><primary>Maximizing +Windows</primary><secondary>Vertically</secondary></indexterm> or the +&RMB;<indexterm><primary>Maximizing Windows</primary><secondary>Horizontally</secondary></indexterm> +will increase the window's size in only the vertical or horizontal direction, respectively.</para> + +</sect3> + +<sect3 id="hiding-windows"> +<title>Hiding Windows</title> +<indexterm><primary>Hiding Windows</primary></indexterm> + +<!-- TODO: Screenshot of the minimize button --> +<para> +<indexterm><primary>Minimize</primary></indexterm> +A window can be made to shrink out of view without closing the application. +There are two ways to shrink a window: minimizing and shading. To +minimize a window, select the <guibutton>Minimize</guibutton> button, +which is located on the window titlebar, third button from the right. The window will +not be displayed, but the application remains running as can be seen +in the taskbar on the panel. To display the window again, +use the mouse to select the respective rectangular button in the taskbar or use the <keycombo +action="simul">&Alt;	</keycombo><indexterm><primary><keycombo +action="simul">&Alt;	</keycombo></primary></indexterm> as described in <xref +linkend="switching-between-windows" />.</para> + +<para> +<indexterm><primary>Shade</primary></indexterm> +Shading windows is similar to minimizing, but the titlebar of the window +remains on the screen. To shade a window, use the mouse to "double-click" +on the titlebar. To restore the window, again "double-click" on the titlebar.</para> +</sect3> + +<sect3 id="cascade-windows"> +<title>Cascading Windows</title> + +<para>Sometimes you might have a whole lot of windows open and all over the place. By selecting to cascade windows &tde; will automatically line them up as a succession from the top-left of your screen. To use this option use your &MMB; on the desktop, and then select <guimenuitem>Cascade Windows</guimenuitem>.</para> + +</sect3> + +<sect3 id="unclutter-windows"> +<title>Uncluttering Windows</title> + +<para>By selecting to unclutter your opened windows &tde; will attempt to use the maximum available space of the desktop in order to display as much of each window as possible. For example, should you have four windows open and you request that they be uncluttered, they will each be placed in a corner of the desktop, regardless of where they were originally. To use this option once again use your &MMB; on the desktop and then select <guimenuitem>Unclutter Windows</guimenuitem>.</para> + +</sect3> + +<sect3 id="closing-windows"> +<title>Closing Windows</title> + +<indexterm><primary>Closing Windows</primary></indexterm> + +<para>When you finish using an application, you will want to stop +the application and close its window. Once again, you have the choice +of a few options: +<itemizedlist> +<listitem> +<para>Click on the right-most button on the window titlebar.<!-- TODO: --> +<!-- Screenie --> If you are editing a document with that application, +you will be asked whether you want to <guibutton>Save</guibutton> your +changes, <guibutton>Discard</guibutton> them, or +<guibutton>Cancel</guibutton> your command to close the application.</para> +</listitem> +<listitem> +<para>Use the <menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem> +</menuchoice> option on the menubar. You will be presented with the +same choice of <guibutton>Save</guibutton>, +<guibutton>Discard</guibutton>, or +<guibutton>Cancel</guibutton>.</para> +</listitem> + +<listitem> +<para> <mousebutton>Right</mousebutton>-click on the respective window in &kicker;, the &tde; panel, and then select <guimenuitem>Close</guimenuitem>. You will be prompted with an option to save any documents that were being edited.</para> +</listitem> + +<listitem> +<para>Press <keycombo action="simul">&Alt;<keycap>F4</keycap></keycombo><indexterm><primary><keycombo action="simul">&Alt;<keycap>F4</keycap> +</keycombo></primary></indexterm> +. Once again, the confirmation dialog will be shown if you +were editing any documents.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<!-- Let's try organising this a different way +<para>The bar along the top is called the titlebar, and contains most +of the things you'll need to manipulate the window. Let's take a +closer look: +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="titlebar.png" format="png"/> +</imageobject> +<textobject><phrase>A window titlebar</phrase> +</textobject> +</mediaobject> +</screenshot> +<note><para>This screenshot shows the titlebar which appears in the +default &tde; configuration. The exact appearance on your system may +be slightly different, but the functions are similar.</para> +</note> +--> + +<!-- TODO:Note &MMB; mouse button/&RMB mouse button on maximize for +vertical/horizontal maximization. Or is this advanced? --> + +</sect2> + +<sect2 id="advanced-window-management"> +<title>Advanced Window Management</title> + +<para>kstart</para> +<sect3 id="kstart"> + +<title>&kstart;</title> + +<para>The simplest way to access the advanced window management +facilities in &tde; is to use a little known +utility called &kstart;. &kstart; lets you control the way an application interacts with +the window manager. The command is usually +used to define special behavior for commonly-used applications, but +it can also be useful for integrating non-&tde; applications into your +desktop.</para> + +<para>Using &kstart; is easy: you simply put +<userinput><command>kstart</command></userinput> and some options +before a command. To begin, let's look at how we might use +&kstart; to customize the behaviour of a +&kcalc; window. The command we'll use is as follows: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--ontop</option> <option>--alldesktops</option> <option>kcalc</option></userinput></screen> +</para> + +<para>Hopefully the effect this command is +obvious - the kcalc window will stay on top of all +the others and be visible on every virtual desktop. A feature that is +less obvious is that this command will work with any NET compliant +environment, not just &tde;.</para> + +<para>We can pass arguments to programs we invoke with &kstart; as normal, for +example: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--skiptaskbar</option> <option>--desktop</option> 1 xmessage 'Hello World'</userinput></screen> + +</para> + +<para>This command displays <computeroutput>Hello +World</computeroutput> with <application>xmessage</application> and +ensures that the window will be shown on the first virtual desktop and +will be omitted from the taskbar. The fact that this program is +written using the Xt toolkit rather than being a native &tde; +application does not cause any problem for +&kstart;. Hopefully this illustrates how +&kstart; can be used to integrate foreign +applications into your &tde; desktop.</para> +</sect3> + +<sect3 id="special-window-settings"> +<title>Other Special Window Settings</title> +<para>While you can use &kstart; to assign particular window settings, &tde; also allows you to alter these — as well as other similar settings — from the program window itself. Simply select the left-most button in the window titlebar (or press <keycombo action="simul">&Alt;<keycap>F3</keycap></keycombo> after the window is focused), and then go to <menuchoice><guisubmenu>Advanced</guisubmenu><guimenuitem>Special Window Settings...</guimenuitem></menuchoice>. As you can see, from here you change various things from its geometry upon startup, to whether it should have a border or not.</para> +</sect3> + +<sect3 id="system-tray"> + +<title>The System Tray</title> + +<para>Now that we know how to customize the decoration of a window +let's take a look at another aspect of the desktop: the system +tray. The system tray is an area in which an application can display a +small window. It is used to display status information or provide +quick access to commands. A window that has an item in the system tray +usually disappears from the task manager when minimised with the tray +icon providing a replacement. Normally tray icons are specifically +developed as part of an application, but as with window decorations, +&tde; provides a tool for changing this: +<application>ksystraycmd</application>.</para> + +<para>To begin with, we'll take the standard application &kcalc; and turn +it into a system tray application. This is acheived with one simple +command: +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--title</option> 'kcalc' kcalc</userinput></screen> + +</para> + +<para>The icon shown in the tray is the one specified in the window +hints and will be updated if the icon changes. The window title is +shown as a tooltip if you hold the mouse pointer over the icon. +<application>ksystraycmd</application> follows standard &tde; +behaviour so the target window can be shown and hidden by clicking the +tray icon, and a standard context menu is available.</para> + +<screenshot> <mediaobject> <imageobject><imagedata +fileref="kcalc-systray.png"></imagedata></imageobject> +</mediaobject></screenshot> +</sect3> + +<sect3 id="more-complex-uses-of-ksystraycmd"> + +<title>More Complex Uses of +<application>ksystraycmd</application></title> + +<para>To illustrate the other features of +<application>ksystraycmd</application>, we'll use a more complicated example: a &konsole; window tracking the +<filename>.xsession-errors</filename> file (this is the log file that records what's +happening on your desktop). To begin with, we'll simply look at how +we can view this: +<screen><prompt>%</prompt> <userinput><command>konsole</command> <option>--icon</option> log <option>--caption</option> 'X Log' \ +<option>--nomenubar</option> <option>--notabbar</option> <option>--noframe</option> \ +<option>-e</option> tail -f ~/.xsession-errors</userinput></screen> +</para> + + <para>The <option>--caption</option> and <option>--icon</option> +arguments are provided as standard by &tde; applications. You can get +a full list of these global options by running an application with the +<option>--help-kde</option> and <option>--help-qt</option> +parameters. Here we give our &konsole; window the title 'X Log' and +the icon <quote>log</quote>. You can use these options with any &tde; application and +as mentioned above, <application>ksystraycmd</application> takes account of these when creating +the tray icon. The <option>-e</option> argument is specific to &konsole; and tells it +to run the <command>less</command> command. Despite its complexity, we can easily move +this window into the tray with <application>ksystraycmd</application>: + +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--hidden</option> <option>--title</option> 'X Log' \ +konsole --icon log --caption 'XLog' \ +--nomenubar --notabbar --noframe \ +-e tail -f .xsession-errors</userinput></screen> +</para> + + <para>In addition to being the +most complex command we've used, this example demonstrates the +<option>--hidden</option> option which starts the command with only the system tray +icon visible. This example achieves our aim of providing quick access +to the log file, but we can do things a little more efficiently if we +only run the konsole process when it is visible. The command we use +is +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--startonshow</option> \ + --<option>icon</option> log <option>--tooltip</option> 'X Log' \ +konsole --icon log --caption 'X Log' \ +--nomenubar --notabbar --noframe \ +-e tail -f ~/.xsession-errors</userinput></screen> +</para> + +<para>The addition of the <option>--startonshow</option> parameter tells +<application>ksystraycmd</application> to start with only the tray +icon visible (like the <option>--hidden</option> parameter), and to wait until the user +activates the tray icon before running the target command. We've also +used the <option>--quitonhide</option> parameter which tells <application>ksystraycmd</application> to terminate +the target app whenever its window is hidden. Using both these +parameters ensures that our &konsole; tray icon doesn't waste resources +when we aren't using it. Creating and destroying the target window as +we do here prevents the standard icon and title handling of +<application>ksystraycmd</application> from working, so we now need to +specify the initial icon and tooltip explicitly +too.</para> +</sect3> + +<sect3 id="improving-reliability"> + +<title>Improving Reliability</title> + +<para>In all of our previous examples we've relied on +&kstart; and +<application>ksystraycmd</application> to figure out which window we +want to affect, and unless we say otherwise, they assume that the first +window to appear is the one we want. This policy is usually OK because +we are starting the application at the same time, but it can fail +badly when lots of windows are appearing (such as when you log on). To +make our commands more robust we can use the +<option>--window</option> parameter. This specifies the title +of the target window. The following example uses the <option>--window</option> parameter +to ensure that a particular konsole window is affected: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--iconify</option> <option>--window</option> 'kstart_me' konsole --caption 'kstart_me' -e tail -f ~/.xsession-errors</userinput></screen> + +</para> + +<para>Here we've used the tried and tested technique of specifying a +title for both &kstart; and the target application. This is generally +the best way to use &kstart; and <application>ksystraycmd</application>. The <option>--window</option> argument is +supported by both &kstart; and <option>ksystraycmd</option> and can be regular expression +(⪚ <quote>window[0-9]</quote>) as well as a particular title. (Regular +expressions are a powerful pattern matching tool you'll find used +throughout &tde;.) </para> + +</sect3> + +</sect2> + +<sect2 id="using-multiple-desktops"> +<title>Using Multiple Desktops</title> + +<indexterm><primary>Virtual Desktops</primary></indexterm> +<indexterm><primary>Multiple Desktops</primary></indexterm> + +<para>Sometimes, one screen's worth is just not enough space. If you +use many applications at the same time, and find yourself drowning in +different windows, virtual desktops offer a solution. By default, +&tde; has four virtual desktops, each one of which is like a separate +screen: you can open windows, move windows around, and set backgrounds and +icons on each of the desktops. If you are familiar with the concept of +virtual terminals, you will have no trouble with &tde;'s virtual +desktops.</para> + +<sect3 id="switching-virtual-desktops"> +<title>Switching Virtual Desktops</title> +<para>One way to move to a different desktop is to use the desktop pager in the panel. +Use the mouse pointer and &LMB; to select the desired desktop.</para> +<para>Another way to move to a different virtual desktop, is using <keycombo action="simul">&Ctrl;	 +</keycombo> in the same way as you would use <keycombo action="simul">&Alt;	 +</keycombo> to switch between windows (refer to the <xref linkend="switching-between-windows"/>): +Hold down &Ctrl; and then press +	. A small popup window appears, showing the virtual desktops, +with one highlighted. When you release &Ctrl;, &tde; will switch to the +highlighted virtual desktop. To select a different desktop, hold down &Ctrl; +whle pressing 	 repeatedly. The selection moves +through the available desktops. When the desktop you want to switch to +is highlighted, release &Ctrl;.</para> + +<!-- TODO: Write about the desktop pager thing --> + +</sect3> + +<sect3 id="windows-and-virtual-desktops"> +<title>Windows and Virtual Desktops</title> +<para>You can move windows to different virtual desktops with the +<guisubmenu>To Desktop</guisubmenu> item in the window menu button. Use the &LMB; +to select the window menu button and select the desktop to which you want to move +the window. You can make the window appear on all desktops with the <guimenuitem>All +Desktops</guimenuitem><indexterm><primary>Sticky +Windows</primary></indexterm> item.</para> + +<!-- Add links to "further reading" here +<itemizedlist> +<title>Related Information</title> +<listitem><para></para> +</listitem> +</itemizedlist> + +--> +</sect3> + + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/userguide/your-tde-account.docbook b/doc/khelpcenter/userguide/your-tde-account.docbook new file mode 100644 index 000000000..96ec4b713 --- /dev/null +++ b/doc/khelpcenter/userguide/your-tde-account.docbook @@ -0,0 +1,62 @@ +<sect1 id="account-intro"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>About Your &tde; Account</title> + +<para>&tde; stores information about your personal settings in a few +different places: + +<itemizedlist> +<listitem><para>The hidden directory <filename>.kde</filename> (note the +period at the beginning), located in your home directory, contains a +large number of files that store &tde; settings. Some subdirectories +you may find useful are:<filename>.kde/share/config</filename>, which +contains configuration files for individual applications; +<filename>.kde/Autostart</filename>, which contains links to +applications which should start each time you start &tde;; and +<filename>.kde/share/apps/tdeabc</filename>, where your address book is +stored.</para> +</listitem> +<!-- FIXME: Apparently TDEDIR and TDEDIRS are deprecated. I need to --> +<!-- get the truth on this --> +<listitem><para>The environment variables <envar>TDEDIR</envar> and +<envar>TDEDIRS</envar> tell &tde; where its files are stored. You will +usually only need to set <envar>TDEDIR</envar> to the directory in which +&tde; is installed, but sometimes you might have other &tde; +programs installed elsewhere: in this case, you can use the +<envar>TDEDIRS</envar> environment variable. Set +<envar>TDEDIRS</envar> to a list of all the directories containing +&tde; programs, separated by commas. For example, if you have &tde; +programs in both <filename>/usr/local/kde</filename> and +<filename>/home/phil/kde</filename>, you can use <userinput>export +TDEDIR=/usr/local/kde,/home/phil/kde</userinput> if you use +<application>bash</application> or <userinput>setenv +TDEDIR=/usr/local/kde,/home/phil/kde</userinput> if you use sh. +</para> +</listitem> +</itemizedlist> +</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> contains +more information about the directories that &tde; uses.</para> +</listitem> +</itemizedlist> + + +</sect1> |
