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/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 +++++++++++++++ 11 files changed, 1079 insertions(+) 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 (limited to 'doc/kate-plugins') 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; + + + + + + -- cgit v1.2.1