diff options
Diffstat (limited to 'doc')
48 files changed, 3560 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6812bd2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/kate-plugins/Makefile.am b/doc/kate-plugins/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kate-plugins/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kate-plugins/configure_insertcommand.png b/doc/kate-plugins/configure_insertcommand.png Binary files differnew file mode 100644 index 0000000..af05441 --- /dev/null +++ b/doc/kate-plugins/configure_insertcommand.png diff --git a/doc/kate-plugins/filetemplates.docbook b/doc/kate-plugins/filetemplates.docbook new file mode 100644 index 0000000..74ee3cb --- /dev/null +++ b/doc/kate-plugins/filetemplates.docbook @@ -0,0 +1,323 @@ +<chapter id="filetemplates"> + <chapterinfo> + + <title>File Templates</title> + + <authorgroup> + <author> + <firstname>Anders</firstname> + <surname>Lund</surname> + <affiliation> + <address>&Anders.Lund.mail;</address> + </affiliation> + </author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + </authorgroup> + <date>2006-01-10</date> + <releaseinfo>0.1</releaseinfo> + + <keywordset> + <keyword>KDE</keyword> + <keyword>kate</keyword> + <keyword>kdeaddons</keyword> + <keyword>template</keyword> + <keyword>macro</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <para>The File Templates plug-in allows you to create files based on other + files. You can use any file as a template, which will create a copy of the + file with an empty &URL;, or use a special template file which may contain + macros to fill in information like your name and email address, the + current date and so on, and position the cursor at a + convenient position in the new file.</para> + <para>Furthermore, templates located in the template folder will + be presented in the menu item + <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice>.</para> <para>The plug-in also + provides a method to easily create a new template + from an open document.</para> + <para>The template folder is part of the &kde; file system, and + consists of at least + KDEDIR/share/applications/kate/plugins/katefiletemplates/templates and + KDEHOME/share/applications/kate/plugins/katefiletemplates/templates. If your + KDEDIRS environment variable contains additional directories, those are + searched for a similar subdirectory as well. If equally named templates are + found, the one in the local (KDEHOME) folder is chosen.</para> + <sect1 id="katefiletemplates-menu"> + <title>Menu Structure</title> + + <variablelist> + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenu>New From Template</guimenu> + <guimenuitem>Any File...</guimenuitem> + </menuchoice> + </term> + <listitem><para>Presents you with Open File dialog that allows + you to use any file as a template. If the chosen file has the + extension <filename>katetemplate</filename> it will be parsed + for template information and macros.</para></listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenu>New From Template</guimenu> + <guimenuitem>Use Recent</guimenuitem> + </menuchoice> + </term> + <listitem><para>Presents a list of files recently used as + templates, represented by their &URL;.</para></listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>New From Template</guimenuitem> + </menuchoice> + </term> + <listitem><para>The remainder of submenus contains links to + templates. Click a menuitem to create a file as described by + the menu item text.</para></listitem> + </varlistentry> + + <!-- Settings menu --> + + <varlistentry> + <term> + <menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage + Templates...</guimenuitem></menuchoice></term> + <listitem><para>This will launch a dialog with a list of all templates + found within the template directories, along with options to add, + edit or remove templates.</para></listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="katefiletemplates-use"> + <title>Using a &kate; Template</title> + <para>When creating a file from a template that contain template + macros, some macros appears as editable variables in the text. Such + variables appears as underlined words in the text.</para> + <para>The first variable will be selected, so you just have to type to edit + it.If the document text contains more instances of the same variable, + they are changed as you edit. To move to the next editable variable, + press the TAB key. When the last variable is edited, the list is + dropped, and your TAB key works as normal.</para> + </sect1> + + <sect1 id="katefiletemplates-create"> + <title>Creating your own templates</title> + <para>To create a new template, use the + <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Manage Templates</guimenuitem></menuchoice> Item to launch + the template management dialog. In that, click + <guibutton>New...</guibutton> to launch the File Template Wizard. You + will be asked for an optional file to turn into a template and prompted + for template information settings, and a template file will be created for + you.</para> <para>Alternatively, you can create a template manually by + adding template information to the top of any file, add text and macros, + and save it with the <filename>katetemplate</filename> extension.</para> + <para>The template menu gets automatically updated if you chose to store + your template in the template directory.</para> + </sect1> + + <sect1 id="katefiletemplates-edit"> + <title>Editing templates</title> + <para>To edit a template, use the + <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Manage Templates...</guimenuitem></menuchoice>. Select the + template you want to work on and click <guibutton>Edit...</guibutton>, + and the template file will be opened. Close the dialog, edit the template + file as desired, save it and close it. Changes to templates takes + immediate effect, you can activate the template to test your changes after + saving it.</para> + </sect1> + + <sect1 id="katefiletemplates-format"> + <title>The &kate; Template Format</title> + <para>If you use files with the extension + <filename>katetemplate</filename>, they will be parsed for template + information, macros and a cursor position.</para> + + <sect2 id="katefiletemplates-template-info"> + <title>Template information</title> + <para>While reading in the file, the parser keeps + lines beginning with the phrase + <constant>katetemplate:</constant> and searches them for + template information in the form VARIABLENAME=VALUE. The first line not + starting with <constant>katetemplate:</constant> will be taken as the + start of the template contents. VALUE may contain any character but + equal sign (=). Legal variable names are: + <variablelist> + <varlistentry> + <term><varname>Template</varname></term> + <listitem><para>This is the template name, displayed in the + <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice> menu.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>Group</varname></term> + <listitem><para>The group places the template in a submenu of + the <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice> menu.</para></listitem> + </varlistentry> + <varlistentry><term><varname>Name</varname></term> + <listitem><para>This is the name that will be set for the + document, and displayed in the file list and title bar. If the + name contains <userinput>%N</userinput> that will be replaced + with a number, increasing if more documents has the same + name.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>Highlight</varname></term> + <listitem><para>The plug-in will try to set the Highlight for + the new document to the value of this variable. The value + should be the name, as found in the + <menuchoice><guimenu>Tools</guimenu> + <guimenuitem>Highlighting</guimenuitem> + </menuchoice>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Description</varname></term> + <listitem><para>A short informative description of the + template. This is currently used to set a Whatsthis string for + the menu item, but may be used for more purposes in the + future.</para></listitem> + </varlistentry> + <varlistentry><term>Author</term> + <listitem><para>A string identifying the author, for example + in the form <userinput>Name <email address></userinput>. + This is currently used to set a Whatsthis string for the menu + item, but may be used for more purposes in the + future.</para></listitem> + </varlistentry> + </variablelist> + </para> + + </sect2> + + <sect2 id="katetemplates-macros"> + <title>Template Macros</title> + + <para>While parsing the template contents, macros in the form + <userinput>%{NAME}</userinput> or <userinput>${NAME}</userinput> are + expanded. If you use the <userinput>$</userinput> prefix, the + expanded macro will be treated as a editable variable when a document + is created from the template, whereas if you use + <userinput>%</userinput> it is not, unless expanding failed.</para> + <para>The following macros are expanded: + <variablelist> + <varlistentry><term>time</term> + <listitem><para>Expands to the current time in your locale + format.</para></listitem> + </varlistentry> + <varlistentry> + <term>date</term> + <listitem><para>Expands to the current date in short + format.</para></listitem> + </varlistentry> + <varlistentry> + <term>datetime</term> + <listitem><para>Expands to the current date and time, + formatted as a string according to your + locale.</para></listitem> + </varlistentry> + <varlistentry> + <term>year</term> + <listitem><para>The current year as a four digit + number.</para></listitem> + </varlistentry> + <varlistentry> + <term>month</term> + <listitem><para>The full name of the current month, according + to your locale.</para></listitem> + </varlistentry> + <varlistentry><term>day</term> + <listitem><para>Expands to the current day of the month.</para> + </listitem> + </varlistentry> + <varlistentry><term>hostname</term> + <listitem><para>Expands to the 'hostname' of your computer.</para> + </listitem> + </varlistentry> + <varlistentry><term>index</term> + <listitem><para>Expands to 'i'.</para></listitem> + </varlistentry> + <varlistentry><term>fullname</term> + <listitem><para>Expands to your full name, as defined by the + owner addressee in your standard &kde; + addressbook.</para></listitem> + </varlistentry> + <varlistentry><term>firstname</term> + <listitem><para>Expands to your first name, as defined in the owner + addressee in your standard &kde; addressbook.</para> + </listitem> + </varlistentry> + <varlistentry><term>lastname</term> + <listitem><para>Expands to your last name, as defined in the owner + addressee in your standard &kde; addressbook.</para> + </listitem> + </varlistentry> + <!-- <varlistentry> + <term>username</term> + <listitem><para>Expands to your username.</para></listitem> + </varlistentry> --> + <varlistentry> + <term>email</term> + <listitem><para>Expands to your email address, as defined by + the owner address in your standard &kde; + addressbook.</para></listitem> + </varlistentry> + <!--<varlistentry> + <term>organisation</term> + <listitem><para>This is your organisation, as defined by + the owner address in your standard KDE + addressbook.</para></listitem> + </varlistentry>--> + </variablelist> + </para> + <para>Any macro not in the above list is treated as a editable variable + no matter the prefix. + If the same variable occurs multiple times in the template, they can be + edited at once after creating a document from the template.</para> + </sect2> + + <sect2 id="katefiletemplates-cursor"> + <title>Setting the cursor position</title> + <para>The special macro <userinput>${cursor}</userinput> will be replaced + with a vertical bar and added to the end of the list of editable variables, + independent on its location in the text.</para> + </sect2> + + </sect1> + + <sect1 id="katefiletemplates-thanks-and-acknowledgements"> + <title>Thanks and Acknowledgments</title> + + <para> + &kate; Plug-in <quote>File Templates</quote> copyright 2004 &Anders.Lund; + &Anders.Lund.mail;. + </para> + + <para> + Documentation copyright 2004 &Anders.Lund; + </para> + + <!-- TRANS:CREDIT_FOR_TRANSLATORS --> + + <!-- &underFDL; --> + &underGPL; + + </sect1> +</chapter> + +<!-- kate: word-wrap on; space-indent on; indent-width 2; -->
\ No newline at end of file diff --git a/doc/kate-plugins/htmltools.docbook b/doc/kate-plugins/htmltools.docbook new file mode 100644 index 0000000..e8c48fa --- /dev/null +++ b/doc/kate-plugins/htmltools.docbook @@ -0,0 +1,84 @@ +<chapter id="htmltools"> +<chapterinfo> + +<title><acronym>HTML</acronym> Tools </title> + +<authorgroup> +<author> +<firstname>Francis</firstname> +<surname>Giannaros</surname> +<affiliation> +<address><email>[email protected]</email></address> +</affiliation> +</author> +</authorgroup> +<date>2002-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +A plugin to help with the insertion of &HTML; elements. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>html</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin will open a dialog which will prompt your for a &HTML; +tag +name. +Attributes and values to be put in the opening tag should be entered +<userinput><replaceable>attribute-name</replaceable>="<replaceable>attribute-value</replaceable>"</userinput>. +After pressing &Enter;, the opening -- and respective closing -- tag +will be placed into the document.</para> + +<sect1 id="htmltools-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>HTML Tag...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will open the dialogue as described above.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="htmltools-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>HTML Tools</quote> copyright 2002 Joseph Wenninger +<email>[email protected]</email>. +</para> + +<para> +Documentation copyright 2005 Francis Giannaros +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/doc/kate-plugins/index.docbook b/doc/kate-plugins/index.docbook new file mode 100644 index 0000000..e927cc9 --- /dev/null +++ b/doc/kate-plugins/index.docbook @@ -0,0 +1,131 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY kappname "&kate;"> + <!ENTITY doc-filetemplates SYSTEM "filetemplates.docbook"> + <!ENTITY doc-htmltools SYSTEM "htmltools.docbook"> + <!ENTITY doc-insertcommand SYSTEM "insertcommand.docbook"> + <!ENTITY doc-openheader SYSTEM "openheader.docbook"> + <!ENTITY doc-projectmanager SYSTEM "projectmanager.docbook"> + <!ENTITY doc-textfilter SYSTEM "textfilter.docbook"> + <!ENTITY doc-xmltools SYSTEM "xmltools.docbook"> + <!ENTITY doc-xmlcheck SYSTEM "xmlcheck.docbook"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kate; Plugins Handbook</title> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<date>2006-02-24</date> +<releaseinfo>3.5.1</releaseinfo> <!-- Used KDE version here --> + +<copyright> +<year>2001</year> +<year>2002</year> +<holder> </holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +This is the handbook for the plugins for &kate;, &kde;'s Advanced Text +Editor. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>Kate</keyword> +<keyword>Plugins</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>&kate; plugins</title> + +<para> +&kate; plugins are additional functions for the &kate; editor. They can +add extra menus and shortcuts, and extend &kate;'s features. You can +install as many or as few as you like, from within &kate;. +Open &kate;'s configuration dialog with +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Select <menuchoice><guimenu>Application</guimenu><guimenuitem>Plugins</guimenuitem></menuchoice> to +choose the wanted plugins. +</para> + +<para> +More information on using &kate; and enabling the plugins you want is +available in the &kate; handbook. +</para> + +<para> +The plugins installed in this handbook are: +</para> + +<itemizedlist> +<listitem> +<para><link linkend="xmltools">&XML; Completion</link></para> +</listitem> +<listitem> +<para><link linkend="xmlcheck">&XML; Validation</link></para> +</listitem> +<listitem> +<para><link linkend="insertcommand">Insert Command</link></para> +</listitem> +<listitem> +<para><link linkend="htmltools">&HTML; Tools</link></para> +</listitem> +<listitem> +<para><link linkend="openheader">Open Header</link></para> +</listitem> +<listitem> +<para><link linkend="textfilter">Text Filter</link></para> +</listitem> +<listitem> +<para><link linkend="filetemplates">File Templates</link></para> +</listitem> +</itemizedlist> + +</chapter> + +&doc-xmltools; +&doc-xmlcheck; +&doc-insertcommand; +&doc-htmltools; +&doc-openheader; +&doc-textfilter; +&doc-filetemplates; + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +Copyrights for each applet is listed in the applicable chapter. +</para> + +&underFDL; +&underGPL; + +</chapter> + +<!-- +<appendix id="installation"> +<title>Installation</title> +<para>To be written +</para> +</appendix> +--> + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> diff --git a/doc/kate-plugins/insertcommand.docbook b/doc/kate-plugins/insertcommand.docbook new file mode 100644 index 0000000..eeafe7e --- /dev/null +++ b/doc/kate-plugins/insertcommand.docbook @@ -0,0 +1,150 @@ +<chapter id="insertcommand"> +<chapterinfo> + +<title>Insert Command</title> + +<authorgroup> +<author> +<firstname>Anders</firstname> +<surname>Lund</surname> +<affiliation> +<address>&Anders.Lund.mail;</address> +</affiliation> +</author> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> +<para> +The <quote>Insert Command</quote> plugin allows you to insert shell +command output into a document open in &kate;. +</para> +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>insert</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>The <quote>Insert Command</quote> plugin allows you to insert +shell command output into a document open in &kate;.</para> + +<para>First enable the <quote>Insert Command</quote> plugin by using the +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +&kate;...</guimenuitem></menuchoice> dialog and checking <guilabel>&kate; +InsertCommand</guilabel> in in the <guilabel>Application</guilabel> +<guilabel>Plugins</guilabel> section and close the dialog.</para> + +<sect1 id="insertcommand-fund"> +<title>Onscreen Fundamentals</title> + +<para> +<!-- Basics of using this plugin --> To use the plugin, select +<guimenu>Insert Command...</guimenu> from the <guimenu>Tools</guimenu> +menu, which will present you with a small dialog for entering the +command, choosing a working folder and selecting whether to include +errors (STDERR output) in the inserted text. You can also have the +command string printed above the output. +</para> + +<mediaobject> +<imageobject><imagedata format="PNG" fileref="insertcommand.png"/></imageobject> +<textobject> +<phrase>The Insert Command Dialog</phrase> +</textobject> +</mediaobject> + +<para>The plugin can remember a number of commands as chosen in the +configuration page. These are used for autocompletion, and can be +selected from a list in the command entry. </para> + +<para>By default, the command will be run in the working folder of the +kate process, which is usually your home folder. This can be changed +in the configuration page for the plugin. </para> + +<para>Note that any shell command that requires user input (for +example passwd) or uses a ncurses interface or something similar (for +example top) will fail to produce the expected output. </para> + +</sect1> + +<sect1 id="insertcommand-config"> +<title>Configuration</title> + +<para> +To configure the <quote>Insert Command</quote> +plugin, open the &kate; configuration dialog from the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kate;...</guimenuitem></menuchoice> menu and choose +<menuchoice><guimenuitem>Plugins</guimenuitem><guilabel>Insert Command +</guilabel></menuchoice>. </para> + +<mediaobject> +<imageobject><imagedata format="PNG" +fileref="configure_insertcommand.png"/></imageobject> +<textobject> +<phrase>The Insert Command Configuration Tab</phrase> +</textobject> +</mediaobject> + +<para> +The following configuration options are available: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Number of commands to remember</guilabel></term> +<listitem> +<para>This setting is presented as a spinbox which you can set to the +number of commands to be remembered. Any number from 0 to 99 is +legal. Default is 20.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Default Working Folder</guilabel></term> +<listitem> +<para>This setting, presented as a set of radio buttons, allows you to +decide how the working folder of a command is chosen. The options are +the working folder of the &kate; process (usually your home folder when &kate; is started from the K menu), the folder of the document (if any, otherwise the +above option is used) or the working folder of the last command run in +the plugin. </para> +</listitem> +</varlistentry> + +</variablelist> + + +</sect1> + +<sect1 id="insertcommand-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>Insert Command</quote> copyright 2001 Anders Lund +&Anders.Lund.mail;. +</para> + +<para> +Documentation copyright 2001 &Anders.Lund; &Anders.Lund.mail; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/insertcommand.png b/doc/kate-plugins/insertcommand.png Binary files differnew file mode 100644 index 0000000..1d756be --- /dev/null +++ b/doc/kate-plugins/insertcommand.png diff --git a/doc/kate-plugins/openheader.docbook b/doc/kate-plugins/openheader.docbook new file mode 100644 index 0000000..60aed58 --- /dev/null +++ b/doc/kate-plugins/openheader.docbook @@ -0,0 +1,49 @@ +<chapter id="openheader"> +<chapterinfo> + +<title>Open Header</title> + +<!-- +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation> +<address><email> </email></address> +</affiliation> +</author> +</authorgroup> +<date>2001-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +Note about open header +</para> +</abstract> +--> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>header</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The &kate; plugin <quote>Open Header</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts <email>[email protected]</email>, &kde;'s +Documentation Team coordinator. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/textfilter.docbook b/doc/kate-plugins/textfilter.docbook new file mode 100644 index 0000000..1d628c5 --- /dev/null +++ b/doc/kate-plugins/textfilter.docbook @@ -0,0 +1,50 @@ +<chapter id="textfilter"> +<chapterinfo> + +<title>Text Filter</title> + +<!-- +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation> +<address><email> </email></address> +</affiliation> +</author> +</authorgroup> +<date>2001-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +Note about text filter plugin +</para> +</abstract> +--> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>text</keyword> +<keyword>filter</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The &kate; plugin <quote>Text Filer</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts <email>[email protected]</email>, &kde;'s +Documentation Team coordinator. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/xmlcheck.docbook b/doc/kate-plugins/xmlcheck.docbook new file mode 100644 index 0000000..0156509 --- /dev/null +++ b/doc/kate-plugins/xmlcheck.docbook @@ -0,0 +1,102 @@ +<chapter id="xmlcheck"> +<chapterinfo> + +<title>&XML; Validation</title> + +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation> +<address>&Daniel.Naber.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> + +<para>This plugin checks &XML; files for well-formedness and validity.</para> + +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>xml</keyword> +<keyword>DTD</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin checks the current file. A list of warnings and errors +will appears at the bottom of &kate;'s main window. You can click on an error message +to jump to the corresponding place in the file. If the file has a <quote>DOCTYPE</quote> +the DTD given with this doctype will be used to check the file for validity. The +DTD is expected at a position relative to the current file, ⪚ if the doctype +refers to <quote>DTD/xhtml1-transitional.dtd</quote> and the file is <filename>/home/peter/test.xml</filename> +the DTD is expected to be located at <filename>/home/peter/DTD/xhtml1-transitional.dtd</filename>. +However, remote DTDs specified via http are supported.</para> + +<para>If the file has no doctype it will be checked for well-formedness.</para> + +<para>To learn more about &XML; check out the <ulink url="http://www.w3.org/XML/"> official W3C &XML; pages</ulink>.</para> + +<para>Internally this plugin calls the external command <command>xmllint</command>, which +is part of libxml2. If this command is not correctly installed on your system, the plugin +will not work.</para> + +<note><para>A temporary file needs to be written to the same folder as the file +that should be checked, so you need to have write access to that folder.</para></note> + +<para>To load this plugin open &kate;s configuration dialog under <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Then select <guilabel>Kate XML Validation</guilabel> which will appear +in the <guilabel>Application</guilabel>/<guilabel>Plugins</guilabel> section and close the dialog. +</para> + +<sect1 id="xmlcheck-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>XML</guimenu> +<guimenuitem>Validate XML</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will start the check, as described above.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmlcheck-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>XML Validation</quote> copyright 2002 &Daniel.Naber; +&Daniel.Naber.mail;. +</para> + +<para> +Documentation copyright 2002 &Daniel.Naber; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/xmltools.docbook b/doc/kate-plugins/xmltools.docbook new file mode 100644 index 0000000..fcbadd2 --- /dev/null +++ b/doc/kate-plugins/xmltools.docbook @@ -0,0 +1,186 @@ +<chapter id="xmltools"> +<chapterinfo> + +<title>&XML; Completion</title> + +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation> +<address>&Daniel.Naber.mail;</address> +</affiliation> +</author> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> + +<para>This plugin supports writing &XML; files by listing allowed tags +and more.</para> + +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>xml</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin gives hints about what is allowed at a certain position in +an &XML; file, according to the file's DTD. It will list possible +elements, attributes, attribute values or entities, depending on the +cursor position (⪚ all entities are listed if the character on the left +of the cursor is <quote>&</quote>). It's also possible to close the nearest +open tag on the left.</para> + +<para>The <acronym>DTD</acronym> must exist in &XML; format, as produced by the Perl program +<command>dtdparse</command>. We will call a DTD in this format <quote>meta DTD</quote>. +Some meta DTDs are supplied. They are installed in +<filename class="directory">$KDEDIR/share/apps/katexmltools/</filename>, +which is also the default folder when you choose +<guimenuitem>Assign Meta DTD...</guimenuitem>. +To produce your own meta DTDs, get <command>dtdparse</command> from +<ulink url="http://dtdparse.sourceforge.net">http://dtdparse.sourceforge.net</ulink>.</para> + +<sect1 id="xmltools-how-to-use"> +<title>How to Use</title> + +<para>Start &kate; and open the configuration dialog under <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Then select <guilabel>Kate XML Completion</guilabel> which will appear +in the <guilabel>Application</guilabel>/<guilabel>Plugins</guilabel> section and close the dialog. After +that, select <menuchoice><guimenu>XML</guimenu><guimenuitem>Assign Meta DTD...</guimenuitem></menuchoice>. +If your document contains no <quote>DOCTYPE</quote> or the doctype is unknown, you'll have to +select a meta DTD from the file system. Otherwise the meta DTD that +matches the current document's DOCTYPE will be loaded automatically.</para> + +<para>You can now use the plugin while typing your text:</para> + +<variablelist> + +<varlistentry> +<term>< (less than key)</term> +<listitem><para>This will trigger a list of possible elements unless the +cursor is inside a tag already. Note that you currently cannot use +this to insert the top level element (⪚ <quote><html></quote>).</para></listitem> +</varlistentry> + +<varlistentry> +<term>" (quote key)</term> +<listitem><para>The quote key will trigger a list of possible attribute +values (if there are some) if you are inside a tag.</para></listitem> +</varlistentry> + +<varlistentry> +<term>(space key)</term> +<listitem><para>This key will trigger a list of possible attributes for the +current element if you are inside a tag.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>& (ampersand key)</term> +<listitem><para>This key will trigger a list of named entities.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmltools-features-and-limitations"> +<title>Features and Limitations</title> + +<para>You can test all functions and limitations by loading +<filename>$KDEDIR/share/apps/katexmltools/testcases.xml</filename> +into &kate; and following the instructions. Note that working with +more than one view per document is not yet correctly supported by +this plugin.</para> + +</sect1> + + +<sect1 id="xmltools-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Return</keycap></keycombo> +</shortcut> +<guimenu>XML</guimenu> +<guimenuitem>Insert Element...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will open a dialog that lets you insert an &XML; element. +The <, > characters and the closing tag will be inserted automatically. +If you have selected text when this menu item is selected, the selected +text will be surrounded by the opening and the closing tag. +The dialog also offers completion of all elements that may be inserted +at the current cursor position if you have assigned a meta DTD by +using <guimenuitem>Assign Meta DTD...</guimenuitem>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap><</keycap></keycombo> +</shortcut> +<guimenu>XML</guimenu> +<guimenuitem>Close Element</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will search your text for a tag that is not yet closed +and will close it by inserting the corresponding closing tag. +The search starts at the cursor position and goes left. If +it cannot find an open tag nothing will happen.</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>XML</guimenu> +<guimenuitem>Assign Meta DTD...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will tell the plugin which meta DTD to use for the +current document. Note that this assignment will not be saved. +You will have to repeat it when you start &kate; the next time.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmltools-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>XML Completion</quote> copyright 2001,2002 &Daniel.Naber; +&Daniel.Naber.mail;. +</para> + +<para> +Documentation copyright 2001,2002 &Daniel.Naber; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kicker-applets/Makefile.am b/doc/kicker-applets/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kicker-applets/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kicker-applets/index.docbook b/doc/kicker-applets/index.docbook new file mode 100644 index 0000000..82a61a8 --- /dev/null +++ b/doc/kicker-applets/index.docbook @@ -0,0 +1,113 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY doc-ktimemon SYSTEM "ktimemon.docbook"> + <!ENTITY doc-kolourpicker SYSTEM "kolourpicker.docbook"> + <!ENTITY ktimemon "<application>KTimemon</application>"> + <!ENTITY kolourpicker "<application>KolourPicker</application>"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kicker; Applets Handbook</title> + +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation><address><email> +</email></address></affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<date>2001-05-12</date> +<releaseinfo>2.20.00</releaseinfo> <!-- Used Kicker version here --> + +<copyright> +<year>2001</year> +<holder> </holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +This is the handbook for the addon applets for &kicker;, &kde;'s panel. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>Kicker</keyword> +<keyword>Applets</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>&kicker; applets</title> + +<para> +Applets are small applications running inside of &kicker;. Almost +everything besides the application starter buttons are applets. They can +be added from the <guimenu>context</guimenu> menu or from the submenu +<guisubmenu>Configure Panel</guisubmenu> by choosing +<guisubmenu>Add</guisubmenu> and the <guimenuitem>Applet</guimenuitem>. +</para> + +<para> +More information on the use of &kicker; and on the base set of applets +that come with &kicker;, can be found in the &kicker; handbook. +</para> + +<para> +The Applets described in this handbook are: +</para> + +<itemizedlist> +<listitem> +<para><link linkend="kolourpicker">&kolourpicker;</link></para> +</listitem> +<listitem> +<para><link linkend="ktimemon">&ktimemon;</link></para> +</listitem> +</itemizedlist> + +</chapter> + +&doc-kolourpicker; +&doc-ktimemon; + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +Copyrights for each applet is listed in the applicable chapter. +</para> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<para> +To be written +</para> + +</appendix> + + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> diff --git a/doc/kicker-applets/kolourpicker.docbook b/doc/kicker-applets/kolourpicker.docbook new file mode 100644 index 0000000..fcbd730 --- /dev/null +++ b/doc/kicker-applets/kolourpicker.docbook @@ -0,0 +1,56 @@ +<chapter id="kolourpicker"> +<chapterinfo> + +<title>&kolourpicker;</title> + +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation> +<address><email> </email></address> +</affiliation> +</author> +</authorgroup> +<date> </date> +<releaseinfo> </releaseinfo> +<abstract> +<para>To be written</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>color</keyword> +<keyword>selector</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The &kicker; plugin <quote>Kolourpicker</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact the kde-doc-english mailing list, which you can reach at +<ulink url="http://master.kde.org/mailman/listinfo/kde-doc-english"> +http://master.kde.org/mailman/listinfo/kde-doc-english +</ulink>. +</para> + +<sect1 id="thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kicker-applets/ktimemon.docbook b/doc/kicker-applets/ktimemon.docbook new file mode 100644 index 0000000..b7ce2d5 --- /dev/null +++ b/doc/kicker-applets/ktimemon.docbook @@ -0,0 +1,429 @@ +<chapter id="ktimemon"> +<chapterinfo> + +<title>&ktimemon;</title> + +<authorgroup> +<author> +<firstname>Martin</firstname> +<surname>Maierhofer</surname> +<affiliation> +<address><email>[email protected]</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2001-11-29</date> +<releaseinfo>0.03.01</releaseinfo> +<abstract> +<para>&ktimemon; is a system monitor for the K Desktop Environment</para> +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>ktimemon</keyword> +<keyword>system monitor</keyword> +<keyword>timemon</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>&ktimemon; is a small program to keep track of your computer's system +usage. It can display bar graphs containing information about +<acronym>CPU</acronym>, memory, and swap usage as well as disk usage and +context switch activity. In keeping with the spirit of <ulink +url="http://www.kde.org/">KDE</ulink>, it supports configuration via a +graphical user interface. It also supports <emphasis>docking</emphasis>, +&ie; it can display information in the system panel tray.</para> + +<note> +<para>Currently, &ktimemon; only supports a limited number of systems: +&Linux; based installations with the <filename>/proc</filename> file +system, &Solaris; based installations with the +<filename>kstat</filename> library, and Digital &UNIX; (formerly +DEC/OSF1) based installations with the +<command>table</command>(2) system call. Help with +porting it to other platforms is most welcome. +</para> +</note> + +<para> +&ktimemon; can be started from the command line or from the &kde; +<guimenu>start</guimenu> menu (in the <guisubmenu>Utilities</guisubmenu> +submenu). If you choose to start from the command line, &ktimemon; +honors the usual &X-Window; program flags such as +<option>-geometry</option>. &ktimemon; is +<emphasis>session-aware</emphasis>, &ie; it keeps track of the current +state (colors, &etc;) and restores it in the user's next session. +</para> + +<sect1 id="fund"> +<title>Onscreen Fundamentals</title> + +<para> +After starting &ktimemon; a small window will appear displaying +information gathered from the operating system. If you move the mouse +pointer over the &ktimemon; window and let it rest for a small amount of +time, a <emphasis>tool-tip</emphasis> (&ie; a small transient window) +will appear. The tool-tip contains numeric information about the system +parameters displayed by the bar graphs. Tool-tips can be disabled (refer +to <link linkend="config">Configuration</link>). +</para> + +<sect2 id="modes"> +<title>Display Modes</title> + +<para> +&ktimemon; can display two different sets of system information. As +explained in the <link linkend="config">Configuration</link> chapter, +mouse buttons can be bound to various actions. Per default, the left +mouse button is bound to the mode switch action, &ie; by clicking the +&LMB; mouse button anywhere in the &ktimemon; window, the displayed +information switches from <guilabel>Normal Mode</guilabel> (the default) +to <guilabel>Extended Mode</guilabel>, and vice versa. +</para> + +<sect3 id="normalmode"> +<title>Normal Mode</title> + +<para>After starting &ktimemon; for the first time, it will show +information about the current CPU activity, as well as memory and swap +usage. Three bar graphs are used to show this information; they are +updated regularly (the default sample interval is 0.5s, but it can be +changed, see <link linkend="config">Configuration</link>). The three bar +graphs represent (from left to right): +<variablelist> +<varlistentry> +<term><acronym>CPU</acronym> usage.</term> +<listitem> +<para>&ktimemon; shows the bar in three different colors, representing +<acronym>CPU</acronym> time spent in various modes. From bottom to top +they are: kernel mode, user mode, and user mode with lowered priority +(<emphasis>nice</emphasis>) - since &Solaris; does not seem to support +statistics for nice mode, the topmost part of the bar represents time +spent in the <emphasis>wait</emphasis> state on such systems. The gap +from the top of the bar to the top of the window represents the +percentage the <acronym>CPU</acronym> idle time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Memory usage.</term> +<listitem> +<para>Similar to the <acronym>CPU</acronym> usage bar, this bar is +composed of three sub fields, representing (from bottom to top): +memory allocated by processes, memory used for I/O buffering, and +memory used for file caching. For Digital &UNIX; based systems, the +middle section represents <quote>inactive</quote> memory (&ie; memory +allocated and not used for a certain amount of time), and for +&Solaris; based systems, the middle section of the bar is not used, +and the topmost section represents the amount of memory used by the +kernel. Again, the gap from the top of the bar to the top of the +window represents free memory.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Swap usage.</term> +<listitem> +<para>This bar consists of a single field representing +the current swap usage relative to the system's total amount of swap +space. </para> +</listitem> +</varlistentry> +</variablelist> +</para> + +<para>Clicking the mouse button bound to <quote>mode switch</quote> in +the &ktimemon; window switches to <quote>Extended Mode</quote>.</para> + +</sect3> + +<sect3 id="xtndmode"> +<title>Extended Mode </title> + +<para>In this mode, the three bar graphs are used to display a different +set of system information. Again from left to right, they show:</para> + +<variablelist> +<varlistentry> +<term>Paging activity.</term> +<listitem> +<para>This bar consists of two parts, the lower half +of which shows the number of memory pages written to secondary +storage in the last sample interval. Similarly, the upper half +indicates the number of pages read from secondary storage.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Swapping activity.</term> +<listitem> +<para>The second bar displays the analog +information for swap activity.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Context switches.</term> +<listitem> +<para>Again, this bar graph consists of a single +field which indicates the number of context switches in the last +sample interval.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Since there is no <quote>natural</quote> way of scaling the +information shown in <quote>Extended Mode</quote>, by default +&ktimemon; uses <emphasis>autoscaling</emphasis> (explained in the +<link linkend="autoscaling">Common Questions Section</link>). There +is, however, the possibility of specifying the scaling information, +see the <link linkend="config">Configuration</link> section.</para> + +<para>Note that the two sets of bar graphs share the same colors, &ie; +the colors setup for <quote>Normal Mode</quote> is also used for +displaying information in <quote>Extended Mode</quote> (see also <link +linkend="config">Configuration</link> on how to change the color +scheme).</para> +</sect3> +</sect2> + </sect1> + +<sect1 id="menu"> +<title>Menu Structure</title> + +<para> +By default, the &RMB; mouse button is bound to the <quote>menu +pop-up</quote> action, &ie; clicking the right mouse button anywhere in +the &ktimemon; window brings up a menu, which is discussed in the +following sections. +</para> + +<sect2 id="config-menu"> +<title><guimenuitem>Settings...</guimenuitem></title> + +<para>The <guimenuitem>Settings...</guimenuitem> menu item is used to +pop up the configuration dialog. Configuration options are discussed in +section <link linkend="config">Configuration</link>. +</para> +</sect2> + +<sect2 id="docked-in-panel"> +<title><guimenuitem>Docked In Panel</guimenuitem></title> + +<para> +By selecting the <guimenuitem>Docked In Panel</guimenuitem> menu item, +&ktimemon; switches between its standard display (&ie; a normal window) +and the panelized state, where the &ktimemon; window disappears and a +smaller version is displayed in the system panel. Apart from the +reduction in size, the <quote>panelized</quote> &ktimemon; behaves +exactly like its big brother. +</para> +</sect2> + +<sect2 id="help"> +<title><guimenu>Help</guimenu></title> + +&help.menu.documentation; + +</sect2> + +<sect2 id="horizontal-bars"> +<title><guimenuitem>Horizontal Bars</guimenuitem></title> + +<para>By selecting the <guimenuitem>Horizontal Bars</guimenuitem> menu +entry, &ktimemon; switches from vertical bars to horizontal bars and +vice versa. Not very useful, but it was easy to implement ;-) +</para> +</sect2> + +<sect2 id="quit"> +<title><guimenuitem>Quit</guimenuitem></title> + +<para> +The <guimenuitem>Quit</guimenuitem> menu item - surprise, surprise +-- is used to terminate &ktimemon;. It will save the current state +(⪚ the color scheme, window size, whether it is displayed in the +panel) and restore the state in the next invocation. +</para> + +<para> +The configuration information is saved in the file +<filename>$<envar>HOME</envar>/.kde/share/config/ktimemonrc</filename>, +where <filename class="directory">$<envar>HOME</envar></filename> refers +to the user's home folder. If this file is deleted, &ktimemon; will +start in its default state in the next invocation. +</para> +</sect2> +</sect1> + +<sect1 id="config"> +<title>Configuration</title> + +<para> +&ktimemon; can be configured via a straight-forward dialog (see also the +discussion of the <link linkend="config-menu">Configuration +Menu</link>). On the <guilabel>General</guilabel> page, the sample +interval can be specified as well as scaling information (see also the +discussion of the <link linkend="xtndmode">extended mode</link>). If the +<guilabel>Autoscaling</guilabel> check box is ticked (autoscaling is +explained in the <link linkend="autoscaling">FAQ</link> section), the +scaling factors cannot be edited, since &ktimemon; determines them +automatically. +</para> + +<para> +The <guilabel>Colors</guilabel> page can be used to tailor the colors of +the bar graph to individual preferences. A small sample bar graph gives +immediate feedback. +</para> + +<para> +In the <guilabel>Interaction</guilabel> page, mouse bindings can be +adapted. Clicking a mouse button on the &ktimemon; window can be +ignored, trigger a mode switch (see also <link +linkend="modes">Modes</link>), invoke the context menu (see also <link +linkend="menu">Menu</link>), or invoke an external process. The command +line specified for external processes is interpreted by the standard +shell, &ie; shell commands, environment variables, redirection &etc; can +be used.</para> + +<para>The <guilabel>Interaction</guilabel> page also contains a check +box which can be used to disable to automatic appearance of tool-tips +with numeric information about the bar graphs (compare <link +linkend="fund">Onscreen Fundamentals</link>).</para> +</sect1> + +<sect1 id="faq"> +<title>Common Questions and Answers </title> + +<qandaset> +<qandaentry> +<question> +<para>Which operating systems does &ktimemon; support?</para> +</question> +<answer> +<para> +&ktimemon; supports &Linux; based systems with the <filename +class="devicefile">/proc</filename> file system, &Solaris; based +systems with the <filename>kstat</filename> library, and Digital +&UNIX; (formerly DEC/OSF1) systems with the +<command>table</command>(2) system call interface. Only the &Linux; +version has been thoroughly tested, if you experience any problems +with the &Solaris;/Digital &UNIX; port, please do not hesitate to +contact me. +</para> + +<para> +Also, contributions to &ktimemon; to adapt it to other platforms are +most welcome. Please contact me at +<email>[email protected]</email> if you intend to port &ktimemon; +to other flavors of &UNIX;. +</para> +</answer> + +</qandaentry> + +<qandaentry id="autoscaling"> +<question> +<para> +How does autoscaling work? +</para> +</question> +<answer> +<para> +Glad you asked. Since there is no sensible predetermined scaling factor +for paging/swapping operations and context switches (unlike ⪚ memory +utilization, where you can take the total memory size as baseline), +&ktimemon; uses a semi-intelligent (well, ...) autoscaling +mechanism. Autoscaling works as follows: +</para> + +<itemizedlist> +<listitem> +<para> +Each of the three bar graphs as described in the <link +linkend="xtndmode">extended mode section</link> has an associated +scaling factor. The initial values of these factors are set to some +predetermined value. +</para> +</listitem> +<listitem> +<para> +Each time a new sample is displayed, the respective value is tentatively +scaled with the corresponding factor. If the value can be displayed in +the scale chosen by the factor, no change occurs (&ie; small changes in +the activity are reflected by a changing height of the bar). +</para> +</listitem> +<listitem> +<para> +If the scaled value would be either too large or too small to be +displayed with the current scaling factor, the scaling is adjusted so +that the new value displayed is roughly halfway up the bar graph. Thus, +subsequent changes should have a good chance of getting displayed +relative to the current value, without having to change the scale again. +</para> +</listitem> +</itemizedlist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +Why does a message box with <errorname>diagnostic output from child +command</errorname> pop up? +</para> +</question> +<answer> +<para> +If you bind a mouse button to an external command as described in the +<link linkend="config">Configuration</link> chapter, &ktimemon; does +not check for a valid command name. Instead a command shell is invoked +to execute the statement, so shell commands, environment variables and +more can be used. To allow some feedback to the user, &ktimemon; +monitors the <systemitem>stderr</systemitem> output of the command +shell, and reports it in this message box. +</para> + +<para> +While this scheme can be helpful in case a command is not found, it can +be quite annoying if the invoked command prints harmless diagnostic +information on <systemitem>stderr</systemitem>. A simple and elegant +solution to this problem is to add <userinput>2>/dev/null</userinput> +at the end of the command specification. This redirects diagnostic +messages to message nirvana, and stops the message box popping up. +</para> +</answer> +</qandaentry> + +</qandaset> +</sect1> + +<sect1 id="ktimemon-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para>&ktimemon; is based on an Xt version by my brother.</para> + +<para>Thanks to Tobe Toben, +<email>[email protected]</email>, Cristian Tibirna +<email>[email protected]</email>, Dirk A. Mueller +<email>[email protected]</email>, Mark Krischer +<email>[email protected]</email>, and Lubos Lunak +<email>[email protected]</email> for bug reports, patches, comments, +suggestions. +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/konq-plugins/Makefile.am b/doc/konq-plugins/Makefile.am new file mode 100644 index 0000000..3f4b33a --- /dev/null +++ b/doc/konq-plugins/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = AUTO + + diff --git a/doc/konq-plugins/babel/Makefile.am b/doc/konq-plugins/babel/Makefile.am new file mode 100644 index 0000000..92a0127 --- /dev/null +++ b/doc/konq-plugins/babel/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/babel + + diff --git a/doc/konq-plugins/babel/index.docbook b/doc/konq-plugins/babel/index.docbook new file mode 100644 index 0000000..fdc5728 --- /dev/null +++ b/doc/konq-plugins/babel/index.docbook @@ -0,0 +1,95 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="babel"> +<sect1info> + +<authorgroup> +<author> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation><address>&Lauri.Watts.mail;</address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-02-26</date> +<releaseinfo>3.5.1</releaseinfo> <!-- Used KDE version --> + +<abstract> +<para>The Babel &konqueror; plugin gives you quick access to the +Babelfish translation service.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>babelfish</keyword> +<keyword>translate</keyword> +</keywordset> +</sect1info> + +<title>The Babel &konqueror; plugin</title> + +<sect2> +<title>Using the Babelfish plugin</title> + +<para>Babelfish is a machine translation service provided by <ulink +url="http://babel.altavista.com/">AltaVista</ulink>.</para> + +<para>The plugin allows you to automatically translate web pages +between several languages.</para> + +<para>The Babelfish plugin can be accessed in the &konqueror; menubar +under <menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Translate Web Page</guimenuitem></menuchoice>. +Select from the list that drops down the language to translate from +and the language to translate to.</para> + +<para>If you have a portion of the text on the page selected, that +will be translated instead of the entire &URL;.</para> + +<para>Not all languages are available from the Babelfish service.</para> + +<important> +<para>Machine translation is not a perfect science! Babelfish will at +best give you a rough translation, and at worst will give you a very +funny read. Don't base important decisions on things you have read +from a Babelfish translated page, without confirming that the +translation is indeed accurate.</para> +</important> + +<note> +<para>You may only translate web pages that are accessible on the +world wide web. To translate any other text, you should go directly +to the Babelfish site itself, where you are able to paste in text for +translation.</para> +</note> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The Babelfish plugin is copyright (C) +2001 &Kurt.Granroth; + +&Kurt.Granroth.mail;</para> + +<para>Documentation Copyright 2002 &Lauri.Watts; +&Lauri.Watts.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect2> +</sect1> +</article> diff --git a/doc/konq-plugins/crashes/Makefile.am b/doc/konq-plugins/crashes/Makefile.am new file mode 100644 index 0000000..07b6370 --- /dev/null +++ b/doc/konq-plugins/crashes/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/crashes + + diff --git a/doc/konq-plugins/crashes/index.docbook b/doc/konq-plugins/crashes/index.docbook new file mode 100644 index 0000000..2918c2f --- /dev/null +++ b/doc/konq-plugins/crashes/index.docbook @@ -0,0 +1,58 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="crashesplugin"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-07-21</date> +<releaseinfo>3.10.00</releaseinfo> + +<abstract> +<para>The crashes plugin bookmarks a list of websites that &konqueror; has crashed on.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword></keyword> +</keywordset> + +</sect1info> + +<title>The Crashes Plugin</title> + +<sect2> +<title>Using the Crashes Plugin</title> + +<para>To use the crashes plugin point &konqueror; to <menuchoice><guimenu>Tools</guimenu><guimenuitem>Crashes</guimenuitem></menuchoice>. Here you can select to view the site that &konqueror; has crashed on or clear the list of crashes, if any.</para> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The crashesplugin is Copyright © +2002-2003 Alexander Kellett +<email>[email protected]</email>.</para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/dirfilter/Makefile.am b/doc/konq-plugins/dirfilter/Makefile.am new file mode 100644 index 0000000..4e18760 --- /dev/null +++ b/doc/konq-plugins/dirfilter/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/dirfilter + + diff --git a/doc/konq-plugins/dirfilter/index.docbook b/doc/konq-plugins/dirfilter/index.docbook new file mode 100644 index 0000000..11e4b89 --- /dev/null +++ b/doc/konq-plugins/dirfilter/index.docbook @@ -0,0 +1,61 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="dirfilter"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-09-15</date> +<releaseinfo>3.10.00</releaseinfo> + +<abstract> +<para>The directory view filter allows you to choose which items are displayed in a directory.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>dirfilter</keyword> +</keywordset> + +</sect1info> + +<title>The View Filter</title> + +<sect2> +<title>Using the View Filter</title> + +<para>The View Filter plugin (also known as <quote>dirfilter</quote>) +can be accessed in the &konqueror; menubar under +<menuchoice><guimenu>Tools</guimenu><guimenuitem>View +Filter</guimenuitem></menuchoice>. This plugin allows you to filter +&konqueror;'s current working directory in a variety of ways.</para> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The dirfilter plugin is copyright © +2000-2002 Dawit Alemayehu <email>[email protected]</email>.</para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/domtreeviewer/Makefile.am b/doc/konq-plugins/domtreeviewer/Makefile.am new file mode 100644 index 0000000..aad8af0 --- /dev/null +++ b/doc/konq-plugins/domtreeviewer/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/domtreeviewer + + diff --git a/doc/konq-plugins/domtreeviewer/index.docbook b/doc/konq-plugins/domtreeviewer/index.docbook new file mode 100644 index 0000000..17421b3 --- /dev/null +++ b/doc/konq-plugins/domtreeviewer/index.docbook @@ -0,0 +1,62 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="domtreeviewer"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-02-26</date> +<releaseinfo>3.5.1</releaseinfo> + +<abstract> +<para>The <acronym>DOM</acronym> Tree Viewer allows a developer to view the styles, attributes and elements of a web document.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>DOMTreeViewer</keyword> +</keywordset> + +</sect1info> + +<title>The <acronym>DOM</acronym> Tree Viewer</title> + +<sect2> +<title>Using the <acronym>DOM</acronym> Tree Viewer</title> + +<para>To begin using The <acronym>DOM</acronym> Tree Viewer in &konqueror;, select <menuchoice><guimenu>Tools</guimenu><guimenuitem>Show DOM Tree</guimenuitem></menuchoice>. This will open a new window which displays the <acronym>DOM</acronym> of the current web page you are viewing. By default the display starts at the root node of the document, example: <quote>documentElement</quote>, all other nodes that you will see are children or descendants of the root node.</para> + +<para>If you wish to manipulate the <acronym>DOM</acronym> tree in any way you will have to use an external script to do so.</para> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The domtreeviewer plugin is Copyright © +2001 The Kafka Team/Andreas Schlapbach + +<email>[email protected]</email> +<email>[email protected]</email></para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/fsview/Makefile.am b/doc/konq-plugins/fsview/Makefile.am new file mode 100644 index 0000000..23e96f9 --- /dev/null +++ b/doc/konq-plugins/fsview/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/fsview + + diff --git a/doc/konq-plugins/fsview/index.docbook b/doc/konq-plugins/fsview/index.docbook new file mode 100644 index 0000000..60ceef1 --- /dev/null +++ b/doc/konq-plugins/fsview/index.docbook @@ -0,0 +1,182 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY fsview "<application>FSView</application>"> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="fsview"> +<sect1info> + +<authorgroup> +<author> +<personname><firstname>Josef</firstname> +<surname>Weidendorfer</surname></personname> +<address><email>[email protected]</email></address> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-02-24</date> +<releaseinfo>3.5.1</releaseinfo> + +<abstract> +<para>The &fsview; Plugin for &konqueror; is another view mode for +objects of mimetype <literal>inode/directory</literal> for local +files. It can be viewed as an alternative to the various iconviews and +listviews for browsing the content of your local file system.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword></keyword> +</keywordset> + +</sect1info> + +<title>&fsview; - the File System View</title> + +<sect2> +<title>Introduction</title> + +<para>The &fsview; Plugin for &konqueror; is another view mode for +objects of mimetype <literal>inode/directory</literal> for local +files. It can be viewed as an alternative to the various iconviews and +listviews for browsing the content of your local file system.</para> + +<para>The unique property of &fsview; is its ability to show whole +nested folder hierarchies using a so-called tree map for graphical +visualization. Tree maps allow for displaying metrics of objects in +nested structures: each object is represented by a rectangle whose +area is proportional to its metric. The sum of the children's metrics must be +equal to or smaller than the parent object's metric.</para> + +<para>For &fsview;, sizes of files and folders are choosen as +metric, where the the size of a folder is defined to be the sum of the +sizes of its subitems. This way, big files even deep down in the +folder hierarchy can be spotted easily be looking for large +rectangles. So &fsview; can be looked at as a graphical and interactive +version of the &UNIX; <command>du</command> command.</para> + +<para>The integration of &fsview; as part of Konqueror allows it to +use the standard features like context file menus, and mime type +sensitive actions. But it was choosen not to implement automatical +update of file system changes by watching: if you delete a file shown +in &fsview; outside of &konqueror;, you have to update manually by +⪚ pressing <keycap>F5</keycap>. The reason for this decision is +the potentially huge amount of files which would have to be watched +for changes, and thus, could put an unreasonable pressure on system +resources for a small feature.</para> + +</sect2> + +<sect2> +<title>Visualization Features</title> + +<para>This section explains the graphical visualization of &fsview; +in detail.</para> + +<sect3> +<title>Item Drawing Options</title> + +<para>In &fsview;, an item of the tree map visualization is a rectangle +representing a file or folder of your file system. For easier navigation, +rectangles have a meaningful coloring and labeling options.</para> + +<para>The color of a rectangle, switchable via menu item +<menuchoice><guimenu>View</guimenu><guisubmenu>Color +Mode</guisubmenu></menuchoice> can be either +<guimenuitem>Depth</guimenuitem> for easy detection of the nesting, or +a color mapping of different file attributes like name, owner, group, +or mime type.</para> + +<para>A rectangle can be labeled with the various attributes +of the corresponding file or folder. For an attribute, you can +choose, whether it should be shown at all, only if space is available, +or if space should be taken from children (thus introducing +errors to pure tree map drawing constrains). Additionally, you can choose +the relative location of the label in the rectangle.</para> + +</sect3> + +<sect3> +<title>TreeMap Drawing Algorithms</title> + +<para>For drawing algorithms in tree maps, the rule that the area +is proportional to the metric of an item should hold true. +With the tree map in &fsview;, this goal isn't always met: we draw borders +to show the nesting of items, and this border takes space for a item +which is possible lost for the areas of child items. Note that +less space is lost for the border if the rectangle is quadratic.</para> + +<para>Similar, it is good for a better overview to let all rectangles +at least have its name as label, taking space, too. It is an option to +always force space for labels, or only to draw labels when empty space +is available. In the latter case, the tool tips appearing when the +mouse is kept over an item for some time, can help a lot. They show +information for the item the mouse is currently over, together with +its parent relations up to the root item of the tree map.</para> + +<para>How the space of an item is split into subareas for children is +left to the implementation. It is always better to try to split areas +in such a way that rectangles are as quadratic as possible, both for +labeling and less space lost by borders. The best methods in this +regard are <guilabel>Rows</guilabel>, <guilabel>Columns</guilabel>, or +<guilabel>Recursive Bisection</guilabel>.</para> + +<para>You can choose the minimal area of items to be drawn via the +menu item <menuchoice><guimenu>View</guimenu><guimenuitem>Stop at +Area</guimenuitem></menuchoice>. Instead, a hash pattern will be drawn +over the parents area to signal that this space is in fact occupied by +a child.</para> + +</sect3> + +</sect2> + +<sect2> +<title>User Interface</title> + +<para>&fsview; supports multiple selection of items, similar to the +iconview and listview. This allows for actions to be done +simultaneously to a set of files. A simple mouse click always selects +a single item below the mouse pointer. Use a mouse click in +combination with pressing the &Shift; key for range selection or the +&Ctrl; Key for selection toggle. Note that by selecting an item, subitems can no +longer be selected. Selecting an item will also clear the selection of all its +parent items before.</para> + +<para>There is keyboard navigation available in tree maps: use +<keycap>Left Arrow</keycap> and <keycap>Right Arrow</keycap> keys to +move the current item between siblings, and the <keycap>Up +Arrow</keycap> and <keycap>Down Arrow</keycap> keys to go up and down +the nesting hierarchy. <keycap>Space</keycap> selects the item, in +conjunction with &Shift; does range selection, and with the &Ctrl; key +hold down simultaneously, toggles selection of the current item. Press +<keycap>Return</keycap> to run the open action onto the current item.</para> + +</sect2> + +<sect2> +<title>Credits and License</title> + +<para>Originally, &fsview; was meant as a small test application and +usage tutorial for the TreeMap widget developed within +<application>KCachegrind</application>.</para> + +<para>Copyright by Josef Weidendorfer, licensed using GPL V2.</para> + +&underGPL; +&underFDL; + +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/imgallery/Makefile.am b/doc/konq-plugins/imgallery/Makefile.am new file mode 100644 index 0000000..9524b61 --- /dev/null +++ b/doc/konq-plugins/imgallery/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/imgallery + + diff --git a/doc/konq-plugins/imgallery/folders.png b/doc/konq-plugins/imgallery/folders.png Binary files differnew file mode 100644 index 0000000..8cce375 --- /dev/null +++ b/doc/konq-plugins/imgallery/folders.png diff --git a/doc/konq-plugins/imgallery/index.docbook b/doc/konq-plugins/imgallery/index.docbook new file mode 100644 index 0000000..517bb99 --- /dev/null +++ b/doc/konq-plugins/imgallery/index.docbook @@ -0,0 +1,207 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="kimgalleryplugin"> +<sect1info> + +<authorgroup> +<author> +<firstname>Mike</firstname> +<surname>Diehl</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-02-24</date> +<releaseinfo>3.00.00</releaseinfo> + +<abstract> +<para>The Image Gallery &konqueror; plugin creates image gallery html pages from a selected directory.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +</keywordset> + +</sect1info> + +<title>The Image Gallery Plugin</title> + +<sect2> +<title>Using the Image Gallery Plugin</title> + +<para>The Image Gallery plugin can be accessed in the &konqueror; menubar under <menuchoice><guimenu>Tools</guimenu><guimenuitem>Create Image Gallery</guimenuitem></menuchoice>, or with <keycombo>&Ctrl;<keycap>I</keycap></keycombo>.</para> + +<para>When you start the Image Gallery plugin a dialog opens allowing you to adjust the way the gallery is created.</para> +</sect2> +</sect1> + +<sect1 id="page_look_dialog"> +<title>Page Look</title> + +<screenshot> +<screeninfo>Look Dialog Screenshot</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="look.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Screenshot</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>The Look dialog is for adjusting the appearance of the gallery page.</para> + +<variablelist> + +<varlistentry> +<term><guimenuitem>Page title</guimenuitem></term> +<listitem><para>The Page title option has a text input box for changing the title of the image gallery page.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Images per row</guimenuitem></term> +<listitem><para>The Images per row option has a slider and a spin box for adjusting the number of thumbnails that are in a single row in the gallery.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Show image file name</guimenuitem></term> +<listitem><para>The Show image file name check box allows you to turn on or off the use of the filenames below the gallery thumbnails.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Show image file size</guimenuitem></term> +<listitem><para>The Show image filesize check box allows you to turn on or off the use of the filesizes below the gallery thumbnails.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Show image dimensions</guimenuitem></term> +<listitem><para>The Show image dimensions check box allows you to turn on or off the use of the image dimensions in pixels below the gallery thumbnails.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Font name</guimenuitem></term> +<listitem><para>The Font name combo box provides you with a choice of which font to use in creating the gallery.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Font size</guimenuitem></term> +<listitem><para>The Font size spin box is for changing the size of the font you selected.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Foreground color</guimenuitem></term> +<listitem><para>The Foreground color option has a selector for choosing the foreground color of the gallery, this includes the text areas.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Background color</guimenuitem></term> +<listitem><para>The Background color option has a selector for choosing the background color of the gallery.</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="folders_dialog"> +<title>Folders</title> + +<screenshot> +<screeninfo>Folders Dialog Screenshot</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="folders.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Screenshot</phrase> +</textobject> +</mediaobject> +</screenshot> + + +<para>The Folders dialog is used for choosing where to save the gallery. This dialog is also used to configure what folders are used.</para> + +<variablelist> + +<varlistentry> +<term><guimenuitem>Save to HTML file</guimenuitem></term> +<listitem><para>The Save to file selector decides where you want to save you image gallery html page.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Recurse subfolders</guimenuitem></term> +<listitem><para>The Recurse subfolders check box enables recursing of subdirectories. If the check box is enabled, a slider and spin box are enabled to select the recursion depth.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Copy original files</guimenuitem></term> +<listitem><para>The Copy original files check box creates an image folder storing copies of the original images used in the gallery.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Use comment file</guimenuitem></term> +<listitem><para>The use comment file check box enables a file selector to choose a comments file to use with your gallery.</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="thumbnails_dialog"> +<title>Thumbnails</title> + +<screenshot> +<screeninfo>Thumbnails Dialog Screenshot</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="thumbnails.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Screenshot</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>The thumbnails dialog is used for adjusting the properties of the thumbnails in the gallery.</para> + +<variablelist> + +<varlistentry> +<term><guimenuitem>Image format for the thumbnails</guimenuitem></term> +<listitem><para>The image format combo box allows you to choose what format is used for the thumbnail images.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Thumbnail size</guimenuitem></term> +<listitem><para>The thumbnail size option provides a slider and spin box for adjusting the size of the thumbnails used in the gallery.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Set different color depth</guimenuitem></term> +<listitem><para>The set different color depth check box enables a combo box for selecting a different color depth for the thumbnails if you wish to use a color depth other than the depth used in the original image.</para></listitem> +</varlistentry> + +</variablelist> + +<sect2> +<title>Credits</title> + +<para> Copyright © 2001,2003 Lukas Tinkl <email>[email protected]</email></para> +<para> Andreas Schlapbach <email>[email protected]</email></para> + +<para>Documentation Copyright 2004 Mike Diehl <email>[email protected]</email></para> +</sect2> + +</sect1> + +</article> diff --git a/doc/konq-plugins/imgallery/look.png b/doc/konq-plugins/imgallery/look.png Binary files differnew file mode 100644 index 0000000..e06c6c4 --- /dev/null +++ b/doc/konq-plugins/imgallery/look.png diff --git a/doc/konq-plugins/imgallery/thumbnails.png b/doc/konq-plugins/imgallery/thumbnails.png Binary files differnew file mode 100644 index 0000000..c1a7c0c --- /dev/null +++ b/doc/konq-plugins/imgallery/thumbnails.png diff --git a/doc/konq-plugins/index.docbook b/doc/konq-plugins/index.docbook new file mode 100644 index 0000000..d105e5c --- /dev/null +++ b/doc/konq-plugins/index.docbook @@ -0,0 +1,158 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY kappname "&konqueror; Plugins"> + <!ENTITY package "kdeaddons"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &konqueror; Plugins Handbook</title> + +<authorgroup> +<author> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation><address>&Lauri.Watts.mail;</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + + +<date>2006-05-20</date> +<releaseinfo>3.5.2</releaseinfo> <!-- Used KDE version here --> + +<copyright> +<year>2002</year> +<holder>&Lauri.Watts;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +This is the handbook for the additional plugins for &konqueror; the +&kde; file manager and web browser. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>Konqueror</keyword> +<keyword>Plugins</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +The &package; package contains several plugins for &konqueror;. +Despite their small size, they provide additional functions and ease +the use of some of the functions &konqueror; already contains, by +making them more accessible. +</para> + +<para> +More information on the use of &konqueror; and it's built in +functionality, can be found in the &konqueror; handbook. +</para> + +<para> +To load these plugins from within &konqueror;, select +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Extensions...</guimenuitem></menuchoice>. +Go to the <guilabel>Tools</guilabel> tab and choose the wanted plugins. +</para> + +<para> +This is a list of the <emphasis>standard</emphasis> configuration +modules provided by the <application role="package">&kde; addons</application> +package. Please note that there may be many more modules on your system if you +have installed additional software. +</para> + +<itemizedlist> +<listitem> +<para><ulink url="help:/konq-plugins/babel/index.html">Babelfish</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/domtreeviewer/index.html">The <acronym>DOM</acronym> tree +viewer</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/imgallery/index.html">The &konqueror; image +gallery</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/mediaplayer/index.html">The Embedded Media +Player</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/validators/index.html">The +Validators</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/kuick/index.html">Kuick</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/dirfilter/index.html">The Folder +Filter</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/khtmlsettings/index.html">KHTMLSettings</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/uachanger/index.html">The User Agent Changer</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/webarchiver/index.html">The Web +Archiver</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/crashes/index.html">The Crashes +Plugin</ulink></para> +</listitem> +<listitem> +<para><ulink url="help:/konq-plugins/fsview/index.html">FSView - the File +System View</ulink></para> +</listitem> +</itemizedlist> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +Copyrights for each plugin are listed in the applicable chapter. +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +<para>You should install the kdebase package which contains +&konqueror; before attempting to compile this package.</para> + +&install.compile.documentation; + +</appendix> + + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> diff --git a/doc/konq-plugins/khtmlsettings/Makefile.am b/doc/konq-plugins/khtmlsettings/Makefile.am new file mode 100644 index 0000000..047e57d --- /dev/null +++ b/doc/konq-plugins/khtmlsettings/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/khtmlsettings + + diff --git a/doc/konq-plugins/khtmlsettings/index.docbook b/doc/konq-plugins/khtmlsettings/index.docbook new file mode 100644 index 0000000..f86999d --- /dev/null +++ b/doc/konq-plugins/khtmlsettings/index.docbook @@ -0,0 +1,114 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="khtmlsettings"> +<sect1info> + +<authorgroup> +<author> +<firstname>Mike</firstname> +<surname>Diehl</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<author> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation><address>&Lauri.Watts.mail;</address></affiliation> +</author> + + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-01-10</date> +<releaseinfo>3.5.1</releaseinfo> + +<abstract> +<para>The &HTML; Settings plugin provides an easy way to access the common &HTML; settings for &konqueror;.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +</keywordset> + +</sect1info> + +<title>KHTMLSettings</title> + +<sect2> +<title>Using KHTMLSettings</title> + +<para>The &HTML; settings plugin can be accessed in the &konqueror; menubar under <menuchoice><guimenu>Tools</guimenu><guimenuitem>HTML Settings</guimenuitem></menuchoice>. Below is a list of the settings and a short description of each one.</para> + +<variablelist> +<varlistentry> +<term><guimenuitem>JavaScript</guimenuitem></term> +<listitem><para>Allows you to turn the use of JavaScript in &konqueror; on or off.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Java</guimenuitem></term> +<listitem><para>Allows you to turn the use of &Java; in &konqueror; on or off.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Cookies</guimenuitem></term> +<listitem><para>Allows you to turn the use of Cookies in &konqueror; on or off.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Plugins</guimenuitem></term> +<listitem><para>Allows you to turn the use of the &konqueror; plugins you have installed on or off.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Autoload Images</guimenuitem></term> +<listitem><para>Allows you to turn on or off the loading of images in web pages.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Enable Proxy</guimenuitem></term> +<listitem><para>Allows you to enable or disable the use of a proxy in the &konqueror; browser.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Enable Cache</guimenuitem></term> +<listitem><para>Allows you to enable or disable the use of cache in the &konqueror; browser.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Cache Policy</guimenuitem></term> +<listitem> +<para>The Cache Policy submenu provides you with a way to configure the how +&konqueror; uses cache. The possible uses include:</para> +<itemizedlist> +<listitem><para>Keep Cache in Sync</para></listitem> +<listitem><para>Use Cache if Possible</para></listitem> +<listitem><para>Offline Browsing Mode</para></listitem> +</itemizedlist> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>Credits</title> + +<para> Copyright © 2001 &Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;</para> + +<para>Documentation Copyright 2004 Mike Diehl <email>[email protected]</email></para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/kuick/Makefile.am b/doc/konq-plugins/kuick/Makefile.am new file mode 100644 index 0000000..7edba19 --- /dev/null +++ b/doc/konq-plugins/kuick/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/kuick + + diff --git a/doc/konq-plugins/kuick/index.docbook b/doc/konq-plugins/kuick/index.docbook new file mode 100644 index 0000000..0b28852 --- /dev/null +++ b/doc/konq-plugins/kuick/index.docbook @@ -0,0 +1,116 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="kuick"> +<sect1info> + +<authorgroup> +<author> +<firstname>Burkhard</firstname> +<surname>Lück</surname> +<affiliation><address> +<email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-03-11</date> +<releaseinfo>3.5.2</releaseinfo> <!-- Used KDE version --> + +<abstract> +<para>Kuick allows you to move and copy files quickly from a context menu in &konqueror;.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>kuick</keyword> +</keywordset> + +</sect1info> + +<title>The Kuick &konqueror; plugin</title> + +<sect2 id="intro"> +<title>Introduction</title> + +<para> +Kuick offers a quick and easy way to copy or move files to another folder. +Open the context menu with a &RMB; click on a file or a selection of files. +Select <guimenu>Copy To</guimenu> or <guimenu>Move To</guimenu> to show a list with +these options: +</para> + +<variablelist> + +<varlistentry> +<term><guimenuitem>Home Folder</guimenuitem></term> +<listitem><para>Copy or Move the selection to the home folder or subfolders</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Root Folder</guimenuitem></term> +<listitem><para>Copy or Move the selection to the root folder or subfolders</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Contact</guimenuitem></term> +<listitem><para>To be written</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Browse...</guimenuitem></term> +<listitem><para>Opens a dialog to choose a target folder or create a +<guibutton>New Folder</guibutton>.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="kcm-kuick"> +<title>The Kuick &kcontrolcenter; module</title> + +<para>In the &kcontrolcenter; select <menuchoice><guimenu>KDE Components</guimenu> +<guimenuitem>File Manager</guimenuitem></menuchoice>. Configure the options of Kuick on the +<guilabel>Quick Copy & Move</guilabel> tab:</para> + +<para>Check <guilabel>Show "Copy To" and "Move To" entries in context menu</guilabel> +to enable the Kuick module.</para> + +<para>In the sections <guilabel>Copy Operations</guilabel> and <guilabel>Move Operations</guilabel> +you can set the number of the last cached folder with the spinbox <guilabel>Cache the last folders</guilabel> +to a value between 1 and 6. Default is 5.</para> + +<para>If you want to remove all cached entries, click on the <guibutton>Clear List</guibutton> button. +</para> + +</sect2> + +<sect2> +<title>Credits and Licenses</title> + +<para>Kuick is Copyright (C) 2001 Holger Freyther +<email>[email protected]</email></para> + +<para>Documentation written by Burkhard Lück +<email>[email protected]</email>, 2006</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; + +</sect2> + +</sect1> + +</article> diff --git a/doc/konq-plugins/mediaplayer/Makefile.am b/doc/konq-plugins/mediaplayer/Makefile.am new file mode 100644 index 0000000..852d6e5 --- /dev/null +++ b/doc/konq-plugins/mediaplayer/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/mediaplayer + + diff --git a/doc/konq-plugins/mediaplayer/index.docbook b/doc/konq-plugins/mediaplayer/index.docbook new file mode 100644 index 0000000..1fa5b4a --- /dev/null +++ b/doc/konq-plugins/mediaplayer/index.docbook @@ -0,0 +1,59 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="sidebar-mediaplayer"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-09-09</date> +<releaseinfo>3.10.00</releaseinfo> + +<abstract> +<para>The sidebar-mediaplayer allows you to play your music files directly in &konqueror;.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>sidebar-mediaplayer</keyword> +</keywordset> + +</sect1info> + +<title>The Sidebar Media Player</title> + +<sect2> +<title>Using the Sidebar Media Player</title> + +<para>The Sidebar Media Player can be accessed in the &konqueror; menubar under<menuchoice><guimenu>Window</guimenu><guimenuitem>Show Navigation Panel</guimenuitem></menuchoice> or by using the <keycap>F9</keycap> shortcut.</para> + +<para>To use, click the <inlinemediaobject><imageobject><imagedata fileref="cr22-app-konqsidebar_mediaplayer.png" format="PNG" width="22"/></imageobject></inlinemediaobject> on the navigation panel in &konqueror;, and drag-and-drop any music files you wish to listen to into the mediaplayer.</para> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The Sidebar Media Player is copyright © +2001 Joseph Wenninger <email>[email protected]</email>.</para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/uachanger/Makefile.am b/doc/konq-plugins/uachanger/Makefile.am new file mode 100644 index 0000000..f1f502b --- /dev/null +++ b/doc/konq-plugins/uachanger/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/uachanger + + diff --git a/doc/konq-plugins/uachanger/index.docbook b/doc/konq-plugins/uachanger/index.docbook new file mode 100644 index 0000000..a40b392 --- /dev/null +++ b/doc/konq-plugins/uachanger/index.docbook @@ -0,0 +1,102 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="uachanger"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-07-13</date> +<releaseinfo>3.10.00</releaseinfo> + +<abstract> +<para>The uachanger adds a menu to &konqueror; that allows you to +change the Browser and Operating System identification on a +domain-by-domain basis. This is useful when browsing websites that +limit access to those using a particular web browser.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>uachanger</keyword> +</keywordset> + +</sect1info> + +<title>The User Agent Changer</title> + +<sect2> +<title>Using the User Agent Changer</title> + +<para>The &konqueror; uachanger plugin can be accessed in the menubar under <menuchoice><guimenu>Tools</guimenu><guimenuitem>Change Browser Identification</guimenuitem></menuchoice></para> +<!-- ************************************ --> +<!-- We probably need an entity for Mozilla, and I should check about --> +<!-- trademark stuff for the MS browsers (Phil)--> +<!-- ************************************ --> +<variablelist> +<varlistentry> +<term><guimenuitem>Default Identification</guimenuitem></term> +<listitem><para>The default User Agent header for &konqueror; is Mozilla/5.0(compatible;Konqueror/3.2)(KHTML, like Gecko). If you come across a site that refuses this browser access, change your User Agent to one of the options below.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Internet Explorer</guimenuitem></term> +<listitem><para>Allows you to change your User Agent header to MSIE for sites that refuse <application>Mozilla</application>-based browsers entry. You will most likely need to use one of the MSIE User Agents if you wish to use &konqueror; to access Hotmail.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Mozilla</guimenuitem></term> +<listitem><para>Allows you to change the User Agent header in &konqueror; to appear as <application>Mozilla</application> version 1.2.1 through 1.6</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Netscape Navigator</guimenuitem></term> +<listitem><para>Pages that don't comply with W3C recommendations, or were written using proprietary &HTML; elements and attributes will render correctly if you choose to send the User Agent of these old browsers.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Other</guimenuitem></term> +<listitem><para>This section contains miscellaneous browsers that you can use to change your User Agent.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Apply To Entire Site</guimenuitem></term> +<listitem><para>This option allows you to specify that the defined User Agent applies across every page on the site you are visiting.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Configure</guimenuitem></term> +<listitem><para>Selecting <guimenuitem>Configure</guimenuitem> allows you to fine tune the amount of information you wish to reveal about the browser and operating system being used.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The User Agent Changer plugin is Copyright © +2001 Dawit Alemayehu. + +<email>[email protected]</email></para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/validators/Makefile.am b/doc/konq-plugins/validators/Makefile.am new file mode 100644 index 0000000..265a69c --- /dev/null +++ b/doc/konq-plugins/validators/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/validators + + diff --git a/doc/konq-plugins/validators/index.docbook b/doc/konq-plugins/validators/index.docbook new file mode 100644 index 0000000..47b08bf --- /dev/null +++ b/doc/konq-plugins/validators/index.docbook @@ -0,0 +1,87 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="validators"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-01-10</date> +<releaseinfo>3.5.1</releaseinfo> + +<abstract> +<para>The &konqueror; validator plugin checks your &CSS; and &HTML; documents +for conformance to W3C recommendations and other standards.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>validators</keyword> +</keywordset> + +</sect1info> + +<title>The Validators Plugin</title> + +<sect2> +<title>Using the Validators Plugin</title> + +<para>The validator plugin can be accessed in the &konqueror; menubar under +<menuchoice><guimenu>Tools</guimenu><guimenuitem>Validate Web Page</guimenuitem></menuchoice>. +A description of each subitem can be found below.</para> + +<variablelist> +<varlistentry> +<term><guimenuitem>Validate &HTML;</guimenuitem></term> +<listitem><para>The validate &HTML; option allows you to compare your &HTML; document to the defined syntax of &HTML; and reports any errors found. Validating your &HTML; will ensure that your pages display properly on all browsers.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Validate CSS</guimenuitem></term> +<listitem><para>Allows you to validate your &CSS; style sheet that is embedded in an &HTML; or &XHTML; +document. Having valid &CSS; is critical to ensuring that your web site maintains a consistent look regardless of the browser that is being used.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Validate Links</guimenuitem></term> +<listitem><para>Allows you to confirm that the links on your site contain no redirects or broken links. This tool recursively checks all links on a site.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Configure Validator</guimenuitem></term> +<listitem><para>The configure validator item allows you to view the preset validators you can use +to validate your &HTML; and &CSS;.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The validators plugin is Copyright © +2001 Richard Moore and Andreas Schlapbach + +&Richard.J.Moore.mail; +<email>[email protected]</email></para> +</sect2> + +</sect1> +</article> diff --git a/doc/konq-plugins/webarchiver/Makefile.am b/doc/konq-plugins/webarchiver/Makefile.am new file mode 100644 index 0000000..5d00374 --- /dev/null +++ b/doc/konq-plugins/webarchiver/Makefile.am @@ -0,0 +1,6 @@ +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = konq-plugins/webarchiver + + diff --git a/doc/konq-plugins/webarchiver/index.docbook b/doc/konq-plugins/webarchiver/index.docbook new file mode 100644 index 0000000..12e561f --- /dev/null +++ b/doc/konq-plugins/webarchiver/index.docbook @@ -0,0 +1,62 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> + +<sect1 id="webarchiver"> +<sect1info> + +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-07-14</date> +<releaseinfo>3.10.00</releaseinfo> + +<abstract> +<para>The webarchiver plugin for &konqueror; allows for archiving of +web pages, documents and images in <literal role="extension">.war</literal> format.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>konqueror</keyword> +<keyword>plugins</keyword> +<keyword>webarchiver</keyword> +</keywordset> + +</sect1info> + +<title>Web Archiver</title> + +<sect2> +<title>Using the Web Archiver</title> + +<para>To access the webarchiver point your mouse to <menuchoice><guimenu>Tools</guimenu><guimenuitem>Archive Web Page...</guimenuitem></menuchoice>. A dialog will appear allowing you to save the current website being viewed.</para> + +</sect2> + +<sect2> +<title>Credits</title> + +<para>The webarchiver plugin is Copyright © +2001-2003 Andreas Schlapbach, Antonio Larossa and Malte Starostik + +<email>[email protected]</email> +<email>[email protected]</email> +<email>[email protected]</email></para> +</sect2> + +</sect1> +</article> diff --git a/doc/ksig/Makefile.am b/doc/ksig/Makefile.am new file mode 100644 index 0000000..1a8064c --- /dev/null +++ b/doc/ksig/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = AUTO diff --git a/doc/ksig/index.docbook b/doc/ksig/index.docbook new file mode 100644 index 0000000..85879cf --- /dev/null +++ b/doc/ksig/index.docbook @@ -0,0 +1,431 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY ksig "<application>KSig</application>"> + <!ENTITY kappname "&ksig;"> + <!ENTITY package "kdeaddons"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> +<book lang="&language;"> + +<!-- This header contains all of the meta-information for the document such +as Authors, publish date, the abstract, and Keywords --> + +<bookinfo> +<title>The &ksig; Handbook</title> + +<authorgroup> +<author> +<personname> +<firstname>Richard</firstname> +<othername>A.</othername> +<surname>Johnson</surname> +</personname> +<email>[email protected]</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2006</year> +<holder>Richard A. Johnson</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2007-01-06</date> +<releaseinfo>1.01.00</releaseinfo> + +<abstract> +<para> +&ksig; is an application specially designed to manage multiple email signatures +graphically. +</para> +</abstract> + +<keywordset> +<keyword>KSig</keyword> +<keyword>kdeaddons</keyword> +<keyword>signature</keyword> +<keyword>kmail</keyword> +<keyword>plugin</keyword> +</keywordset> + +</bookinfo> + +<!-- CHAPTER: INTRODUCTION --> +<chapter id="introduction"> +<title>Introduction</title> +<para> +&ksig; is a graphical tool for keeping track of many different email signatures. +The signatures themselves can be edited through &ksig;'s graphical user +interface. A command-line interface is then available for generating random or +daily signatures from a list. The command-line interface makes a suitable plugin +for generating signatures in external mail clients such as &kmail;. +</para> +<para> +Random signatures will pull signatures from the &ksig; signature file randomly. +You can make every email more exiciting and uniqe than the previous by creating +multiple signatures with varying quotes, styles, and information. +</para> +<para> +Daily signatures will pull signatures from the &ksig; signature file only using +one signature for an entire day. Every day will provide a different signature, +and just like the random signatures provide uniqueness to your emails. +</para> +<para> + Please report any problems or feature requests to the &kde; mailing lists. +</para> +</chapter> + +<chapter id="using-ksig"> +<title>Using &ksig;</title> +<para> +Go to +<menuchoice><guimenu>KMenu</guimenu><guisubmenu>Utilities</guisubmenu> +<guisubmenu>PIM</guisubmenu><guimenuitem>&ksig; Signature Editor</guimenuitem></menuchoice></para> + +<para> +<screenshot> +<screeninfo>Here's a screenshot of &ksig;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<sect1 id="ksig-newsig"> +<title>Creating a new signature</title> +<para>To create a new signature, go to <menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> </menuchoice>. This will create an +<guilabel><empty signature></guilabel> in the +<guilabel>Signatures</guilabel> section. <mousebutton>Left</mousebutton> click +the <empty signature> and in the bottom section type in your new +signature. +<example> +<title>Signature example</title> +<screen> +Mr. Konqi +http://www.kde.org +</screen> +</example> +Once you have completed your signature, save it by going to <menuchoice> +<shortcut> <keycombo +action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> </menuchoice>, or by pressing the +<guibutton>Save</guibutton> button (floppy disc icon). +</para> + +<para>You can create as many signatures as you would like. Doing so provides you +with a list of signatures to use in email applications such as &kmail;, so no +matter how informal or professional you need to be, there will always be an +available signature.</para> + +</sect1> + +<sect1 id="ksig-delsig"> +<title>Deleting a signature</title> +<para>To remove a signature first select the signature that you want to remove +and then click +<menuchoice><guimenu>File</guimenu><guimenuitem>Remove</guimenuitem></menuchoice +>, or by clicking the <guibutton>Remove</guibutton> button with the red x icon in the +toolbar. +</para> +</sect1> + +<sect1 id="ksig-kmail-daily"> +<title>Adding daily signatures to &kmail;</title> +<para>Adding a daily signature is pretty straight forward. Open &kmail; by +pressing <keycombo>&Alt;<keycap>F2</keycap></keycombo>. Enter +<command>kmail</command> in the text box and then press +<guibutton>Run</guibutton>. Once inside &kmail;, go to +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +KMail...</guimenuitem></menuchoice>. In the <guilabel>Identities</guilabel> +selection, highlight the identity to add the signature to and then press the +<guibutton>Modify...</guibutton> button on the right-hand side of the window. Select +the <guilabel>Signature</guilabel> tab. Check the <guilabel>Enable +signature</guilabel> box. From the <guilabel>Obtain signature text +from</guilabel> drop down, select <guimenuitem>Output of Command</guimenuitem>. +In the <guilabel>Specify command</guilabel> text box, enter <command>ksig +--daily</command> and then press the <guibutton>OK</guibutton> button. +</para> +</sect1> + +<sect1 id="ksig-kmail-random"> +<title>Adding random signatures to &kmail;</title> +<para>Adding a random signature, just like the daily signature, is pretty +straight forward. Open &kmail; by pressing +<keycombo>&Alt;<keycap>F2</keycap></keycombo>. Enter <command>kmail</command> in +the text box and then press <guibutton>Run</guibutton>. Once inside &kmail;, go +to <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +KMail...</guimenuitem></menuchoice>. In the <guilabel>Identities</guilabel> +selection, highlight the identity to add the signature to and then press the +<guibutton>Modify...</guibutton> button on the right-hand side of the window. Select +the <guilabel>Signature</guilabel> tab. Check the <guilabel>Enable +signature</guilabel> box. From the <guilabel>Obtain signature text +from</guilabel> drop down, select <guimenuitem>Output of Command</guimenuitem>. +In the <guilabel>Specify command</guilabel> text box, enter <command>ksig +--random</command> and then press the <guibutton>OK</guibutton> button. +</para> +</sect1> +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the +application windows and their menubar and toolbar commands for easy reference. +Also include any keys that have a special function but have no equivalent in the +menus or toolbars. This may not be necessary for small apps or apps with no tool +or menu bars. --> + +<sect1 id="filemenu"> +<title>The <guilabel>File</guilabel> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Creates a new signature.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Saves the signature.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Remove</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Removes a signature.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Quits &ksig;.</action></para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="editmenu"> +<title>The <guilabel>Edit</guilabel> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>X</keycap></keycombo> </shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Cuts the current selection.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>C</keycap></keycombo> </shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Copies the current selection.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>V</keycap></keycombo> </shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Pastes the current &klipper; content.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Clear</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Clears the current selection.</action></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settingsmenu"> +<title>The <guilabel>Settings</guilabel> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Toolbars</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Toggles whether the <guimenuitem>Main Toolbar +(&ksig;)</guimenuitem> or the <guimenuitem>Search Toolbar (&ksig;)</guimenuitem> +is displayed.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Statusbar</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Toggles whether the status bar is displayed.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Edit Standard Header</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Edits the <guilabel>Standard signature +header.</guilabel></action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Edit Standard Footer</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Edits the <guilabel>Standard signature +footer.</guilabel></action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Displays the <guilabel>Configure Shortcuts</guilabel> dialog box. +This lets you choose shortcut keys for various menu items. To change a shortcut, +select an action from the list, and then choose which keystroke to use. Clicking +on the bottom right <guibutton>Custom</guibutton> button lets you choose which +specific key to use. Just press the new key or key combo.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Displays a &kde; standard dialog where you can configure the +toolbar icons.</action></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="helpmenu"> +<title>The <guilabel>Help</guilabel> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&ksig; +</para> +<para> +Program copyright 2002 &Scott.Wheeler; &Scott.Wheeler.mail; +</para> + +<para> +Documentation Copyright © 2006 Richard A. Johnson +<email>[email protected]</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kapp"> +<title>How to obtain &ksig;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully use &ksig;, you need &kde; 3.5. To apply a signature to +your emails you will also need a client such as &kmail; or any other client that +can obtain the signature text from the output of a command. +</para> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +kate: space-indent on; indent-width 2; tab-width 2; indent-mode none; +--> diff --git a/doc/ksig/screenshot.png b/doc/ksig/screenshot.png Binary files differnew file mode 100644 index 0000000..69be819 --- /dev/null +++ b/doc/ksig/screenshot.png |
