Replace <term><command><arg> with <term><property><parameter> to describe

options in the config file because:
 * <arg> can only be used within <cmdsynopsis>.
 * <cmdsynopsis> does not allow text outside <command> and <arg>.
 * <arg> does not allow decorating elements like <literal> or <emphasis>.
This fixes #2803057.

Add shortcut entities for commonly used parameters (yes/no, size).
Remove Debian patch which is obsoleted by above changes.
This commit is contained in:
mmdolze
2009-06-12 09:12:50 +00:00
parent 5108e4931e
commit f59af2e241
48 changed files with 794 additions and 1321 deletions
+9 -18
View File
@@ -58,12 +58,7 @@ USB library.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size. The default <literal>20x2</literal> should be safe
@@ -75,10 +70,8 @@ USB library.
<varlistentry>
<term>
<command>VendorID</command> =
<arg choice="plain">
<replaceable>VENDORID</replaceable>
</arg>
<property>VendorID</property> =
<parameter><replaceable>VENDORID</replaceable></parameter>
</term>
<listitem>
<para>
@@ -96,16 +89,14 @@ USB library.
<varlistentry>
<term>
<command>ProductID</command> =
<arg choice="plain">
<replaceable>PRODUCTID</replaceable>
</arg>
<property>ProductID</property> =
<parameter><replaceable>PRODUCTID</replaceable></parameter>
</term>
<listitem>
<para>
The USB Product ID of the device to use.
If not given, it defaults to <literal>0x6001</literal> for a VLSystems L.I.S. MCE 2005 VFD
based on a FT232BL USB-to-RS232 converter by FTDI, which was produced
based on a FT232BL USB-to-RS232 converter by FTDI, which was produced
before March 2007.
</para>
<para>
@@ -117,12 +108,12 @@ USB library.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem>
<para>
Set the initial brightness [default: <literal>1000</literal>;
Set the initial brightness [default: <literal>1000</literal>;
legal: <literal>0</literal> - <literal>1000</literal>. Values
between 0 and 250 give 25% brightness, 251 to 500 give 50% brightness,
501 and 750, give 75% brightness, and values higher than 751 give 100%