forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From diwa...@apache.org
Subject svn commit: r227321 - /forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
Date Thu, 04 Aug 2005 08:04:15 GMT
Author: diwaker
Date: Thu Aug  4 01:04:08 2005
New Revision: 227321

URL: http://svn.apache.org/viewcvs?rev=227321&view=rev
Log:
Minor fixes to the FAQ:

o replace xml by XML where appropriate
o navigation is no longer left-handed. With views, it could appear anywhere.


Modified:
    forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml?rev=227321&r1=227320&r2=227321&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml Thu Aug  4 01:04:08 2005
@@ -93,9 +93,9 @@
     <faq id="edit-content">
       <question>What tools can be used to edit the content?</question>
       <answer>
-        <p>If you are using the Apache Forrest xml <link href="site:v0.80//dtd-docs">document
format</link>
-          or DocBook or other xml document types, then you can use any text editor or even
a
-          dedicated xml editor. You must ensure valid xml. See our <link href="site:v0.80//catalog"
+        <p>If you are using the Apache Forrest XML <link href="site:v0.80//dtd-docs">document
format</link>
+          or DocBook or other XML document types, then you can use any text editor or even
a
+          dedicated XML editor. You must ensure valid XML. See our <link href="site:v0.80//catalog"
             >configuration notes</link> for various editors. </p>
         <p>There are content management systems like <link href="ext:lenya">Apache
Lenya</link>. </p>
         <p>Remember that Forrest can also use other source formats, such as OpenOffice.org
docs or
@@ -112,7 +112,7 @@
       <answer>
         <p>
           The <code>site.xml</code> configuration file is used for two different
purposes:
-          defining the left-hand navigation menus, and as a method for defining references
+          defining the navigation menus, and as a method for defining references
           to be used when linking between documents.
           This file is fully explained in
           <link href="site:v0.80//linking">Menus and Linking</link>. Here is
a precis:
@@ -154,7 +154,8 @@
       <answer>
         <p>
           There are examples in the 'forrest seed site' and also the Forrest website documents
-          are included with the distribution (cd forrest/site-author; forrest run).
+          are included with the distribution (<code>cd forrest/site-author;
+            forrest run</code>).
         </p>
       </answer>
     </faq>
@@ -190,8 +191,15 @@
           the following to the <code>extra-css</code> element in your projects
           <code>skinconf.xml</code>
         </p>
-        <source> .pageBreakBefore { margin-bottom: 0; page-break-before: always; }
.pageBreakAfter {
-          margin-bottom: 0; page-break-after: always; } </source>
+        <source> 
+          .pageBreakBefore { 
+            margin-bottom: 0; 
+            page-break-before: always; 
+          } 
+          .pageBreakAfter {
+            margin-bottom: 0; 
+            page-break-after: always; 
+            } </source>
       </answer>
     </faq>
     <faq id="clickable-email-address">
@@ -229,7 +237,7 @@
               <code>$FORREST/lib/optional/jimi-1.0.jar</code>.</li>
         </ol>
         <p>Alternatively you can use JAI (Java Advanced Imaging API at
-          http://java.sun.com/products/java-media/jai). For more info, see <link
+          <code>http://java.sun.com/products/java-media/jai</code>). For more
info, see <link
             href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</link>
         </p>
         <note>Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</note>
@@ -326,8 +334,8 @@
           <li>diereses: ä ë ï ö ü</li>
           <li>tildes: ã ñ ĩ õ ũ</li>
         </ul>
-        <p>This is because sources for Forrest docs are xml documents, which can include
any of
-          these, provided the encoding declared by the xml doc matches the actual encoding
used in
+        <p>This is because sources for Forrest docs are XML documents, which can include
any of
+          these, provided the encoding declared by the XML doc matches the actual encoding
used in
           the file. For example if you declare the default encoding:</p>
         <source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]></source>
         <p>but the file content is actually using ISO-8859-1 then you will receive
validation
@@ -345,7 +353,7 @@
         <source>[localhost]$ export LANG=en_US.UTF-8</source>
         <p>Of course the <em>appropriate</em> way to set the encoding depends
on the editor/OS, but
           ultimately relys on the user preferences. So you can use the encoding you prefer,
as long
-          as the <code>encoding</code> attribute of the xml declaration matches
the actual encoding
+          as the <code>encoding</code> attribute of the XML declaration matches
the actual encoding
           of the file. This means that if you are not willing to abandon ISO-8859-1 you can
always
           use the following declaration instead:</p>
         <source><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>]]></source>
@@ -647,7 +655,7 @@
       </answer>
     </faq>
     <faq id="docbook">
-      <question> How do I use DocBook as the xml documentation format? </question>
+      <question> How do I use DocBook as the XML documentation format? </question>
       <answer>
         <p> There are two ways. Forrest has a <code>simplifiedDocbook</code>
plugin which can
           transform the DocBook format into the Forrest "xdocs" format on-the-fly and then
render
@@ -684,7 +692,7 @@
         <p> You can also use a mixture of the two methods, some handled automatically
by Forrest and
           some directly using DocBook stylesheets. You can also have a mixture of source
files as
           "document-v*" DTD and DocBook. </p>
-        <p> Ensure that the document type declaration in your xml instance is well
specified. Use a
+        <p> Ensure that the document type declaration in your XML instance is well
specified. Use a
           public identifier. The DTD will then be properly resolved by Forrest. If you need
to use
           different DTDs, then see <link href="site:v0.80//your-project/new_dtd">Using
Forrest</link> for
           configuration guidance. </p>



Mime
View raw message