diff options
Diffstat (limited to 'doc/kate-plugins')
| -rw-r--r-- | doc/kate-plugins/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/kate-plugins/configure_insertcommand.png | bin | 0 -> 23622 bytes | |||
| -rw-r--r-- | doc/kate-plugins/filetemplates.docbook | 323 | ||||
| -rw-r--r-- | doc/kate-plugins/htmltools.docbook | 84 | ||||
| -rw-r--r-- | doc/kate-plugins/index.docbook | 131 | ||||
| -rw-r--r-- | doc/kate-plugins/insertcommand.docbook | 150 | ||||
| -rw-r--r-- | doc/kate-plugins/insertcommand.png | bin | 0 -> 6558 bytes | |||
| -rw-r--r-- | doc/kate-plugins/openheader.docbook | 49 | ||||
| -rw-r--r-- | doc/kate-plugins/textfilter.docbook | 50 | ||||
| -rw-r--r-- | doc/kate-plugins/xmlcheck.docbook | 102 | ||||
| -rw-r--r-- | doc/kate-plugins/xmltools.docbook | 186 |
11 files changed, 1079 insertions, 0 deletions
diff --git a/doc/kate-plugins/Makefile.am b/doc/kate-plugins/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kate-plugins/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kate-plugins/configure_insertcommand.png b/doc/kate-plugins/configure_insertcommand.png Binary files differnew file mode 100644 index 0000000..af05441 --- /dev/null +++ b/doc/kate-plugins/configure_insertcommand.png diff --git a/doc/kate-plugins/filetemplates.docbook b/doc/kate-plugins/filetemplates.docbook new file mode 100644 index 0000000..74ee3cb --- /dev/null +++ b/doc/kate-plugins/filetemplates.docbook @@ -0,0 +1,323 @@ +<chapter id="filetemplates"> + <chapterinfo> + + <title>File Templates</title> + + <authorgroup> + <author> + <firstname>Anders</firstname> + <surname>Lund</surname> + <affiliation> + <address>&Anders.Lund.mail;</address> + </affiliation> + </author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + </authorgroup> + <date>2006-01-10</date> + <releaseinfo>0.1</releaseinfo> + + <keywordset> + <keyword>KDE</keyword> + <keyword>kate</keyword> + <keyword>kdeaddons</keyword> + <keyword>template</keyword> + <keyword>macro</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <para>The File Templates plug-in allows you to create files based on other + files. You can use any file as a template, which will create a copy of the + file with an empty &URL;, or use a special template file which may contain + macros to fill in information like your name and email address, the + current date and so on, and position the cursor at a + convenient position in the new file.</para> + <para>Furthermore, templates located in the template folder will + be presented in the menu item + <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice>.</para> <para>The plug-in also + provides a method to easily create a new template + from an open document.</para> + <para>The template folder is part of the &kde; file system, and + consists of at least + KDEDIR/share/applications/kate/plugins/katefiletemplates/templates and + KDEHOME/share/applications/kate/plugins/katefiletemplates/templates. If your + KDEDIRS environment variable contains additional directories, those are + searched for a similar subdirectory as well. If equally named templates are + found, the one in the local (KDEHOME) folder is chosen.</para> + <sect1 id="katefiletemplates-menu"> + <title>Menu Structure</title> + + <variablelist> + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenu>New From Template</guimenu> + <guimenuitem>Any File...</guimenuitem> + </menuchoice> + </term> + <listitem><para>Presents you with Open File dialog that allows + you to use any file as a template. If the chosen file has the + extension <filename>katetemplate</filename> it will be parsed + for template information and macros.</para></listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenu>New From Template</guimenu> + <guimenuitem>Use Recent</guimenuitem> + </menuchoice> + </term> + <listitem><para>Presents a list of files recently used as + templates, represented by their &URL;.</para></listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>New From Template</guimenuitem> + </menuchoice> + </term> + <listitem><para>The remainder of submenus contains links to + templates. Click a menuitem to create a file as described by + the menu item text.</para></listitem> + </varlistentry> + + <!-- Settings menu --> + + <varlistentry> + <term> + <menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage + Templates...</guimenuitem></menuchoice></term> + <listitem><para>This will launch a dialog with a list of all templates + found within the template directories, along with options to add, + edit or remove templates.</para></listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="katefiletemplates-use"> + <title>Using a &kate; Template</title> + <para>When creating a file from a template that contain template + macros, some macros appears as editable variables in the text. Such + variables appears as underlined words in the text.</para> + <para>The first variable will be selected, so you just have to type to edit + it.If the document text contains more instances of the same variable, + they are changed as you edit. To move to the next editable variable, + press the TAB key. When the last variable is edited, the list is + dropped, and your TAB key works as normal.</para> + </sect1> + + <sect1 id="katefiletemplates-create"> + <title>Creating your own templates</title> + <para>To create a new template, use the + <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Manage Templates</guimenuitem></menuchoice> Item to launch + the template management dialog. In that, click + <guibutton>New...</guibutton> to launch the File Template Wizard. You + will be asked for an optional file to turn into a template and prompted + for template information settings, and a template file will be created for + you.</para> <para>Alternatively, you can create a template manually by + adding template information to the top of any file, add text and macros, + and save it with the <filename>katetemplate</filename> extension.</para> + <para>The template menu gets automatically updated if you chose to store + your template in the template directory.</para> + </sect1> + + <sect1 id="katefiletemplates-edit"> + <title>Editing templates</title> + <para>To edit a template, use the + <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Manage Templates...</guimenuitem></menuchoice>. Select the + template you want to work on and click <guibutton>Edit...</guibutton>, + and the template file will be opened. Close the dialog, edit the template + file as desired, save it and close it. Changes to templates takes + immediate effect, you can activate the template to test your changes after + saving it.</para> + </sect1> + + <sect1 id="katefiletemplates-format"> + <title>The &kate; Template Format</title> + <para>If you use files with the extension + <filename>katetemplate</filename>, they will be parsed for template + information, macros and a cursor position.</para> + + <sect2 id="katefiletemplates-template-info"> + <title>Template information</title> + <para>While reading in the file, the parser keeps + lines beginning with the phrase + <constant>katetemplate:</constant> and searches them for + template information in the form VARIABLENAME=VALUE. The first line not + starting with <constant>katetemplate:</constant> will be taken as the + start of the template contents. VALUE may contain any character but + equal sign (=). Legal variable names are: + <variablelist> + <varlistentry> + <term><varname>Template</varname></term> + <listitem><para>This is the template name, displayed in the + <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice> menu.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>Group</varname></term> + <listitem><para>The group places the template in a submenu of + the <menuchoice><guimenu>File</guimenu><guimenuitem>New from + Template</guimenuitem></menuchoice> menu.</para></listitem> + </varlistentry> + <varlistentry><term><varname>Name</varname></term> + <listitem><para>This is the name that will be set for the + document, and displayed in the file list and title bar. If the + name contains <userinput>%N</userinput> that will be replaced + with a number, increasing if more documents has the same + name.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>Highlight</varname></term> + <listitem><para>The plug-in will try to set the Highlight for + the new document to the value of this variable. The value + should be the name, as found in the + <menuchoice><guimenu>Tools</guimenu> + <guimenuitem>Highlighting</guimenuitem> + </menuchoice>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Description</varname></term> + <listitem><para>A short informative description of the + template. This is currently used to set a Whatsthis string for + the menu item, but may be used for more purposes in the + future.</para></listitem> + </varlistentry> + <varlistentry><term>Author</term> + <listitem><para>A string identifying the author, for example + in the form <userinput>Name <email address></userinput>. + This is currently used to set a Whatsthis string for the menu + item, but may be used for more purposes in the + future.</para></listitem> + </varlistentry> + </variablelist> + </para> + + </sect2> + + <sect2 id="katetemplates-macros"> + <title>Template Macros</title> + + <para>While parsing the template contents, macros in the form + <userinput>%{NAME}</userinput> or <userinput>${NAME}</userinput> are + expanded. If you use the <userinput>$</userinput> prefix, the + expanded macro will be treated as a editable variable when a document + is created from the template, whereas if you use + <userinput>%</userinput> it is not, unless expanding failed.</para> + <para>The following macros are expanded: + <variablelist> + <varlistentry><term>time</term> + <listitem><para>Expands to the current time in your locale + format.</para></listitem> + </varlistentry> + <varlistentry> + <term>date</term> + <listitem><para>Expands to the current date in short + format.</para></listitem> + </varlistentry> + <varlistentry> + <term>datetime</term> + <listitem><para>Expands to the current date and time, + formatted as a string according to your + locale.</para></listitem> + </varlistentry> + <varlistentry> + <term>year</term> + <listitem><para>The current year as a four digit + number.</para></listitem> + </varlistentry> + <varlistentry> + <term>month</term> + <listitem><para>The full name of the current month, according + to your locale.</para></listitem> + </varlistentry> + <varlistentry><term>day</term> + <listitem><para>Expands to the current day of the month.</para> + </listitem> + </varlistentry> + <varlistentry><term>hostname</term> + <listitem><para>Expands to the 'hostname' of your computer.</para> + </listitem> + </varlistentry> + <varlistentry><term>index</term> + <listitem><para>Expands to 'i'.</para></listitem> + </varlistentry> + <varlistentry><term>fullname</term> + <listitem><para>Expands to your full name, as defined by the + owner addressee in your standard &kde; + addressbook.</para></listitem> + </varlistentry> + <varlistentry><term>firstname</term> + <listitem><para>Expands to your first name, as defined in the owner + addressee in your standard &kde; addressbook.</para> + </listitem> + </varlistentry> + <varlistentry><term>lastname</term> + <listitem><para>Expands to your last name, as defined in the owner + addressee in your standard &kde; addressbook.</para> + </listitem> + </varlistentry> + <!-- <varlistentry> + <term>username</term> + <listitem><para>Expands to your username.</para></listitem> + </varlistentry> --> + <varlistentry> + <term>email</term> + <listitem><para>Expands to your email address, as defined by + the owner address in your standard &kde; + addressbook.</para></listitem> + </varlistentry> + <!--<varlistentry> + <term>organisation</term> + <listitem><para>This is your organisation, as defined by + the owner address in your standard KDE + addressbook.</para></listitem> + </varlistentry>--> + </variablelist> + </para> + <para>Any macro not in the above list is treated as a editable variable + no matter the prefix. + If the same variable occurs multiple times in the template, they can be + edited at once after creating a document from the template.</para> + </sect2> + + <sect2 id="katefiletemplates-cursor"> + <title>Setting the cursor position</title> + <para>The special macro <userinput>${cursor}</userinput> will be replaced + with a vertical bar and added to the end of the list of editable variables, + independent on its location in the text.</para> + </sect2> + + </sect1> + + <sect1 id="katefiletemplates-thanks-and-acknowledgements"> + <title>Thanks and Acknowledgments</title> + + <para> + &kate; Plug-in <quote>File Templates</quote> copyright 2004 &Anders.Lund; + &Anders.Lund.mail;. + </para> + + <para> + Documentation copyright 2004 &Anders.Lund; + </para> + + <!-- TRANS:CREDIT_FOR_TRANSLATORS --> + + <!-- &underFDL; --> + &underGPL; + + </sect1> +</chapter> + +<!-- kate: word-wrap on; space-indent on; indent-width 2; -->
\ No newline at end of file diff --git a/doc/kate-plugins/htmltools.docbook b/doc/kate-plugins/htmltools.docbook new file mode 100644 index 0000000..e8c48fa --- /dev/null +++ b/doc/kate-plugins/htmltools.docbook @@ -0,0 +1,84 @@ +<chapter id="htmltools"> +<chapterinfo> + +<title><acronym>HTML</acronym> Tools </title> + +<authorgroup> +<author> +<firstname>Francis</firstname> +<surname>Giannaros</surname> +<affiliation> +<address><email>francisg@gmail.com</email></address> +</affiliation> +</author> +</authorgroup> +<date>2002-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +A plugin to help with the insertion of &HTML; elements. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>html</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin will open a dialog which will prompt your for a &HTML; +tag +name. +Attributes and values to be put in the opening tag should be entered +<userinput><replaceable>attribute-name</replaceable>="<replaceable>attribute-value</replaceable>"</userinput>. +After pressing &Enter;, the opening -- and respective closing -- tag +will be placed into the document.</para> + +<sect1 id="htmltools-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>HTML Tag...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will open the dialogue as described above.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="htmltools-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>HTML Tools</quote> copyright 2002 Joseph Wenninger +<email>kde@jowenn.at</email>. +</para> + +<para> +Documentation copyright 2005 Francis Giannaros +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/doc/kate-plugins/index.docbook b/doc/kate-plugins/index.docbook new file mode 100644 index 0000000..e927cc9 --- /dev/null +++ b/doc/kate-plugins/index.docbook @@ -0,0 +1,131 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY kappname "&kate;"> + <!ENTITY doc-filetemplates SYSTEM "filetemplates.docbook"> + <!ENTITY doc-htmltools SYSTEM "htmltools.docbook"> + <!ENTITY doc-insertcommand SYSTEM "insertcommand.docbook"> + <!ENTITY doc-openheader SYSTEM "openheader.docbook"> + <!ENTITY doc-projectmanager SYSTEM "projectmanager.docbook"> + <!ENTITY doc-textfilter SYSTEM "textfilter.docbook"> + <!ENTITY doc-xmltools SYSTEM "xmltools.docbook"> + <!ENTITY doc-xmlcheck SYSTEM "xmlcheck.docbook"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kate; Plugins Handbook</title> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<date>2006-02-24</date> +<releaseinfo>3.5.1</releaseinfo> <!-- Used KDE version here --> + +<copyright> +<year>2001</year> +<year>2002</year> +<holder> </holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +This is the handbook for the plugins for &kate;, &kde;'s Advanced Text +Editor. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeaddons</keyword> +<keyword>Kate</keyword> +<keyword>Plugins</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>&kate; plugins</title> + +<para> +&kate; plugins are additional functions for the &kate; editor. They can +add extra menus and shortcuts, and extend &kate;'s features. You can +install as many or as few as you like, from within &kate;. +Open &kate;'s configuration dialog with +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Select <menuchoice><guimenu>Application</guimenu><guimenuitem>Plugins</guimenuitem></menuchoice> to +choose the wanted plugins. +</para> + +<para> +More information on using &kate; and enabling the plugins you want is +available in the &kate; handbook. +</para> + +<para> +The plugins installed in this handbook are: +</para> + +<itemizedlist> +<listitem> +<para><link linkend="xmltools">&XML; Completion</link></para> +</listitem> +<listitem> +<para><link linkend="xmlcheck">&XML; Validation</link></para> +</listitem> +<listitem> +<para><link linkend="insertcommand">Insert Command</link></para> +</listitem> +<listitem> +<para><link linkend="htmltools">&HTML; Tools</link></para> +</listitem> +<listitem> +<para><link linkend="openheader">Open Header</link></para> +</listitem> +<listitem> +<para><link linkend="textfilter">Text Filter</link></para> +</listitem> +<listitem> +<para><link linkend="filetemplates">File Templates</link></para> +</listitem> +</itemizedlist> + +</chapter> + +&doc-xmltools; +&doc-xmlcheck; +&doc-insertcommand; +&doc-htmltools; +&doc-openheader; +&doc-textfilter; +&doc-filetemplates; + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +Copyrights for each applet is listed in the applicable chapter. +</para> + +&underFDL; +&underGPL; + +</chapter> + +<!-- +<appendix id="installation"> +<title>Installation</title> +<para>To be written +</para> +</appendix> +--> + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> diff --git a/doc/kate-plugins/insertcommand.docbook b/doc/kate-plugins/insertcommand.docbook new file mode 100644 index 0000000..eeafe7e --- /dev/null +++ b/doc/kate-plugins/insertcommand.docbook @@ -0,0 +1,150 @@ +<chapter id="insertcommand"> +<chapterinfo> + +<title>Insert Command</title> + +<authorgroup> +<author> +<firstname>Anders</firstname> +<surname>Lund</surname> +<affiliation> +<address>&Anders.Lund.mail;</address> +</affiliation> +</author> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> +<para> +The <quote>Insert Command</quote> plugin allows you to insert shell +command output into a document open in &kate;. +</para> +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>insert</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>The <quote>Insert Command</quote> plugin allows you to insert +shell command output into a document open in &kate;.</para> + +<para>First enable the <quote>Insert Command</quote> plugin by using the +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +&kate;...</guimenuitem></menuchoice> dialog and checking <guilabel>&kate; +InsertCommand</guilabel> in in the <guilabel>Application</guilabel> +<guilabel>Plugins</guilabel> section and close the dialog.</para> + +<sect1 id="insertcommand-fund"> +<title>Onscreen Fundamentals</title> + +<para> +<!-- Basics of using this plugin --> To use the plugin, select +<guimenu>Insert Command...</guimenu> from the <guimenu>Tools</guimenu> +menu, which will present you with a small dialog for entering the +command, choosing a working folder and selecting whether to include +errors (STDERR output) in the inserted text. You can also have the +command string printed above the output. +</para> + +<mediaobject> +<imageobject><imagedata format="PNG" fileref="insertcommand.png"/></imageobject> +<textobject> +<phrase>The Insert Command Dialog</phrase> +</textobject> +</mediaobject> + +<para>The plugin can remember a number of commands as chosen in the +configuration page. These are used for autocompletion, and can be +selected from a list in the command entry. </para> + +<para>By default, the command will be run in the working folder of the +kate process, which is usually your home folder. This can be changed +in the configuration page for the plugin. </para> + +<para>Note that any shell command that requires user input (for +example passwd) or uses a ncurses interface or something similar (for +example top) will fail to produce the expected output. </para> + +</sect1> + +<sect1 id="insertcommand-config"> +<title>Configuration</title> + +<para> +To configure the <quote>Insert Command</quote> +plugin, open the &kate; configuration dialog from the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kate;...</guimenuitem></menuchoice> menu and choose +<menuchoice><guimenuitem>Plugins</guimenuitem><guilabel>Insert Command +</guilabel></menuchoice>. </para> + +<mediaobject> +<imageobject><imagedata format="PNG" +fileref="configure_insertcommand.png"/></imageobject> +<textobject> +<phrase>The Insert Command Configuration Tab</phrase> +</textobject> +</mediaobject> + +<para> +The following configuration options are available: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Number of commands to remember</guilabel></term> +<listitem> +<para>This setting is presented as a spinbox which you can set to the +number of commands to be remembered. Any number from 0 to 99 is +legal. Default is 20.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Default Working Folder</guilabel></term> +<listitem> +<para>This setting, presented as a set of radio buttons, allows you to +decide how the working folder of a command is chosen. The options are +the working folder of the &kate; process (usually your home folder when &kate; is started from the K menu), the folder of the document (if any, otherwise the +above option is used) or the working folder of the last command run in +the plugin. </para> +</listitem> +</varlistentry> + +</variablelist> + + +</sect1> + +<sect1 id="insertcommand-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>Insert Command</quote> copyright 2001 Anders Lund +&Anders.Lund.mail;. +</para> + +<para> +Documentation copyright 2001 &Anders.Lund; &Anders.Lund.mail; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/insertcommand.png b/doc/kate-plugins/insertcommand.png Binary files differnew file mode 100644 index 0000000..1d756be --- /dev/null +++ b/doc/kate-plugins/insertcommand.png diff --git a/doc/kate-plugins/openheader.docbook b/doc/kate-plugins/openheader.docbook new file mode 100644 index 0000000..60aed58 --- /dev/null +++ b/doc/kate-plugins/openheader.docbook @@ -0,0 +1,49 @@ +<chapter id="openheader"> +<chapterinfo> + +<title>Open Header</title> + +<!-- +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation> +<address><email> </email></address> +</affiliation> +</author> +</authorgroup> +<date>2001-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +Note about open header +</para> +</abstract> +--> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>header</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The &kate; plugin <quote>Open Header</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts <email>lauri@kde.org</email>, &kde;'s +Documentation Team coordinator. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/textfilter.docbook b/doc/kate-plugins/textfilter.docbook new file mode 100644 index 0000000..1d628c5 --- /dev/null +++ b/doc/kate-plugins/textfilter.docbook @@ -0,0 +1,50 @@ +<chapter id="textfilter"> +<chapterinfo> + +<title>Text Filter</title> + +<!-- +<authorgroup> +<author> +<firstname> </firstname> +<surname> </surname> +<affiliation> +<address><email> </email></address> +</affiliation> +</author> +</authorgroup> +<date>2001-05-15</date> +<releaseinfo>1.00.00</releaseinfo> +<abstract> +<para> +Note about text filter plugin +</para> +</abstract> +--> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>text</keyword> +<keyword>filter</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The &kate; plugin <quote>Text Filer</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Lauri Watts <email>lauri@kde.org</email>, &kde;'s +Documentation Team coordinator. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/xmlcheck.docbook b/doc/kate-plugins/xmlcheck.docbook new file mode 100644 index 0000000..0156509 --- /dev/null +++ b/doc/kate-plugins/xmlcheck.docbook @@ -0,0 +1,102 @@ +<chapter id="xmlcheck"> +<chapterinfo> + +<title>&XML; Validation</title> + +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation> +<address>&Daniel.Naber.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> + +<para>This plugin checks &XML; files for well-formedness and validity.</para> + +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>xml</keyword> +<keyword>DTD</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin checks the current file. A list of warnings and errors +will appears at the bottom of &kate;'s main window. You can click on an error message +to jump to the corresponding place in the file. If the file has a <quote>DOCTYPE</quote> +the DTD given with this doctype will be used to check the file for validity. The +DTD is expected at a position relative to the current file, ⪚ if the doctype +refers to <quote>DTD/xhtml1-transitional.dtd</quote> and the file is <filename>/home/peter/test.xml</filename> +the DTD is expected to be located at <filename>/home/peter/DTD/xhtml1-transitional.dtd</filename>. +However, remote DTDs specified via http are supported.</para> + +<para>If the file has no doctype it will be checked for well-formedness.</para> + +<para>To learn more about &XML; check out the <ulink url="http://www.w3.org/XML/"> official W3C &XML; pages</ulink>.</para> + +<para>Internally this plugin calls the external command <command>xmllint</command>, which +is part of libxml2. If this command is not correctly installed on your system, the plugin +will not work.</para> + +<note><para>A temporary file needs to be written to the same folder as the file +that should be checked, so you need to have write access to that folder.</para></note> + +<para>To load this plugin open &kate;s configuration dialog under <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Then select <guilabel>Kate XML Validation</guilabel> which will appear +in the <guilabel>Application</guilabel>/<guilabel>Plugins</guilabel> section and close the dialog. +</para> + +<sect1 id="xmlcheck-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>XML</guimenu> +<guimenuitem>Validate XML</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will start the check, as described above.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmlcheck-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>XML Validation</quote> copyright 2002 &Daniel.Naber; +&Daniel.Naber.mail;. +</para> + +<para> +Documentation copyright 2002 &Daniel.Naber; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kate-plugins/xmltools.docbook b/doc/kate-plugins/xmltools.docbook new file mode 100644 index 0000000..fcbadd2 --- /dev/null +++ b/doc/kate-plugins/xmltools.docbook @@ -0,0 +1,186 @@ +<chapter id="xmltools"> +<chapterinfo> + +<title>&XML; Completion</title> + +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation> +<address>&Daniel.Naber.mail;</address> +</affiliation> +</author> +</authorgroup> +<date>2006-05-17</date> +<releaseinfo>3.5.2</releaseinfo> +<abstract> + +<para>This plugin supports writing &XML; files by listing allowed tags +and more.</para> + +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kate</keyword> +<keyword>xml</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para>This plugin gives hints about what is allowed at a certain position in +an &XML; file, according to the file's DTD. It will list possible +elements, attributes, attribute values or entities, depending on the +cursor position (⪚ all entities are listed if the character on the left +of the cursor is <quote>&</quote>). It's also possible to close the nearest +open tag on the left.</para> + +<para>The <acronym>DTD</acronym> must exist in &XML; format, as produced by the Perl program +<command>dtdparse</command>. We will call a DTD in this format <quote>meta DTD</quote>. +Some meta DTDs are supplied. They are installed in +<filename class="directory">$KDEDIR/share/apps/katexmltools/</filename>, +which is also the default folder when you choose +<guimenuitem>Assign Meta DTD...</guimenuitem>. +To produce your own meta DTDs, get <command>dtdparse</command> from +<ulink url="http://dtdparse.sourceforge.net">http://dtdparse.sourceforge.net</ulink>.</para> + +<sect1 id="xmltools-how-to-use"> +<title>How to Use</title> + +<para>Start &kate; and open the configuration dialog under <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>. +Then select <guilabel>Kate XML Completion</guilabel> which will appear +in the <guilabel>Application</guilabel>/<guilabel>Plugins</guilabel> section and close the dialog. After +that, select <menuchoice><guimenu>XML</guimenu><guimenuitem>Assign Meta DTD...</guimenuitem></menuchoice>. +If your document contains no <quote>DOCTYPE</quote> or the doctype is unknown, you'll have to +select a meta DTD from the file system. Otherwise the meta DTD that +matches the current document's DOCTYPE will be loaded automatically.</para> + +<para>You can now use the plugin while typing your text:</para> + +<variablelist> + +<varlistentry> +<term>< (less than key)</term> +<listitem><para>This will trigger a list of possible elements unless the +cursor is inside a tag already. Note that you currently cannot use +this to insert the top level element (⪚ <quote><html></quote>).</para></listitem> +</varlistentry> + +<varlistentry> +<term>" (quote key)</term> +<listitem><para>The quote key will trigger a list of possible attribute +values (if there are some) if you are inside a tag.</para></listitem> +</varlistentry> + +<varlistentry> +<term>(space key)</term> +<listitem><para>This key will trigger a list of possible attributes for the +current element if you are inside a tag.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>& (ampersand key)</term> +<listitem><para>This key will trigger a list of named entities.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmltools-features-and-limitations"> +<title>Features and Limitations</title> + +<para>You can test all functions and limitations by loading +<filename>$KDEDIR/share/apps/katexmltools/testcases.xml</filename> +into &kate; and following the instructions. Note that working with +more than one view per document is not yet correctly supported by +this plugin.</para> + +</sect1> + + +<sect1 id="xmltools-menu"> +<title>Menu Structure</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Return</keycap></keycombo> +</shortcut> +<guimenu>XML</guimenu> +<guimenuitem>Insert Element...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will open a dialog that lets you insert an &XML; element. +The <, > characters and the closing tag will be inserted automatically. +If you have selected text when this menu item is selected, the selected +text will be surrounded by the opening and the closing tag. +The dialog also offers completion of all elements that may be inserted +at the current cursor position if you have assigned a meta DTD by +using <guimenuitem>Assign Meta DTD...</guimenuitem>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap><</keycap></keycombo> +</shortcut> +<guimenu>XML</guimenu> +<guimenuitem>Close Element</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will search your text for a tag that is not yet closed +and will close it by inserting the corresponding closing tag. +The search starts at the cursor position and goes left. If +it cannot find an open tag nothing will happen.</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>XML</guimenu> +<guimenuitem>Assign Meta DTD...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This will tell the plugin which meta DTD to use for the +current document. Note that this assignment will not be saved. +You will have to repeat it when you start &kate; the next time.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="xmltools-thanks-and-acknowledgements"> +<title>Thanks and Acknowledgments</title> + +<para> +&kate; Plugin <quote>XML Completion</quote> copyright 2001,2002 &Daniel.Naber; +&Daniel.Naber.mail;. +</para> + +<para> +Documentation copyright 2001,2002 &Daniel.Naber; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- &underFDL; --> +&underGPL; + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + |
