/usr/share/doc/kildclient/html/ch10s01.xhtml is in kildclient-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>10.1. Creating and Editing Macros</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="chap_macros.xhtml" title="Chapter 10. Macros"/><link rel="next" href="sec_macro_cmdline.xhtml" title="10.2. Defining Macros in the Command Line"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">10.1. Creating and Editing Macros</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="chap_macros.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 10. Macros</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="sec_macro_cmdline.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm1841"><div class="titlepage"><div><div><h2 class="title" style="clear: both">10.1. Creating and Editing Macros</h2></div></div></div><p>The easiest way to create and alter macros is from the World
Editor, the place where all settings of a World are altered (see <a class="xref" href="chap_world_editor.xhtml" title="Chapter 4. Editing a World">Chapter 4, <em>Editing a World</em></a>).</p><p>Macro are defined in the <span class="guilabel">Macros</span> section
inside the <span class="guilabel">Automation</span> section. When you open that
section, you'll see a list of the defined macros and some buttons
like this:</p><div class="figure" id="idm1849"><div class="figure-title">Figure 10.1. The graphical Macro editor</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_macros.png" alt="The graphical Macro editor."/></div></div></div><br class="figure-break"/><p>The main part of the window is the list of defined macros. The
columns are as follows:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="guilabel">Enabled</span> specifies whether the
macro is enabled or not. Macros that are not enabled are not active
and will not be run even if their key is pressed, but they remain in
the list so that they can later be enabled again.</p></li><li class="listitem"><p><span class="guilabel">Name</span> is a name that is assigned
to a macro. This helps you identify the macro's purpose and is
useful when editing a macro via the command line (as described in
<a class="xref" href="sec_macro_cmdline.xhtml#sec_edit_macro_cmdline" title="10.2.1. Editing Macros">Section 10.2.1, “Editing Macros”</a>). Assigning a name to a
macro is optional.</p></li><li class="listitem"><p><span class="guilabel">Key</span> is the key that activates
the macro.</p></li><li class="listitem"><p><span class="guilabel">Action</span> is the action that is
run when the key is pressed.</p></li><li class="listitem"><p><span class="guilabel">Plugin</span>: if this is non-empty,
it means that the macro belongs to a plugin (and the name of the
plugin is displayed). However, by default plugin macros are not
displayed. See <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a> for information on
how to display plugin macros here.</p></li></ul></div><section class="sect2" id="sec_add_macro_gui"><div class="titlepage"><div><div><h3 class="title">10.1.1. Adding Macros</h3></div></div></div><p>To add a new macro, press the <span class="guilabel">Add</span> button.
This will open a window for you to edit the new macro's parameters:</p><div class="figure" id="idm1881"><div class="figure-title">Figure 10.2. The window to edit macros</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_macro_edit.png" alt="The window to edit macros."/></div></div></div><br class="figure-break"/><p>What can be set represents the columns described above. To
define the key, press the key combination desired in the text box for
<span class="guilabel">Key</span> and the appropriate key code will be
inserted.</p><p>When you are finished, press <span class="guilabel">OK</span> and the
macro will be added. If you change your mind, press
<span class="guilabel">Cancel</span> and the macro will not be added.</p><p>To see some things macros can do, read <a class="xref" href="sec_macro_cmdline.xhtml" title="10.2. Defining Macros in the Command Line">Section 10.2, “Defining Macros in the Command Line”</a>. If you want to try the macros described
there, you can create them from the World Editor.</p></section><section class="sect2" id="idm1896"><div class="titlepage"><div><div><h3 class="title">10.1.2. Editing Macros</h3></div></div></div><p>To edit a macro, select it by clicking its line in the list
(the line will be highlighted), and press the
<span class="guilabel">Edit</span> button. A window like the one used for
adding macro (see <a class="xref" href="ch10s01.xhtml#sec_add_macro_gui" title="10.1.1. Adding Macros">Section 10.1.1, “Adding Macros”</a>) will be
opened, filled with the macro's parameters. Change what you want,
and press the <span class="guilabel">OK</span> to commit the changes. If,
however, you change you mind, press <span class="guilabel">Cancel</span> and
the changes will be not be made, the macro will remain as it was
before.</p><p>Another shorter way to edit a macro is to double click its
line in the list.</p><p>It is also possible to change the value of the enabled option
directly from the macro list. Make sure that the macro you want to
change is selected, and click in the check button. The state will be
toggled.</p><p>To delete a macro, select it and press the
<span class="guilabel">Delete</span> button. You will be asked for
confirmation, and can cancel the operation, but once deleted, you
cannot recover the macro. If you want, you can disable this
confirmation dialog, but if you do so and click the
<span class="guilabel">Delete</span> button, the only way to undo your action
will be creating the macro again. See <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a>. To delete several macros at once, select
them all and press <span class="guilabel">Delete</span>.</p><p>The final thing that needs to be explained with regard to
macros is how to reorder them. Macros as tried from the first one
to the last, so in a few cases the order might matter. To move a
macro up or down in the list, select it and press the corresponding
button.</p></section></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="chap_macros.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_macros.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="sec_macro_cmdline.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Chapter 10. Macros </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> 10.2. Defining Macros in the Command Line</td></tr></table></div></footer></body></html>
|