cvs commit: jakarta-struts/doc kickstart.xml

[hu...@apache.org]

husted      2002/06/04 08:10:34

  Modified:    doc      kickstart.xml
  Log:
  Add section regarding contributing documentation.
  
  Revision  Changes    Path
  1.8       +22 -0     jakarta-struts/doc/kickstart.xml
  
  Index: kickstart.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-struts/doc/kickstart.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- kickstart.xml	24 May 2002 11:24:33 -0000	1.7
  +++ kickstart.xml	4 Jun 2002 15:10:34 -0000	1.8
  @@ -33,6 +33,7 @@
     
       <li><a href="#bugs">Where can I report bugs or make feature requests?</a></li>
       <li><a href="#contribute">How can I contribute to the development of Struts?</a></li>
  +    <li><a href="#documentation">How can I contribute to the documentation?</a></li>
       <li><a href="#release">When is the next release coming out?</a></li>
       <li><a href="#unsubscribe">How do I unsubscribe from the mailing list?</a></li>
       <li><a href="#digest">Is there a digest for the mailing list?</a></li>
  @@ -201,6 +202,27 @@
   then sign up for the Struts Developer list too. If you find any problems with Struts, 
   or find a missing feature, you can enter a record to our 
   <a href="#bugs">Bugzilla</a> database.</p>
  +</section>
  +
  +<section href="documentation" name="How can I contribute to the documentation?">
  +<p>The only difference is that the documentation is keptin XML rather than Java 
  +source code. Otherwise, all the same precepts and procedures pertain. </p>
  +<p>The trick is to getting started is to download the nightly build and try 
  +building the documentation WAR. Then try adding your own XML page under doc/ to see 
  +if the build succeeds. If it doesn't, it will report where the bad element is, much 
  +like it reports where a bad programming expression is. If it does, then your page 
  +should be available under target/documention/. </p>
  +<p>The website portion of the package is the root directory of doc/. The User Guide 
  +portion is under the userGuide/ folder. If the material you'd to add doesn't 
  +fit right in with what's there, the best thing may be to start a new section after 
  +the existing material. The navigation column can be found in the project.xml document.</p>
  +<p>To display markup, substitute &amp;lt; for &lt;. The unmatched trailing > will be 
  +ignored. Since it is XML, all elements also need to be closed. So elements like 
  +&lt;br> and &lt;hr> need to be set out as &lt;br/> and &lt;hr/>.</p>
  +<p>Also watch for the length of code samples. These do not wrap. If a line is too long, 
  +it will force the right margin out past the edge of the screen or printed page. </p>
  +<p>The stylesheets we use are adequate, but could certainly be improved by an XML 
  +guru, if you happen to be one of those.</p>
   </section>
   
   <section href="release" name="When is the next release coming out?">
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>