forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From morr...@apache.org
Subject cvs commit: xml-forrest/src/documentation/content/xdocs contrib.xml document-v11.xml dreams.xml faq.xml howto-v10.xml index.xml
Date Tue, 21 May 2002 21:16:16 GMT
morrijr     02/05/21 14:16:16

  Modified:    src/documentation/content/xdocs contrib.xml document-v11.xml
                        dreams.xml faq.xml howto-v10.xml index.xml
  Log:
  Spelling corrections
  
  Revision  Changes    Path
  1.5       +8 -8      xml-forrest/src/documentation/content/xdocs/contrib.xml
  
  Index: contrib.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/contrib.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- contrib.xml	20 May 2002 18:23:27 -0000	1.4
  +++ contrib.xml	21 May 2002 21:16:16 -0000	1.5
  @@ -19,7 +19,7 @@
         <p> To begin with, we suggest you to subscribe to the
           <link href="mail-lists.html">Forrest mailing lists</link> (follow the
link for
         information on how to subscribe and to access the mail list archives).
  -      Listen-in for a while, to hear how others make contibutions. </p> 
  +      Listen-in for a while, to hear how others make contributions. </p> 
         <p>You can get your local working copy of the
           <link href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/Forrest">latest
and
         greatest code</link> (which you find in the Forrest module in the CVS code
  @@ -51,7 +51,7 @@
           <link href="mail-lists.html">mail archives</link>. You should have
a strong
         "fluency" in XML technologies, Java and a basic understanding of the Forrest
         architecture - don't just say "it should have XYZ" without reading anything
  -      first - because chances are, someone's already thought of that feature!)</li>

  +      first - because chances are, somebodies already thought of that feature!)</li>

         <li>Packaging easy-to-install packages (such as RPMs) for the myriad of
           possible configurations out there. (The project does not maintain anything but
           the basic <code>.zip</code> and <code>.tar.gz</code> packages,
but anyone is
  @@ -119,8 +119,8 @@
           the list to deal with it.) Do not be impatient - remember that the whole world
           is busy, not just you. Bear in mind that other countries will have holidays at
           different times to your country and that they are in different time zones. You
  -        might also consider re-writing your initial posting - perhaps it was not clear
  -        enough and the readers' eyes glazed over. </p> 
  +        might also consider rewriting your initial posting - perhaps it was not clear
  +        enough and the readers eyes glazed over. </p> 
       </section> <anchor id="tips"/> 
       <section title="Contribution Notes and Tips"> 
         <p> This is a collection of tips for contributing to the project in a
  @@ -132,14 +132,14 @@
             and humans trying to browse a voluminous list, will respond favourably to a
             descriptive title. </li> 
           <li>Start new threads with new Subject for new topics, rather than
  -          re-using the previous Subject line. </li> 
  -        <li>Keep each topic focussed. If some new topic arises then start a new
  -          discussion. This leaves the original topic to continue un-cluttered. </li>

  +          reusing the previous Subject line. </li> 
  +        <li>Keep each topic focused. If some new topic arises then start a new
  +          discussion. This leaves the original topic to continue uncluttered. </li>

           <li>Whenever you decide to start a new topic, then start with a fresh
             new email message window. Do not use the &quot;Reply to&quot; button,
because
             threaded mail-readers get confused (they utilise the <code>In-reply-to</code>
             header). If so, then your new topic will get lost in the previous thread and
go
  -          un-answered. </li> 
  +          unanswered. </li> 
           <li> Prepend your email subject line with a marker when that is
             appropriate, e.g. <code>[Patch]</code>, <code>[Proposal]</code>,
             <code>[RT]</code> (Random Thought which quickly blossom into research
topics
  
  
  
  1.6       +2 -2      xml-forrest/src/documentation/content/xdocs/document-v11.xml
  
  Index: document-v11.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/document-v11.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- document-v11.xml	13 May 2002 16:39:37 -0000	1.5
  +++ document-v11.xml	21 May 2002 21:16:16 -0000	1.6
  @@ -87,7 +87,7 @@
       elements.</p> 
     <fixme author="SN">The <code>&lt;fixme&gt;</code> element is
used for stuff
       which still needs work. Mind the <code>author</code> attribute!</fixme>

  -  <note>Use the <code>&lt;note&gt;</code> element to draw attention
to somethin, e.g. ...The <code>&lt;code&gt;</code> element is used when
the author can't
  +  <note>Use the <code>&lt;note&gt;</code> element to draw attention
to something, e.g. ...The <code>&lt;code&gt;</code> element is used when
the author can't
       express himself clearly using normal sentences ;-)</note>
     <warning>Sleep deprivation can be the result of being involved in an open
       source project. (a.k.a. the <code>&lt;warning&gt;</code> element).</warning>

  @@ -112,7 +112,7 @@
     </section> 
   
     <anchor id="source"/>
  -  <section title="Showing pre-formatted source code"> 
  +  <section title="Showing preformatted source code"> 
     <p>Enough about these sections. Let's have a look at more interesting
       elements, <code>&lt;source&gt;</code> for instance:</p> 
     <source>// This example is from the book _Java in a Nutshell_ by David Flanagan.
  
  
  
  1.3       +3 -3      xml-forrest/src/documentation/content/xdocs/dreams.xml
  
  Index: dreams.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/dreams.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- dreams.xml	20 May 2002 18:23:27 -0000	1.2
  +++ dreams.xml	21 May 2002 21:16:16 -0000	1.3
  @@ -17,7 +17,7 @@
   
     <p>This is the initial attempt to give focus to the Forrest project. 
      This summary is a loose collection of items from the forrest-dev
  -   mailing list. Please add and re-arrange so that it can evolve into a
  +   mailing list. Please add and rearrange so that it can evolve into a
      focus document.
     </p>
   
  @@ -149,7 +149,7 @@
    </li>
   
    <li>
  -Downloads, number of commiters, numbers of people subscribed on the users/dev
  +Downloads, number of committers, numbers of people subscribed on the users/dev
   list, numbers of mail messages / week on these lists, CVS activity...
   These are the kind of parameters I use to "judge" an Apache project that I
   have not been looking into before.
  @@ -177,7 +177,7 @@
   
    <li>
    news, announcements, events and project calendaring: the news and
  -the annoucements will generate a RSS feed, events will be aggregated
  +the announcements will generate a RSS feed, events will be aggregated
   into a project-wide calendar, or an effort-specific calendar, the events
   will also be overwritten on the logs, to indicate how logs were
   influenced by the events (say, a release or a new committer added)
  
  
  
  1.4       +2 -2      xml-forrest/src/documentation/content/xdocs/faq.xml
  
  Index: faq.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/faq.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- faq.xml	13 May 2002 16:36:59 -0000	1.3
  +++ faq.xml	21 May 2002 21:16:16 -0000	1.4
  @@ -17,7 +17,7 @@
   
   <faq>
    <question>
  -  Why is there no &quot;Forrest To Do List&quot; so that i can help?
  +  Why is there no &quot;Forrest To Do List&quot; so that I can help?
    </question>
    <answer>
     <p>
  @@ -61,7 +61,7 @@
   
   <faq>
    <question>
  -  I gather that i will be able to use the Forrest infrastructure to build
  +  I gather that I will be able to use the Forrest infrastructure to build
     my own website.
    </question>
    <answer>
  
  
  
  1.3       +174 -174  xml-forrest/src/documentation/content/xdocs/howto-v10.xml
  
  Index: howto-v10.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/howto-v10.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- howto-v10.xml	20 May 2002 18:23:27 -0000	1.2
  +++ howto-v10.xml	21 May 2002 21:16:16 -0000	1.3
  @@ -1,174 +1,174 @@
  -<?xml version="1.0" encoding="UTF-8"?>
  -<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
  -
  -<howto>
  - <header>
  -  <title>How to Author a How-To</title>
  -  
  -  <version>0.2</version>
  -  <authors>
  -   <person name="Diana Shannon" email="shannon@apache.org"/>
  -  </authors>
  -  <notice>This document is a sample to test the new howto-v11.dtd</notice>
  -  <abstract>This How-To describes the steps necessary to write a How-To for Cocoon.
The Cocoon documentation project needs your help. Writing a Cocoon How-To is a valuable way
to give back to the community.</abstract>
  -  <last-modified-content-date date="2002-05-19"/>
  - </header>
  -
  -
  -  <audience title="Intended Audience">
  -<p>
  -Cocoon users who are ready to share their knowledge and experiences with the larger Cocoon
community.
  -</p>
  -  </audience>
  -  
  -  <purpose title="Purpose">
  -<p>
  -These guidelines are based on successful how-to document structures used by other open
source projects with diverse author groups. Following these tried and true guidelines will
help to insure the effectiveness of your work.
  -</p>
  -  </purpose>
  -
  -
  -  <prerequisites title="Prerequisites">
  -<p>
  -How-To authors should have:
  -</p>
  -<ul>
  -<li>A unique How-To topic, related to using Cocoon, which fulfills a specific need.
Check out <link href="index.html">existing How-Tos</link> to find a niche for
your work. Consider posting your idea for the How-To to cocoon-user list, to make sure another
author's draft is not already in process.</li>
  -<li>A sufficient ability in English to write the FAQ. If you need a little extra
help with language, consider partnering with another user with more advanced English writing
skills.</li>
  -<li>Currently, the Cocoon documentation project is still working out the exact details
for a How-To dtd and template. For now, just edit the most recent version of any existing
How-To, filling in your own content as necessary. Make sure you use most recent version of
document dtd to validate your How-To before submitting. You will find it in <code>src/documentation/xdocs/dtd</code>
in your cocoon distribution.</li>
  -</ul>
  -<note>Within Forrest, the dtd is located in <code>src/resources/schema/dtd</code>.</note></prerequisites>
  -
  -  <steps title="Steps">
  -<p>
  -Here's how to proceed.</p>
  -
  -  <section title="Write the Overview">
  -<p>
  -An overview helps potential readers to determine quickly if a particular How-To matches
their interests or needs. In a few sentences, summarize the main points of your How-To. Make
sure to include any critical definitions which will help readers evaluate the utility of your
How-To. Consider writing the overview last, after you have completed all other sections.
  -</p>
  -  </section>
  -
  -  <section title="Describe your Intended Audience">
  -<p>
  -If your How-To is targetted at a specific audience, describe it here. For example, potential
readers will have different levels of skill using Cocoon. They will also bring different areas
of expertise and backgrounds to their How-To learning experience. When you clarify your target
audience up front, you will save all other readers time and confusion. 
  -</p> 
  -  </section>
  -
  -  <section title="State the Purpose">
  -<p>
  -State the purpose of your How-To. Explain how the reader will benefit by reading it. Give
your reader an incentive or two to continue. 
  -</p>
  -  </section>
  -
  -  <section title="List any Prerequsites">
  -<p>
  -Inform your reader about any required knowledge, configuration, or resources they may need
before stepping through your How-To. Assist them in this preparation by linking to other useful
resources on the Cocoon site or the web. Helping your readers to prepare increases the likelihood
that they will continue reading your How-To.
  -</p>
  -  </section>
  -
  -  <section title="Describe the Steps of your How-To">
  -<p>
  -In a precise, step-by-step approach, walk your reader through the process. Make sure your
reader can reproduce your intended result by following your exact steps. Make the learning
process efficient by supplying sample code snippets or configuration details as necessary.
  -</p>
  -  </section>
  -
  -  <section title="Extend the Learning">
  -<p>
  -Provide your reader with a few real-world examples of how the techniques or capabilities
gained from your How-To could be applied. Reward the reader for successfully completing the
How-To with a few ideas about how it will pay off.
  -</p>
  -  </section>
  -
  -
  -  <section title="Summarize the Entire Process">
  -<p>
  -In a few sentences, remind the reader what they have just learned. This helps to reinforce
the main points of your How-To.  
  -</p>
  -  </section>
  -
  -
  -  <section title="Additional Tips or FAQs">
  -<p>
  -In some cases, step-by-step instructions simply aren't enough. Use this section to pass
on any other tips or frequently asked questions. Anticipating the needs of your readers will
increase the overall success of your writing effort.
  -</p>
  -  </section>
  -
  -  <section title="References">
  -<p>
  -Remember to acknowledge any third-party resources or individuals who contributed to the
development of your How-To. Consider providing links for those motivated readers who want
to learn more.
  -</p>
  -  </section>
  -  
  -  <section title="Get some feedback">
  -<p>
  -Ask a few other Cocoon users to proofread your How-To. Or, post a text version of it to
the cocoon-user list, and ask for comments.
  -</p> 
  -  </section>
  -  
  -  <section title="Submit via Bugzilla">
  -<p>
  -Create an attachment for your How-To document, and submit it via Bugzilla. 
  -<!-- link to How-To Bugzilla here -->
  -</p> 
  -  </section>
  -    
  -
  -  </steps>
  -
  -  <extension title="Extension">
  -<p>
  -Cocoon solutions can be extended to cover many different problem domains. A nearly unlimited
number of potential How-To topics, from simple to complex, are available right now, limited
only by your imagination. 
  -</p>
  -  </extension>
  -
  -  <faqs title="Frequently Asked Questions">
  -  
  -  <faq>
  -   <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>
  -   <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>
  -  
  -  <tips title="Tips">
  -  
  -  <section title="How-To dtd">
  -<p>
  -The document structure of Cocoon's How-To page is likely to change soon. Please note that
this HOWTO page is likely to change as well.
  -</p>
  -  </section>
  -  
  -  </tips>
  -
  -  <references title="References">
  -<p>
  -This is not the first, nor will it be the last, How-To on writing How-Tos. For other ideas
and opinions on the matter, check out the following sources.
  -</p>
  -  <ul>
  -<li>
  -Joel D. Canfield's <link 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>
  -<li>
  -The Linux Documentation Project's <link href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</link>
index page provides many excellent How-To documents to inspire your efforts.
  -</li>
  -  </ul>
  -  
  -  </references>
  -  
  -</howto>
  +<?xml version="1.0" encoding="UTF-8"?>
  +<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
  +
  +<howto>
  + <header>
  +  <title>How to Author a How-To</title>
  +  
  +  <version>0.2</version>
  +  <authors>
  +   <person name="Diana Shannon" email="shannon@apache.org"/>
  +  </authors>
  +  <notice>This document is a sample to test the new howto-v11.dtd</notice>
  +  <abstract>This How-To describes the steps necessary to write a How-To for Cocoon.
The Cocoon documentation project needs your help. Writing a Cocoon How-To is a valuable way
to give back to the community.</abstract>
  +  <last-modified-content-date date="2002-05-19"/>
  + </header>
  +
  +
  +  <audience title="Intended Audience">
  +<p>
  +Cocoon users who are ready to share their knowledge and experiences with the larger Cocoon
community.
  +</p>
  +  </audience>
  +  
  +  <purpose title="Purpose">
  +<p>
  +These guidelines are based on successful how-to document structures used by other open
source projects with diverse author groups. Following these tried and true guidelines will
help to insure the effectiveness of your work.
  +</p>
  +  </purpose>
  +
  +
  +  <prerequisites title="Prerequisites">
  +<p>
  +How-To authors should have:
  +</p>
  +<ul>
  +<li>A unique How-To topic, related to using Cocoon, which fulfills a specific need.
Check out <link href="index.html">existing How-Tos</link> to find a niche for
your work. Consider posting your idea for the How-To to cocoon-user list, to make sure another
authors' draft is not already in process.</li>
  +<li>A sufficient ability in English to write the FAQ. If you need a little extra
help with language, consider partnering with another user with more advanced English writing
skills.</li>
  +<li>Currently, the Cocoon documentation project is still working out the exact details
for a How-To dtd and template. For now, just edit the most recent version of any existing
How-To, filling in your own content as necessary. Make sure you use most recent version of
document dtd to validate your How-To before submitting. You will find it in <code>src/documentation/xdocs/dtd</code>
in your cocoon distribution.</li>
  +</ul>
  +<note>Within Forrest, the dtd is located in <code>src/resources/schema/dtd</code>.</note></prerequisites>
  +
  +  <steps title="Steps">
  +<p>
  +Here's how to proceed.</p>
  +
  +  <section title="Write the Overview">
  +<p>
  +An overview helps potential readers to determine quickly if a particular How-To matches
their interests or needs. In a few sentences, summarize the main points of your How-To. Make
sure to include any critical definitions which will help readers evaluate the utility of your
How-To. Consider writing the overview last, after you have completed all other sections.
  +</p>
  +  </section>
  +
  +  <section title="Describe your Intended Audience">
  +<p>
  +If your How-To is targeted at a specific audience, describe it here. For example, potential
readers will have different levels of skill using Cocoon. They will also bring different areas
of expertise and backgrounds to their How-To learning experience. When you clarify your target
audience up front, you will save all other readers time and confusion. 
  +</p> 
  +  </section>
  +
  +  <section title="State the Purpose">
  +<p>
  +State the purpose of your How-To. Explain how the reader will benefit by reading it. Give
your reader an incentive or two to continue. 
  +</p>
  +  </section>
  +
  +  <section title="List any Prerequisites">
  +<p>
  +Inform your reader about any required knowledge, configuration, or resources they may need
before stepping through your How-To. Assist them in this preparation by linking to other useful
resources on the Cocoon site or the web. Helping your readers to prepare increases the likelihood
that they will continue reading your How-To.
  +</p>
  +  </section>
  +
  +  <section title="Describe the Steps of your How-To">
  +<p>
  +In a precise, step-by-step approach, walk your reader through the process. Make sure your
reader can reproduce your intended result by following your exact steps. Make the learning
process efficient by supplying sample code snippets or configuration details as necessary.
  +</p>
  +  </section>
  +
  +  <section title="Extend the Learning">
  +<p>
  +Provide your reader with a few real-world examples of how the techniques or capabilities
gained from your How-To could be applied. Reward the reader for successfully completing the
How-To with a few ideas about how it will pay off.
  +</p>
  +  </section>
  +
  +
  +  <section title="Summarize the Entire Process">
  +<p>
  +In a few sentences, remind the reader what they have just learned. This helps to reinforce
the main points of your How-To.  
  +</p>
  +  </section>
  +
  +
  +  <section title="Additional Tips or FAQs">
  +<p>
  +In some cases, step-by-step instructions simply aren't enough. Use this section to pass
on any other tips or frequently asked questions. Anticipating the needs of your readers will
increase the overall success of your writing effort.
  +</p>
  +  </section>
  +
  +  <section title="References">
  +<p>
  +Remember to acknowledge any third-party resources or individuals who contributed to the
development of your How-To. Consider providing links for those motivated readers who want
to learn more.
  +</p>
  +  </section>
  +  
  +  <section title="Get some feedback">
  +<p>
  +Ask a few other Cocoon users to proofread your How-To. Or, post a text version of it to
the cocoon-user list, and ask for comments.
  +</p> 
  +  </section>
  +  
  +  <section title="Submit via Bugzilla">
  +<p>
  +Create an attachment for your How-To document, and submit it via Bugzilla. 
  +<!-- link to How-To Bugzilla here -->
  +</p> 
  +  </section>
  +    
  +
  +  </steps>
  +
  +  <extension title="Extension">
  +<p>
  +Cocoon solutions can be extended to cover many different problem domains. A nearly unlimited
number of potential How-To topics, from simple to complex, are available right now, limited
only by your imagination. 
  +</p>
  +  </extension>
  +
  +  <faqs title="Frequently Asked Questions">
  +  
  +  <faq>
  +   <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 concise 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>
  +   <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>
  +  
  +  <tips title="Tips">
  +  
  +  <section title="How-To dtd">
  +<p>
  +The document structure of Cocoons' How-To page is likely to change soon. Please note that
this HOWTO page is likely to change as well.
  +</p>
  +  </section>
  +  
  +  </tips>
  +
  +  <references title="References">
  +<p>
  +This is not the first, nor will it be the last, How-To on writing How-Tos. For other ideas
and opinions on the matter, check out the following sources.
  +</p>
  +  <ul>
  +<li>
  +Joel D. Canfield's <link 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>
  +<li>
  +The Linux Documentation Project's <link href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</link>
index page provides many excellent How-To documents to inspire your efforts.
  +</li>
  +  </ul>
  +  
  +  </references>
  +  
  +</howto>
  
  
  
  1.5       +2 -2      xml-forrest/src/documentation/content/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/index.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- index.xml	12 May 2002 22:37:19 -0000	1.4
  +++ index.xml	21 May 2002 21:16:16 -0000	1.5
  @@ -13,11 +13,11 @@
           ASF practices and experience, and modern software design principles.</p>

         <p>Our first target is to create a consistent
           <link href="http://xml.apache.org/">xml.apache.org</link> website,
with a
  -      uniform, light-weigth and easy to navigate layout and structure. Each project
  +      uniform, lightweight and easy to navigate layout and structure. Each project
         will be responsible for maintaining its own documentation and website, which
         are imported, aggregated and published automatically by Forrest. To achieve
         this goal, we provide XML document grammars for the different types of
  -      documents a project's website typically consists of, and a
  +      documents a projects website typically consists of, and a
         <link href="http://xml.apache.org/cocoon/">Cocoon</link>-based site generation
         mechanism.</p> 
         <p>The Forrest developers -
  
  
  

Mime
View raw message