Author: crossley
Date: Fri Jan 21 05:48:06 2011
New Revision: 1061641
URL: http://svn.apache.org/viewvc?rev=1061641&view=rev
Log:
Explain the "Improved generated IDs for sections".
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
forrest/trunk/site-author/status.xml
Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml?rev=1061641&r1=1061640&r2=1061641&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml
(original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/upgrading_09.xml Fri Jan
21 05:48:06 2011
@@ -192,6 +192,26 @@
to the required plugin name.
</p>
</section>
+ <section id="generated-id">
+ <title>Improved generated IDs for sections</title>
+ <p>
+ The conversion of xdoc sections to html will generate named anchors
+ for use with URI fragment identifiers.
+ </p>
+ <p>
+ Forrest utilises the @id attribute if it exists (ideal).
+ Otherwise it generates one utilising the "section/title" element.
+ </p>
+ <p>
+ With prior versions of Forrest, an extra automatic ID was always
generated.
+ This now only happens if those other pieces are missing.
+ </p>
+ <p>
+ So when you first update your project's deployed html documentation,
there will
+ be many changes removing those old superfluous named anchors
+ (e.g. <code><a name="N1000E"</code>).
+ </p>
+ </section>
<section id="docs">
<title>Notes about documentation</title>
<p>
Modified: forrest/trunk/site-author/status.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?rev=1061641&r1=1061640&r2=1061641&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Fri Jan 21 05:48:06 2011
@@ -154,6 +154,10 @@
<link href="site:upgrading_09">upgrading to v0.9</link>
</action>
<!-- 2011-01 -->
+ <action context="code" type="fix" dev="BMD" importance="high">
+ Suppress extra generated id when converting xdoc sections to html.
+ See <link href="site:upgrading_09">upgrading notes</link>.
+ </action>
<action context="docs" type="update" dev="DC">
Added an <link href="site:faq/svn-eol-style">FAQ</link>
to explain "svn:eol-style" and un-necessary svn diffs.
