forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r161378 - in forrest/trunk/site-author: content/xdocs/docs/howto/howto-howto.xml status.xml
Date Fri, 15 Apr 2005 04:45:00 GMT
Author: crossley
Date: Thu Apr 14 21:44:58 2005
New Revision: 161378

URL: http://svn.apache.org/viewcvs?view=rev&rev=161378
Log:
Handle FAQs sections and faqs with both howto-v1.* and howto-v2.* docs.
Apply proper section numbering.
Submitted by: Mark Eggers
Issue: FOR-427 Howto V 2.0 FAQ section currently not transformed properly

Modified:
    forrest/trunk/site-author/content/xdocs/docs/howto/howto-howto.xml
    forrest/trunk/site-author/status.xml

Modified: forrest/trunk/site-author/content/xdocs/docs/howto/howto-howto.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/howto/howto-howto.xml?view=diff&r1=161377&r2=161378
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/howto/howto-howto.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/howto/howto-howto.xml Thu Apr 14 21:44:58
2005
@@ -15,8 +15,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.3//EN"
-"http://forrest.apache.org/dtd/howto-v13.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN"
+"http://forrest.apache.org/dtd/howto-v20.dtd">
 <howto>
   <header>
     <title>How to write a How-To</title>
@@ -64,7 +64,7 @@
       contributing your document.</li>
     </ul>
 
-    <note>See the <link href="site:howto-v13-dtd">DTD documentation</link>
+    <note>See the <a href="site:howto-v13-dtd">DTD documentation</a>
     which explains the document structure.</note>
   </prerequisites>
 
@@ -157,7 +157,7 @@
       <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>
+      project <a href="site:bugs">issue tracker</a>.</p>
     </section>
 
     <section id="feedback">
@@ -165,7 +165,7 @@
 
       <p>When the committers have added your document then it will be
       available for everyone to to build upon and enhance. Feedback will
-      happen via the <link href="site:mail-lists">mailing lists</link>.</p>
+      happen via the <a href="site:mail-lists">mailing lists</a>.</p>
     </section>
   </steps>
 
@@ -175,30 +175,37 @@
     complex, are available right now, limited only by your imagination.</p>
   </extension>
 
-  <faqs title="Frequently Asked Questions">
-    <faq id="faq-difference">
-      <question>What is the difference between a How-To and a
-      tutorial?</question>
-
-      <answer>
-        <p>The goal of a How-To is to help the reader to accomplish a specific
-        task with clear and consise instructions. While tutorials may contain
-        How-To-like instructions and content, they also include additional
-        background and conceptual content to help teach their readers higher
-        order concepts along the way. How-Tos are concerned about filling an
-        immediate, short-term need. Tutorials often provide long-term
-        knowledge which can be applied across a range of needs.</p>
-      </answer>
-    </faq>
-
-    <faq id="spelling">
-      <question>What spelling convention should I follow?</question>
-
-      <answer>
-        <p>Use whatever spelling convention (American, British, etc.) that is
-        most intuitive to you.</p>
-      </answer>
-    </faq>
+  <faqs id="faqs">
+    <title>Frequently Asked Questions</title>
+    <faqsection id="faq-general">
+      <title>General issues</title>
+      <faq id="faq-difference">
+        <question>What is the difference between a How-To and a
+        tutorial?</question>
+
+        <answer>
+          <p>The goal of a How-To is to help the reader to accomplish a specific
+          task with clear and consise instructions. While tutorials may contain
+          How-To-like instructions and content, they also include additional
+          background and conceptual content to help teach their readers higher
+          order concepts along the way. How-Tos are concerned about filling an
+          immediate, short-term need. Tutorials often provide long-term
+          knowledge which can be applied across a range of needs.</p>
+        </answer>
+      </faq>
+    </faqsection>
+
+    <faqsection id="faq-style">
+      <title>Style issues</title>
+      <faq id="spelling">
+        <question>What spelling convention should I follow?</question>
+
+        <answer>
+          <p>Use whatever spelling convention (American, British, etc.) that is
+          most intuitive to you.</p>
+        </answer>
+      </faq>
+    </faqsection>
   </faqs>
 
   <tips title="Tips">
@@ -216,12 +223,12 @@
     following sources.</p>
 
     <ul>
-      <li>Joel D. Canfield's <link
+      <li>Joel D. Canfield's <a
       href="http://www.evolt.org/article/How_To_Write_A_How_To/9741/18250/index.html">How
-      to Write a How-To</link> on evolt.org.</li>
+      to Write a How-To</a> on evolt.org.</li>
 
-      <li>The Linux Documentation Project's <link
-      href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</link>
+      <li>The Linux Documentation Project's <a
+      href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</a>
       index page provides many excellent How-To documents to inspire your
       efforts.</li>
     </ul>

Modified: forrest/trunk/site-author/status.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/status.xml?view=diff&r1=161377&r2=161378
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Thu Apr 14 21:44:58 2005
@@ -51,6 +51,10 @@
         Added document to facilitate
         <link href="site:upgrading_07">upgrading to v0.7</link>
       </action>
+      <action dev="DC" type="add" context="xsl" fixes-bug="FOR-427" due-to"Mark Eggers">
+       Handle FAQs sections and faqs with both howto-v1.* and howto-v2.* docs.
+       Apply proper section numbering.
+      </action>
       <action dev="DC" type="update" context="docs">
         Removed old versions of pre-release plugins following renaming to the
         convention defined in



Mime
View raw message