svn commit - mysqldoc@docsrva: r12608 - in trunk: . mysqldoc-guide

[paul.dubois]

Author: paul
Date: 2008-11-22 06:15:28 +0100 (Sat, 22 Nov 2008)
New Revision: 12608

Log:
 r36026@frost:  paul | 2008-11-21 22:56:42 -0500
 Describe markup for SQL mode and transaction isolation level auto-linking


Modified:
   trunk/mysqldoc-guide/special-markup.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:39854
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:36016
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:34596
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:39854
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:36026
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:34596


Modified: trunk/mysqldoc-guide/special-markup.xml
===================================================================
--- trunk/mysqldoc-guide/special-markup.xml	2008-11-22 00:15:09 UTC (rev 12607)
+++ trunk/mysqldoc-guide/special-markup.xml	2008-11-22 05:15:28 UTC (rev 12608)
Changed blocks: 7, Lines Added: 56, Lines Deleted: 10; 4299 bytes

@@ -853,8 +853,12 @@
           the object type. The value should be <literal>"func"</literal>
           for an SQL function, <literal>"op"</literal> for an SQL
           operator, <literal>"type"</literal> for an SQL data type,
-          <literal>"stmt"</literal> for an SQL statement, or
-          <literal>"cfunc"</literal> for a C API function.
+          <literal>"stmt"</literal> for an SQL statement,
+          <literal>"sysvar"</literal> for a system variable,
+          <literal>"statvar"</literal> for a status variable,
+          <literal>"sqlmode"</literal> for a SQL mode,
+          <literal>"isolevel"</literal> for a transaction isolation
+          level, or <literal>"cfunc"</literal> for a C API function.
         </para>
       </listitem>
 

@@ -884,10 +888,10 @@
         <para>
           SQL function: Use element content up to the leading open
           parenthesis, with underscores converted to dashes and letters
-          converted to lowercase, then add a
-          <literal>function_</literal> prefix. Some functions can be
-          written without parentheses, so if no opening parenthesis is
-          found, use the entire element content.
+          converted to lowercase. Add a <literal>function_</literal>
+          prefix. Some functions can be written without parentheses, so
+          if no opening parenthesis is found, use the entire element
+          content.
         </para>
 
         <para>

@@ -905,7 +909,7 @@
         <para>
           SQL operator: Use the entire element content, with underscores
           and spaces converted to dashes and letters converted to
-          lowercase, then add an <literal>operator_</literal> prefix.
+          lowercase. Add an <literal>operator_</literal> prefix.
         </para>
 
         <para>

@@ -933,6 +937,12 @@
 <programlisting>
 &lt;literal role="type"&gt;DATETIME&lt;/literal&gt;
 </programlisting>
+
+        <para>
+          Data type sections do not always correspond to the type name,
+          so the link generator actually uses a lookup table to map
+          types to section IDs.
+        </para>
       </listitem>
 
       <listitem>

@@ -958,7 +968,7 @@
           element content (stripping off any
           <literal>INFORMATION_SCHEMA.</literal> qualifier), with
           underscores converted to dashes and letters converted to
-          lowercase.
+          lowercase. Add a <literal>-table</literal> suffix.
         </para>
 
         <para>

@@ -974,8 +984,10 @@
 
       <listitem>
         <para>
-System variable or status variable:
-Use the first word of the content, without lettercase conversion.
+          System variable or status variable: Use the first word of the
+          content, without lettercase conversion. Add a
+          <literal>sysvar_</literal> or <literal>statvar_</literal>
+          prefix.
         </para>
 
 <programlisting>

@@ -986,6 +998,40 @@
 
       <listitem>
         <para>
+          SQL mode: Use the entire element content, with underscores
+          converted to dashes and letters converted to lowercase.
+        </para>
+
+        <para>
+          This reference will link to an ID of
+          <literal>sqlmode_ansi_quotes</literal>:
+        </para>
+
+<programlisting>
+&lt;literal role="sqlmode"&gt;ANSI_QUOTES&lt;/literal&gt;
+</programlisting>
+      </listitem>
+
+      <listitem>
+        <para>
+          Transaction isolation level: Use the entire element content,
+          with spaces converted to dashes and letters converted to
+          lowercase. Add an <literal>isolevel_</literal> prefix.
+        </para>
+
+        <para>
+          Either of these references will link to an ID of
+          <literal>isolevel_read-committed</literal>:
+        </para>
+
+<programlisting>
+&lt;literal role="isolevel"&gt;READ COMMITTED&lt;/literal&gt;
+&lt;literal role="isolevel"&gt;READ-COMMITTED&lt;/literal&gt;
+</programlisting>
+      </listitem>
+
+      <listitem>
+        <para>
           C API function: Use element content up to the leading open
           parenthesis, with underscores converted to dashes.
         </para>