Author: jstephens
Date: 2010-11-02 07:02:49 +0100 (Tue, 02 Nov 2010)
New Revision: 23519
Log:
Rearrange and improve description for using role="ndbparam:..."
References to dbk-prep.xsl should be to auto-link.xsl (Thanks, Paul!)
Modified:
trunk/mysqldoc-guide/special-markup.xml
Modified: trunk/mysqldoc-guide/special-markup.xml
===================================================================
--- trunk/mysqldoc-guide/special-markup.xml 2010-11-01 21:51:43 UTC (rev 23518)
+++ trunk/mysqldoc-guide/special-markup.xml 2010-11-02 06:02:49 UTC (rev 23519)
Changed blocks: 4, Lines Added: 78, Lines Deleted: 53; 7946 bytes
@@ -807,7 +807,7 @@
For references to certain objects that can be associated with a
section or paragraph in a manual, we generate links automatically.
The processing for this is handled in the
- <filename>dbk-prep.xsl</filename> transform to add
+ <filename>auto-link.xsl</filename> transform to add
<literal><link></literal> elements. In this way, we get
auto-linking of object references to their descriptions, which is
useful for those output formats that support hyperlinking (HTML,
@@ -881,63 +881,15 @@
<literal>priv</literal> for an access privilege. For MySQL
Cluster configuration parameters, the <literal>role</literal>
value starts with the prefix <literal>ndbparam:</literal>;
- this is explained further in the next two paragraphs.
+ this is explained further later in this section.
</para>
-
- <formalpara>
-
- <title>MySQL Cluster configuration parameters</title>
-
- <para>
- For <literal>NDB</literal> parameters used to configure
- MySQL Cluster nodes and processes, the
- <literal>role</literal> is formed and used somewhat
- differently. Each parameter is used in one or more specific
- sections of the MySQL Cluster
- <filename>config.ini</filename> file. This is because some
- parameters have differing characteristics depending on the
- <filename>config.ini</filename> section in which they occur,
- and a given parameter does not necessarily apply to all
- sections of the file. Each valid mapping between a parameter
- name and a <filename>config.ini</filename> section type
- (often referred to simply as the parameter's type) is
- described separately in
- <xref linkend="mysql-cluster-config-file"/>; each
- description provides a target having a unique identifier.
- These IDs take the form
- ndbparam-<replaceable>type</replaceable>-<replaceable>name</replaceable>,
- where <replaceable>type</replaceable> is the parameter type,
- and <replaceable>name</replaceable> is the parameter's
- name converted to lowercase.
- </para>
-
- </formalpara>
-
- <para>
- For an <literal>NDB</literal> configuration parameter, the
- <literal>role</literal> value takes the form
- <literal>ndbparam:<replaceable>type</replaceable></literal>,
- where <replaceable>type</replaceable> is the node type; these
- types are <literal>ndbd</literal>, <literal>api</literal>,
- <literal>mgmd</literal>, <literal>shm</literal>,
- <literal>tcp</literal>, <literal>sci</literal>,
- <literal>system</literal>, <literal>computer</literal>, and
- <literal>ndbmtd</literal>. For example, <literal><literal
- role="ndbparam:ndbd">HostName<literal></literal>
- generates a link to the target having the ID
- <literal>ndbparam-ndbd-hostname</literal>, and
- <literal><literal
- role="ndbparam:tcp">NodeIdServer<literal></literal>
- generates a link to the target whose ID is
- <literal>ndbparam-tcp-nodeidserver</literal>.
- </para>
</listitem>
<listitem>
<para>
A <literal>condition</literal> attribute may be added as a
- hint. The <filename>dbk-prep.xsl</filename> transform tries to
- determine the ID to use for the link, using the rules
+ hint. The <filename>auto-link.xsl</filename> transform tries
+ to determine the ID to use for the link, using the rules
described shortly. If it cannot determine the ID, the
<literal>condition</literal> attribute indicates which ID to
use.
@@ -947,7 +899,7 @@
</itemizedlist>
<para>
- When <filename>dbk-prep.xsl</filename> determines the ID for the
+ When <filename>auto-link.xsl</filename> determines the ID for the
<literal>linkend</literal> attribute when generating
<literal><link></literal> elements, the name-to-ID mapping
rule depends on the function type.
@@ -1151,6 +1103,79 @@
</programlisting>
</listitem>
+ <listitem>
+ <para>
+ MySQL Cluster configuration parameter: The
+ <literal>role</literal> is constructed and used somewhat
+ differently from the others just described. A configuration
+ parameter is used in one or more specific sections of the
+ MySQL Cluster <filename>config.ini</filename> file; some
+ parameters have differing characteristics depending on the
+ <filename>config.ini</filename> section in which they occur,
+ and a given parameter does not necessarily apply in all
+ sections of the file. Each <emphasis>valid</emphasis> mapping
+ between a parameter name and a <filename>config.ini</filename>
+ section type (often referred to simply as the parameter's
+ type) is described separately in
+ <xref linkend="mysql-cluster-config-file"/>, where each such
+ description provides a target having a unique identifier.
+ These IDs take the form
+ ndbparam-<replaceable>type</replaceable>-<replaceable>name</replaceable>,
+ where <replaceable>type</replaceable> is the parameter type
+ (that is, the <filename>config.ini</filename> section to which
+ it applies), and <replaceable>name</replaceable> is the
+ parameter's name converted to lowercase.
+ </para>
+
+ <para>
+ For an <literal>NDB</literal> configuration parameter, the
+ <literal>role</literal> value takes the form
+ <literal>ndbparam:<replaceable>type</replaceable></literal>,
+ where <replaceable>type</replaceable> is the parameter type
+ (which corresponds to the name of a section of
+ <filename>config.ini</filename>). Because there is no way to
+ determine the parameter type automatically, the type
+ <emphasis>must</emphasis> be specified by the author. Possible
+ types are shown in the following table:
+ </para>
+
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colwidth="33*"/>
+ <colspec colwidth="34*"/>
+ <colspec colwidth="33*"/>
+ <tbody>
+ <row>
+ <entry><literal>api</literal></entry>
+ <entry><literal>computer</literal></entry>
+ <entry><literal>mgmd</literal></entry>
+ </row>
+ <row>
+ <entry><literal>ndbd</literal></entry>
+ <entry><literal>ndbmtd</literal></entry>
+ <entry><literal>sci</literal></entry>
+ </row>
+ <row>
+ <entry><literal>shm</literal></entry>
+ <entry><literal>tcp</literal></entry>
+ <entry><literal>system</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ For example, <literal><literal
+ role="ndbparam:ndbd">HostName<literal></literal>
+ generates a link to the target having the ID
+ <literal>ndbparam-ndbd-hostname</literal>, and
+ <literal><literal
+ role="ndbparam:tcp">NodeIdServer<literal></literal>
+ generates a link to the target whose ID is
+ <literal>ndbparam-tcp-nodeidserver</literal>.
+ </para>
+ </listitem>
+
</itemizedlist>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r23519 - trunk/mysqldoc-guide | jon.stephens | 2 Nov |
