You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/07/19 06:36:26 UTC
svn commit: rev 23053 - forrest/trunk/src/documentation/content/xdocs/howto
Author: crossley
Date: Sun Jul 18 21:36:25 2004
New Revision: 23053
Modified:
forrest/trunk/src/documentation/content/xdocs/howto/howto-howto.xml
forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml
Log:
Add id attributes to all section elements
to avoid the ugly automatically generated local hrefs.
Modified: forrest/trunk/src/documentation/content/xdocs/howto/howto-howto.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/howto/howto-howto.xml (original)
+++ forrest/trunk/src/documentation/content/xdocs/howto/howto-howto.xml Sun Jul 18 21:36:25 2004
@@ -67,7 +67,7 @@
<steps title="Steps">
<p>Here is how to proceed.</p>
- <section>
+ <section id="overview">
<title>Write the Overview</title>
<p>An overview helps potential readers to determine quickly if a
@@ -78,7 +78,7 @@
completed all other sections.</p>
</section>
- <section>
+ <section id="audience">
<title>Describe your Intended Audience</title>
<p>If your How-To is targetted at a specific audience, describe it here.
@@ -89,15 +89,15 @@
confusion.</p>
</section>
- <section>
+ <section id="purpose">
<title>State the Purpose</title>
<p>State the purpose of your How-To. Explain how the reader will benefit
by reading it. Give your reader an incentive or two to continue.</p>
</section>
- <section>
- <title>List any Prerequsites</title>
+ <section id="prerequisites">
+ <title>List any Prerequisites</title>
<p>Inform your reader about any required knowledge, configuration, or
resources they may need before stepping through your How-To. Assist them
@@ -106,7 +106,7 @@
likelihood that they will continue reading your How-To.</p>
</section>
- <section>
+ <section id="steps">
<title>Describe the Steps of your How-To</title>
<p>In a precise, step-by-step approach, walk your reader through the
@@ -116,7 +116,7 @@
necessary.</p>
</section>
- <section>
+ <section id="extension">
<title>Extend the Learning</title>
<p>Provide your reader with a few real-world examples of how the
@@ -125,14 +125,14 @@
ideas about how it will pay off.</p>
</section>
- <section>
+ <section id="summarize">
<title>Summarize the Entire Process</title>
<p>In a few sentences, remind the reader what they have just learned.
This helps to reinforce the main points of your How-To.</p>
</section>
- <section>
+ <section id="tips">
<title>Additional Tips or FAQs</title>
<p>In some cases, step-by-step instructions simply aren't enough. Use
@@ -141,7 +141,7 @@
of your writing effort.</p>
</section>
- <section>
+ <section id="references">
<title>References</title>
<p>Remember to acknowledge any third-party resources or individuals who
@@ -149,14 +149,14 @@
for those motivated readers who want to learn more.</p>
</section>
- <section>
+ <section id="contribute">
<title>Submit via the project issue tracker</title>
<p>Create an attachment for your How-To document, and submit it via the
project <link href="site:bugs">issue tracker</link>.</p>
</section>
- <section>
+ <section id="feedback">
<title>Get some feedback</title>
<p>When the committers have added your document then it will be
@@ -172,7 +172,7 @@
</extension>
<faqs title="Frequently Asked Questions">
- <faq>
+ <faq id="faq-difference">
<question>What is the difference between a How-To and a
tutorial?</question>
@@ -187,7 +187,7 @@
</answer>
</faq>
- <faq>
+ <faq id="spelling">
<question>What spelling convention should I follow?</question>
<answer>
@@ -198,7 +198,7 @@
</faqs>
<tips title="Tips">
- <section>
+ <section id="tip-dtd">
<title>How-To dtd</title>
<p>The document structure is likely to change soon. Please note that
Modified: forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml (original)
+++ forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml Sun Jul 18 21:36:25 2004
@@ -54,7 +54,7 @@
<code>sitemap.xmap</code> and create a new
<code>pdf-tab.xmap</code> based on the <code>aggregate.xmap</code>
</p>
- <section>
+ <section id="sitemap">
<title>Create your project's main sitemap.xmap</title>
<p>
Simply copy the sitemap.xmap from the Forrest sitemaps at
@@ -64,7 +64,7 @@
</p>
</section>
- <section>
+ <section id="aggregator">
<title>Create the aggregator sitemap pdf-tab.xmap</title>
<p>
Copy the aggregate.xmap from Forrest sitemaps into your
@@ -72,7 +72,7 @@
</p>
</section>
- <section>
+ <section id="workaround-202">
<title>Edit project sitemap.xmap</title>
<note>
This is a workaround for Issue FOR-202
@@ -94,7 +94,7 @@
</source>
</section>
- <section>
+ <section id="mount">
<title>Edit project sitemap.xmap to mount pdf-tab.xmap</title>
<p>
Insert the following lines after the
@@ -110,7 +110,7 @@
</source>
</section>
- <section>
+ <section id="edit-aggregator">
<title>Edit the file <code>pdf-tab.xmap</code></title>
<p>
The <code><![CDATA[<map:match pattern="*.xml">]]></code> element
@@ -134,7 +134,7 @@
</map:match>]]>
</source>
</section>
- <section>
+ <section id="edit-site">
<title>Edit your site.xml</title>
<p>Add the following entry to your site.xml in the
<code><![CDATA[<about>]]></code> element
@@ -172,7 +172,7 @@
as the child (will cause a <code>stack overflow</code> if you do)!!!
</note>
</section>
- <section>
+ <section id="explain">
<title>Explanation of the operation</title>
<p>
Line 4 of our example