1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-02-25 08:55:47 +01:00

Minor fixes in the group documentation.

This commit is contained in:
Štěpán Němec
2011-02-11 11:09:04 +01:00
parent 98e5b79d7b
commit 41200aa6a9

View File

@@ -146,21 +146,21 @@
<item> <item>
<tags>:gr :group</tags> <tags>:gr :group</tags>
<spec>:group<oa>!</oa> <a>group</a></spec> <spec>:gr<oa>oup</oa></spec>
<description> <description>
<p>List all active <t>groups</t>.</p> <p>List all active <t>groups</t>.</p>
</description> </description>
</item> </item>
<item> <item>
<spec>:group<oa>!</oa> <a>group</a></spec> <spec>:gr<oa>oup</oa><oa>!</oa> <a>group</a></spec>
<description> <description>
<p> <p>
Select, create, or modify a <t>group</t>. After invocation, Select, create, or modify a <t>group</t>. After invocation,
<a>group</a> becomes the default group for all further commands <a>group</a> becomes the default group for all further commands
issued in the current script. If <oa>!</oa> is given the group is issued in the current script. If <oa>!</oa> is given the group is
cleared of all mappings, commands, and any other entries bound to cleared of all mappings, commands, and any other entries bound to
it. it before making the specified additions (if any).
</p> </p>
<p>The following <a>group</a> names have special meanings:</p> <p>The following <a>group</a> names have special meanings:</p>
@@ -174,9 +174,16 @@
<p>The following arguments are available:</p> <p>The following arguments are available:</p>
<dl> <dl>
<dt>-args=<a>javascript</a></dt> <dd>JavaScript Object which augments the arguments passed to commands, mappings, and autocommands (short name: <em>-a</em>)</dd> <dt>-args=<a>javascript</a></dt> <dd>JavaScript Object which
augments the arguments passed to commands, mappings, and
autocommands, e.g., given <str delim="">{ foo: "bar" }</str>,
<tt>foo</tt> (<tt>&lt;foo></tt> if the Ex syntax is used) will
be replaced by <str delim="">bar</str> inside the definitions
(short name: <em>-a</em>)</dd>
<dt>-description</dt> <dd>A description of this group (short names: <em>-desc</em>, <em>-d</em>)</dd> <dt>-description</dt> <dd>A description of this group (short names: <em>-desc</em>, <em>-d</em>)</dd>
<dt>-locations=<a>filters</a></dt> <dd>The URLs for which this group should be active. See <t>site-filters</t> (short names: <em>-locs</em>, <em>-loc</em>, <em>-l</em>)</dd> <dt>-locations=<a>filters</a></dt> <dd>The URLs for which this
group should be active. See <t>site-filters</t> (short names:
<em>-locs</em>, <em>-loc</em>, <em>-l</em>)</dd>
<dt>-nopersist</dt> <dd>Do not save this group to an auto-generated RC file (short name: <em>-n</em>)</dd> <dt>-nopersist</dt> <dd>Do not save this group to an auto-generated RC file (short name: <em>-n</em>)</dd>
</dl> </dl>
</description> </description>
@@ -192,33 +199,33 @@
</p> </p>
<dl> <dl>
<dd>domain</dd> <dt>domain</dt>
<dt> <dd>
Any filter which is a valid domain name will match any site on that Any filter which is a valid domain name will match any site on that
domain or any sub-domain thereof. These filters may contain any letter domain or any sub-domain thereof. These filters may contain any letter
of the Roman alphabet, Arabic numerals, hyphens, and full stops. of the Roman alphabet, Arabic numerals, hyphens, and full stops.
Non-Latin domain names must be punycode encoded. Non-Latin domain names must be punycode encoded.
</dt> </dd>
<dd>URL prefix</dd> <dt>URL prefix</dt>
<dt> <dd>
Any URL beginning with a valid protocol name and ending with a Any URL beginning with a valid protocol name and ending with a
<tt>*</tt> is treated as a URL prefix. It will match any URL which <tt>*</tt> is treated as a URL prefix. It will match any URL which
begins with the given filter sans the trailing asterisk. begins with the given filter sans the trailing asterisk.
</dt> </dd>
<dd>Full URL</dd> <dt>Full URL</dt>
<dt> <dd>
Any URL beginning with a valid protocol name and not ending with an Any URL beginning with a valid protocol name and not ending with an
asterisk is treated as a full URL match. It will match any page which asterisk is treated as a full URL match. It will match any page which
has a URL identical to the filter. has a URL identical to the filter.
</dt> </dd>
<dd>Regular expression</dd> <dt>Regular expression</dt>
<dt> <dd>
Any filter which does not fall into one of the above categories is Any filter which does not fall into one of the above categories is
treated as a case-sensitive regular expression. treated as a case-sensitive regular expression.
</dt> </dd>
</dl> </dl>
<p> <p>