forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject cvs commit: xml-forrest/src/documentation/content/xdocs/community/howto/xmlform howto-xmlform.xml revision-howto-xmlform-2002-05-20.xml revision-howto-xmlform-2002-05-25.xml revision-step1-2002-05-20.xml step1.xml step2.xml step3.xml step4.xml step5.xml
Date Wed, 17 Sep 2003 04:59:49 GMT
crossley    2003/09/16 21:59:49

  Modified:    src/documentation/content/xdocs site.xml linking.xml
                        sitemap-ref.xml
               src/documentation/content/xdocs/community/howto index.xml
  Added:       src/documentation/content/xdocs/community/howto/multi
                        howto-multi.xml revision-howto-multi-2003-09-14.xml
                        revision-howto-multi-2003-09-15.xml
                        revision-step1-2003-09-16.xml step1.xml step2.xml
                        step3.xml
  Removed:     src/documentation/content/xdocs/community/howto/xmlform
                        howto-xmlform.xml
                        revision-howto-xmlform-2002-05-20.xml
                        revision-howto-xmlform-2002-05-25.xml
                        revision-step1-2002-05-20.xml step1.xml step2.xml
                        step3.xml step4.xml step5.xml
  Log:
  Replace the obsolete xmlform how-to with a sample multi-page how-to.
  It would be nice if this became a real how-to.
  
  Revision  Changes    Path
  1.27      +3 -5      xml-forrest/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  --- site.xml	15 Sep 2003 03:22:48 -0000	1.26
  +++ site.xml	17 Sep 2003 04:59:49 -0000	1.27
  @@ -63,14 +63,12 @@
       <howto-samples label="How-To Samples" href="howto/" tab="howto">
         <overview label="Overview" href="index.html"/>
         <single-page label="Single Page" href="v10/howto-v10.html"/>
  -      <xmlform label="Multi-Page" href="xmlform/">
  -        <intro label="Intro" href="howto-xmlform.html"/>
  +      <multi-page label="Multi-Page" href="multi/">
  +        <intro label="Intro" href="howto-multi.html"/>
           <step1 label="Step 1" href="step1.html"/>
           <step2 label="Step 2" href="step2.html"/>
           <step3 label="Step 3" href="step3.html"/>
  -        <step4 label="Step 4" href="step4.html"/>
  -        <step5 label="Step 5" href="step5.html"/>
  -      </xmlform>
  +      </multi-page>
         <with-images label="With Images" href="bugzilla-patch/howto-bugzilla-patch.html"/>
       </howto-samples>
       <howto-committers label="Committers" href="howto/" tab="howto">
  
  
  
  1.9       +4 -4      xml-forrest/src/documentation/content/xdocs/linking.xml
  
  Index: linking.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/linking.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- linking.xml	13 Jul 2003 13:10:03 -0000	1.8
  +++ linking.xml	17 Sep 2003 04:59:49 -0000	1.9
  @@ -85,11 +85,11 @@
               <howto-samples label="How-To Samples" href="howto/" tab="howto">
                 <overview label="Overview" href="index.html"/>
                 <single-page label="Single Page" href="v10/howto-v10.html"/>
  -              <xmlform label="Multi-Page" href="xmlform/">
  -                <intro label="Intro" href="howto-xmlform.html"/>
  +              <multi-page label="Multi-Page" href="multi/">
  +                <intro label="Intro" href="howto-multi.html"/>
                   <step1 label="Step 1" href="step1.html"/>
                   <step2 label="Step 2" href="step2.html"/>
  -              </xmlform>
  +              </multi-page>
               </howto-samples>
             </community>
   
  
  
  
  1.4       +3 -3      xml-forrest/src/documentation/content/xdocs/sitemap-ref.xml
  
  Index: sitemap-ref.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/sitemap-ref.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- sitemap-ref.xml	13 Aug 2003 09:53:12 -0000	1.3
  +++ sitemap-ref.xml	17 Sep 2003 04:59:49 -0000	1.4
  @@ -193,7 +193,7 @@
               href="site:cap">SourceTypeAction</link> to work out the type of XML
             it is processing, and converts it to doc-v12 if necessary.
           </p>
  -        <p>For instance, say we are rendering <link href="site:xmlform/step1">a
  +        <p>For instance, say we are rendering <link href="site:multi-page/step1">a
               Howto document</link> called 'step1.xml'.  It contains this DOCTYPE
             declaration:</p>
           <source>&lt;!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd"></source>
  @@ -206,7 +206,7 @@
             ]]></source>
           <p>
             The result is visible at the URL <link
  -            href="community/howto/xmlform/step1.xml">community/howto/xmlform/step1.xml</link>.
  +            href="community/howto/multi/step1.xml">community/howto/multi/step1.xml</link>.
           </p>
         </section>
         <section>
  
  
  
  1.8       +2 -2      xml-forrest/src/documentation/content/xdocs/community/howto/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/community/howto/index.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- index.xml	13 Aug 2003 10:34:56 -0000	1.7
  +++ index.xml	17 Sep 2003 04:59:49 -0000	1.8
  @@ -27,7 +27,7 @@
          Go to the bottom of the Multi-page sample to see the revisions which
          are automatically appended by the sitemap during 'build docs'.
          Any snippet document with the filename
  -       <code>revision-howto-xmlform-YYYY-MM-DD.xml</code> is appended to the
  +       <code>revision-howto-multi-YYYY-MM-DD.xml</code> is appended to the
          main page.
         </p>
     </section>
  @@ -40,7 +40,7 @@
   </p>
         <ul>
           <li><link href="site:howto-samples/single-page">Single Page How-To</link></li>
  -        <li><link href="site:howto-samples/xmlform/intro">Multi-Page How-To
with Revisions</link></li>
  +        <li><link href="site:howto-samples/multi-page/intro">Multi-Page How-To
with Revisions</link></li>
           <li><link href="site:howto-samples/with-images">How-To with Images</link></li>
         </ul>
     </section>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/howto-multi.xml
  
  Index: howto-multi.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.2//EN" "http://apache.org/forrest/dtd/howto-v12.dtd">
  
  <howto>
    <header>
      <title>Example of a multi-page how-to</title>
      <abstract>This is the shell of a multi-page how-to. Add your own content.
      </abstract>
      <last-modified-content-date date="2003-09-10"/>
    </header>
  
    <audience title="Intended audience">
       <p>Describe the audience here.</p>
    </audience>
  
    <purpose title="Purpose">
      <p>Explain the purpose of the howto here.</p>
    </purpose>
  
    <prerequisites title="Prerequisites">
      <p>Configuration requirements:</p>
      <ul> 
        <li>This.</li>
        <li>That.</li>
      </ul>
      <p>Requisite skills:</p>
      <ul> 
        <li>These.</li>
        <li>Those.</li>
      </ul>
  
    </prerequisites>
  
    <steps title="Various Steps">
      <p>After this brief introductory paragraph, the steps are described in
       separate documents:</p>
      <ul>
        <li><link href="step1.html">Step 1: Do foo</link></li>
        <li><link href="step2.html">Step 2: Do foobar</link></li>
        <li><link href="step3.html">Step 3: Finish up</link></li>
      </ul>
    </steps>
  
    <extension title="Real World Extension">
     <p>Briefly describe some relevant extensions that go beyond these basics.</p>
    </extension> 
  
    <tips title="Tips">
     <p>If you have a problem running the example, then you can try the
      following tips:</p>
     <ul>
       <li>Tip #1</li>
       <li>Tip #2</li>
     </ul>
    </tips> 
  
    <references title="Related Resources">
      <p>Cocoon resources:</p>
      <ul>
        <li>For all Cocoon basics see the
          <link href="ext:cocoon">Cocoon Web site</link>.
        </li>
      </ul>
    </references>
      
    <feedback title="Feedback">
      <p>If you find any faults in this How-to or can see any improvements,
        please contact the
        <link href="site:mail-lists">project mail lists</link> with them.
      </p>
    </feedback>
  </howto>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/revision-howto-multi-2003-09-14.xml
  
  Index: revision-howto-multi-2003-09-14.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
  
  <document>
    <header>
      <title>Sample Revision notes</title>
      <authors>
        <person name="Motivated User" email="motivated@user.org"/>
      </authors>
    </header>
  
    <body>
      <section>
        <title>Some text here</title>
        <p>There is a problem with this approach</p>
        <ul>
          <li>Problem A.</li>
          <li>Problem B.</li>
        </ul>
      </section>
    </body>
  
  </document>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/revision-howto-multi-2003-09-15.xml
  
  Index: revision-howto-multi-2003-09-15.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
  
  <document>
    <header>
      <title>Another Sample Revision</title>
      <authors>
        <person name="Motivated User" email="motivated@user.org"/>
      </authors>
    </header>
  
    <body>
  <p>
  I see that the revision2document.xsl adds a footer to suggest that the
  author should be contacted to make revisions. This is not the opensource way.
  This would create a bottleneck at the author. Community feedback should be
  encouraged to go to the relevant listserver, and patches submitted via Bugzilla.
  </p>
    </body>
  </document>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/revision-step1-2003-09-16.xml
  
  Index: revision-step1-2003-09-16.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
  
  <document>
    <header>
      <title>Sample Revision notes for Step 1</title>
      <authors>
        <person name="Motivated User" email="motivated@user.org"/>
      </authors>
    </header>
  
    <body>
      <section>
        <title>Other comments</title>
        <p>There is a problem with this approach</p>
        <ul>
          <li>Problem d.</li>
          <li>Problem e.</li>
        </ul>
      </section>
    </body>
  
  </document>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/step1.xml
  
  Index: step1.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.2//EN" "http://apache.org/forrest/dtd/howto-v12.dtd">
  
  <howto>
    <header>
      <title>Multi-page how-to: Step 1</title>
      <last-modified-content-date date="2003-09-10"/>
    </header>
  
    <steps title="Step 1: Do foo"> 
      <section>
        <title>First section of this step</title>
        <p>Description here.</p>
      </section>
      <section>
        <title>Second section of this step</title>
        <p>Description here.</p>
        <p>Source code follows ...</p>
        <source><![CDATA[
  <pointy-brackets>
    <are-allowed-in-source-CDATA-sections/>
  </pointy-brackets>
  ]]>
        </source>
        <p>Now we move on to <link href="step2.html">Step 2: Do foobar</link></p>
      </section>
    </steps>
  </howto>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/step2.xml
  
  Index: step2.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "http://apache.org/forrest/dtd/howto-v10.dtd">
  
  <howto>
    <header>
      <title>Multi-page how-to: Step 2</title>
      <last-modified-content-date date="2003-09-10"/>
    </header>
  
    <steps title="Step 2: Do foobar"> 
      <section>
        <title>First section of this step</title>
        <p>Description here.</p>
      </section>
      <section>
        <title>Second section of this step</title>
        <p>Description here.</p>
        <p>Now we move on to <link href="step3.html">Step 3: Finish up</link></p>
      </section>
    </steps>
  </howto>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/multi/step3.xml
  
  Index: step3.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.2//EN" "http://apache.org/forrest/dtd/howto-v12.dtd">
  
  <howto>
    <header>
      <title>Multi-page how-to: Step 3</title>
      <last-modified-content-date date="2002-09-10"/>
    </header>
  
    <steps title="Step 3: Finish up"> 
      <section>
        <title>First section of this step</title>
        <p>Description here.</p>
      </section>
      <section>
        <title>Second section of this step</title>
        <p>Description here.</p>
        <p>Congratulations, you have finished. Now return to the
        <link href="site:multi-page/intro">start</link>.</p>
      </section>
    </steps>
  </howto>
  
  
  

Mime
View raw message