diff options
Diffstat (limited to 'doc/kxsldbg')
39 files changed, 1223 insertions, 0 deletions
diff --git a/doc/kxsldbg/1downarrow.png b/doc/kxsldbg/1downarrow.png Binary files differnew file mode 100644 index 00000000..b8a8b0ff --- /dev/null +++ b/doc/kxsldbg/1downarrow.png diff --git a/doc/kxsldbg/Makefile.am b/doc/kxsldbg/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kxsldbg/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kxsldbg/breakpoints_window.png b/doc/kxsldbg/breakpoints_window.png Binary files differnew file mode 100644 index 00000000..b4033935 --- /dev/null +++ b/doc/kxsldbg/breakpoints_window.png diff --git a/doc/kxsldbg/callstack.docbook b/doc/kxsldbg/callstack.docbook new file mode 100644 index 00000000..20c46fab --- /dev/null +++ b/doc/kxsldbg/callstack.docbook @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="callstack"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> + +<title>Working With the Callstack</title> + +<para> +All call stack items found are listed here. The older the callstack entry +the lower the frame number it will have. See below for an example.</para> + +<screenshot> +<screeninfo>The Callstack Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="callstack_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>The Callstack Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para> +Clicking on a callstack entry in the list shown will cause the cursor in +the main window to move to the file and line number indicated. +</para> +</sect1> + diff --git a/doc/kxsldbg/callstack_window.png b/doc/kxsldbg/callstack_window.png Binary files differnew file mode 100644 index 00000000..0bccd8e5 --- /dev/null +++ b/doc/kxsldbg/callstack_window.png diff --git a/doc/kxsldbg/configure.png b/doc/kxsldbg/configure.png Binary files differnew file mode 100644 index 00000000..37fd0bc6 --- /dev/null +++ b/doc/kxsldbg/configure.png diff --git a/doc/kxsldbg/configure_window.png b/doc/kxsldbg/configure_window.png Binary files differnew file mode 100644 index 00000000..3910c99f --- /dev/null +++ b/doc/kxsldbg/configure_window.png diff --git a/doc/kxsldbg/credits.docbook b/doc/kxsldbg/credits.docbook new file mode 100644 index 00000000..0bd018d6 --- /dev/null +++ b/doc/kxsldbg/credits.docbook @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<chapter id="credits-and-licenses"> +<chapterinfo> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</chapterinfo> +<title>Credits and Licenses</title> + +<para>&kxsldbg; © 2004 Keith Isdale</para> +<para>Documentation © 2004 Keith Isdale</para> + + +<itemizedlist> +<title>Thanks to:</title> +<listitem> +<para> +The writers the <application>libxml</application> and +<application>libxslt</application>. +</para> +</listitem> +<listitem> +<para> +Robert Jacolin for feedback on earlier version of &kxsldbg;. +</para> +</listitem> +<listitem> +<para> +Igor Zlatkovic for creating WIN32 binaries of +<application>libxml/xslt</application> and &xsldbg;. +</para> +</listitem> +</itemizedlist> +&underFDL; +&underGPL; + +</chapter> diff --git a/doc/kxsldbg/entities.docbook b/doc/kxsldbg/entities.docbook new file mode 100644 index 00000000..1f680971 --- /dev/null +++ b/doc/kxsldbg/entities.docbook @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="entities"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> +<title>Working With &XML; Data Files (Entities)</title> + +<para> If the inspector dialog is not showing use the <menuchoice> +<guimenu>Tools</guimenu> <guimenuitem>Show inspectors</guimenuitem> +</menuchoice> menu item. To work with entities click on the +<guilabel>Entities</guilabel> tab of dialog shown. </para> + +<para> All external &XML; entities included via the DATA file or one +of its siblings are listed here. For this example I have run &kxsldbg; +on <filename>testdoc.xsl</filename> with +<filename>testdoc.xml</filename> (found in the +<filename role="directory"><KDE PREFIX>/share/apps/kxsldbg</filename> folder so that you can see some entities.</para> + +<screenshot> +<screeninfo>The Entities Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="entities_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>The Entities Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para> +Clicking on a entity entry in the list shown will cause the cursor in the +main window to move to the start of the file indicated. +</para> +</sect1> diff --git a/doc/kxsldbg/entities_window.png b/doc/kxsldbg/entities_window.png Binary files differnew file mode 100644 index 00000000..29d57f6b --- /dev/null +++ b/doc/kxsldbg/entities_window.png diff --git a/doc/kxsldbg/exit.png b/doc/kxsldbg/exit.png Binary files differnew file mode 100644 index 00000000..6ea935d1 --- /dev/null +++ b/doc/kxsldbg/exit.png diff --git a/doc/kxsldbg/glossary.docbook b/doc/kxsldbg/glossary.docbook new file mode 100644 index 00000000..4a980984 --- /dev/null +++ b/doc/kxsldbg/glossary.docbook @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<glossary id="glossary"> +<glossaryinfo> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</glossaryinfo> + +<glossdiv> +<title>Keywords</title> +<glossentry id="xsldbg-glosref"> +<glossterm>&xsldbg;</glossterm> +<glossdef> +<para> +See <ulink url="http://xsldbg.sourceforge.net"></ulink>. +</para> +</glossdef> +</glossentry> + +<glossentry> +<glossterm>XPath</glossterm> +<glossdef> +<para> +A valid expression that defines what data is required. See +<ulink url="http://www.w3.org">W3C web site</ulink>. +</para> +</glossdef> +</glossentry> + +<glossentry> +<glossterm>QName</glossterm> +<glossdef> +<para> +A fully qualified name. For example, <emphasis>xsl:myvariable</emphasis>. +See <ulink url="http://www.w3.org">W3C web site</ulink> +</para> +</glossdef> +</glossentry> +</glossdiv> +</glossary> diff --git a/doc/kxsldbg/index.docbook b/doc/kxsldbg/index.docbook new file mode 100644 index 00000000..8b52c114 --- /dev/null +++ b/doc/kxsldbg/index.docbook @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kxsldbg "<application>KXSLDbg</application>"> + <!ENTITY kappname "&kxsldbg;"> + <!ENTITY package "quanta"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> + <!ENTITY configure-section SYSTEM "kxsldbg_configure.docbook"> + <!ENTITY mainwindow-section SYSTEM "kxsldbg_mainwindow.docbook"> + <!ENTITY inspector-section SYSTEM "kxsldbg_inspector.docbook"> + <!ENTITY tools-section SYSTEM "kxsldbg_tools.docbook"> + <!ENTITY credits-chapter SYSTEM "credits.docbook"> + <!ENTITY callstack SYSTEM "callstack.docbook"> + <!ENTITY entities SYSTEM "entities.docbook"> + <!ENTITY sources SYSTEM "sources.docbook"> + <!ENTITY templates SYSTEM "templates.docbook"> + <!ENTITY variables SYSTEM "variables.docbook"> + <!ENTITY xsldbg "<application>xsldbg</application>"> + <!ENTITY DTD "<acronym>DTD</acronym>"> + <!ENTITY XSD "<acronym>XSD</acronym>"> + <!ENTITY XSLT "<acronym>XSLT</acronym>"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kxsldbg; Handbook</title> + +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2002</year> +<year>2003</year> +<year>2004</year> +<holder>Keith Isdale</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> +<date>2004-11-18</date> +<releaseinfo>0.5</releaseinfo> + +<abstract> +<para> +&kxsldbg; is a provides a graphic user interface front-end to +&xsldbg;, which supports +debugging of &XSLT; scripts. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>xsldbg</keyword> +<keyword>libxslt</keyword> +<keyword>debugger</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="features"> +<title>Features</title> + +<para> +&kxsldbg; provides access to most of &xsldbg;'s commands to + +<itemizedlist> +<listitem> +<para> +Set and modify breakpoints +</para> +</listitem> +<listitem> +<para> +Display value of XPaths +</para> +</listitem> +<listitem> +<para> +Display information about the templates, variables, +callstack entries, stylesheets and entities present +</para> +</listitem> +<listitem> +<para> +Set and modify breakpoints and variables +</para> +</listitem> +<listitem> +<para> +Move around &XSL; source and &XML; document via XPaths +</para> +</listitem> +<listitem> +<para> +Lookup PUBLIC and SYSTEM ID's in the current &XML; catalog +</para> +</listitem> +</itemizedlist> +</para> +</sect1> + +<sect1 id="new-features"> +<title>Recently added features</title> +<para>&kxsldbg; can now +</para> +<itemizedlist> +<listitem> +<para> +Set and modify variables +</para> +</listitem> +<listitem> +<para> +Renders the text in the main window using the &kate; libraries +</para> +</listitem> +</itemizedlist> +</sect1> + + +</chapter> + +<chapter id="using-kxsldbg"> +<title>Using &kxsldbg;</title> +&configure-section; +&mainwindow-section; +&inspector-section; +&variables; +&callstack; +&templates; +&sources; +&entities; +&tools-section; +</chapter> + +&credits-chapter; + +</book> diff --git a/doc/kxsldbg/kxsldbg_configure.docbook b/doc/kxsldbg/kxsldbg_configure.docbook new file mode 100644 index 00000000..115cd4d3 --- /dev/null +++ b/doc/kxsldbg/kxsldbg_configure.docbook @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="configure"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> + +<title>Configuring a &kxsldbg; Session</title> + +<para> +You start configuration by clicking +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Configure</guimenuitem> +</menuchoice> in the Menubar. +</para> + +<screenshot> +<screeninfo>The Configuration Dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="configure_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>The Configuration Dialog</phrase></textobject> +<caption><para>The Configuration Dialog.</para></caption> +</mediaobject> +</screenshot> + +<sect2> +<title>Getting Started</title> + +<para> +To be able to run a stylesheet you need to specify the: +<itemizedlist mark="bullet"> +<listitem><para>&XSL; source</para></listitem> +<listitem><para>&XML; data</para></listitem> +<listitem><para>Output file</para></listitem> +</itemizedlist> +</para> + +<para> By using the <guibutton>...</guibutton> button to choose file +desired. The <guilabel>&XSL; source</guilabel> and <guilabel>>&XML; data</guilabel> may refer +to URI that contains a http://, ftp:// or file://. The <guilabel>Output file</guilabel> +must refer to a writable local file.</para> +<para> +To follow along with the examples, select the following files in the +example <filename role="directory"><KDE PREFIX>/share/apps/kxsldbg</filename> folder +<itemizedlist mark="bullet"> +<listitem><para>&XSL; source: testdoc.xsl</para></listitem> +<listitem><para>&XML; data: testdoc.xml</para></listitem> +<listitem><para>Output file: /tmp/xsldbg_output.txt</para></listitem> +</itemizedlist> +</para> +</sect2> + +<sect2> +<title>Working With Options</title> + +<para> +You can select zero or more options from the <guilabel>Options</guilabel> dialog. Each option has a tooltip with a hint on what effect it has. +</para> +</sect2> + +<sect2> +<title>Working With Parameters</title> + +<para> +You can add zero or more parameters via the <guilabel>LibXSLT Parameters</guilabel> +section of dialog. This allows you to provide parameter values to the +stylesheet. +</para> + +<para> +For example you could add a enter a <guilabel>Parameter name</guilabel> of <parameter>myparam</parameter> +with a <guilabel>Parameter value</guilabel> of <parameter>'Hello World!'</parameter> and click the <guibutton>Add</guibutton> button. +. To update the value of an existing +parameter just use the navigate to the value you wish to change with the <guibutton>Prev</guibutton> or <guibutton>Next</guibutton> button, provide a new <guilabel>Parameter value</guilabel> then click the <guibutton>Apply</guibutton>. +</para> +</sect2> + +<sect2> +<title>Apply Changes</title> + +<para> +For the changes you have made to take effect press the <guibutton>Apply</guibutton> +button. To ignore any changes press the <guibutton>Cancel</guibutton> button. +</para> + +<para> +You can close the dialog using the <guibutton>X</guibutton> provided at the top right of the window. If you need to change the configuration just re-open the +configuration dialog as shown before. +</para> +</sect2> +</sect1> diff --git a/doc/kxsldbg/kxsldbg_inspector.docbook b/doc/kxsldbg/kxsldbg_inspector.docbook new file mode 100644 index 00000000..ec9995bc --- /dev/null +++ b/doc/kxsldbg/kxsldbg_inspector.docbook @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="breakpoints"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> +<title>Setting and Modifying Breakpoints</title> + +<para> +The primary way to work with breakpoints is via the main window. See +<xref linkend="mainwindow-section"/> +</para> + +<para> +Once you have started the style sheet, you can use the +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Show inspectors</guimenuitem> +</menuchoice> +menu item. Then click on the Breakpoints tab. See below for an example. +</para> + +<screenshot> +<screeninfo>Setting Breakpoints</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="breakpoints_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>Setting Breakpoints</phrase></textobject> +</mediaobject> +</screenshot> + +<sect2> +<title>Adding a Breakpoint</title> + +<para> +You can add a breakpoint by supplying any of:</para> +<orderedlist> +<listitem><para>a file and line number</para> +</listitem> +<listitem><para>a template name</para> +</listitem> +<listitem><para>a template name and a mode name</para> +</listitem> +<listitem><para>a mode name</para> +</listitem> +</orderedlist> + + +<para> +And then pressing the <guibutton>Add</guibutton> button. +</para> +</sect2> + +<sect2> +<title>Argument Details</title> + +<para> +A file name may be absolute path to a local file. Or partial file (⪚ +<filename>xsldoc.xsl</filename>). +</para> + +<para> +A template or mode name may is fully Qualified Name where the non-local +part is optional ⪚ <emphasis>xsl:mytemplate</emphasis> is matched by +<emphasis>mytemplate</emphasis> +</para> +</sect2> + +<sect2> +<title>Deleting a Breakpoint</title> + +<para> +Firstly left mouse click the breakpoint you want to delete in the list of +current breakpoints. Then click the <guibutton>Delete</guibutton> button. +</para> +</sect2> + +<sect2> +<title>Deleting All Breakpoints</title> + +<para> +Click the <guibutton>Delete All</guibutton> button. +</para> +</sect2> + +<sect2> +<title>Enabling or Disabling a Breakpoint</title> + +<para> +Firstly &LMB; click the breakpoint you want to delete in the list of +current breakpoints. Then click the <guibutton>Enable</guibutton> button. +</para> +</sect2> +</sect1> diff --git a/doc/kxsldbg/kxsldbg_mainwindow.docbook b/doc/kxsldbg/kxsldbg_mainwindow.docbook new file mode 100644 index 00000000..3dcd3a55 --- /dev/null +++ b/doc/kxsldbg/kxsldbg_mainwindow.docbook @@ -0,0 +1,455 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="mainwindow-section"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> +<title>Using the Main Window</title> + +<screenshot> +<screeninfo>The Main Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="main_window.png" format="PNG"/> +</imageobject> +<textobject><phrase>A text view of the current file being debugged</phrase></textobject> +<caption><para>A text view of the current file being debugged.</para></caption> +</mediaobject> +</screenshot> + +<sect2> +<title>Working With the Main Window</title> + +<para> +The state of a given breakpoint is indicated via the relevant text with a different background color. +You can choose the color desired: see the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Editor</guimenuitem></menuchoice> dialog, on the +<guilabel>Colors</guilabel> page.</para> + + +<para>You can set, disable or delete a breakpoint using keys, the <guimenu>Debug</guimenu> menu or the buttons on the tool bar.</para> + +<para>You can move the cursor around the text using the following keys:</para> + +<simplelist> +<member>Arrow keys: <keysym>Left Arrow</keysym>, <keysym>Right Arrow</keysym>, <keysym>Up Arrow</keysym> or <keysym>Down Arrow</keysym>.</member> +<member>Page keys: <keycap>Page Up</keycap> or <keycap>Page Down</keycap></member> + +</simplelist> + +</sect2> + +<sect2> +<title>Working With &kxsldbg; Output</title> + +<para> +Most of the output from &kxsldbg; is captured and presented either in the +inspectors dialog or the &kxsldbg; output window. The exceptions to this rule +are:</para> +<itemizedlist> +<listitem> +<para>An error message that comes from &kxsldbg; is displayed inside a message dialog.</para> +</listitem> +<listitem> +<para>The result of evaluating an expression is displayed in a message dialog.</para> +</listitem> +<listitem> +<para>The output of search is sent to the file indicated in the &kxsldbg; output window.</para> +</listitem> +</itemizedlist> + +</sect2> + +<!-- FIXME: There's way too many things wrong with this, for people to +bother translating it just yet. We can fix post 3.2 + +Specifically: Wrong icon images, all keybindings are incorrect, all +keybindings in the app are unmodified and therefore will probably be +changed, and this isn't the ideal place to put a toolbar ref anyway. + +Plan: Add a menu ref chapter, include an updated toolbar ref in it + +<sect2> +<title>&kxsldbg; Toolbar</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="configure.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Configure</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Configuration for a session, <xref linkend="configure"/> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="configure.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Inspect</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +To be written. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="run.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Run</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Restart execution applying current configuration. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="1downarrow.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Continue</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Continue execution stoping at next breakpoint. This will cause the +debugger to stop at the start of the stylesheet if no further breakpoints +are found. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="step.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Step</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Step to the next XSLT instruction found. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="next.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Next</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Proceed to the next instruction at the same call stack depth. This is +useful for stepping over a <emphasis>xsl:apply-templates</emphasis> or +<emphasis>xsl:call-template</emphasis>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_stepup.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>StepUp</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Proceed to the next instruction in a cooler stack frame. This is best +used within a template at a greater depth than the root match template. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_stepdown.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>StepDown</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Proceed to the next instruction in a warmer stack frame. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_break.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Break</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Add a breakpoint at the current cursor location +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_delete.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Delete</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Delete a breakpoint at the current cursor location +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_enable.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Enable/Disable</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Enable or disable a breakpoint at the current cursor location +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_source.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Source</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Cause the current XSLT source file to be shown +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_data.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Data</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Cause the current &XML; data file to be shown +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_output.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Output</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Cause the current Output file to be shown +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="xsldbg_refresh.png" /> +</imageobject> +</inlinemediaobject> +</guiicon> +<guimenu>Debug</guimenu> +<guimenuitem>Reload</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Cause the displayed file to be reloaded from disk +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> +--> + +</sect1> diff --git a/doc/kxsldbg/kxsldbg_tools.docbook b/doc/kxsldbg/kxsldbg_tools.docbook new file mode 100644 index 00000000..0fa7ae8a --- /dev/null +++ b/doc/kxsldbg/kxsldbg_tools.docbook @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="tools-section"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> + +<title>Miscellenous Tools</title> + +<para> +Several tools are available via the tools menu the main tool is the +inspector tool. +</para> + +<sect2> +<title>Inspector Tool</title> + +<para> +The inspector tool is the contains all the individual dialogs for working +with:</para> +<itemizedlist> +<listitem><para>Breakpoints</para></listitem> +<listitem><para>Templates</para></listitem> +<listitem><para>Variables</para></listitem> +<listitem><para>Callstack entries</para></listitem> +<listitem><para>&XSL; source files</para></listitem> +<listitem><para>&XML; Enties</para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Execute by Walking</title> + +<para>By clicking on <guimenuitem>Start execution with +walking</guimenuitem> menu a dialog is shown to allow the walk speed +to be chosen.</para> + +<screenshot> +<screeninfo>The Walk Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="walk_window.png" format="PNG"/> +</imageobject> +<textobject><phrase>The Walk Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para>To stop walking either use the <keycap>W</keycap> key or select the +<guimenuitem>Start execution with walking</guimenuitem> menu item.</para> +</sect2> + +<sect2> +<title>Lookup &XML; Entities</title> + +<para>To lookup a System ID in the current &XML; catalog +use the <guimenuitem>Lookup System ID</guimenuitem> menu then enter the +value to find the the dialog that displays.</para> + +<screenshot> +<screeninfo>The System ID Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="systemid_window.png" format="PNG"/> +</imageobject> +<textobject><phrase>The System ID Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para>To lookup a PUBLIC ID use the <guimenuitem>Lookup Public +ID</guimenuitem> menu entry then enter the value to find the the dialog that +displays.</para> + +<screenshot> +<screeninfo>The Public ID Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="publicid_window.png" format="PNG"/> +</imageobject> +<textobject><phrase>The Public ID Window</phrase></textobject> +</mediaobject> +</screenshot> + +</sect2> +</sect1> diff --git a/doc/kxsldbg/main_window.png b/doc/kxsldbg/main_window.png Binary files differnew file mode 100644 index 00000000..970459a5 --- /dev/null +++ b/doc/kxsldbg/main_window.png diff --git a/doc/kxsldbg/next.png b/doc/kxsldbg/next.png Binary files differnew file mode 100644 index 00000000..00d4fd9d --- /dev/null +++ b/doc/kxsldbg/next.png diff --git a/doc/kxsldbg/publicid_window.png b/doc/kxsldbg/publicid_window.png Binary files differnew file mode 100644 index 00000000..01af4d04 --- /dev/null +++ b/doc/kxsldbg/publicid_window.png diff --git a/doc/kxsldbg/run.png b/doc/kxsldbg/run.png Binary files differnew file mode 100644 index 00000000..e9b35a28 --- /dev/null +++ b/doc/kxsldbg/run.png diff --git a/doc/kxsldbg/sources.docbook b/doc/kxsldbg/sources.docbook new file mode 100644 index 00000000..ecfb658e --- /dev/null +++ b/doc/kxsldbg/sources.docbook @@ -0,0 +1,44 @@ +<sect1 id="sources-section"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> +<title>Working With &XSLT; Source Files (Sources)</title> + +<para> +If the inspector dialog is not showing use the +<menuchoice> +<guimenu>Tools</guimenu> + +<guimenuitem>Show inspectors</guimenuitem> +</menuchoice> +menu item. To work with sources click on the sources tab of dialog shown. +</para> + +<para> +All &XSLT; source files that are included by the &XSLT; file or one of its +siblings are listed here.</para> + +<screenshot> +<screeninfo>The Sources Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="sources_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>The Sources Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para> +Clicking on a source entry in the list shown will cause the cursor in the +main window to move to the start of file indicated. +</para> +</sect1> diff --git a/doc/kxsldbg/sources_window.png b/doc/kxsldbg/sources_window.png Binary files differnew file mode 100644 index 00000000..14e9d3da --- /dev/null +++ b/doc/kxsldbg/sources_window.png diff --git a/doc/kxsldbg/step.png b/doc/kxsldbg/step.png Binary files differnew file mode 100644 index 00000000..a0e64fc0 --- /dev/null +++ b/doc/kxsldbg/step.png diff --git a/doc/kxsldbg/systemid_window.png b/doc/kxsldbg/systemid_window.png Binary files differnew file mode 100644 index 00000000..04b7be70 --- /dev/null +++ b/doc/kxsldbg/systemid_window.png diff --git a/doc/kxsldbg/templates.docbook b/doc/kxsldbg/templates.docbook new file mode 100644 index 00000000..bdd0bdd2 --- /dev/null +++ b/doc/kxsldbg/templates.docbook @@ -0,0 +1,34 @@ +<sect1 id="templates"> +<title>Working With Templates</title> + +<para> +If the inspector dialog is not showing use the +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Show inspectors</guimenuitem> +</menuchoice> +menu item. To work with templates click on the templates tab of dialog +shown. +</para> + +<para> +All templates found are listed here. Please note that the export rules of +&XSLT; apply. So only there may be more than one template with the same +match and mode details.</para> + +<screenshot> +<screeninfo>The Templates Window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="templates_window.png" format="PNG"/> +</imageobject> +<textobject><phrase>The Templates Window</phrase></textobject> +</mediaobject> +</screenshot> + +<para> +Clicking on a template entry in the list shown will cause the cursor in +the main window to move to the file and line number indicated. +</para> +</sect1> + diff --git a/doc/kxsldbg/templates_window.png b/doc/kxsldbg/templates_window.png Binary files differnew file mode 100644 index 00000000..f20f798f --- /dev/null +++ b/doc/kxsldbg/templates_window.png diff --git a/doc/kxsldbg/variables.docbook b/doc/kxsldbg/variables.docbook new file mode 100644 index 00000000..7cdd1cdf --- /dev/null +++ b/doc/kxsldbg/variables.docbook @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<sect1 id="variables"> +<sect1info> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect1info> + +<title>Working With Variables</title> + +<para> +If the inspector dialog is not showing use the +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Show inspectors</guimenuitem> +</menuchoice> +menu item. +</para> + +<para> +Local and global variables are show in a tab on the inspector dialog. +The following example shows a XSLT code segment that declares a global and a local variable +</para> +<informalexample> +<programlisting> + <xsl:variable name="globalvariable" select="'foo'"/> + + <xsl:template match="/"/> + <xsl:param name="localvariable" select="'bar'"/> + </xsl:template match="/"/> +</programlisting> +</informalexample> +<para> +Clicking with with mouse on a variable in the list will cause summary +information to be displayed in the bottom of the dialog. If a variable has + a select expression, for example +</para> +<informalexample> +<programlisting> + <xsl:variable name="changeable" select="'oldValue'" /> +</programlisting> +</informalexample> +<para> +then a new XPath an be choosen by entering a new value + for <guilabel>Variable expression</guilabel> then clicking the <guibutton>Set expression</guibutton> button.</para> + +<screenshot> +<screeninfo>The Variables tab</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="variables_window.png" format="PNG" /> +</imageobject> +<textobject><phrase>The Variables Tab</phrase></textobject> +<caption><para>The Variables Tab</para></caption> +</mediaobject> +</screenshot> + +<para> +Clicking on a variable entry in the list shown will cause the cursor in +the main window to move to the file and line number indicated. +</para> +</sect1> diff --git a/doc/kxsldbg/variables_window.png b/doc/kxsldbg/variables_window.png Binary files differnew file mode 100644 index 00000000..d90cb92d --- /dev/null +++ b/doc/kxsldbg/variables_window.png diff --git a/doc/kxsldbg/walk_window.png b/doc/kxsldbg/walk_window.png Binary files differnew file mode 100644 index 00000000..b30ce81b --- /dev/null +++ b/doc/kxsldbg/walk_window.png diff --git a/doc/kxsldbg/xsldbg_break.png b/doc/kxsldbg/xsldbg_break.png Binary files differnew file mode 100644 index 00000000..68657082 --- /dev/null +++ b/doc/kxsldbg/xsldbg_break.png diff --git a/doc/kxsldbg/xsldbg_data.png b/doc/kxsldbg/xsldbg_data.png Binary files differnew file mode 100644 index 00000000..8feb8c2e --- /dev/null +++ b/doc/kxsldbg/xsldbg_data.png diff --git a/doc/kxsldbg/xsldbg_delete.png b/doc/kxsldbg/xsldbg_delete.png Binary files differnew file mode 100644 index 00000000..fbe766c2 --- /dev/null +++ b/doc/kxsldbg/xsldbg_delete.png diff --git a/doc/kxsldbg/xsldbg_enable.png b/doc/kxsldbg/xsldbg_enable.png Binary files differnew file mode 100644 index 00000000..56c5e5c8 --- /dev/null +++ b/doc/kxsldbg/xsldbg_enable.png diff --git a/doc/kxsldbg/xsldbg_output.png b/doc/kxsldbg/xsldbg_output.png Binary files differnew file mode 100644 index 00000000..5c8fdc53 --- /dev/null +++ b/doc/kxsldbg/xsldbg_output.png diff --git a/doc/kxsldbg/xsldbg_refresh.png b/doc/kxsldbg/xsldbg_refresh.png Binary files differnew file mode 100644 index 00000000..0297288e --- /dev/null +++ b/doc/kxsldbg/xsldbg_refresh.png diff --git a/doc/kxsldbg/xsldbg_source.png b/doc/kxsldbg/xsldbg_source.png Binary files differnew file mode 100644 index 00000000..17618fe8 --- /dev/null +++ b/doc/kxsldbg/xsldbg_source.png diff --git a/doc/kxsldbg/xsldbg_stepdown.png b/doc/kxsldbg/xsldbg_stepdown.png Binary files differnew file mode 100644 index 00000000..3430b61e --- /dev/null +++ b/doc/kxsldbg/xsldbg_stepdown.png diff --git a/doc/kxsldbg/xsldbg_stepup.png b/doc/kxsldbg/xsldbg_stepup.png Binary files differnew file mode 100644 index 00000000..3170b14c --- /dev/null +++ b/doc/kxsldbg/xsldbg_stepup.png |
