cvs commit: jakarta-turbine-maven/xdocs/ref musings.xml

[jstrachan]

jstrachan    02/05/28 02:56:52

  Modified:    xdocs/ref musings.xml
  Log:
  added an idea about improving the creation of FAQs via a simple XML format that 
makes the FAQ easier to write, using a simple XML format
  
  Revision  Changes    Path
  1.4       +14 -0     jakarta-turbine-maven/xdocs/ref/musings.xml
  
  Index: musings.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/musings.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- musings.xml       25 May 2002 04:59:39 -0000      1.3
  +++ musings.xml       28 May 2002 09:56:52 -0000      1.4
  @@ -227,6 +227,20 @@
            automatically) document how the API changed from the previous
            release. (suggested by jstrachan)
          </li>
  +       <li>
  +         Consider introducing an XML FAQ format for Maven builds. Right now the FAQ
  +         format (e.g. Maven's xdocs/ref/faq.xml) is a little fiddly to edit.
  +         Consider some simple XML format instead like the following along with 
patching
  +         the DVSL scripts...
  +         <pre>
  +&lt;section name="General"&gt;
  +  &lt;entry ref="foo"&gt;
  +    &lt;question&gt;How do I foo?&lt;/question&gt;
  +    &lt;answer&gt;The way you do this is...?&lt;/question&gt;
  +  &lt;/entry&gt;
  +&lt;/section&gt;
  +              </pre>                 
  +       </li>
        </ol>
      </section>
    </body>
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>