diff options
| author | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
|---|---|---|
| committer | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
| commit | e9ae80694875f869892f13f4fcaf1170a00dea41 (patch) | |
| tree | aa2f8d8a217e2d376224c8d46b7397b68d35de2d /doc/xsldbg | |
| download | tdewebdev-e9ae80694875f869892f13f4fcaf1170a00dea41.tar.gz tdewebdev-e9ae80694875f869892f13f4fcaf1170a00dea41.zip | |
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/kdewebdev@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/xsldbg')
| -rw-r--r-- | doc/xsldbg/Makefile.am | 3 | ||||
| -rw-r--r-- | doc/xsldbg/commands.docbook | 801 | ||||
| -rw-r--r-- | doc/xsldbg/credits.docbook | 21 | ||||
| -rw-r--r-- | doc/xsldbg/index.docbook | 124 | ||||
| -rw-r--r-- | doc/xsldbg/introduction.docbook | 20 | ||||
| -rw-r--r-- | doc/xsldbg/usage.docbook | 147 | ||||
| -rw-r--r-- | doc/xsldbg/xsldbghelp.xml | 22 | ||||
| -rw-r--r-- | doc/xsldbg/xsldbghelp.xsl | 127 |
8 files changed, 1265 insertions, 0 deletions
diff --git a/doc/xsldbg/Makefile.am b/doc/xsldbg/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/xsldbg/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/xsldbg/commands.docbook b/doc/xsldbg/commands.docbook new file mode 100644 index 00000000..0c1e6735 --- /dev/null +++ b/doc/xsldbg/commands.docbook @@ -0,0 +1,801 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="addparam_cmd"><title id="addparam_cmd.title">Addparam</title> +<para>Add a libxslt parameter ; equivalent to providing --param <QNAME>:<XPATH> via command line. +</para> +<para></para> +<table><title>Addparam usage</title> +<tgroup cols="1"><tbody> +<row><entry>addparam <QNAME> <XPATH> <emphasis>(The <XPATH> must not contain any spaces nor double quotation marks.) </emphasis></entry></row> +<row><entry>addparam <QNAME> "<XPATH>" <emphasis>(Must not contain double quotation marks in <XPATH>)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="addwatch_cmd"><title id="addwatch_cmd.title">Addwatch</title> +<para>Add an expression to be watched. See showwatch for display watch values</para> +<para>Shortcut name: watch</para> +<table><title>Addwatch usage</title> +<tgroup cols="1"><tbody> +<row><entry>addwatch <XPATH></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="base_cmd"><title id="base_cmd.title">Base</title> +<para>Print the base for this node</para> +<table><title>Base usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>base</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="break_cmd"><title id="break_cmd.title">Break</title> +<para>Break at a template, at a location in a stylesheet or xml file loaded by xsldbg, or at the current node. +New for xsldbg 3.1.4: When in gdb compatabilty mode orpaned breakpoints can be +set at a specific file and line number and be resolved to an active later on. </para> +<para>Shortcut name: b</para><para>xsldbg will try to guess the complete URL given a +<informaltable> +<tgroup cols="1"><tbody> +<row><entry>file name without a path specified.</entry></row> +<row><entry>a file name in the same directory as the "top" stylesheet loaded</entry></row> +<row><entry>a file name relative to the current working directory of xsldbg</entry></row> +</tbody></tgroup> +</informaltable> +Ie if you have loaded a stylesheet file of ../en/xsldoc.xsl you can do this +</para><para> break -l xsldoc.xsl 26 +</para><para>This command will match a partial or complete QNAME template and or mode name provided. Eg "template" will ma/tch any QNAME with a local part of "template" +</para><para>Any name spaces in the provided QNAME will be expanded as specified +by the names spaces defined in the XSL SOURCE file. eg "xsl:test1" will be expanded to "http://www.w3.org/199/XSL/Transform:test1" +</para><para>A requested breakpoint may need to be resolved to its associated URL and line number. This is done automaticly after +the first template has been seen by xsldbg. Breakpoints are re-validated shortly after the start of each run. +</para><para>Automatic breakpoint validation is used when gdb mode is enabled - the default behaviour of xsldbg</para> +<table><title>Break usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>break -l <FILENAME> <LINENO> <emphasis>(To set breakpoint at specified file, line number)</emphasis></entry></row> +<row><entry>break -l <URI> <LINENO> <emphasis>(To set breakpoint at specified URI, line number)</emphasis></entry></row> +<row><entry>break <TEMPLATE_NAME> <emphasis>(To break at named or matched template.)</emphasis></entry></row> +<row><entry>break <TEMPLATE_NAME> <MODE_NAME> <emphasis>(To break at named template with given mode.)></emphasis></entry></row> +<row><entry>break "" <MODE_NAME> <emphasis>(To break at any template that has a given mode name)</emphasis></entry></row> +<row><entry>break * <emphasis>(To break at any template found.)</emphasis></entry></row> +<row><entry>break \* <emphasis>(To break at the "*" template. Other name that include '*' will not be treated specialy.)</emphasis></entry></row> +<row><entry>break <emphasis>(To break point at current node. Yes that includes xml data nodes!)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="bye_cmd"><title id="bye_cmd.title">Bye</title> +<para>Exit processing stylesheet as soon as possible.</para> +<table><title>Bye usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>bye</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="cat_cmd"><title id="cat_cmd.title">Cat</title> +<para>Print the result of a xpath expression on relative current node.</para> +<table><title>Cat usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>Usage : cat <XPATH> <emphasis>(To view a variable or parameter)</emphasis></entry></row> +<row><entry>Usage : cat $<QNAME></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="cd_cmd"><title id="cd_cmd.title">Cd</title> +<para>Change to the path specified by a xpath.</para> +<table><title>Cd usage</title> +<tgroup cols="1"> +<tbody> +<row><entry><< = preceding-sibling::node()</entry></row> +<row><entry>>> = following-sibling::node()</entry></row> +<row><entry><- = ancestor::node()</entry></row> +<row><entry>-> = decendant::node()</entry></row> +</tbody></tgroup> +</table> +</sect1> + +<sect1 id="chdir_cmd"><title id="chdir_cmd.title">Chdir</title> +<para>Change the working directory</para> +<table><title>Chdir usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>chdir <PATH> <emphasis>(A relative or absolute path for operating system)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="continue_cmd"><title id="continue_cmd.title">Continue</title> +<para>Continue running stylesheet, stopping at any break points found.</para> +<para>Shortcut name: c</para> +<table><title>Contine usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>continue</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="data_cmd"><title id="data_cmd.title">Data</title> +<para>Switch to displaying the current node in xml data. Or change xml data used</para> +<table><title>Data usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>data <emphasis>(Switch to the current document node.)</emphasis></entry></row> +<row><entry>data <DATA> <emphasis>(To change to a new xml data file. A leading "~" is replaced by the $HOME environment variable value. Will need to use "run" command to process it)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="delete_cmd"><title id="delete_cmd.title">Delete</title> +<para>Delete a template breakpoint</para> +<para>Shortcut name: d</para> +<table><title>Delete usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>delete <emphasis>(To delete breakpoint at current node)</emphasis></entry></row> +<row><entry>delete <BREAKPOINT_ID> <emphasis>(To delete breakpoint at specified break point number)</emphasis></entry></row> +<row><entry>delete -l <FILENAME> <LINENO> <emphasis>(Delete at specifed file, line number)</emphasis></entry></row> +<row><entry>delete -l <URI> <LINENO> <emphasis>(Delete at specifed URI, line number)</emphasis></entry></row> +<row><entry>delete <TEMMPLATENAME> <emphasis>(To delete break point at named template.)</emphasis></entry></row> +<row><entry>delete * <emphasis>(To delete all break points.)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="delparam_cmd"><title id="delparam_cmd.title">Delparam</title> +<para>Delete a libxslt parameter</para> +<table><title>Delparam usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>delparam <emphasis>(Delete all parameters present)</emphasis></entry></row> +<row><entry>delparam <PARAM_ID></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="delwatch_cmd"><title id="delwatch_cmd.title">Delwatch</title> +<para>Delete a watch expression or remove all watch expressions as displayed by "showwatch." command</para> +<table><title>Delwatch usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>delwatch <WATCHID> <emphasis>(Delete a watch expression with given ID)</emphasis></entry></row> +<row><entry>delwatch * <emphasis>(Delete all watch expressions)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="dir_cmd"><title id="dir_cmd.title">Dir</title> +<para>Print list of nodes in a similary way to the dir shell command.</para> +<para/> +<table><title>Dir usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>dir</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="disable_cmd"><title id="disable_cmd.title">Disable</title> +<para>Disable a breakpoint</para> +<table><title>Disable usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>disable <emphasis>(To disable breakpoint at current node)</emphasis></entry></row> +<row><entry>disable <BREAKPOINT_ID> <emphasis>(To disable breakpoint at specified break point number</emphasis></entry></row> +<row><entry>disable -l <FILENAME> <LINENO> <emphasis>(Disable breakpoint at specifed file, line number)</emphasis></entry></row> +<row><entry>disable -l <URI> <LINENO> <emphasis>(Disable breakpoint at specifed URI, line number)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="du_cmd"><title id="du_cmd.title">Du</title> +<para>Print a summary of child nodes in a tree format.</para> +<table><title>Du usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>du</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="dump_cmd"><title id="dump_cmd.title">Dump</title> +<para>Dump the gory details of this node</para> +<table><title>Dump usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>dump</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="enable_cmd"><title id="enable_cmd.title">Enable</title> +<para>Enable or disable a breakpoint (Toggle enable/disable/)</para> +<para>Shortcut name: e</para> +<table><title>Enable usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>enable <emphasis>(To enable/disable breakpoint at current node)</emphasis></entry></row> +<row><entry>enable <BREAKPOINT_ID> <emphasis>(To enable/disable breakpoint at specified break point number</emphasis></entry></row> +<row><entry>enable -l <FILENAME> <LINENO> <emphasis>(Enable/disable breakpoint at specifed file, line number)</emphasis></entry></row> +<row><entry>enable -l <URI> <LINENO> <emphasis>(Enable/disable breakpoint at specifed URI, line number)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="entities_cmd"><title id="entities_cmd.title">Entities</title> +<para>Print list of external General Parsed entities used data file (document)</para> +<para>Shortcut name : ent</para> +<table><title>Entities usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>entities</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="exit_cmd"><title id="exit_cmd.title">Exit</title> +<para>Exit processing stylesheet as soon as possible.</para> +<table><title>Exit usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>exit</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="frame_cmd"><title id="frame_cmd.title">Frame</title> +<para>Print the stack frame at a given depth</para> +<para>Shortcut name: f</para> +<table><title>Frame usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>frame <FRAME_DEPTH> <emphasis>(Depth is a number from 0 to the current depth of call stack)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="free_cmd"><title id="free_cmd.title">Free</title> +<para>Free stylesheet and data (Disabled see run)</para> +<table><title>Free usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>free</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="globals_cmd"><title id="globals_cmd.title">Globals</title> +<para>Print a list of global stylesheet variables or parameters. Print the value of a global variable</para> +<table><title>Globals usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>globals <emphasis>(Print list of all globaly available variables)</emphasis></entry></row> +<row><entry>globals -f <emphasis>(Print list of all globaly available variables and thier values)</emphasis></entry></row> +<row><entry>globals <QNAME> <emphasis>(Print the value of variable specified)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="help_cmd"><title id="help_cmd.title">Help</title> +<para>Display help on command or overiew</para> +<para>Shortcut name: h</para> +<table><title>Help usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>help <emphasis>(Show overview of product)</emphasis></entry></row> +<row><entry>help <COMMAND> <emphasis>(Show help about a command)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="load_cmd"><title id="load_cmd.title">Load</title> +<para>Load the xsldbg's options and user preferences from disk</para> +<table><title>Load usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>load</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="locals_cmd"><title id="locals_cmd.title">Locals</title> +<para>Print a list of local stylesheet variables or parameters. Print the value of a local variable</para> +<table><title>Locals usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>locals <emphasis>(Print list of all locally available variables)</emphasis></entry></row> +<row><entry>locals -f <emphasis>(Print list of all locally available variables and thier values)</emphasis></entry></row> +<row><entry>locals <QNAME> <emphasis>(Print the value of variable specified)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="ls_cmd"><title id="ls_cmd.title">Ls</title> +<para>List nodes in a brief format</para> +<table><title>Ls usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>ls</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="next_cmd"><title id="next_cmd.title">Next</title> +<para>Skip over an xsl:call-template or xsl:apply-templates. +This command has the same effect of entering the commands "step" and then "up"</para> +<para>Shortcut name: n</para> +<table><title>Next usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>next <emphasis>(proceed to next sibling instruction)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="options_cmd"><title id="options_cmd.title">Options</title> +<para>Print the values for xsldbg's option</para> +<table><title>Options usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>options</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="output_cmd"><title id="output_cmd.title">Output</title> +<para>Specify a local, writable file to be used for output of results</para> +<para>Shortcut name : o</para> +<table><title>Output usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>output <FILENAME> <emphasis>(A local writable file name. Which can have a "~" prefix on *nix and CYGWIN platforms. Or environment variables under RISC OS)</emphasis></entry></row> +<row><entry>output <URI> <emphasis>(The <URI> must only use the "file://" protocol. This is then converted to a file name suitable for the operating system)</emphasis></entry></row> +<row><entry>output - <emphasis>( Send to standard output. Must only be used when using xsldbg's command line prompt )</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="public_cmd"><title id="public_cmd.title">Public</title> +<para>Print the value that a public ID maps via the current catalog</para> +<para>Shortcut name : pub</para> +<table><title>Public usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>public "<PublicID>"</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="pwd_cmd"><title id="pwd_cmd.title">Pwd</title> +<para>Print the current working directory.</para> +<table><title>Pwd usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>pwd</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="quit_cmd"><title id="quit_cmd.title">Quit</title> +<para>Exit processing stylesheet as soon as possible.</para> +<para>Shortcut name: q</para> +<table><title>Quit usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>quit</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="run_cmd"><title id="run_cmd.title">Run</title> +<para>Restart the stylesheet.</para> +<para>Shortcut name: r</para> +<table><title>Run usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>run</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="save_cmd"><title id="save_cmd.title">Save</title> +<para>Save the xsldbg's options and user preferences to disk</para> +<table><title>Save usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>save</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="search_cmd"><title id="search_cmd.title">Search</title> +<para>Search a dataBase of all information gathered from stylesheets loaded</para> +<para>All output files are stored in, value of the "searchresultspath" option if set, or the same directory as the provided stylesheet. searchresults.xml is normally transformed by search.xsl, but will be transformed using searchhtml.xsl if the "prefrehtml" option is set. +</para><para>When the search command is issued a xml file (searchresults.xml) will be created. You can then process this file with your own stylesheet to present data in a other ways. If "preferhtml" option is not set +then searchresult.txt is printed to display. +</para><para>Depending on the amount of data collected it might take a while to complete this command. +</para> +<table><title>Search usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>search <XPATH> <emphasis>(See what xpath can be used see search.dtd. The deafault <XPATH> is '//search/*' )</emphasis></entry></row> +<row><entry>search -sort <XPATH> <emphasis>(Tell search.xsl to sort the result before outputing it)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="set_cmd"><title id="set_cmd.title">Set</title> +<para>Set the value of a variable</para> +<table><title>Set usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>set <VARIABLE_NAME> <XPATH></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="setoption_cmd"><title id="setoption_cmd.title">Setoption</title> +<para>Set an option for execution of stylesheet</para> +<para>You will need to use run command to active changes</para> +<table><title>Setoption usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>setoption <OPTION_NAME> <INTEGER_VALUE></entry></row> +<row><entry>Where <OPTION_NAME> can be either</entry></row> +<row><entry> + <para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>debug <emphasis>(If <INTEGER_VALUE> is true dump the tree of the result instead)</emphasis></entry></row> + <row><entry>catalogs <emphasis>(If <INTEGER_VALUE> is true use the catalogs from $SGML_CATALOG_FILES or SGML$CatalogFiles for risc operating system)</emphasis></entry></row> + <row><entry>html <emphasis>(If <INTEGER_VALUE> is true the input document is an HTML file)</emphasis></entry></row> + <row><entry>docbook <emphasis>(If <INTEGER_VALUE> is true and docbook is still supported by libxml the input document is SGML docbook)</emphasis></entry></row> + <row><entry>xinclude <emphasis>(If <INTEGER_VALUE> is true do XInclude processing on document intput)</emphasis></entry></row> + <row><entry>preferhtml <emphasis>(If <INTEGER_VALUE> is true the prefer html output for search results. : See search command)</emphasis></entry></row> + <row><entry>autoencode <emphasis>(If <INTEGER_VALUE> is true try to use the encoding from the stylesheet)</emphasis></entry></row> + <row><entry>utf8input <emphasis>(If <INTEGER_VALUE> is true All input from user is in UTF-8.This is normaly used when xsldbg is running as a thread)</emphasis></entry></row> + <row><entry> <emphasis></emphasis></entry></row> + <row><entry>gdb <emphasis>(Run in gdb compatability mode)</emphasis> + <para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>For a value of 1 this means + <para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>Print lots more messages. Increase the frequency of printing "Breapoint at ..."</entry></row> + <row><entry>At most GDB_LINES_TO_PRINT lines will be printed when evalating expressions, followed by a "...". See options.h to change this value, the default is three lines of text</entry></row> + <row><entry>Both local and globals will be printed when the "locals" command is issued </entry></row> + <row><entry>When printing expresssions with cat/print. The evaluated value will be prefixed by "= " < EXPRESSION ></entry></row> + </tbody></tgroup> + </informaltable> + </para> + </entry></row> + <row><entry/></row> + <row><entry>For a value of 2 this means + <para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>Print messages needed by KDbg as well as the output state above (when value is 1) </entry></row> + </tbody></tgroup> + </informaltable> + </para> + </entry></row> + </tbody></tgroup> + </informaltable> + </para> + </entry></row> + <row><entry>nonet <emphasis>(If <INTEGER_VALUE> is true refuse to fetch DTDs or entities over network)</emphasis></entry></row> + <row><entry>novalid <emphasis>(If <INTEGER_VALUE> is true skip the DTD loading phase)</emphasis></entry></row> + <row><entry>repeat <emphasis>(If <INTEGER_VALUE> is true run the transformation 20 times)</emphasis></entry></row> + <row><entry>profile <emphasis>(If <INTEGER_VALUE> is true dump profiling informations)</emphasis></entry></row> + <row><entry>timing <emphasis>(If <INTEGER_VALUE> is true display the time used)</emphasis></entry></row> + <row><entry>noout <emphasis>(If <INTEGER_VALUE> is true do not dump the result)</emphasis></entry></row> + </tbody></tgroup> + </informaltable> + </para> +</entry></row> +<row><entry>Where value is true if it is NOT equal to zero</entry></row> +<row><entry>Where value is false if it IS equal to zero</entry></row> +<row><entry>stdout <emphasis>Print all error messages to stdout. Normally error messages go to stderr.</emphasis></entry></row> +<row><entry>setoption <OPTION_NAME> "<STRING_VALUE>" <emphasis>(Must not contain double quotation marks in <STRING_VALUE>)</emphasis></entry></row> +<row><entry>setoption <OPTION_NAME> <STRING_VALUE> <emphasis>(Must not contain any spaces, nor double quotation marks in <STRING_VALUE>)</emphasis></entry></row> +<row><entry>Where <OPTION_NAME> can be either</entry></row> +<row><entry> + <para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>data <emphasis>(Data file's URI)</emphasis></entry></row> + <row><entry>source <emphasis>(Source file's URI)</emphasis></entry></row> + <row><entry>output <emphasis>(Output file's SystemID )</emphasis></entry></row> + <row><entry>docspath <emphasis>(Path to use when looking for documentation)</emphasis></entry></row> + <row><entry>catalognames <emphasis>(The names of the catalogs to use when the catalogs option is set. Value will be lost if set before setting catalogs option)</emphasis></entry></row> + <row><entry>encoding <emphasis>(What encoding to use for standard output)</emphasis></entry></row> + <row><entry>searchresultspath <emphasis>What path is to be used when storing the results of searching. If this is not set then xsldbg will use the path of the stylesheet</emphasis></entry></row> + </tbody></tgroup> + </informaltable> + </para> +</entry></row></tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="shell_cmd"><title id="shell_cmd.title">Shell</title> +<para>Execute shell command</para> +<table><title>Shell usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>shell <TEXT> <emphasis>(<TEXT> is the text to be passed to operating system for execution)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="showbreak_cmd"><title id="showbreak_cmd.title">Showbreak</title> +<para>To display list of template break points.</para> +<para>Shortcut name: show</para><para>If a mode exists on a template breakpoint then it will + be appended to the end of template name for breakpoint. An example of the output is : +<informaltable> +<tgroup cols="1"><tbody> +<row><entry> Breakpoint 3 enabled for template :"*" in file test1.xsl : line 105</entry></row> +<row><entry> Breakpoint 2 enabled for template :"* testMode" in file test1.xsl : line 109</entry></row> +<row><entry> Breakpoint 1 enabled for template :"* http://www.w3.org/1999/XSL/Transform:testMode" in file test1.xsl : line 113</entry></row> +<row><entry/></row> +<row><entry> Total of 3 breakpoints present</entry></row> +</tbody></tgroup></informaltable></para> +<table><title>Showbreak usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>showbreak</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="showparam_cmd"><title id="showparam_cmd.title">Showparam</title> +<para>Print the libxslt parameters present</para> +<table><title>Showparam usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>showparam</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="showwatch_cmd"><title id="showwatch_cmd.title">Showwatch</title> +<para>Show the current expression being watched</para> +<para>Shortcut name: watches</para> +<table><title>Showwatch usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>showwatch <emphasis>(Show the currently selected watches and thier values)</emphasis></entry></row> +<row><entry>showwatch 1 <emphasis>(Enable the automatic printing of watch expressions. This is used by default.)</emphasis></entry></row> +<row><entry>showwatch 0 <emphasis>(Disable the automatic printing of watch expressions.)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="source_cmd"><title id="source_cmd.title">Source</title> +<para>Switch to displaying the current node in stylesheet. Or change stylesheet used</para> +<table><title>Source usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>source <emphasis>(Switch to the current node in stylesheet.)</emphasis></entry></row> +<row><entry>source <SOURCE> <emphasis>(To change to a new source file. A leading "~" is replaced by the $HOME environment variable value. Will need to use "run" command to execute it)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="step_cmd"><title id="step_cmd.title">Step</title> +<para>Step until next stylesheet instruction.</para> +<para>Shortcut name: s</para> +<table><title>Step usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>step</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="stepdown_cmd"><title id="stepdown_cmd.title">Stepdown</title> +<para>Step down to a newer "call frame". </para> +<para>Shortcut name: down</para> +<table><title>Stepdown usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>stepdown <emphasis>(step down one frame)</emphasis></entry></row> +<row><entry>stepdown <NUMBER_OF_FRAMES> <emphasis>(step down specified number of frames)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="stepup_cmd"><title id="stepup_cmd.title">Stepup</title> +<para>Step up to a older "call frame". </para> +<para>Shortcut name: up</para><para>This is not an accurate command, xsldbg will stop as close as it can. </para> +<table><title>Stepup usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>stepup <emphasis>(step up one frame)</emphasis></entry></row> +<row><entry>stepup <NUMBER_OF_FRAMES> <emphasis>(step up specified number of frames)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="stylesheets_cmd"><title id="stylesheets_cmd.title">Stylesheets</title> +<para>Print out a list of stylesheets loaded</para> +<para>Shortcut name: style</para> +<table><title>Stylesheets usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>stylesheets</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + + +<sect1 id="system_cmd"><title id="system_cmd.title">System</title> +<para>Print the value that a system file maps via the current catalog</para> +<para>Shortcut name : sys</para> +<table><title>System usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>system "<SystemID>"</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="templates_cmd"><title id="templates_cmd.title">Templates</title> +<para>Print a list of available templates. Search for a template</para> +<para>Shortcut name: t</para> +<table><title>Templates usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>templates</entry></row> +<row><entry>templates <TEMPLATE> <emphasis>(Print details of template named <TEMPLATE> if it can be found)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="trace_cmd"><title id="trace_cmd.title">Trace</title> +<para>Trace one execution of the stylesheet printing the file and lines of +intermediate steps</para> +<table><title>Trace usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>trace</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="tty_cmd"><title id="tty_cmd.title">Tty</title> +<para>Open a terminal. Set the level of tty redirection.</para> +<table><title>Tty usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>tty <DEVICE_PATH> <emphasis>(Where <DEVICE_PATH> is a valid terminal on the operating system. Just tries to open the terminal</emphasis></entry></row> +<row><entry>tty <TTY_LEVEL> <emphasis>(Set the level of tty redirection, where <TTY_LEVEL> is a valid level of input/output to use)</emphasis> +<para> + <informaltable> + <tgroup cols="1"><tbody> + <row><entry>Where level is </entry></row> + <row><entry>0 = Default input/output </entry></row> + <row><entry>1 = Terminal output of results of transformation, tracing and walking <emphasis>(Default state when tty device has been opened. Not fully implemented yet.)</emphasis></entry></row> + <row><entry>2 = Full redirection to terminal <emphasis>(Not implemented yet.)</emphasis></entry></row> + <row><entry>All other integer values are assumed to mean level 0 + </entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +</entry></row></tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="validate_cmd"><title id="validate_cmd.title">Validate</title> +<para>Validate the output file generated by stylesheet (Disabled)</para> +<table><title>Validate usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>validate</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="walk_cmd"><title id="walk_cmd.title">Walk</title> +<para>Walk through code using a range of speeds</para> +<table><title>Walk usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>walk <SPEED> <emphasis>(Use Ctrl-c to stop +execution, <SPEED> is a value between 0 and 9. Where 0 means stop, 1 is +very fast, 9 is very slow)</emphasis></entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="where_cmd"><title id="where_cmd.title">Where</title> +<para>Print a trace of templates calls (frame stack) and print the working directory.</para> +<para>Shortcut name: w</para> +<table><title>Where usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>where</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="write_cmd"><title id="write_cmd.title">Write</title> +<para>To be completed</para> +<table><title>Write usage</title> +<tgroup cols="1"> +<tbody> +<row><entry>write</entry></row> +</tbody> +</tgroup> +</table> +</sect1> + + + + + +</chapter> diff --git a/doc/xsldbg/credits.docbook b/doc/xsldbg/credits.docbook new file mode 100644 index 00000000..89bdadc4 --- /dev/null +++ b/doc/xsldbg/credits.docbook @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&xsldbg; +</para> +<para> +Program copyright 2004 Keith Isdale <email>k_isdale tpg com au</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; + +<sect1 id="thanks"> +<title>Thanks to </title> +<para> The writers the libxml and libxsl.</para> +<para><ulink url="http://members.nextra.at/johsixt/">Johannes Sixt</ulink> for helping with adding xsldbg support to KDbg</para></sect1> + +</chapter> diff --git a/doc/xsldbg/index.docbook b/doc/xsldbg/index.docbook new file mode 100644 index 00000000..4c211c10 --- /dev/null +++ b/doc/xsldbg/index.docbook @@ -0,0 +1,124 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY xsldbg "<application>xsldbg</application>"> + <!ENTITY kappname "&xsldbg;"> + <!ENTITY package "kdewebdev"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> + <!ENTITY introduction-chapter SYSTEM "introduction.docbook"> + <!ENTITY usage-chapter SYSTEM "usage.docbook"> + <!ENTITY commands-chapter SYSTEM "commands.docbook"> + <!ENTITY credits-chapter SYSTEM "credits.docbook"> +]> + +<!-- More content formatting is in need of being done asking for help on kde-i18n-doc@kde.org : remove these two lines when done --> +<!-- NO TRANSLATION --> + +<!-- ................................................................ --> +<!-- The language must NOT be changed here. --> +<!-- If you are writing original documentation in a language other --> +<!-- than English, change the language above ONLY, not here --> +<book lang="&language;"> + +<bookinfo> +<title>The &xsldbg; 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> +<holder>Keith Isdale</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> +<date>2004-09-26</date> +<releaseinfo>1.01.00</releaseinfo> + + +<abstract> +<para> +&xsldbg; is a tool intended to help understand stylesheets. +What makes it different to other stylesheet debuggers is the ability +to search for items of interest and trace stylesheet execution. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeutils</keyword> +<keyword>xsldbg</keyword> +<keyword>xsl</keyword> +<keyword>XML</keyword> +</keywordset> + +</bookinfo> + +&introduction-chapter; +&usage-chapter; +&commands-chapter; +&credits-chapter; + + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-xsldbg"> +<title>How to obtain &xsldbg;</title> + +<para> +See the kxsldbg component of the kdewebdev module in &kde; SVN. +</para> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully use &xsldbg;, you need &kde; libxslt, libexslt and +libxml installed which are available on a typical &kde; installation. +</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> +<para>&xsldbg; is usually compiled as part of the kxsldbg component in the kdewebdev module</para> +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> + +<para>&xsldbg; is configured using arguments passed via the command line and its <link linkend="setoption_cmd" endterm="setoption_cmd.title">setoption</link> command</para> + +</sect1> + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +--> diff --git a/doc/xsldbg/introduction.docbook b/doc/xsldbg/introduction.docbook new file mode 100644 index 00000000..65879ce0 --- /dev/null +++ b/doc/xsldbg/introduction.docbook @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&xsldbg; is a text based tool to debug stylesheets (the eXtensible +Stylesheet Language) and has commands similar to the Unix/Linux debugger +gdb. It has three major modes of execution of stylesheets. +</para> +<para> +<informaltable> + <tgroup cols="1"><tbody> + <row><entry>Run the whole stylesheet</entry></row> + <row><entry>Step to next xsl instruction</entry></row> + <row><entry>Continue until next break point is found, or stylesheet has restarted</entry></row> + </tbody></tgroup> +</informaltable> +</para> + +</chapter> diff --git a/doc/xsldbg/usage.docbook b/doc/xsldbg/usage.docbook new file mode 100644 index 00000000..5fe2fdc2 --- /dev/null +++ b/doc/xsldbg/usage.docbook @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<chapter id="using-xsldbg"> +<title>Using &xsldbg;</title> +<para></para> +<sect1><title>xsldbg command arguments</title> +<para> +On systems with readline library available you can use the back/forward +keys to navigate the history of entered commands. +On all systems the last entered command can be repeated by just pressing +the <ENTER> key. +</para> +<para>If your operating system supports it file names will be expanded.</para> +<para> +Several commands take more that one argument. Quotes may be used to lead to +complex expressions being treated as one arument. eg break "* | @" would allow you to se a breakpoint on the + template with the name "* | @" +</para> +</sect1> + +<sect1 id="legend"><title>Legend of terms</title> +<para>The following table describes the terms used in the subsiquent command guide</para> +<informaltable> +<tgroup cols="1"><tbody> + <row><entry> + TEMPLATE_NAME : A valid template name contains only ASCI + character codes 0x00 to 0x7F. And can be a fully qualified name ie + "xsl:templateName". </entry></row> + <row><entry> + FILENAME : A valid file name local to the system of the + user. It can have a "~" prefix on *nix and CYGWIN platforms. Or + environment variables under RISC OS + </entry></row> + <row><entry>URI : A Uniform Resource Identifiers as defined by RFC 2396</entry></row> + <row><entry>MODE_NAME The mode of template which can be fully qualified name ie "xsl:modeName".</entry></row> + <row><entry>QNAME : A fully qualified name ie "xsl:localPart"</entry></row> + <row><entry>LINENO : A valid line number in associated <FILENAME></entry></row> + <row><entry>NUMBER_OF_FRAMES : A valid line number frames to change position by</entry></row> + <row><entry>BREAKPOINT_ID : A valid break point number</entry></row> + <row><entry>WATCH_ID : A valid watch expression number as indicated by showwatch command</entry></row> + <row><entry>SPEED: speed to walk through code at, between 0 to 9</entry></row> + <row><entry> + <emphasis>(Comment)</emphasis>: a + comment about command meaning or usage + </entry></row> + <row><entry>{ opt1 | opt2 | opt2 .. etc} : Choose one of the opt's</entry></row> + <row><entry>XPATH : a xpath selection of node(s)</entry></row> + <row><entry>PARAM_ID : a valid parameter number as indicated by showparam command</entry></row> + <row><entry> + PATH : A path to change working directory to On some operating systems a + "~" prefix will be replaced by your home directory path + </entry></row> + <row><entry> + TEXT : Free form text <emphasis>(no + restrictions)</emphasis> + </entry></row> + <row><entry>COMMAND : A valid command for the xsdbg</entry></row> + <row><entry>QNAME : A valid variable/parameter name</entry></row> + <row><entry>SOURCE : The stylesheet being/to be executed. See <FILENAME> and <URI></entry></row> + <row><entry> + DATA : The xml data(document) being/to be processed by the + stylesheet. See <FILENAME> + and <URI> + </entry></row> + <row><entry>DEVICE_PATH : Is a valid terminal on the operating system</entry></row> + <row><entry>TTY_LEVEL : Is a valid level of input/output to use</entry></row> +</tbody></tgroup></informaltable> +<para></para> +</sect1> + +<sect1 id="command_summary"><title>Overview of available commands</title> +<informaltable> +<tgroup cols="1"><tbody> +<row><entry>Help related :<link linkend="help_cmd" endterm="help_cmd.title">help</link></entry></row> +<row><entry> + Running related : {<link linkend="bye_cmd" endterm="bye_cmd.title">bye</link>|<link linkend="exit_cmd" endterm="exit_cmd.title">exit</link>| + <link linkend="quit_cmd" endterm="quit_cmd.title">quit</link>}, <link linkend="step_cmd" endterm="step_cmd.title">step</link>, + <link linkend="stepup_cmd" endterm="stepup_cmd.title">stepup</link>, <link linkend="stepdown_cmd" endterm="stepdown_cmd.title">stepdown</link>, + <link linkend="next_cmd" endterm="next_cmd.title">next</link>, + <link linkend="continue_cmd" endterm="continue_cmd.title">continue</link>, + <link linkend="run_cmd" endterm="run_cmd.title">run</link>, +<link linkend="trace_cmd" endterm="trace_cmd.title">trace</link>, <link linkend="setoption_cmd" endterm="setoption_cmd.title">setoption</link>, + <link linkend="options_cmd" endterm="options_cmd.title">options</link> +</entry></row> +<row><entry> + Libxslt parameter related : <link linkend="addparam_cmd" endterm="addparam_cmd.title">addparam</link>, + <link linkend="delparam_cmd" endterm="delparam_cmd.title">delparam</link>, <link linkend="showparam_cmd" endterm="showparam_cmd.title">showparam</link>, + <link linkend="output_cmd" endterm="output_cmd.title">output</link>, <link linkend="setoption_cmd" endterm="setoption_cmd.title">setoption</link>, + <link linkend="options_cmd" endterm="options_cmd.title">options</link> +</entry></row> +<row><entry> + Template related : <link linkend="templates_cmd" endterm="templates_cmd.title">templates</link>, + <link linkend="where_cmd" endterm="where_cmd.title">where</link>, <link + linkend="frame_cmd" endterm="frame_cmd.title">frame</link> +</entry></row> +<row><entry> + Break point related : <link linkend="break_cmd" endterm="break_cmd.title">break</link>, + <link linkend="showbreak_cmd" + endterm="showbreak_cmd.title">showbreak</link>, <link linkend="delete_cmd" endterm="delete_cmd.title">delete</link>, + <link linkend="enable_cmd" endterm="enable_cmd.title">enable</link> +</entry></row> +<row><entry> + Expression viewing(xpath) : <link linkend="cat_cmd" + endterm="cat_cmd.title">cat</link> +</entry></row> +<row><entry> + Node viewing : <link linkend="ls_cmd" endterm="ls_cmd.title">ls</link>, <link linkend="dir_cmd" endterm="dir_cmd.title">dir</link>, + <link linkend="du_cmd" endterm="du_cmd.title">du</link>, <link + linkend="cat_cmd" endterm="cat_cmd.title">cat</link>, <link + linkend="pwd_cmd" endterm="pwd_cmd.title">pwd</link> +</entry></row> +<row><entry> + Variable viewing : <link linkend="globals_cmd" endterm="globals_cmd.title">globals</link>, + <link linkend="locals_cmd" endterm="locals_cmd.title">locals</link>, + <link linkend="cat_cmd" endterm="cat_cmd.title">cat</link>, + <link linkend="addwatch_cmd" endterm="addwatch_cmd.title">addwatch</link> +</entry></row> +<row><entry> + Variable setting: <link linkend="set_cmd" + endterm="set_cmd.title">set</link> +</entry></row> +<row><entry> + Node selection : <link linkend="source_cmd" endterm="source_cmd.title">source</link>, + <link linkend="data_cmd" endterm="data_cmd.title">data</link>, <link + linkend="cd_cmd" endterm="cd_cmd.title">cd</link> +</entry></row> +<row><entry> + Searching :<link linkend="search_cmd" + endterm="search_cmd.title">search</link> +</entry></row> +<row><entry> + Operating system related :<link linkend="chdir_cmd" endterm="chdir_cmd.title">chdir</link>, + <link linkend="shell_cmd" endterm="shell_cmd.title">shell</link>, <link linkend="tty_cmd" endterm="tty_cmd.title">tty</link></entry></row> +<row><entry>File related : <link linkend="output_cmd" endterm="output_cmd.title">output</link>, + <link linkend="entities_cmd" endterm="entities_cmd.title">entities</link>, <link linkend="system_cmd" endterm="system_cmd.title">system</link>, + <link linkend="public_cmd" endterm="public_cmd.title">public</link> +</entry></row> +<row><entry> + Disabled file commands: <link linkend="validate_cmd" endterm="validate_cmd.title">validate</link>, + <link linkend="load_cmd" endterm="load_cmd.title">load</link>, <link linkend="save_cmd" endterm="save_cmd.title">save</link>, + <link linkend="write_cmd" endterm="write_cmd.title">write</link>, <link + linkend="free_cmd" endterm="free_cmd.title">free</link> +</entry></row> +</tbody></tgroup></informaltable> +</sect1> + +</chapter> + diff --git a/doc/xsldbg/xsldbghelp.xml b/doc/xsldbg/xsldbghelp.xml new file mode 100644 index 00000000..64d9b81b --- /dev/null +++ b/doc/xsldbg/xsldbghelp.xml @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE helpbook [ + <!ENTITY nbsp " "> + <!ENTITY introduction-chapter SYSTEM "introduction.docbook"> + <!ENTITY usage-chapter SYSTEM "usage.docbook"> + <!ENTITY commands-chapter SYSTEM "commands.docbook"> + <!ENTITY xsldbg "xsldbg"> +]> + + +<!-- + Note: xsldbg's index.docbook file is not used because it is much slower to process. + Translations required are passed as command line arguments to xsldbg + --> + + + +<helpbook> +&introduction-chapter; +&usage-chapter; +&commands-chapter; +</helpbook> diff --git a/doc/xsldbg/xsldbghelp.xsl b/doc/xsldbg/xsldbghelp.xsl new file mode 100644 index 00000000..50e45ebd --- /dev/null +++ b/doc/xsldbg/xsldbghelp.xsl @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- + File : xsldoc.xsl + Author: Keith Isdale <k_isdale@tpg.com.au> + Description: Stylesheet to process xsldoc.xml and generate help text + Copyright Reserved Under GPL +--> +<!-- This file does not require translation --> +<!-- NO TRANSLATION --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + <xsl:output method="text"/> + <xsl:strip-space elements="text"/> + <!-- The selected nodes to be printed for overview --> + <xsl:variable name="overview_node" select="//chapter[@id='introduction']"/> + <!-- The selected nodes to be printed for usage overview --> + <xsl:variable name="usage_node" select="//chapter[@id='using-xsldbg']"/> + <!-- The list of valid xsldbg commands --> + <xsl:variable name="command_nodes" select="//chapter[@id='commands']"/> + <!-- The list of i18n paras --> + <xsl:variable name="i18n_para" select="//i18n"/> + <!-- What version is this document--> + <xsl:variable name="doc_version" select="'3.3.0-1'"/> + <!-- The default version of xsldbg --> + <xsl:param name="xsldbg_version" select="'3.3.0'"/> + <!-- We want 'help' to point to a invalid command if stylesheet + user has not provided a value for 'help' param--> + <xsl:param name="help" select="'_#_'"/> + <xsl:variable name="help_id" select="concat($help,'_cmd')"/> + <!-- Do we printout all documentation '1' if so '0' otherwise --> + <xsl:param name="alldocs" select="0"/> + <!-- The documentation we can find for 'help' user requires --> + <xsl:variable name="help_cmd" select="$command_nodes/sect1[@id=$help_id or @shortcut=$help_id]"/> + + <!-- Our translatables --> + <xsl:param name="xsldbgVerTxt" select="'xsldbg version'"/> + <xsl:param name="helpDocVerTxt" select="'Help document version'"/> + <xsl:param name="helpErrorTxt" select="'Help not found for command'"/> + + + + <!-- Main template--> + <xsl:template match="/"> +<xsl:text> </xsl:text><xsl:value-of select="$xsldbgVerTxt"/><xsl:text> </xsl:text><xsl:value-of select="$xsldbg_version"/> +<xsl:text> +</xsl:text> +<xsl:text> ====================</xsl:text><xsl:text> +</xsl:text> + <xsl:choose> + <xsl:when test="count($help_cmd) > 0" > + <xsl:apply-templates select="$help_cmd" /> + <xsl:value-of select="$helpDocVerTxt"/><xsl:text> </xsl:text><xsl:value-of select="$doc_version"/><xsl:text> +</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$help !='_#_'"> + <xsl:value-of select="$helpErrorTxt"/><xsl:text> </xsl:text> + <xsl:value-of select="$help"/> + </xsl:if> + <xsl:if test="$help ='_#_'"> + <xsl:apply-templates select="$overview_node"/> + <xsl:text> +</xsl:text> + <xsl:apply-templates select="$usage_node"/> + <xsl:value-of select="$helpDocVerTxt"/><xsl:text> </xsl:text><xsl:value-of select="$doc_version"/><xsl:text> +</xsl:text> + </xsl:if> +<xsl:text> +</xsl:text> + </xsl:otherwise> + </xsl:choose> +<xsl:text> +</xsl:text> + </xsl:template> + + + <!-- Convert title into something useful --> + <xsl:template match="title"> +<xsl:for-each select="ancestor::node()"><xsl:text> </xsl:text></xsl:for-each><xsl:value-of select="."/> +<xsl:text> +</xsl:text><xsl:for-each select="ancestor::node()"><xsl:text> </xsl:text></xsl:for-each> +<xsl:value-of + select="substring('____________________________________________________________', + 1, string-length())" /> +<xsl:text> +</xsl:text> + </xsl:template> + + <xsl:template match="text()"> + <xsl:value-of select="normalize-space()"/> + </xsl:template> + + <xsl:template match="row"> + <xsl:value-of select="$indentgroup/indent[@level=$indentcount]" /> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="para"> + <xsl:text> +</xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="informaltable|table"> + <xsl:text> +</xsl:text> + <xsl:apply-templates select="title"/> + <xsl:for-each select="tgroup/tbody/row/entry|tbody/row/entry"> + <xsl:for-each select="ancestor::node()"><xsl:text> </xsl:text></xsl:for-each><xsl:apply-templates/> + <xsl:text> +</xsl:text> + </xsl:for-each> + </xsl:template> + +</xsl:stylesheet> + + +<!-- initialization code for xemacs --> +<!-- +Local Variables: +mode: xsl +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:2 +sgml-indent-data:nil +End: +--> |