From 84da08d7b7fcda12c85caeb5a10b4903770a6f69 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeaddons@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/Makefile.am | 5 + doc/kate-plugins/Makefile.am | 4 + doc/kate-plugins/configure_insertcommand.png | Bin 0 -> 23622 bytes doc/kate-plugins/filetemplates.docbook | 323 ++++++++++++++++++++ doc/kate-plugins/htmltools.docbook | 84 ++++++ doc/kate-plugins/index.docbook | 131 ++++++++ doc/kate-plugins/insertcommand.docbook | 150 ++++++++++ doc/kate-plugins/insertcommand.png | Bin 0 -> 6558 bytes doc/kate-plugins/openheader.docbook | 49 +++ doc/kate-plugins/textfilter.docbook | 50 ++++ doc/kate-plugins/xmlcheck.docbook | 102 +++++++ doc/kate-plugins/xmltools.docbook | 186 ++++++++++++ doc/kicker-applets/Makefile.am | 4 + doc/kicker-applets/index.docbook | 113 +++++++ doc/kicker-applets/kolourpicker.docbook | 56 ++++ doc/kicker-applets/ktimemon.docbook | 429 ++++++++++++++++++++++++++ doc/konq-plugins/Makefile.am | 6 + doc/konq-plugins/babel/Makefile.am | 6 + doc/konq-plugins/babel/index.docbook | 95 ++++++ doc/konq-plugins/crashes/Makefile.am | 6 + doc/konq-plugins/crashes/index.docbook | 58 ++++ doc/konq-plugins/dirfilter/Makefile.am | 6 + doc/konq-plugins/dirfilter/index.docbook | 61 ++++ doc/konq-plugins/domtreeviewer/Makefile.am | 6 + doc/konq-plugins/domtreeviewer/index.docbook | 62 ++++ doc/konq-plugins/fsview/Makefile.am | 6 + doc/konq-plugins/fsview/index.docbook | 182 +++++++++++ doc/konq-plugins/imgallery/Makefile.am | 6 + doc/konq-plugins/imgallery/folders.png | Bin 0 -> 26953 bytes doc/konq-plugins/imgallery/index.docbook | 207 +++++++++++++ doc/konq-plugins/imgallery/look.png | Bin 0 -> 27791 bytes doc/konq-plugins/imgallery/thumbnails.png | Bin 0 -> 20725 bytes doc/konq-plugins/index.docbook | 158 ++++++++++ doc/konq-plugins/khtmlsettings/Makefile.am | 6 + doc/konq-plugins/khtmlsettings/index.docbook | 114 +++++++ doc/konq-plugins/kuick/Makefile.am | 6 + doc/konq-plugins/kuick/index.docbook | 116 +++++++ doc/konq-plugins/mediaplayer/Makefile.am | 6 + doc/konq-plugins/mediaplayer/index.docbook | 59 ++++ doc/konq-plugins/uachanger/Makefile.am | 6 + doc/konq-plugins/uachanger/index.docbook | 102 +++++++ doc/konq-plugins/validators/Makefile.am | 6 + doc/konq-plugins/validators/index.docbook | 87 ++++++ doc/konq-plugins/webarchiver/Makefile.am | 6 + doc/konq-plugins/webarchiver/index.docbook | 62 ++++ doc/ksig/Makefile.am | 2 + doc/ksig/index.docbook | 431 +++++++++++++++++++++++++++ doc/ksig/screenshot.png | Bin 0 -> 7692 bytes 48 files changed, 3560 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/kate-plugins/Makefile.am create mode 100644 doc/kate-plugins/configure_insertcommand.png create mode 100644 doc/kate-plugins/filetemplates.docbook create mode 100644 doc/kate-plugins/htmltools.docbook create mode 100644 doc/kate-plugins/index.docbook create mode 100644 doc/kate-plugins/insertcommand.docbook create mode 100644 doc/kate-plugins/insertcommand.png create mode 100644 doc/kate-plugins/openheader.docbook create mode 100644 doc/kate-plugins/textfilter.docbook create mode 100644 doc/kate-plugins/xmlcheck.docbook create mode 100644 doc/kate-plugins/xmltools.docbook create mode 100644 doc/kicker-applets/Makefile.am create mode 100644 doc/kicker-applets/index.docbook create mode 100644 doc/kicker-applets/kolourpicker.docbook create mode 100644 doc/kicker-applets/ktimemon.docbook create mode 100644 doc/konq-plugins/Makefile.am create mode 100644 doc/konq-plugins/babel/Makefile.am create mode 100644 doc/konq-plugins/babel/index.docbook create mode 100644 doc/konq-plugins/crashes/Makefile.am create mode 100644 doc/konq-plugins/crashes/index.docbook create mode 100644 doc/konq-plugins/dirfilter/Makefile.am create mode 100644 doc/konq-plugins/dirfilter/index.docbook create mode 100644 doc/konq-plugins/domtreeviewer/Makefile.am create mode 100644 doc/konq-plugins/domtreeviewer/index.docbook create mode 100644 doc/konq-plugins/fsview/Makefile.am create mode 100644 doc/konq-plugins/fsview/index.docbook create mode 100644 doc/konq-plugins/imgallery/Makefile.am create mode 100644 doc/konq-plugins/imgallery/folders.png create mode 100644 doc/konq-plugins/imgallery/index.docbook create mode 100644 doc/konq-plugins/imgallery/look.png create mode 100644 doc/konq-plugins/imgallery/thumbnails.png create mode 100644 doc/konq-plugins/index.docbook create mode 100644 doc/konq-plugins/khtmlsettings/Makefile.am create mode 100644 doc/konq-plugins/khtmlsettings/index.docbook create mode 100644 doc/konq-plugins/kuick/Makefile.am create mode 100644 doc/konq-plugins/kuick/index.docbook create mode 100644 doc/konq-plugins/mediaplayer/Makefile.am create mode 100644 doc/konq-plugins/mediaplayer/index.docbook create mode 100644 doc/konq-plugins/uachanger/Makefile.am create mode 100644 doc/konq-plugins/uachanger/index.docbook create mode 100644 doc/konq-plugins/validators/Makefile.am create mode 100644 doc/konq-plugins/validators/index.docbook create mode 100644 doc/konq-plugins/webarchiver/Makefile.am create mode 100644 doc/konq-plugins/webarchiver/index.docbook create mode 100644 doc/ksig/Makefile.am create mode 100644 doc/ksig/index.docbook create mode 100644 doc/ksig/screenshot.png (limited to 'doc') 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 new file mode 100644 index 0000000..af05441 Binary files /dev/null and b/doc/kate-plugins/configure_insertcommand.png differ 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 @@ + + + + File Templates + + + + Anders + Lund + +
&Anders.Lund.mail;
+ + + + + 2006-01-10 + 0.1 + + + KDE + kate + kdeaddons + template + macro + + + + Introduction + + 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. + Furthermore, templates located in the template folder will + be presented in the menu item + FileNew from + Template. The plug-in also + provides a method to easily create a new template + from an open document. + 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. + + Menu Structure + + + + + + File + New From Template + Any File... + + + Presents you with Open File dialog that allows + you to use any file as a template. If the chosen file has the + extension katetemplate it will be parsed + for template information and macros. + + + + + + File + New From Template + Use Recent + + + Presents a list of files recently used as + templates, represented by their &URL;. + + + + + + File + New From Template + + + The remainder of submenus contains links to + templates. Click a menuitem to create a file as described by + the menu item text. + + + + + + + SettingsManage + Templates... + 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. + + + + + + Using a &kate; Template + 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. + 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. + + + + Creating your own templates + To create a new template, use the + Settings + Manage Templates Item to launch + the template management dialog. In that, click + New... 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. 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 katetemplate extension. + The template menu gets automatically updated if you chose to store + your template in the template directory. + + + + Editing templates + To edit a template, use the + Settings + Manage Templates.... Select the + template you want to work on and click Edit..., + 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. + + + + The &kate; Template Format + If you use files with the extension + katetemplate, they will be parsed for template + information, macros and a cursor position. + + + Template information + While reading in the file, the parser keeps + lines beginning with the phrase + katetemplate: and searches them for + template information in the form VARIABLENAME=VALUE. The first line not + starting with katetemplate: will be taken as the + start of the template contents. VALUE may contain any character but + equal sign (=). Legal variable names are: + + + Template + This is the template name, displayed in the + FileNew from + Template menu. + + + Group + The group places the template in a submenu of + the FileNew from + Template menu. + + Name + This is the name that will be set for the + document, and displayed in the file list and title bar. If the + name contains %N that will be replaced + with a number, increasing if more documents has the same + name. + + + Highlight + 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 + Tools + Highlighting + . + + + + Description + 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. + + Author + A string identifying the author, for example + in the form Name <email address>. + This is currently used to set a Whatsthis string for the menu + item, but may be used for more purposes in the + future. + + + + + + + + Template Macros + + While parsing the template contents, macros in the form + %{NAME} or ${NAME} are + expanded. If you use the $ prefix, the + expanded macro will be treated as a editable variable when a document + is created from the template, whereas if you use + % it is not, unless expanding failed. + The following macros are expanded: + + time + Expands to the current time in your locale + format. + + + date + Expands to the current date in short + format. + + + datetime + Expands to the current date and time, + formatted as a string according to your + locale. + + + year + The current year as a four digit + number. + + + month + The full name of the current month, according + to your locale. + + day + Expands to the current day of the month. + + + hostname + Expands to the 'hostname' of your computer. + + + index + Expands to 'i'. + + fullname + Expands to your full name, as defined by the + owner addressee in your standard &kde; + addressbook. + + firstname + Expands to your first name, as defined in the owner + addressee in your standard &kde; addressbook. + + + lastname + Expands to your last name, as defined in the owner + addressee in your standard &kde; addressbook. + + + + + email + Expands to your email address, as defined by + the owner address in your standard &kde; + addressbook. + + + + + 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. + + + + Setting the cursor position + The special macro ${cursor} 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. + + + + + + Thanks and Acknowledgments + + + &kate; Plug-in File Templates copyright 2004 &Anders.Lund; + &Anders.Lund.mail;. + + + + Documentation copyright 2004 &Anders.Lund; + + + + + + &underGPL; + + + + + \ 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 @@ + + + +<acronym>HTML</acronym> Tools + + + +Francis +Giannaros + +
francisg@gmail.com
+ + + +2002-05-15 +1.00.00 + + +A plugin to help with the insertion of &HTML; elements. + + + + +KDE +kate +html + + + +Introduction + +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 +attribute-name="attribute-value". +After pressing &Enter;, the opening -- and respective closing -- tag +will be placed into the document. + + +Menu Structure + + + + + +Tools +HTML Tag... + + +This will open the dialogue as described above. + + + + + + +Thanks and Acknowledgments + + +&kate; Plugin HTML Tools copyright 2002 Joseph Wenninger +kde@jowenn.at. + + + +Documentation copyright 2005 Francis Giannaros + + + + + +&underGPL; + + + + + + 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 @@ + + + + + + + + + + + +]> + + + +The &kate; Plugins Handbook + + + +2006-02-24 +3.5.1 + + +2001 +2002 + + + +&FDLNotice; + + + +This is the handbook for the plugins for &kate;, &kde;'s Advanced Text +Editor. + + + + +KDE +kdeaddons +Kate +Plugins + + + + + +&kate; plugins + + +&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 +SettingsConfigure &kate;.... +Select ApplicationPlugins to +choose the wanted plugins. + + + +More information on using &kate; and enabling the plugins you want is +available in the &kate; handbook. + + + +The plugins installed in this handbook are: + + + + +&XML; Completion + + +&XML; Validation + + +Insert Command + + +&HTML; Tools + + +Open Header + + +Text Filter + + +File Templates + + + + + +&doc-xmltools; +&doc-xmlcheck; +&doc-insertcommand; +&doc-htmltools; +&doc-openheader; +&doc-textfilter; +&doc-filetemplates; + + +Credits and License + + +Copyrights for each applet is listed in the applicable chapter. + + +&underFDL; +&underGPL; + + + + + + + + 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 @@ + + + +Insert Command + + + +Anders +Lund + +
&Anders.Lund.mail;
+ + + +2006-05-17 +3.5.2 + + +The Insert Command plugin allows you to insert shell +command output into a document open in &kate;. + + + +KDE +kate +insert + + + +Introduction + +The Insert Command plugin allows you to insert +shell command output into a document open in &kate;. + +First enable the Insert Command plugin by using the +Settings Configure +&kate;... dialog and checking &kate; +InsertCommand in in the Application +Plugins section and close the dialog. + + +Onscreen Fundamentals + + + To use the plugin, select +Insert Command... from the Tools +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. + + + + + +The Insert Command Dialog + + + +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. + +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. + +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. + + + + +Configuration + + +To configure the Insert Command +plugin, open the &kate; configuration dialog from the +SettingsConfigure +&kate;... menu and choose +PluginsInsert Command +. + + + + +The Insert Command Configuration Tab + + + + +The following configuration options are available: + + + + +Number of commands to remember + +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. + + + + +Default Working Folder + +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. + + + + + + + + + +Thanks and Acknowledgments + + +&kate; Plugin Insert Command copyright 2001 Anders Lund +&Anders.Lund.mail;. + + + +Documentation copyright 2001 &Anders.Lund; &Anders.Lund.mail; + + + + + +&underGPL; + + + + + + diff --git a/doc/kate-plugins/insertcommand.png b/doc/kate-plugins/insertcommand.png new file mode 100644 index 0000000..1d756be Binary files /dev/null and b/doc/kate-plugins/insertcommand.png differ 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 @@ + + + +Open Header + + + +KDE +kate +header + + + +Introduction + + +The &kate; plugin Open Header currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts lauri@kde.org, &kde;'s +Documentation Team coordinator. + + + + + + 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 @@ + + + +Text Filter + + + +KDE +kate +text +filter + + + +Introduction + + +The &kate; plugin Text Filer currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts lauri@kde.org, &kde;'s +Documentation Team coordinator. + + + + + + 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 @@ + + + +&XML; Validation + + + +Daniel +Naber + +
&Daniel.Naber.mail;
+ + + + +2006-05-17 +3.5.2 + + +This plugin checks &XML; files for well-formedness and validity. + + + +KDE +kate +xml +DTD + + + +Introduction + +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 DOCTYPE +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 DTD/xhtml1-transitional.dtd and the file is /home/peter/test.xml +the DTD is expected to be located at /home/peter/DTD/xhtml1-transitional.dtd. +However, remote DTDs specified via http are supported. + +If the file has no doctype it will be checked for well-formedness. + +To learn more about &XML; check out the official W3C &XML; pages. + +Internally this plugin calls the external command xmllint, which +is part of libxml2. If this command is not correctly installed on your system, the plugin +will not work. + +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. + +To load this plugin open &kate;s configuration dialog under Settings +Configure &kate;.... +Then select Kate XML Validation which will appear +in the Application/Plugins section and close the dialog. + + + +Menu Structure + + + + + +XML +Validate XML + + +This will start the check, as described above. + + + + + + +Thanks and Acknowledgments + + +&kate; Plugin XML Validation copyright 2002 &Daniel.Naber; +&Daniel.Naber.mail;. + + + +Documentation copyright 2002 &Daniel.Naber; + + + + +&underGPL; + + + + + + 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 @@ + + + +&XML; Completion + + + +Daniel +Naber + +
&Daniel.Naber.mail;
+ + + +2006-05-17 +3.5.2 + + +This plugin supports writing &XML; files by listing allowed tags +and more. + + + +KDE +kate +xml + + + +Introduction + +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 &). It's also possible to close the nearest +open tag on the left. + +The DTD must exist in &XML; format, as produced by the Perl program +dtdparse. We will call a DTD in this format meta DTD. +Some meta DTDs are supplied. They are installed in +$KDEDIR/share/apps/katexmltools/, +which is also the default folder when you choose +Assign Meta DTD.... +To produce your own meta DTDs, get dtdparse from +http://dtdparse.sourceforge.net. + + +How to Use + +Start &kate; and open the configuration dialog under Settings +Configure &kate;.... +Then select Kate XML Completion which will appear +in the Application/Plugins section and close the dialog. After +that, select XMLAssign Meta DTD.... +If your document contains no DOCTYPE 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. + +You can now use the plugin while typing your text: + + + + +< (less than key) +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 (⪚ <html>). + + + +" (quote key) +The quote key will trigger a list of possible attribute +values (if there are some) if you are inside a tag. + + + +(space key) +This key will trigger a list of possible attributes for the +current element if you are inside a tag. + + + + +& (ampersand key) +This key will trigger a list of named entities. + + + + + + +Features and Limitations + +You can test all functions and limitations by loading +$KDEDIR/share/apps/katexmltools/testcases.xml +into &kate; and following the instructions. Note that working with +more than one view per document is not yet correctly supported by +this plugin. + + + + + +Menu Structure + + + + + + +&Ctrl;Return + +XML +Insert Element... + + +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 Assign Meta DTD.... + + + + + + + +&Ctrl;< + +XML +Close Element + + +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. + + + + + +XML +Assign Meta DTD... + + +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. + + + + + + +Thanks and Acknowledgments + + +&kate; Plugin XML Completion copyright 2001,2002 &Daniel.Naber; +&Daniel.Naber.mail;. + + + +Documentation copyright 2001,2002 &Daniel.Naber; + + + + + +&underGPL; + + + + + + 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 @@ + + + + KTimemon"> + KolourPicker"> + +]> + + + +The &kicker; Applets Handbook + + + + + +
+
 + + + + + +2001-05-12 +2.20.00 + + +2001 + + + +&FDLNotice; + + + +This is the handbook for the addon applets for &kicker;, &kde;'s panel. + + + + +KDE +kdeaddons +Kicker +Applets + + + + + +&kicker; applets + + +Applets are small applications running inside of &kicker;. Almost +everything besides the application starter buttons are applets. They can +be added from the context menu or from the submenu +Configure Panel by choosing +Add and the Applet. + + + +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. + + + +The Applets described in this handbook are: + + + + +&kolourpicker; + + +&ktimemon; + + + + + +&doc-kolourpicker; +&doc-ktimemon; + + +Credits and License + + +Copyrights for each applet is listed in the applicable chapter. + + +&underFDL; +&underGPL; + + + + +Installation + + +To be written + + + + + + + + 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 @@ + + + +&kolourpicker; + + + + + + +
+ + + + + + +To be written + + + +KDE +color +selector + + + +Introduction + + +The &kicker; plugin Kolourpicker 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 + +http://master.kde.org/mailman/listinfo/kde-doc-english +. + + + +Thanks and Acknowledgments + + + +&underGPL; + + + + + + 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 @@ + + + +&ktimemon; + + + +Martin +Maierhofer + +
m.maierhofer@tees.ac.uk
+ + + + +2001-11-29 +0.03.01 + +&ktimemon; is a system monitor for the K Desktop Environment + + +KDE +ktimemon +system monitor +timemon + + + +Introduction + +&ktimemon; is a small program to keep track of your computer's system +usage. It can display bar graphs containing information about +CPU, memory, and swap usage as well as disk usage and +context switch activity. In keeping with the spirit of KDE, it supports configuration via a +graphical user interface. It also supports docking, +&ie; it can display information in the system panel tray. + + +Currently, &ktimemon; only supports a limited number of systems: +&Linux; based installations with the /proc file +system, &Solaris; based installations with the +kstat library, and Digital &UNIX; (formerly +DEC/OSF1) based installations with the +table(2) system call. Help with +porting it to other platforms is most welcome. + + + + +&ktimemon; can be started from the command line or from the &kde; +start menu (in the Utilities +submenu). If you choose to start from the command line, &ktimemon; +honors the usual &X-Window; program flags such as +. &ktimemon; is +session-aware, &ie; it keeps track of the current +state (colors, &etc;) and restores it in the user's next session. + + + +Onscreen Fundamentals + + +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 tool-tip (&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 Configuration). + + + +Display Modes + + +&ktimemon; can display two different sets of system information. As +explained in the Configuration 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 Normal Mode (the default) +to Extended Mode, and vice versa. + + + +Normal Mode + +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 Configuration). The three bar +graphs represent (from left to right): + + +CPU usage. + +&ktimemon; shows the bar in three different colors, representing +CPU time spent in various modes. From bottom to top +they are: kernel mode, user mode, and user mode with lowered priority +(nice) - since &Solaris; does not seem to support +statistics for nice mode, the topmost part of the bar represents time +spent in the wait state on such systems. The gap +from the top of the bar to the top of the window represents the +percentage the CPU idle time. + + + +Memory usage. + +Similar to the CPU 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 inactive 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. + + + +Swap usage. + +This bar consists of a single field representing +the current swap usage relative to the system's total amount of swap +space. + + + + + +Clicking the mouse button bound to mode switch in +the &ktimemon; window switches to Extended Mode. + + + + +Extended Mode + +In this mode, the three bar graphs are used to display a different +set of system information. Again from left to right, they show: + + + +Paging activity. + +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. + + + +Swapping activity. + +The second bar displays the analog +information for swap activity. + + + +Context switches. + +Again, this bar graph consists of a single +field which indicates the number of context switches in the last +sample interval. + + + + +Since there is no natural way of scaling the +information shown in Extended Mode, by default +&ktimemon; uses autoscaling (explained in the +Common Questions Section). There +is, however, the possibility of specifying the scaling information, +see the Configuration section. + +Note that the two sets of bar graphs share the same colors, &ie; +the colors setup for Normal Mode is also used for +displaying information in Extended Mode (see also Configuration on how to change the color +scheme). + + + + + +Menu Structure + + +By default, the &RMB; mouse button is bound to the menu +pop-up action, &ie; clicking the right mouse button anywhere in +the &ktimemon; window brings up a menu, which is discussed in the +following sections. + + + +<guimenuitem>Settings...</guimenuitem> + +The Settings... menu item is used to +pop up the configuration dialog. Configuration options are discussed in +section Configuration. + + + + +<guimenuitem>Docked In Panel</guimenuitem> + + +By selecting the Docked In Panel 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 panelized &ktimemon; behaves +exactly like its big brother. + + + + +<guimenu>Help</guimenu> + +&help.menu.documentation; + + + + +<guimenuitem>Horizontal Bars</guimenuitem> + +By selecting the Horizontal Bars menu +entry, &ktimemon; switches from vertical bars to horizontal bars and +vice versa. Not very useful, but it was easy to implement ;-) + + + + +<guimenuitem>Quit</guimenuitem> + + +The Quit 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. + + + +The configuration information is saved in the file +$HOME/.kde/share/config/ktimemonrc, +where $HOME refers +to the user's home folder. If this file is deleted, &ktimemon; will +start in its default state in the next invocation. + + + + + +Configuration + + +&ktimemon; can be configured via a straight-forward dialog (see also the +discussion of the Configuration +Menu). On the General page, the sample +interval can be specified as well as scaling information (see also the +discussion of the extended mode). If the +Autoscaling check box is ticked (autoscaling is +explained in the FAQ section), the +scaling factors cannot be edited, since &ktimemon; determines them +automatically. + + + +The Colors page can be used to tailor the colors of +the bar graph to individual preferences. A small sample bar graph gives +immediate feedback. + + + +In the Interaction page, mouse bindings can be +adapted. Clicking a mouse button on the &ktimemon; window can be +ignored, trigger a mode switch (see also Modes), invoke the context menu (see also Menu), 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. + +The Interaction 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 Onscreen Fundamentals). + + + +Common Questions and Answers + + + + +Which operating systems does &ktimemon; support? + + + +&ktimemon; supports &Linux; based systems with the /proc file system, &Solaris; based +systems with the kstat library, and Digital +&UNIX; (formerly DEC/OSF1) systems with the +table(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. + + + +Also, contributions to &ktimemon; to adapt it to other platforms are +most welcome. Please contact me at +m.maierhofer@tees.ac.uk if you intend to port &ktimemon; +to other flavors of &UNIX;. + + + + + + + + +How does autoscaling work? + + + + +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: + + + + + +Each of the three bar graphs as described in the extended mode section has an associated +scaling factor. The initial values of these factors are set to some +predetermined value. + + + + +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). + + + + +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. + + + + + + + + + +Why does a message box with diagnostic output from child +command pop up? + + + + +If you bind a mouse button to an external command as described in the +Configuration 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 stderr output of the command +shell, and reports it in this message box. + + + +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 stderr. A simple and elegant +solution to this problem is to add 2>/dev/null +at the end of the command specification. This redirects diagnostic +messages to message nirvana, and stops the message box popping up. + + + + + + + + +Thanks and Acknowledgments + +&ktimemon; is based on an Xt version by my brother. + +Thanks to Tobe Toben, +ttoben@artis.uni-oldenburg.de, Cristian Tibirna +ctibirna@gch.ulaval.ca, Dirk A. Mueller +dmuell@rhrk.uni-kl.de, Mark Krischer +krischem@amp.com, and Lubos Lunak +l.lunak@sh.cvut.cz for bug reports, patches, comments, +suggestions. + + + + +&underGPL; + + + + + + 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 @@ + + + +]> + +
+ + + + + + +Lauri +Watts +
&Lauri.Watts.mail;
 + + + + + +2006-02-26 +3.5.1 + + +The Babel &konqueror; plugin gives you quick access to the +Babelfish translation service. + + + +KDE +kdeaddons +konqueror +plugins +babelfish +translate + + + +The Babel &konqueror; plugin + + +Using the Babelfish plugin + +Babelfish is a machine translation service provided by AltaVista. + +The plugin allows you to automatically translate web pages +between several languages. + +The Babelfish plugin can be accessed in the &konqueror; menubar +under Tools +Translate Web Page. +Select from the list that drops down the language to translate from +and the language to translate to. + +If you have a portion of the text on the page selected, that +will be translated instead of the entire &URL;. + +Not all languages are available from the Babelfish service. + + +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. + + + +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. + + + + + +Credits + +The Babelfish plugin is copyright (C) +2001 &Kurt.Granroth; + +&Kurt.Granroth.mail; + +Documentation Copyright 2002 &Lauri.Watts; +&Lauri.Watts.mail; + + + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2004-07-21 +3.10.00 + + +The crashes plugin bookmarks a list of websites that &konqueror; has crashed on. + + + +KDE +kdeaddons +konqueror +plugins + + + + + +The Crashes Plugin + + +Using the Crashes Plugin + +To use the crashes plugin point &konqueror; to ToolsCrashes. Here you can select to view the site that &konqueror; has crashed on or clear the list of crashes, if any. + + + + +Credits + +The crashesplugin is Copyright © +2002-2003 Alexander Kellett +lypanov@kde.org. + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2004-09-15 +3.10.00 + + +The directory view filter allows you to choose which items are displayed in a directory. + + + +KDE +kdeaddons +konqueror +plugins +dirfilter + + + + +The View Filter + + +Using the View Filter + +The View Filter plugin (also known as dirfilter) +can be accessed in the &konqueror; menubar under +ToolsView +Filter. This plugin allows you to filter +&konqueror;'s current working directory in a variety of ways. + + + + +Credits + +The dirfilter plugin is copyright © +2000-2002 Dawit Alemayehu adawit@kde.org. + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2006-02-26 +3.5.1 + + +The DOM Tree Viewer allows a developer to view the styles, attributes and elements of a web document. + + + +KDE +kdeaddons +konqueror +plugins +DOMTreeViewer + + + + +The <acronym>DOM</acronym> Tree Viewer + + +Using the <acronym>DOM</acronym> Tree Viewer + +To begin using The DOM Tree Viewer in &konqueror;, select ToolsShow DOM Tree. This will open a new window which displays the DOM of the current web page you are viewing. By default the display starts at the root node of the document, example: documentElement, all other nodes that you will see are children or descendants of the root node. + +If you wish to manipulate the DOM tree in any way you will have to use an external script to do so. + + + + +Credits + +The domtreeviewer plugin is Copyright © +2001 The Kafka Team/Andreas Schlapbach + +kde-kafka@master.kde.org +schlpbch@unibe.ch + + + +
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 @@ + +FSView"> + + +]> + +
+ + + + + + +Josef +Weidendorfer +
Josef.Weidendorfer@gmx.de
+ + + + + +2006-02-24 +3.5.1 + + +The &fsview; Plugin for &konqueror; is another view mode for +objects of mimetype inode/directory 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. + + + +KDE +kdeaddons +konqueror +plugins + + + + + +&fsview; - the File System View + + +Introduction + +The &fsview; Plugin for &konqueror; is another view mode for +objects of mimetype inode/directory 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. + +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. + +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; du command. + +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 F5. 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. + + + + +Visualization Features + +This section explains the graphical visualization of &fsview; +in detail. + + +Item Drawing Options + +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. + +The color of a rectangle, switchable via menu item +ViewColor +Mode can be either +Depth for easy detection of the nesting, or +a color mapping of different file attributes like name, owner, group, +or mime type. + +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. + + + + +TreeMap Drawing Algorithms + +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. + +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. + +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 Rows, Columns, or +Recursive Bisection. + +You can choose the minimal area of items to be drawn via the +menu item ViewStop at +Area. Instead, a hash pattern will be drawn +over the parents area to signal that this space is in fact occupied by +a child. + + + + + + +User Interface + +&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. + +There is keyboard navigation available in tree maps: use +Left Arrow and Right Arrow keys to +move the current item between siblings, and the Up +Arrow and Down Arrow keys to go up and down +the nesting hierarchy. Space 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 +Return to run the open action onto the current item. + + + + +Credits and License + +Originally, &fsview; was meant as a small test application and +usage tutorial for the TreeMap widget developed within +KCachegrind. + +Copyright by Josef Weidendorfer, licensed using GPL V2. + +&underGPL; +&underFDL; + + + + +
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 new file mode 100644 index 0000000..8cce375 Binary files /dev/null and b/doc/konq-plugins/imgallery/folders.png differ 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 @@ + + + +]> + +
+ + + + + + +Mike +Diehl +
madpenguin8@yahoo.com
 + + + + + +2006-02-24 +3.00.00 + + +The Image Gallery &konqueror; plugin creates image gallery html pages from a selected directory. + + + +KDE +kdeaddons +konqueror +plugins + + + + +The Image Gallery Plugin + + +Using the Image Gallery Plugin + +The Image Gallery plugin can be accessed in the &konqueror; menubar under ToolsCreate Image Gallery, or with &Ctrl;I. + +When you start the Image Gallery plugin a dialog opens allowing you to adjust the way the gallery is created. + + + + +Page Look + + +Look Dialog Screenshot + + + + + +Screenshot + + + + +The Look dialog is for adjusting the appearance of the gallery page. + + + + +Page title +The Page title option has a text input box for changing the title of the image gallery page. + + + +Images per row +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. + + + +Show image file name +The Show image file name check box allows you to turn on or off the use of the filenames below the gallery thumbnails. + + + +Show image file size +The Show image filesize check box allows you to turn on or off the use of the filesizes below the gallery thumbnails. + + + +Show image dimensions +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. + + + +Font name +The Font name combo box provides you with a choice of which font to use in creating the gallery. + + + +Font size +The Font size spin box is for changing the size of the font you selected. + + + +Foreground color +The Foreground color option has a selector for choosing the foreground color of the gallery, this includes the text areas. + + + +Background color +The Background color option has a selector for choosing the background color of the gallery. + + + + + + +Folders + + +Folders Dialog Screenshot + + + + + +Screenshot + + + + + +The Folders dialog is used for choosing where to save the gallery. This dialog is also used to configure what folders are used. + + + + +Save to HTML file +The Save to file selector decides where you want to save you image gallery html page. + + + +Recurse subfolders +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. + + + +Copy original files +The Copy original files check box creates an image folder storing copies of the original images used in the gallery. + + + +Use comment file +The use comment file check box enables a file selector to choose a comments file to use with your gallery. + + + + + + +Thumbnails + + +Thumbnails Dialog Screenshot + + + + + +Screenshot + + + + +The thumbnails dialog is used for adjusting the properties of the thumbnails in the gallery. + + + + +Image format for the thumbnails +The image format combo box allows you to choose what format is used for the thumbnail images. + + + +Thumbnail size +The thumbnail size option provides a slider and spin box for adjusting the size of the thumbnails used in the gallery. + + + +Set different color depth +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. + + + + + +Credits + + Copyright © 2001,2003 Lukas Tinkl lukas@kde.org + Andreas Schlapbach schlpbch@iam.unibe.ch + +Documentation Copyright 2004 Mike Diehl madpenguin8@yahoo.com + + + + +
diff --git a/doc/konq-plugins/imgallery/look.png b/doc/konq-plugins/imgallery/look.png new file mode 100644 index 0000000..e06c6c4 Binary files /dev/null and b/doc/konq-plugins/imgallery/look.png differ diff --git a/doc/konq-plugins/imgallery/thumbnails.png b/doc/konq-plugins/imgallery/thumbnails.png new file mode 100644 index 0000000..c1a7c0c Binary files /dev/null and b/doc/konq-plugins/imgallery/thumbnails.png differ 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 @@ + + + + +]> + + + +The &konqueror; Plugins Handbook + + + +Lauri +Watts +
&Lauri.Watts.mail;
 + + + + + +2006-05-20 +3.5.2 + + +2002 +&Lauri.Watts; + + +&FDLNotice; + + + +This is the handbook for the additional plugins for &konqueror; the +&kde; file manager and web browser. + + + + +KDE +kdeaddons +Konqueror +Plugins + + + + + +Introduction + + +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. + + + +More information on the use of &konqueror; and it's built in +functionality, can be found in the &konqueror; handbook. + + + +To load these plugins from within &konqueror;, select +SettingsConfigure Extensions.... +Go to the Tools tab and choose the wanted plugins. + + + +This is a list of the standard configuration +modules provided by the &kde; addons +package. Please note that there may be many more modules on your system if you +have installed additional software. + + + + +Babelfish + + +The DOM tree +viewer + + +The &konqueror; image +gallery + + +The Embedded Media +Player + + +The +Validators + + +Kuick + + +The Folder +Filter + + +KHTMLSettings + + +The User Agent Changer + + +The Web +Archiver + + +The Crashes +Plugin + + +FSView - the File +System View + + + + + + +Credits and License + + +Copyrights for each plugin are listed in the applicable chapter. + + + +&underFDL; +&underGPL; + + + + +Installation + +&install.intro.documentation; + +You should install the kdebase package which contains +&konqueror; before attempting to compile this package. + +&install.compile.documentation; + + + + + + + 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 @@ + + + +]> + +
+ + + + + + +Mike +Diehl +
madpenguin8@yahoo.com
 + + + +Lauri +Watts +
&Lauri.Watts.mail;
 + + + + + + +2006-01-10 +3.5.1 + + +The &HTML; Settings plugin provides an easy way to access the common &HTML; settings for &konqueror;. + + + +KDE +kdeaddons +konqueror +plugins + + + + +KHTMLSettings + + +Using KHTMLSettings + +The &HTML; settings plugin can be accessed in the &konqueror; menubar under ToolsHTML Settings. Below is a list of the settings and a short description of each one. + + + +JavaScript +Allows you to turn the use of JavaScript in &konqueror; on or off. + + + +Java +Allows you to turn the use of &Java; in &konqueror; on or off. + + + +Cookies +Allows you to turn the use of Cookies in &konqueror; on or off. + + + +Plugins +Allows you to turn the use of the &konqueror; plugins you have installed on or off. + + + +Autoload Images +Allows you to turn on or off the loading of images in web pages. + + + +Enable Proxy +Allows you to enable or disable the use of a proxy in the &konqueror; browser. + + + +Enable Cache +Allows you to enable or disable the use of cache in the &konqueror; browser. + + + +Cache Policy + +The Cache Policy submenu provides you with a way to configure the how +&konqueror; uses cache. The possible uses include: + +Keep Cache in Sync +Use Cache if Possible +Offline Browsing Mode + + + + + + + + +Credits + + Copyright © 2001 &Carsten.Pfeiffer; &Carsten.Pfeiffer.mail; + +Documentation Copyright 2004 Mike Diehl madpenguin8@yahoo.com + + + +
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 @@ + + + +]> + +
+ + + + + + +Burkhard +Lück +
+lueck@hube-lueck.de
 + + + + + +2006-03-11 +3.5.2 + + +Kuick allows you to move and copy files quickly from a context menu in &konqueror;. + + + +KDE +kdeaddons +konqueror +plugins +kuick + + + + +The Kuick &konqueror; plugin + + +Introduction + + +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 Copy To or Move To to show a list with +these options: + + + + + +Home Folder +Copy or Move the selection to the home folder or subfolders + + + +Root Folder +Copy or Move the selection to the root folder or subfolders + + + +Contact +To be written + + + +Browse... +Opens a dialog to choose a target folder or create a +New Folder. + + + + + + + +The Kuick &kcontrolcenter; module + +In the &kcontrolcenter; select KDE Components +File Manager. Configure the options of Kuick on the +Quick Copy & Move tab: + +Check Show "Copy To" and "Move To" entries in context menu +to enable the Kuick module. + +In the sections Copy Operations and Move Operations +you can set the number of the last cached folder with the spinbox Cache the last folders +to a value between 1 and 6. Default is 5. + +If you want to remove all cached entries, click on the Clear List button. + + + + + +Credits and Licenses + +Kuick is Copyright (C) 2001 Holger Freyther +freyther@yahoo.com + +Documentation written by Burkhard Lück +lueck@hube-lueck.de, 2006 + + +&underFDL; +&underGPL; + + + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2004-09-09 +3.10.00 + + +The sidebar-mediaplayer allows you to play your music files directly in &konqueror;. + + + +KDE +kdeaddons +konqueror +plugins +sidebar-mediaplayer + + + + +The Sidebar Media Player + + +Using the Sidebar Media Player + +The Sidebar Media Player can be accessed in the &konqueror; menubar underWindowShow Navigation Panel or by using the F9 shortcut. + +To use, click the on the navigation panel in &konqueror;, and drag-and-drop any music files you wish to listen to into the mediaplayer. + + + + +Credits + +The Sidebar Media Player is copyright © +2001 Joseph Wenninger jowenn@kde.org. + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2004-07-13 +3.10.00 + + +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. + + + +KDE +kdeaddons +konqueror +plugins +uachanger + + + + +The User Agent Changer + + +Using the User Agent Changer + +The &konqueror; uachanger plugin can be accessed in the menubar under ToolsChange Browser Identification + + + + + + +Default Identification +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. + + + +Internet Explorer +Allows you to change your User Agent header to MSIE for sites that refuse Mozilla-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. + + + +Mozilla +Allows you to change the User Agent header in &konqueror; to appear as Mozilla version 1.2.1 through 1.6 + + + +Netscape Navigator +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. + + + +Other +This section contains miscellaneous browsers that you can use to change your User Agent. + + + +Apply To Entire Site +This option allows you to specify that the defined User Agent applies across every page on the site you are visiting. + + + +Configure +Selecting Configure allows you to fine tune the amount of information you wish to reveal about the browser and operating system being used. + + + + + + +Credits + +The User Agent Changer plugin is Copyright © +2001 Dawit Alemayehu. + +adawit@kde.org + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2006-01-10 +3.5.1 + + +The &konqueror; validator plugin checks your &CSS; and &HTML; documents +for conformance to W3C recommendations and other standards. + + + +KDE +kdeaddons +konqueror +plugins +validators + + + + +The Validators Plugin + + +Using the Validators Plugin + +The validator plugin can be accessed in the &konqueror; menubar under +ToolsValidate Web Page. +A description of each subitem can be found below. + + + +Validate &HTML; +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. + + + +Validate CSS +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. + + + +Validate Links +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. + + + +Configure Validator +The configure validator item allows you to view the preset validators you can use +to validate your &HTML; and &CSS;. + + + + + + +Credits + +The validators plugin is Copyright © +2001 Richard Moore and Andreas Schlapbach + +&Richard.J.Moore.mail; +schlpbch@iam.unibe.ch + + + +
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 @@ + + + +]> + +
+ + + + + + +Gardner +Bell +
gbell72@rogers.com
 + + + + + +2004-07-14 +3.10.00 + + +The webarchiver plugin for &konqueror; allows for archiving of +web pages, documents and images in .war format. + + + +KDE +kdeaddons +konqueror +plugins +webarchiver + + + + +Web Archiver + + +Using the Web Archiver + +To access the webarchiver point your mouse to ToolsArchive Web Page.... A dialog will appear allowing you to save the current website being viewed. + + + + +Credits + +The webarchiver plugin is Copyright © +2001-2003 Andreas Schlapbach, Antonio Larossa and Malte Starostik + +schlpbch@iam.unibe.ch +larossa@kde.org +malte@kde.org + + + +
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 @@ + +KSig"> + + + + +]> + + + + + +The &ksig; Handbook + + + + +Richard +A. +Johnson + +nixternal@ubuntu.com + + + + + +2006 +Richard A. Johnson + + + +&FDLNotice; + +2007-01-06 +1.01.00 + + + +&ksig; is an application specially designed to manage multiple email signatures +graphically. + + + + +KSig +kdeaddons +signature +kmail +plugin + + + + + + +Introduction + +&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;. + + +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. + + +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. + + + Please report any problems or feature requests to the &kde; mailing lists. + + + + +Using &ksig; + +Go to +KMenuUtilities +PIM&ksig; Signature Editor + + + +Here's a screenshot of &ksig; + + + + + + Screenshot + + + + + + +Creating a new signature +To create a new signature, go to &Ctrl;N +File +New . This will create an +<empty signature> in the +Signatures section. Left click +the <empty signature> and in the bottom section type in your new +signature. + +Signature example + +Mr. Konqi +konqi@kde.org +http://www.kde.org + + +Once you have completed your signature, save it by going to + &Ctrl;S +File +Save , or by pressing the +Save button (floppy disc icon). + + +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. + + + + +Deleting a signature +To remove a signature first select the signature that you want to remove +and then click +FileRemove, or by clicking the Remove button with the red x icon in the +toolbar. + + + + +Adding daily signatures to &kmail; +Adding a daily signature is pretty straight forward. Open &kmail; by +pressing &Alt;F2. Enter +kmail in the text box and then press +Run. Once inside &kmail;, go to +SettingsConfigure +KMail.... In the Identities +selection, highlight the identity to add the signature to and then press the +Modify... button on the right-hand side of the window. Select +the Signature tab. Check the Enable +signature box. From the Obtain signature text +from drop down, select Output of Command. +In the Specify command text box, enter ksig +--daily and then press the OK button. + + + + +Adding random signatures to &kmail; +Adding a random signature, just like the daily signature, is pretty +straight forward. Open &kmail; by pressing +&Alt;F2. Enter kmail in +the text box and then press Run. Once inside &kmail;, go +to SettingsConfigure +KMail.... In the Identities +selection, highlight the identity to add the signature to and then press the +Modify... button on the right-hand side of the window. Select +the Signature tab. Check the Enable +signature box. From the Obtain signature text +from drop down, select Output of Command. +In the Specify command text box, enter ksig +--random and then press the OK button. + + + + + +Command Reference + + + + +The <guilabel>File</guilabel> Menu + + + + &Ctrl;N +File +New + +Creates a new signature. + + + + + &Ctrl;S +File +Save + +Saves the signature. + + + + + +File +Remove + +Removes a signature. + + + + + &Ctrl;Q +File +Quit + +Quits &ksig;. + + + + + + + +The <guilabel>Edit</guilabel> Menu + + + + &Ctrl;X +Edit +Cut + +Cuts the current selection. + + + + + &Ctrl;C +Edit +Copy + +Copies the current selection. + + + + + &Ctrl;V +Edit +Paste + +Pastes the current &klipper; content. + + + + + +Edit +Clear + +Clears the current selection. + + + + + + + +The <guilabel>Settings</guilabel> Menu + + + + +Settings +Toolbars + +Toggles whether the Main Toolbar +(&ksig;) or the Search Toolbar (&ksig;) +is displayed. + + + + + +Settings +Show/Hide Statusbar + +Toggles whether the status bar is displayed. + + + + + +Settings +Edit Standard Header + +Edits the Standard signature +header. + + + + + +Settings +Edit Standard Footer + +Edits the Standard signature +footer. + + + + + +Settings +Configure Shortcuts... + +Displays the Configure Shortcuts 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 Custom button lets you choose which +specific key to use. Just press the new key or key combo. + + + + + +Settings +Configure Toolbars... + +Displays a &kde; standard dialog where you can configure the +toolbar icons. + + + + + + + +The <guilabel>Help</guilabel> Menu + +&help.menu.documentation; + + + + + +Credits and License + + +&ksig; + + +Program copyright 2002 &Scott.Wheeler; &Scott.Wheeler.mail; + + + +Documentation Copyright © 2006 Richard A. Johnson +nixternal@ubuntu.com + + + + +&underFDL; + +&underGPL; + + + + +Installation + + +How to obtain &ksig; + +&install.intro.documentation; + + + + +Requirements + + +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. + + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + + +&documentation.index; + + + diff --git a/doc/ksig/screenshot.png b/doc/ksig/screenshot.png new file mode 100644 index 0000000..69be819 Binary files /dev/null and b/doc/ksig/screenshot.png differ -- cgit v1.2.3