svn commit: r681016 - /maven/doxia/site/src/site/xdoc/references/xdoc-format.xml

[lt...@apache.org]

Author: ltheussl
Date: Wed Jul 30 06:39:13 2008
New Revision: 681016

URL: http://svn.apache.org/viewvc?rev=681016&view=rev
Log:
Document DOXIA-245

Modified:
    maven/doxia/site/src/site/xdoc/references/xdoc-format.xml

Modified: maven/doxia/site/src/site/xdoc/references/xdoc-format.xml
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/xdoc/references/xdoc-format.xml?rev=681016&r1=681015&r2=681016&view=diff
==============================================================================
--- maven/doxia/site/src/site/xdoc/references/xdoc-format.xml (original)
+++ maven/doxia/site/src/site/xdoc/references/xdoc-format.xml Wed Jul 30 06:39:13 2008
@@ -124,7 +124,7 @@
         <p>
           The core doxia modules do <b>not</b> construct anchors from
           section/subsection names. If you want to reference a section,
-          you have to provide an explicit anchor:
+          you should either provide an explicit anchor:
         </p>
 
         <source><![CDATA[<a name="Section1"/>
@@ -137,6 +137,19 @@
 </section>]]></source>
 
         <p>
+          or use an <code>id</code> attribute for section and subsections
+          (note that <code>id</code>'s have to be unique within one xdoc
+          source document):
+        </p>
+
+        <source><![CDATA[<section name="Section" id="Section1">
+
+  <subsection name="SubSection" id="SubSection1">
+  </subsection>
+
+</section>]]></source>
+
+        <p>
           <b>Note</b> that this differs from previous behavior, where anchors
           were constructed from section/subsection names, replacing special
           characters by underscores. This behavior presents two shortcomings: