[KildClient-cvs] kildclient branch master updated. 4527470921eded510d17db42af538313f0bbe66a
KildClient is a powerful MUD client with a built-in Perl interpreter
Brought to you by:
ekalin
From: Eduardo M K. <ek...@us...> - 2015-02-15 17:57:55
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "kildclient". The branch, master has been updated via 4527470921eded510d17db42af538313f0bbe66a (commit) from 9686fd17d785df265e761b9d3ad9d00a06a5d7ce (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://kildclient.git.sourceforge.net/git/gitweb.cgi?p=kildclient/kildclient;a=commit;h=4527470921eded510d17db42af538313f0bbe66a commit 4527470921eded510d17db42af538313f0bbe66a Author: Eduardo M KALINOWSKI <ed...@ka...> Date: Sun Feb 15 15:57:45 2015 -0200 Updated manual to Docbook 5.0; and simplified the generation of html to use the XSL stylesheet directly. diff --git a/debian/changelog b/debian/changelog index 12da0e5..af6f5d9 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,7 +6,10 @@ kildclient (3.0.0-3) unstable; urgency=low * control: Require libgtk-3-dev >= 3.12.0. - -- Eduardo M Kalinowski <ed...@ka...> Sun, 21 Dec 2014 15:10:24 -0200 + * kildclient-doc.doc-base: Updated path of index file (it now ends in + xhtml), and adjusted Files field to include images and css. + +-- Eduardo M Kalinowski <ed...@ka...> Sun, 15 Feb 2015 15:29:02 -0200 kildclient (3.0.0-2) unstable; urgency=medium diff --git a/debian/kildclient-doc.doc-base b/debian/kildclient-doc.doc-base index 380a430..617122d 100644 --- a/debian/kildclient-doc.doc-base +++ b/debian/kildclient-doc.doc-base @@ -6,5 +6,5 @@ Abstract: This manual describes what kildclient is Section: Games/Adventure Format: HTML -Index: /usr/share/doc/kildclient/html/index.html -Files: /usr/share/doc/kildclient/html/*.html +Index: /usr/share/doc/kildclient/html/index.xhtml +Files: /usr/share/doc/kildclient/html/* diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am index fa53b23..e1faa87 100644 --- a/doc/C/Makefile.am +++ b/doc/C/Makefile.am @@ -4,9 +4,9 @@ pkgdocdir = $(datadir)/doc/kildclient manualdir = $(pkgdocdir)/html -#pkgdoc_DATA = kildclient.pdf - -manual_DATA = $(wildcard kildclient/*.html) +manual_DATA = $(wildcard kildclient/*.xhtml) \ + $(wildcard kildclient/*.css) \ + ../kildclient.css EXTRA_DIST = kildclient.xml $(pkgdoc_DATA) $(manual_DATA) @@ -17,11 +17,7 @@ dist-hook: html verify: xmllint --valid --noout kildclient.xml -html: kildclient.xml - db2html kildclient.xml - -pdf: kildclient.xml - -db2pdf kildclient.xml - +html: kildclient.xml ../kildclient-html.xsl ../kildclient.css + xsltproc ../kildclient-html.xsl kildclient.xml -.PHONY: verify html pdf +.PHONY: verify html diff --git a/doc/C/kildclient.xml b/doc/C/kildclient.xml index 7368b58..ddb048e 100644 --- a/doc/C/kildclient.xml +++ b/doc/C/kildclient.xml @@ -1,24 +1,27 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<book> -<bookinfo> +<book xmlns="http://docbook.org/ns/docbook" version="5.0" + xmlns:xlink="http://www.w3.org/1999/xlink"> + +<info> <title>KildClient Manual</title> <subtitle>Version 3.0.1</subtitle> <author> - <firstname>Eduardo</firstname> - <othername>M</othername> - <surname>Kalinowski</surname> + <personname> + <firstname>Eduardo</firstname> + <othername>M</othername> + <surname>Kalinowski</surname> + </personname> </author> <copyright> <year>2004-2015</year><holder>Eduardo M Kalinowski</holder> </copyright> -</bookinfo> +</info> -<part><title>KildClient User's Guide</title> +<part><info><title>KildClient User's Guide</title></info> -<chapter><title>Introduction</title> +<chapter><info><title>Introduction</title></info> <para>KildClient is a MUD Client written with the GTK+ windowing toolkit. It supports many common features of other clients, such as @@ -45,7 +48,7 @@ MUDs.</para> -<chapter id="chap:running"><title>Running KildClient</title> +<chapter xml:id="chap_running"><info><title>Running KildClient</title></info> <para>To run KildClient, type <command>kildclient</command> in your command prompt:</para> @@ -90,20 +93,20 @@ clicking on it, or perhaps just cliking in an icon somewhere.</para> -<chapter><title>Basic Usage</title> +<chapter><info><title>Basic Usage</title></info> <para>This chapter will describe the most basic and important things you need to know in order to use KildClient. It is recommended that you read this section throughly, as it will ease understanding of the next chapters.</para> -<sect1 id="sec:world-selector"><title>Connecting to a MUD</title> +<sect1 xml:id="sec_world-selector"><info><title>Connecting to a MUD</title></info> -<para>When you launch KildClient (see <xref linkend="chap:running"/>), +<para>When you launch KildClient (see <xref linkend="chap_running"/>), you'll see a screen like this one below:</para> -<figure><title>When KildClient is first started, you are asked to - connect to a world</title> +<figure><info><title>When KildClient is first started, you are asked to + connect to a world</title></info> <mediaobject> <imageobject> <imagedata fileref="images/firstscreen.png" format="PNG"/> @@ -138,7 +141,7 @@ between the options is not so great.</para> <guibutton>New</guibutton>. You'll be taken to the <emphasis>World Editor</emphasis>, a dialog in which you can configure everything about the World. We'll talk about the World Editor in <xref -linkend="chap:world_editor"/>. For now, fill in the +linkend="chap_world_editor"/>. For now, fill in the <guilabel>Name</guilabel>, <guilabel>Host</guilabel> and <guilabel>Port</guilabel> fields, and click <guibutton>OK</guibutton>.</para> @@ -150,7 +153,7 @@ double-click the World in the list.</para> <para>Sometimes you may see a little expander sign to the left of a World's name, and when you click it some options appear inside that World. This happens when there is more than one character associated -with that World (see <xref linkend="sec:we_general"/> for information +with that World (see <xref linkend="sec_we_general"/> for information on auto-login and associating characters with a World). The list shown is the list of all characters defined for that World. Select the entry corresponding to the character you want to use to auto-login with that @@ -172,11 +175,11 @@ and you can select another World.</para> </sect1> -<sect1 id="sec:interacting"><title>Interacting with the MUD</title> +<sect1 xml:id="sec_interacting"><info><title>Interacting with the MUD</title></info> <para>The figure below shows a typical KildClient session:</para> -<figure><title>A typical KildClient session with two open Worlds</title> +<figure><info><title>A typical KildClient session with two open Worlds</title></info> <mediaobject> <imageobject> <imagedata fileref="images/typical.png" format="PNG"/> @@ -268,7 +271,7 @@ to the MUD in sequence: first <literal>unlock door</literal>, and then <literal>open door</literal>. Spaces around the <literal>%;</literal> are ignore and can be used for clarity. Note: it is possible to configure the command separator to be another string instead of -<literal>%;</literal>. See <xref linkend="sec:we_input"/>.</para> +<literal>%;</literal>. See <xref linkend="sec_we_input"/>.</para> <para>Another special feature of the command line is that you can execute Perl statements from it. Starting a line with a slash @@ -281,7 +284,7 @@ that the command <userinput>$world->echonl("Hello, Perl World!")</userinput> has been run by Perl, and this command causes a string to be printed in the screen (but not to be sent to the MUD). Don't worry if you do not understand the syntax yet, we will explain -it in <xref linkend="chap:perl"/>. For now, just keep in mind that if +it in <xref linkend="chap_perl"/>. For now, just keep in mind that if you type a line starting with <literal>/</literal>, it will not be sent to the MUD, but what follows the slash is treated as a Perl command and executed.</para> @@ -295,12 +298,12 @@ to the MUD.</para> built in spell checker to verify the text as you type. Misspelled words will be highlighted with a red line below them, and you can right-click on them to show a menu with possible spellings. To -configure this feature, see <xref linkend="sec:we_input"/>.</para> +configure this feature, see <xref linkend="sec_we_input"/>.</para> </sect1> -<sect1 id="sec:closing_worlds"> -<title>Closing Worlds and Exiting KildClient</title> +<sect1 xml:id="sec_closing_worlds"> +<info><title>Closing Worlds and Exiting KildClient</title></info> <para>When you are disconnected from a World (either because you requested it, with the <literal>quit</literal> command or something @@ -308,9 +311,9 @@ similar, or because the server has gone down), you will see a dialog box from which you can choose from four options: <guibutton>Reconnect</guibutton> will attempt to reconnect to the same World (using the same character for auto-login, if there is more than -one defined, see <xref linkend="sec:we_general"/>). <guibutton>Connect +one defined, see <xref linkend="sec_we_general"/>). <guibutton>Connect to another world</guibutton> will open the World Selection dialog (see -<xref linkend="sec:world-selector"/>) for you to choose another World +<xref linkend="sec_world-selector"/>) for you to choose another World to connect to. <guilabel>Offline</guilabel> will keep the world open so that you still see its output or execute some things with Perl. Finally, <guibutton>Close</guibutton> will close the tab for that @@ -350,16 +353,16 @@ World, use <function>$world->close</function>. And to quit KildClient closing all Worlds, use <function>quit</function> (type <userinput>/quit</userinput>, as you might imagine). The reason <function>quit</function> does not have <literal>$world-></literal> in -front will be explained in <xref linkend="sec:perl_basics"/>, but for +front will be explained in <xref linkend="sec_perl_basics"/>, but for now suffices to say that since it operates on all Worlds (and not in one specific one), it does not have that.</para> </sect1> -<sect1 id="sec:searching"><title>Reviewing and Searching Text</title> +<sect1 xml:id="sec_searching"><info><title>Reviewing and Searching Text</title></info> -<figure><title>A typical KildClient session with two open Worlds</title> +<figure><info><title>A typical KildClient session with two open Worlds</title></info> <mediaobject> <imageobject> <imagedata fileref="images/typical.png" format="PNG"/> @@ -372,7 +375,7 @@ one specific one), it does not have that.</para> <para>The main box that shows the output of the MUD keeps by default the last 2000 lines received (but this number can be changed, see -<xref linkend="sec:we_mainwindow"/>). You can recall the previous +<xref linkend="sec_we_mainwindow"/>). You can recall the previous lines with the scrollbar or with the <keysym>page up</keysym> and <keysym>page down</keysym> keys.</para> @@ -447,7 +450,7 @@ box.</para> -<chapter id="chap:world_editor"><title>Editing a World</title> +<chapter xml:id="chap_world_editor"><info><title>Editing a World</title></info> <para>This chapter will describe all the options found in the World Editor that let you customize the behaviour of KildClient. Only @@ -469,12 +472,12 @@ dialog, just click once in the World from the list and press following sections will describe each one in turn.</para> -<sect1 id="sec:we_general"><title>General</title> +<sect1 xml:id="sec_we_general"><info><title>General</title></info> <para>The figure below shows the General section of the World Editor:</para> -<figure><title>The General section of the World Editor</title> +<figure><info><title>The General section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_general.png" format="PNG"/> @@ -512,14 +515,14 @@ parameters that specify how to connect to the MUD:</para> certificate verification, so you must not assume that the connection is authenticated. You can, however, see some information on the certificate in the Statistics dialog (see - <xref linkend="mnu:statistics"/>).</para> + <xref linkend="sec_mnu_statistics"/>).</para> </listitem> </itemizedlist> <para>The second second, <guilabel>Proxy</guilabel> allows you to specify a proxy server to use when connecting to the MUD. By default, Worlds use the global proxy settings configured in the Preferences -dialog (see <xref linkend="prefs:proxy" />). But you can override the +dialog (see <xref linkend="sec_pref_proxy"/>). But you can override the default settings for individual worlds.</para> <para>Select <guilabel>No proxy</guilabel> if there is a default proxy @@ -536,7 +539,7 @@ the parameters that you need to configure if you want KildClient to login automatically to the MUD for you. You can associate several characters with a World, and then when you can select which character you use to login to the MUD, as explained in <xref -linkend="sec:world-selector"/>.</para> +linkend="sec_world-selector"/>.</para> <para>First, select how the login will be made in <guilabel>Connection Style</guilabel>. If this is set to "<guilabel>No @@ -551,7 +554,7 @@ followed by the character name and password.</para> <para>If neither of these options apply to your MUD, you should disable auto-login here, but you can still use a hook to send commands -just after you connect. See <xref linkend="chap:hooks"/>.</para> +just after you connect. See <xref linkend="chap_hooks"/>.</para> <para>Next follows a list of all the characters that you have defined. Each character is associated with a password, however the password is @@ -571,19 +574,19 @@ if you connect using the main entry for that World.</para> </sect1> -<sect1><title>Display settings</title> +<sect1><info><title>Display settings</title></info> <para>The Display category controls several aspects of the appearance of KildClient. It is divided in sub-categories, which will be described in the following sections.</para> -<sect2 id="sec:we_mainwindow"><title>Main Window</title> +<sect2 xml:id="sec_we_mainwindow"><info><title>Main Window</title></info> <para>The figure below shows the Main Window section of the World Editor:</para> -<figure><title>The Main Window section of the World Editor</title> +<figure><info><title>The Main Window section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_mainwindow.png" format="PNG"/> @@ -608,7 +611,7 @@ represent text that has the "bold" or "highlight" attribute set. By default, this text is rendered in a lighter color and with a boldface, but you can disable the use of a bold font from this dialog. You can also change the colors used for the highlighted text, see <xref -linkend="sec:we_colors"/>.</para> +linkend="sec_we_colors"/>.</para> <para>You can also configure whether to use word wrap or not. If this option is not set, lines will be broken when they do not fit the @@ -653,7 +656,7 @@ received.</para> controls how this world is identified in the tabs and in the window title. By default, only its name is used. But you can also display the name of the character logged in (provided auto logon was used, see -section <xref linkend="sec:we_general" />). If none of the options +section <xref linkend="sec_we_general"/>). If none of the options suit you, you can define your own. Use <literal>%Kw</literal> to represent the world name and <literal>%Kc</literal> to represent the character.</para> @@ -662,12 +665,12 @@ character.</para> </sect2> -<sect2 id="sec:we_colors"><title>Colors</title> +<sect2 xml:id="sec_we_colors"><info><title>Colors</title></info> <para>The figure below shows the Colors section of the World Editor:</para> -<figure><title>The Colors section of the World Editor</title> +<figure><info><title>The Colors section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_colors.png" format="PNG"/> @@ -682,7 +685,7 @@ Editor:</para> by KildClient. The ANSI standard defines eight colors, both in the "normal" state and in the "bold" state. These "bold" colors are by default shown with lighter colors, and, optionally, with a bold font -also (see <xref linkend="sec:we_mainwindow"/>). Additionally, there are +also (see <xref linkend="sec_we_mainwindow"/>). Additionally, there are "default" colors for the foreground and background, when no specific color is set.</para> @@ -699,12 +702,12 @@ button.</para> </sect2> -<sect2 id="sec:we_statusbar"><title>Status Bar</title> +<sect2 xml:id="sec_we_statusbar"><info><title>Status Bar</title></info> <para>The figure below shows the Status Bar section of the World Editor:</para> -<figure><title>The Status Bar section of the World Editor</title> +<figure><info><title>The Status Bar section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_statusbar.png" format="PNG"/> @@ -745,12 +748,12 @@ counter to be reset.</para> </sect1> -<sect1 id="sec:we_input"><title>Input</title> +<sect1 xml:id="sec_we_input"><info><title>Input</title></info> <para>The figure below shows the Input section of the World Editor:</para> -<figure><title>The Input section of the World Editor</title> +<figure><info><title>The Input section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_input.png" format="PNG"/> @@ -811,7 +814,7 @@ the behaviour of the command entry textbox:</para> <listitem><para><guilabel>Enable auto-completion</guilabel> controls whether the auto-completion feature (see <xref - linkend="sec:interacting"/>) is enabled or not. However, + linkend="sec_interacting"/>) is enabled or not. However, auto-completion only works for single line input bars.</para></listitem> @@ -854,7 +857,7 @@ might be sent anytime.</para> </sect1> -<sect1 id="sec:we_logging"><title>Logging</title> +<sect1 xml:id="sec_we_logging"><info><title>Logging</title></info> <para>A useful feature of KildClient is it hability to log all the output from the MUD, as shown in the screen, so that you can retrieve @@ -870,7 +873,7 @@ timestamp.</para> <para>The figure below shows the Logging section of the World Editor:</para> -<figure><title>The Logging section of the World Editor</title> +<figure><info><title>The Logging section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_logging.png" format="PNG"/> @@ -902,13 +905,13 @@ be "<filename>log_11_25.txt</filename>". This is done replacing escape sequences beginning with the <literal>%</literal> character for the values depending on the date and time. The valid escape sequences are those of the <function>strftime()</function> function, and can be -found <ulink -url="http://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#index-strftime-2660">here</ulink>.</para> +found <link +xlink:href="http://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#index-strftime-2660">here</link>.</para> <para>Similarly, you can use <literal>%Kw</literal> in the file name and it will be replaced by the name of the World. And the string <literal>%Kc</literal> is replaced by the name of the character used -in auto-login (see <xref linkend="sec:we_general" />). (If auto-login +in auto-login (see <xref linkend="sec_we_general"/>). (If auto-login was not used, then <literal>%Kc</literal> is replaced by an empty string.)</para> @@ -929,7 +932,7 @@ time.</para> </sect1> -<sect1 id="sec:we_automation"><title>Automation</title> +<sect1 xml:id="sec_we_automation"><info><title>Automation</title></info> <para>This section allows you to configure the features that make your MUD playing experience easier, faster and more efficient. You can @@ -939,12 +942,12 @@ the features. Here we will deal with another section that is more generic.</para> -<sect2 id="sec:we_scripting"><title>Scripting</title> +<sect2 xml:id="sec_we_scripting"><info><title>Scripting</title></info> <para>The figure below shows the Scripting section of the World Editor:</para> -<figure><title>The Scripting section of the World Editor</title> +<figure><info><title>The Scripting section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_scripting.png" format="PNG"/> @@ -961,7 +964,7 @@ file that will be read by the Perl interpreter when the World is loaded. This file can contain sub-routine definitions that will be available for you to use in your triggers, aliases etc., or to be called directly. For more details, see <xref -linkend="sec:perl_basics"/>.</para> +linkend="sec_perl_basics"/>.</para> <para>Enter the path to the file in the textbox, or click the button next to it to open a dialog from which you can select a file.</para> @@ -971,12 +974,12 @@ next to it to open a dialog from which you can select a file.</para> </sect1> -<sect1 id="sec:we_protocols"><title>Protocols</title> +<sect1 xml:id="sec_we_protocols"><info><title>Protocols</title></info> <para>The figure below shows the Protocols section of the World Editor:</para> -<figure><title>The Protocols section of the World Editor</title> +<figure><info><title>The Protocols section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_protocols.png" format="PNG"/> @@ -1016,12 +1019,12 @@ data. Attempts by malicious players will not succeed.</para> </sect1> -<sect1 id="sec:we_advanced"><title>Advanced</title> +<sect1 xml:id="sec_we_advanced"><info><title>Advanced</title></info> <para>The figure below shows the Advanced section of the World Editor:</para> -<figure><title>The Advanced section of the World Editor</title> +<figure><info><title>The Advanced section of the World Editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_advanced.png" format="PNG"/> @@ -1110,7 +1113,7 @@ arrow keys as part of the input process.</para> -<chapter id="chap:preferences"><title>Configuring KildClient</title> +<chapter xml:id="chap_preferences"><info><title>Configuring KildClient</title></info> <para>The previous Chapter described how to configure a World. Those settings are individual for each World. There are some settings, @@ -1126,12 +1129,12 @@ menu. The following sections will describe the groups in the Preferences dialog.</para> -<sect1><title>Appearance</title> +<sect1><info><title>Appearance</title></info> <para>The figure below shows the Appearance section of the Preferences dialog:</para> -<figure><title>The Appearance section of the Preferences dialog</title> +<figure><info><title>The Appearance section of the Preferences dialog</title></info> <mediaobject> <imageobject> <imagedata fileref="images/pref_appearance.png" format="PNG"/> @@ -1144,7 +1147,7 @@ dialog:</para> <para>In this section you configure the colors that KildClient uses for its own purposes. (The configuration of the colors that the MUD -displays is explained in <xref linkend="sec:we_colors"/>.)</para> +displays is explained in <xref linkend="sec_we_colors"/>.)</para> <para>Two colors can be configured: <guilabel>Informative messages</guilabel> is the color used by KildClient to print messages @@ -1152,12 +1155,12 @@ about the status of the connection, such as the ones showing that a connection is being tried or has succeeded. <guilabel>Command echo</guilabel> specifies the color in which the commands you send to the World are printed in the screen (if this feature is enabled, see -<xref linkend="sec:we_input"/>).</para> +<xref linkend="sec_we_input"/>).</para> <para>In each case, select from the drop-down list the color you want. Note that the actual color that is displayed depends on how it was configured in the World Editor (see <xref -linkend="sec:we_colors"/>).</para> +linkend="sec_we_colors"/>).</para> <para>How the tabs representing the open worlds are displayed is configured here. They can be at the top, bottom, left or right. Select @@ -1178,12 +1181,12 @@ with the "Urgent" flag set.</para> </sect1> -<sect1 id="pref:sending"><title>Sending</title> +<sect1 xml:id="sec_pref_sending"><info><title>Sending</title></info> <para>The figure below shows the Sending section of the Preferences dialog:</para> -<figure><title>The Sending section of the Preferences dialog</title> +<figure><info><title>The Sending section of the Preferences dialog</title></info> <mediaobject> <imageobject> <imagedata fileref="images/pref_sending.png" format="PNG"/> @@ -1196,8 +1199,8 @@ dialog:</para> <para>In this section you configure the default paramenters used when sending several commands at once. This setting is used in the Command -History (<xref linkend="sec:cmd_history"/>) and Multi-line Send -(<xref linkend="sec:ml_send"/>) dialogs.</para> +History (<xref linkend="sec_cmd_history"/>) and Multi-line Send +(<xref linkend="sec_ml_send"/>) dialogs.</para> <para>You specify the number of commands or lines that are sent simultaneously, and the delay between sending each group of @@ -1209,7 +1212,7 @@ if you need so.</para> </sect1> -<sect1 id="pref:progs"><title>External Programs (Linux)</title> +<sect1 xml:id="sec_pref_progs"><info><title>External Programs (Linux)</title></info> <para>This section of the Preferences dialog only appears when KildClient is run in Linux.</para> @@ -1217,8 +1220,8 @@ KildClient is run in Linux.</para> <para>The figure below shows the External Programs section of the Preferences dialog:</para> -<figure><title>The External Programs section of the Preferences - dialog</title> +<figure><info><title>The External Programs section of the Preferences + dialog</title></info> <mediaobject> <imageobject> <imagedata fileref="images/pref_progs.png" format="PNG"/> @@ -1239,7 +1242,7 @@ is to be executed in the background, so that you can continue using KildClient while browsing the URL.</para> <para>You can also set a command used to play audio files (see <xref -linkend="sec:sounds"/>). Enter the command, with <literal>%s</literal> +linkend="sec_sounds"/>). Enter the command, with <literal>%s</literal> in the place of the file path. The default should work (it uses the SOX program, which is usually installed), but you can use other commands if you use ALSA, ARTS, ESD, JACK, etc.</para> @@ -1247,12 +1250,12 @@ commands if you use ALSA, ARTS, ESD, JACK, etc.</para> </sect1> -<sect1 id="prefs:proxy"><title>Proxy</title> +<sect1 xml:id="sec_pref_proxy"><info><title>Proxy</title></info> <para>The figure below shows the Proxy section of the Preferences dialog:</para> -<figure><title>The Proxy section of the Preferences dialog</title> +<figure><info><title>The Proxy section of the Preferences dialog</title></info> <mediaobject> <imageobject> <imagedata fileref="images/pref_proxy.png" format="PNG"/> @@ -1266,7 +1269,7 @@ dialog:</para> <para>In this section you configure the default proxy settings that will apply to Worls that are configured to use the global proxy configuration. It is possible for individual worlds to override the -settings configured here, see <xref linkend="sec:we_general" />.</para> +settings configured here, see <xref linkend="sec_we_general"/>.</para> <para>The default setting is <guilabel>No proxy</guilabel>, which means connect directly to the MUD's host. Alternatively, you can use a @@ -1282,26 +1285,26 @@ fields.</para> -<chapter><title>Menu Reference</title> +<chapter><info><title>Menu Reference</title></info> <para>This chapter will describe all the menus and their commands in KildClient.</para> -<sect1><title>World menu</title> +<sect1><info><title>World menu</title></info> -<sect2><title>Open</title> +<sect2><info><title>Open</title></info> <para>This menu command opens the World Selector dialog for you to connect to a World, either a saved one or a new one. You can also edit the saved worlds from the World Selector dialog.</para> -<para>See <xref linkend="sec:world-selector"/> for more information +<para>See <xref linkend="sec_world-selector"/> for more information on opening Worlds.</para> </sect2> -<sect2><title>Reconnect</title> +<sect2><info><title>Reconnect</title></info> <para>If you are not connected to a World, but have it still open (in offline mode), use this menu to connect again to the World. If you are @@ -1310,7 +1313,7 @@ it.</para> </sect2> -<sect2><title>Disconnect</title> +<sect2><info><title>Disconnect</title></info> <para>This command closes the connection to the World. Note that this is not the recommended way to exit from a MUD, you should use the @@ -1318,16 +1321,16 @@ proper command (generally <userinput>quit</userinput>).</para> </sect2> -<sect2><title>Connect to Another</title> +<sect2><info><title>Connect to Another</title></info> <para>This command opens the World Selector (see <xref -linkend="sec:world-selector"/>) for you to connect to another World +linkend="sec_world-selector"/>) for you to connect to another World using the same tab. If you are still connected to a World, the connection will be closed.</para> </sect2> -<sect2><title>Close</title> +<sect2><info><title>Close</title></info> <para>This command closes the connection to the World (if it is open) and closes the current tab. If this is the only tab, the program is @@ -1335,14 +1338,14 @@ exited.</para> </sect2> -<sect2><title>Edit</title> +<sect2><info><title>Edit</title></info> <para>This command brings up the World Editor for you to configure the -World. See <xref linkend="chap:world_editor"/>.</para> +World. See <xref linkend="chap_world_editor"/>.</para> </sect2> -<sect2><title>Save</title> +<sect2><info><title>Save</title></info> <para>This command saves any changes made to the World to the disk so that they are made permanent. Note that whenever a World is closed, it @@ -1350,27 +1353,27 @@ is automatically saved before.</para> </sect2> -<sect2 id="mnu:statistics"><title>Statistics</title> +<sect2 xml:id="sec_mnu_statistics"><info><title>Statistics</title></info> <para>This command opens a dialog showing some information and statistics about the currently open World. If you are connected using -SSL (see <xref linkend="sec:we_general"/>), some information about the +SSL (see <xref linkend="sec_we_general"/>), some information about the SSL session and the certificate are displayed.</para> </sect2> -<sect2><title>Previous and Next</title> +<sect2><info><title>Previous and Next</title></info> <para>These two commands allow you to navigate between the open Worlds, going to the next or previous tabs, repectively.</para> </sect2> -<sect2><title>Quit</title> +<sect2><info><title>Quit</title></info> <para>This command exits KildClient, closing any open Worlds. If an open world has "OnCloseConnected" hooks (see <xref -linkend="chap:hooks"/>), they are executed. If there is at least one +linkend="chap_hooks"/>), they are executed. If there is at least one open world without such hook, you are asked for confirmation first.</para> @@ -1379,16 +1382,16 @@ first.</para> </sect1> -<sect1><title>Edit Menu</title> +<sect1><info><title>Edit Menu</title></info> -<sect2><title>Cut</title> +<sect2><info><title>Cut</title></info> <para>This command copies the text selected in the command entry box to the clipboard and deletes the selected text.</para> </sect2> -<sect2><title>Copy</title> +<sect2><info><title>Copy</title></info> <para>This command copies text either from the MUD (that is, in the output window) or from the command entry box to the clipboard.</para> @@ -1399,24 +1402,24 @@ it is this text that is copied.</para> </sect2> -<sect2><title>Paste</title> +<sect2><info><title>Paste</title></info> <para>This command pastes the text in the clipboard to the command entry box, possibly overwriting any selected text.</para> </sect2> -<sect2><title>Delete</title> +<sect2><info><title>Delete</title></info> <para>This command deletes the text selected in the command entry box.</para> </sect2> -<sect2><title>Find and Find Next</title> +<sect2><info><title>Find and Find Next</title></info> <para>These commands are used to search for some text in the output -buffer. Their use is described in <xref linkend="sec:searching"/>.</para> +buffer. Their use is described in <xref linkend="sec_searching"/>.</para> </sect2> @@ -1424,9 +1427,9 @@ buffer. Their use is described in <xref linkend="sec:searching"/>.</para> -<sect1><title>Input Menu</title> +<sect1><info><title>Input Menu</title></info> -<sect2><title>Clear</title> +<sect2><info><title>Clear</title></info> <para>This command clears the command entry box. The same can be achieved by using the button to the left of the command entry @@ -1434,7 +1437,7 @@ box.</para> </sect2> -<sect2><title>Previous and Next</title> +<sect2><info><title>Previous and Next</title></info> <para>These commands retrieve the previous or next command in the history, putting them in the command input box. They are equivalent of @@ -1443,7 +1446,7 @@ the arrows, in some circunstances).</para> </sect2> -<sect2><title>Find Previous and Find Next</title> +<sect2><info><title>Find Previous and Find Next</title></info> <para>These commands search the command history for a command that starts with the text that is in the input bar. To use that feature, @@ -1453,13 +1456,13 @@ with that prefix with these menu entries.</para> </sect2> -<sect2 id="sec:cmd_history"><title>Command History</title> +<sect2 xml:id="sec_cmd_history"><info><title>Command History</title></info> <para>This command allows you to review the commands that have been sent recently, and send one or more commands again. When you select the menu item, a dialog like this appears:</para> -<figure><title>Command History Dialog</title> +<figure><info><title>Command History Dialog</title></info> <mediaobject> <imageobject> <imagedata fileref="images/cmdhistory.png" format="PNG"/> @@ -1472,7 +1475,7 @@ the menu item, a dialog like this appears:</para> <para>The list on the left shows the commands which are saved. You can configure how many commands are saved, see <xref -linkend="sec:we_input"/>.</para> +linkend="sec_we_input"/>.</para> <para>To send again commands to the World, select the commands you would like to send and press <guilabel>Send</guilabel>. Since most @@ -1499,13 +1502,13 @@ commands with the string. To start another search, use </sect2> -<sect2 id="sec:ml_send"><title>Multi-line Send</title> +<sect2 xml:id="sec_ml_send"><info><title>Multi-line Send</title></info> <para>This command allows you to send several lines of output and/or a file to the World. When you select the menu item, a dialog like this appears:</para> -<figure><title>Multi-Line Send</title> +<figure><info><title>Multi-Line Send</title></info> <mediaobject> <imageobject> <imagedata fileref="images/mlsend.png" format="PNG"/> @@ -1539,10 +1542,10 @@ further changes to the text.</para> </sect2> -<sect2><title>Test Triggers</title> +<sect2><info><title>Test Triggers</title></info> <para>This command brings up the Test Triggers window, which is -described in <xref linkend="sec:test_triggers"/>. +described in <xref linkend="sec_test_triggers"/>. </para> @@ -1551,9 +1554,9 @@ described in <xref linkend="sec:test_triggers"/>. </sect1> -<sect1><title>Preferences Menu</title> +<sect1><info><title>Preferences Menu</title></info> -<sect2><title>Disable Triggers, Aliases, Macros or Timers</title> +<sect2><info><title>Disable Triggers, Aliases, Macros or Timers</title></info> <para>If each of these menu entries is checked, then the corresponding automation feature is disabled: lines are not matched against @@ -1563,7 +1566,7 @@ since the triggers, aliases, macros or timers are not deleted.</para> </sect2> -<sect2><title>Debug Matches</title> +<sect2><info><title>Debug Matches</title></info> <para>If this entry is selected, whenever a trigger or alias matches, information is printed about it. The information is printed on stdout, @@ -1571,15 +1574,15 @@ which means you must start KildClient from a terminal.</para> </sect2> -<sect2><title>Preferences</title> +<sect2><info><title>Preferences</title></info> <para>This command opens a dialog where you can configure some aspects of KildClient global to all Worlds. See <xref -linkend="chap:preferences"/>.</para> +linkend="chap_preferences"/>.</para> </sect2> -<sect2><title>Edit Default World</title> +<sect2><info><title>Edit Default World</title></info> <para>This command opens a dialog where you can set some default parameters used for Worlds. For example, you can define your preferred @@ -1587,7 +1590,7 @@ font or colors, and all new Worlds will use these default font and colors.</para> <para>The things that can be set are described in <xref -linkend="chap:world_editor"/>, but not all things described there can +linkend="chap_world_editor"/>, but not all things described there can be set as default parameters. (There's no sense in having a default World name, for example.)</para> @@ -1596,30 +1599,30 @@ World name, for example.)</para> </sect1> -<sect1><title>Diplay Menu</title> +<sect1><info><title>Diplay Menu</title></info> -<sect2><title>Split screen</title> +<sect2><info><title>Split screen</title></info> <para>This option toggles displaying or hiding another window with the output from the world, so that you can see both the text as it is received and some other part of the scrollback buffer. See <xref -linkend="sec:searching"/>.</para> +linkend="sec_searching"/>.</para> </sect2> </sect1> -<sect1><title>Help Menu</title> +<sect1><info><title>Help Menu</title></info> -<sect2><title>Help</title> +<sect2><info><title>Help</title></info> <para>This commands opens a browser showing the KildClient manual (which you are reading now).</para> </sect2> -<sect2><title>About</title> +<sect2><info><title>About</title></info> <para>This commands shows a window with some information about the program.</para> @@ -1632,7 +1635,7 @@ program.</para> -<chapter id="chap:perl"><title>Using Perl in KildClient</title> +<chapter xml:id="chap_perl"><info><title>Using Perl in KildClient</title></info> <para>This chapter will describe briefly how to use Perl (Practical Extration and Report Language, or, according to some, Pathologically @@ -1645,7 +1648,7 @@ Some knowledge of Perl will certainly help in understanding this Chapter.</para> -<sect1 id="sec:perl_basics"><title>The Basics</title> +<sect1 xml:id="sec_perl_basics"><info><title>The Basics</title></info> <para>KildClient has a built-in Perl interpreter. To run a perl statement, just type if preceded by a slash (<literal>/</literal>) in @@ -1671,7 +1674,7 @@ is not enough, because Perl's built-in functions will not allow you to interact with the World. Because of that, KildClient defines a set of functions that you can use to interact with the World. A full list describing them detailedly is found in <xref -linkend="app:functions"/>, but some of the most useful ones will be +linkend="app_functions"/>, but some of the most useful ones will be described in this Chapter. Many of these functions deal with creating and editing triggers, gags, aliases etc. These will be described in the corresponding chapters.</para> @@ -1688,7 +1691,7 @@ not necessary.)</para> <para>Some functions are in a way global, that is, they do not refer to a specific world. One such example is <function>colorize</function> -(see <xref linkend="func:colorize" endterm="func:colorize.title"/>), +(see <xref linkend="func_colorize" endterm="func_colorize.title"/>), which inserts ANSI color codes in strings (useful when you want to print something in the screen). These are called like any built-in Perl function. For example, if you enter <userinput>/$colorstr = @@ -1697,8 +1700,8 @@ colorize("&WI'm in white!")</userinput>, the variable in white.</para> <para>Many functions, however, are specific to a World, such as -<function>echo</function> (see <xref linkend="func:echo" -endterm="func:echo.title"/>), which prints something in the World +<function>echo</function> (see <xref linkend="func_echo" +endterm="func_echo.title"/>), which prints something in the World window (but does not send it to the World). Because of that, they are called in a slightly different way. To print that string which has just been created, you would enter @@ -1713,7 +1716,7 @@ references the current World.</para> <para>It is also possible to control other worlds, if you have a variable pointing at them. You can get such a variable with the <function>getworld</function> function (see <xref -linkend="func:getworld" endterm="func:getworld.title"/>). In that +linkend="func_getworld" endterm="func_getworld.title"/>). In that case, you should use the variable you got instead of <varname>$world</varname>.</para> @@ -1723,7 +1726,7 @@ remember that many functions have to be called by adding be listed with that in front.</para> <para>When a World is opened, the Perl interpreter reads and executes -a file you specify. (See <xref linkend="sec:we_scripting"/> for +a file you specify. (See <xref linkend="sec_we_scripting"/> for information on how to specify the file.) In this file, you can define sub-routines and variables. They will be then available for you to use during your session. If you define a sub-routine called @@ -1739,7 +1742,7 @@ affect the others.</para> </sect1> -<sect1><title>Echoing and Sending Text</title> +<sect1><info><title>Echoing and Sending Text</title></info> <para>As mentioned in the previous section, the <function>$world->echo</function> function is used to print (or @@ -1784,7 +1787,7 @@ actually less efficient that typing the commands directly. However, when combined with variables and/or control flow structures, <function>send</function> can actually be quite useful.</para> -<sect2 id="sec:paths"><title>Paths and Speed-Walking</title> +<sect2 xml:id="sec_paths"><info><title>Paths and Speed-Walking</title></info> <para>A useful feature of some MUD clients, which KildClient implements, is the support for <emphasis>speed-walking</emphasis>. @@ -1797,8 +1800,8 @@ directions: <literal>s s s e e s e e e e n nw n</literal>. This is often written in a more compact way as <literal>3s 2e s 4e n nw n</literal>. KildClient allows you to send to the MUD all the 13 required commands in a single command. To do that, use the -<function>$world->path</function> function. For example, if you enter -<userinput>/$world->path("3s2es4en{nw}n")</userinput> in the command +<function>$world->path</function> function. For example, if you enter +<userinput>/$world->path("3s2es4en{nw}n")</userinput> in the command line, 13 commands will be sent to the MUD: exactly the 13 that form the path defined above.</para> @@ -1810,37 +1813,37 @@ is sent only once.</para> <para>Note also that the command to move to the north-west is enclosed in braces: <literal>{nw}</literal>. This is because if the -<function>$world->path</function> function sees <literal>nw</literal>, +<function>$world->path</function> function sees <literal>nw</literal>, it will think you want to move to the north than to the west. -Enclosing it in braces causes <function>$world->path</function> to see +Enclosing it in braces causes <function>$world->path</function> to see that as a single command. Should you need to move several times to the northwest, you can add a number before: <literal>4{nw}</literal> will send <literal>nw</literal> four times.</para> <para>Naturally, you can include any command that is not a single -letter in braces to force <function>$world->path</function> to see it +letter in braces to force <function>$world->path</function> to see it as a command. It is likely that some paths will need something like <literal>{open door}</literal> in the middle.</para> <para>Of course, simply entering paths in the command line is not that useful. But you can store the path in a variable, and then just call -<userinput>$world->path($stored_path)</userinput>. Just add a line +<userinput>$world->path($stored_path)</userinput>. Just add a line that defines the variable to you script file (see <xref -linkend="sec:perl_basics"/>), and you will be able to use the +linkend="sec_perl_basics"/>), and you will be able to use the variabled anywhere.</para> <para>Alternatively, you can define an alias (see <xref -linkend="chap:aliases"/>) or a macro (see <xref -linkend="chap:macros"/>) to execute your path even faster. The +linkend="chap_aliases"/>) or a macro (see <xref +linkend="chap_macros"/>) to execute your path even faster. The <literal>easypath</literal> plugin does that, see section <xref -linkend="plugin:easypath"/>.</para> +linkend="sec_plugin_easypath"/>.</para> </sect2> </sect1> -<sect1 id="sec:sounds"><title>Playing Sounds</title> +<sect1 xml:id="sec_sounds"><info><title>Playing Sounds</title></info> <para>To play a sound (for example, as the action of a trigger, to call your attention), use the <function>play</function> function. Pass @@ -1849,12 +1852,12 @@ it the path to the sound file, for example: <para>Under Windows, this function supports playing WAV files. Under Linux, you must set-up a command to play sounds, see <xref -linkend="pref:progs"/>.</para> +linkend="sec_pref_progs"/>.</para> </sect1> -<sect1><title>Saving Variables Permanently</title> +<sect1><info><title>Saving Variables Permanently</title></info> <para>You can define variables for use in your Perl scripts. Since KildClient has a full-featured Perl interpreter, you can use all kinds @@ -1874,14 +1877,14 @@ is opened again later. This way, their values are saved across sessions.</para> <para>To make a variable permanent, open the World Editor (see <xref -linkend="chap:world_editor"/>) and select the +linkend="chap_world_editor"/>) and select the <guilabel>Variables</guilabel> section inside <guilabel>Automation</guilabel>.</para> <para>There you will see a list of the variables that are set to be permanent:</para> -<figure><title>Permanent Variables</title> +<figure><info><title>Permanent Variables</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_vars.png" format="PNG"/> @@ -1908,7 +1911,7 @@ usefor for grouping similar variables together, but does not otherwise affect the saving of the variables.</para> -<sect2><title>Permanent Variables in the Command Line</title> +<sect2><info><title>Permanent Variables in the Command Line</title></info> <para>It is possible to make a variable permanent from the command line. To do that, use the <function>$world->makepermanent</function> @@ -1942,9 +1945,9 @@ permanent.</para> </sect1> -<sect1><title>Controlling Worlds with Perl</title> +<sect1><info><title>Controlling Worlds with Perl</title></info> -<para>In <xref linkend="sec:closing_worlds"/> it was explained that +<para>In <xref linkend="sec_closing_worlds"/> it was explained that you can disconnect from a World with the <function>$world->dc</function> function. It now should be clear why there is a <literal>$world-></literal> in front. Another function that @@ -1974,7 +1977,7 @@ disconnect and close all Worlds and then exit KildClient.</para> -<chapter id="chap:triggers"><title>Triggers</title> +<chapter xml:id="chap_triggers"><info><title>Triggers</title></info> <para>Triggers allow you to react automatically to text that comes from the MUD. This reaction can be of two forms: sending something to @@ -2008,18 +2011,18 @@ a basic idea of how triggers work. Next follows a more detailed explanation of all aspects involving triggers.</para> -<sect1><title>Creating and Editing Triggers</title> +<sect1><info><title>Creating and Editing Triggers</title></info> <para>The easiest way to create and alter triggers is from the World Editor, the place where all settings of a World are altered (see <xref -linkend="chap:world_editor"/>).</para> +linkend="chap_world_editor"/>).</para> <para>Trigger are defined in the <guilabel>Triggers</guilabel> section inside the <guilabel>Automation</guilabel> section. When you open that section, you'll see a list of the defined triggers and some buttons like this:</para> -<figure><title>The graphical Trigger editor</title> +<figure><info><title>The graphical Trigger editor</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_triggers.png" format="PNG"/> @@ -2043,7 +2046,7 @@ columns are as follows:</para> <listitem><para><guilabel>Name</guilabel> is a name that is assigned to a trigger. This helps you identify the trigger's purpose and is useful when editing a trigger via the command line (as described in - <xref linkend="sec:edit_trigger_cmdline"/>). Assigning a name to a + <xref linkend="sec_edit_trigger_cmdline"/>). Assigning a name to a trigger is optional.</para></listitem> <listitem><para><guilabel>Pattern</guilabel> and @@ -2062,7 +2065,7 @@ columns are as follows:</para> <listitem><para><guilabel>Gag Log</guilabel> defines if the line that matches the trigger will be written to the log file. If this is active, the line is gaged (omitted) from the log file, if logging is - enabled (see <xref linkend="chap:logging"/>).</para></listitem> + enabled (see <xref linkend="chap_logging"/>).</para></listitem> <listitem><para><guilabel>Keep Exec</guilabel> defines what happens when the trigger is matched. By default, if a trigger matches @@ -2073,22 +2076,22 @@ columns are as follows:</para> <listitem><para><guilabel>Rewriter</guilabel> defines if the trigger is a <emphasis>rewriter</emphasis> trigger, a special kind of trigger described in <xref - linkend="sec:trigger_rewriter"/>.</para></listitem> + linkend="sec_trigger_rewriter"/>.</para></listitem> <listitem><para><guilabel>Plugin</guilabel>: if this is non-empty, it means that the trigger belongs to a plugin (and the name of the plugin is displayed). However, by default plugin triggers are not - displayed. See <xref linkend="sec:we_advanced"/> for information on + displayed. See <xref linkend="sec_we_advanced"/> for information on how to display plugin triggers here.</para></listitem> </itemizedlist> -<sect2 id="sec:add_trigger_gui"><title>Adding Triggers</title> +<sect2 xml:id="sec_add_trigger_gui"><info><title>Adding Triggers</title></info> <para>To add a new trigger, press the <guilabel>Add</guilabel> button. This will open a window for you to edit the new trigger's parameters:</para> -<figure><title>The window to edit triggers</title> +<figure><info><title>The window to edit triggers</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_trigger_edit.png" format="PNG"/> @@ -2111,12 +2114,12 @@ with triggers.</para> </sect2> -<sect2><title>Editing Triggers</title> +<sect2><info><title>Editing Triggers</title></info> <para>To edit a trigger, select it by clicking its line in the list (the line will be highlighted), and press the <guilabel>Edit</guilabel> button. A window like the one used for -adding trigger (see <xref linkend="sec:add_trigger_gui"/>) will be +adding trigger (see <xref linkend="sec_add_trigger_gui"/>) will be opened, filled with the trigger's parameters. Change what you want, and press the <guilabel>OK</guilabel> to commit the changes. If, however, you change you mind, press <guilabel>Cancel</guilabel> and @@ -2136,7 +2139,7 @@ in the check button. The state will be toggled.</para> confirmation, and can cancel the operation, but once deleted, you cannot recover the trigger. If you want, you can disable this confirmation dialog (see <xref -linkend="sec:we_advanced"/>), but if you do so and click the +linkend="sec_we_advanced"/>), but if you do so and click the <guilabel>Delete</guilabel> button, the only way to undo your action will be creating the trigger again. To delete several triggers at once, select them all and press <guilabel>Delete</guilabel>.</para> @@ -2152,7 +2155,7 @@ button.</para> </sect1> -<sect1><title>Basic Triggers</title> +<sect1><info><title>Basic Triggers</title></info> <para>The simplest kind of trigger specifies only a pattern and an action. Below these parameters are described in detail.</para> @@ -2171,7 +2174,7 @@ matching.</para> anything that could be entered in the command line. It can be a simple command, that is sent to the MUD. Or you can send several commands at separating them with <literal>%;</literal> as described in -<xref linkend="sec:interacting"/>. Finally, you can execute some Perl +<xref linkend="sec_interacting"/>. Finally, you can execute some Perl code when a trigger matches, and this allows you to do virtually anything you want.</para> @@ -2180,7 +2183,7 @@ trigger, inform the <guilabel>Pattern</guilabel> and <guilabel>Action</guilabel> parameters shown below. Leave the other parameters in their default values.</para> -<example id="ex:simplest_trigger"><title>A very simple trigger</title> +<example xml:id="ex_simplest_trigger"><info><title>A very simple trigger</title></info> <itemizedlist> <listitem><para>Pattern: <literal>has attacked you!</literal></para></listitem> <listitem><para>Action: <literal>wield sword</literal></para></listitem> @@ -2207,9 +2210,9 @@ the <guilabel>Ignore case when matching</guilabel> option.</para> what was received from the server. This is better explained by an example:</para> -<example id="ex:trigger_regex_grouping"> - <title>A trigger which captures part of the received line and uses - it in the action</title> +<example xml:id="ex_trigger_regex_grouping"> + <info><title>A trigger which captures part of the received line and uses + it in the action</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^(.*) has attacked you!$</literal></para></listitem> <listitem><para>Action: <literal>cast missile $1</literal></para></listitem> @@ -2252,11 +2255,11 @@ by <literal>/</literal>. If the action is simple you can enter the statements there directly, if not, you can define a function in your script file and call it from the trigger.</para> -<para>Let us rewrite <xref linkend="ex:trigger_regex_grouping"/> to use +<para>Let us rewrite <xref linkend="ex_trigger_regex_grouping"/> to use Perl in the action:</para> -<example id="ex:trigger_perl"> -<title>A trigger with an action in Perl</title> +<example xml:id="ex_trigger_perl"> +<info><title>A trigger with an action in Perl</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^(.*) has attacked you!$</literal></para></listitem> <listitem><para>Action: <literal>/$world->send("cast missile $_[1]")</literal></para></listitem> @@ -2315,7 +2318,7 @@ instead of the whole array.</para> <para>Here's an example of a trigger that calls a sub-routine:</para> -<example><title>A trigger that calls a sub-routine</title> +<example><info><title>A trigger that calls a sub-routine</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^(.*) has attacked you!$</literal></para></listitem> <listitem><para>Action: <literal>/myGreatAttackSequence(@_)</literal></para></listitem> @@ -2333,8 +2336,8 @@ parameters.</para> </sect1> -<sect1 id="sec:trigger_highlight"> -<title>Changing the Style of the Matched Text</title> +<sect1 xml:id="sec_trigger_highlight"> +<info><title>Changing the Style of the Matched Text</title></info> <para>It is possible to cause a trigger to change the style of the line that matched (or of a part of it). This can be used, for example, @@ -2342,11 +2345,11 @@ to make some text that interests you stand out.</para> <para>To do that, enable the <guilabel>Change Style</guilabel> check box in the Edit Trigger dialog (see <xref -linkend="sec:add_trigger_gui"/>). The <guilabel>Configure</guilabel> +linkend="sec_add_trigger_gui"/>). The <guilabel>Configure</guilabel> button then allows you to set the style to be applied. When pressed, it brings up a window like this:</para> -<figure><title>The window to configure style</title> +<figure><info><title>The window to configure style</title></info> <mediaobject> <imageobject> <imagedata fileref="images/we_trigger_highlight.png" format="PNG"/> @@ -2373,7 +2376,7 @@ selection will override the style that the MUD sends.</para> </sect1> -<sect1><title>Gags</title> +<sect1><info><title>Gags</title></info> <para>Now that the basic usage of triggers has been explained, let us see some more advanced features.</para> @@ -2393,7 +2396,7 @@ creating the trigger.</para> <para>Let's create a simple gag to omit all that is said by Joe, a very silly and annoying player:</para> -<example id="ex:simple_gag"><title>A simple gag</title> +<example xml:id="ex_simple_gag"><info><title>A simple gag</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^Joe chats</literal></para></listitem> <listitem><para>Action: <literal>/$world->echonl("Joe said something silly here.")</literal></para></listitem> @@ -2413,7 +2416,7 @@ altogether. And we can. It is not necessary to specify an action for a gag trigger. In this case, nothing will be done, but the matched line will not be printed. So our example becomes:</para> -<example><title>A gag with no action</title> +<example><info><title>A gag with no action</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^Joe chats</literal></para></listitem> <listitem><para>Omit (gag) from output: Checked</para></listitem> @@ -2430,7 +2433,7 @@ way to do that is with a gag, and an action that outputs the modified line. Heres a simple example that changes the way a hypothetical chat channel is displayed:</para> -<example><title>Rewriting a line with gags</title> +<example><info><title>Rewriting a line with gags</title></info> <itemizedlist> <listitem><para>Pattern: <literal>^(.*) chats, '(.*)'</literal></para></listitem> <listitem><para>Action: <literal>/$world->echonl("[Chat] $_[1]: $_[2]")</literal></para></listitem> @@ -2440,7 +2443,7 @@ channel is displayed:</para> <para>The <guilabel>Omit (gag) from output</guilabel> check box only controls whether the line is displayed in the screen or not. If you -have logging enabled (see <xref linkend="chap:logging"/>), a the line +have logging enabled (see <xref linkend="chap_logging"/>), a the line that matched a trigger with that option checked will be written in the log file normally. If you want the line to be omitted from the log file, you must set also the <guilabel>Omit (gag) from log @@ -2452,7 +2455,7 @@ from neither.</para> </sect1> -<sect1 id="sec:trigger_other"><title>Other trigger features</title> +<sect1 xml:id="sec_trigger_other"><info><title>Other trigger features</title></info> <para>By default, when a trigger matches, no more checking is done. So if a line would match two or more triggers, only the first would have @@ -2477,7 +2480,7 @@ will be printed to stderr. (This means you must start KildClient from a terminal to see the output.)</para> -<sect2 id="sec:trigger_rewriter"><title>Rewriter Triggers</title> +<sect2 xml:id="sec_trigger_rewriter"><info><title>Rewriter Triggers</title></info> <para>Rewriter triggers are a special kind of trigger that allows something not possible with ordinary triggers: changing the received @@ -2489,7 +2492,7 @@ codes. Rewriter triggers can alter this variable, and then the other triggers will match on this changed line.</para> <para>Rewriter triggers run before normal triggers. Also, the Keep -executing option (see <xref linkend="sec:trigger_other"/>) is not +executing option (see <xref linkend... [truncated message content] |