You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2004/07/13 14:08:50 UTC

cvs commit: maven/xdocs/reference project-descriptor.xml

brett       2004/07/13 05:08:50

  Modified:    xdocs    Tag: MAVEN-1_0-BRANCH musings.xml
                        navigation-pdf.xml navigation.xml site.xml
               xdocs/misc Tag: MAVEN-1_0-BRANCH tasks.xml
               xdocs/reference Tag: MAVEN-1_0-BRANCH project-descriptor.xml
  Log:
  cleanup tabs, old doco
  
  Revision  Changes    Path
  No                   revision
  No                   revision
  1.32.10.3 +0 -13     maven/xdocs/musings.xml
  
  Index: musings.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/musings.xml,v
  retrieving revision 1.32.10.2
  retrieving revision 1.32.10.3
  diff -u -r1.32.10.2 -r1.32.10.3
  --- musings.xml	23 Jun 2004 12:56:19 -0000	1.32.10.2
  +++ musings.xml	13 Jul 2004 12:08:50 -0000	1.32.10.3
  @@ -163,19 +163,6 @@
            Standard JavaCC pattern. Maven, Lucene, Jython all need something
            like this and now that JavaCC is OSS it will be even easier!
          </li>
  -       <li>
  -         Consider introducing an XML FAQ format for Maven builds. Right now the FAQ
  -         format (e.g. Maven's xdocs/reference/faq.xml) is a little fiddly to edit.
  -         Consider some simple XML format instead like the following along with patching
  -         the DVSL scripts...
  -         <source><![CDATA[
  -<section name="General">
  -  <entry ref="foo">
  -    <question>How do I foo?</question>
  -    <answer>The way you do this is...?</question>
  -  </entry>
  -</section>]]></source>
  -       </li>
        </ol>
      </section>
    </body>
  
  
  
  1.1.2.9   +1 -0      maven/xdocs/navigation-pdf.xml
  
  Index: navigation-pdf.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/navigation-pdf.xml,v
  retrieving revision 1.1.2.8
  retrieving revision 1.1.2.9
  diff -u -r1.1.2.8 -r1.1.2.9
  --- navigation-pdf.xml	10 Jul 2004 01:24:24 -0000	1.1.2.8
  +++ navigation-pdf.xml	13 Jul 2004 12:08:50 -0000	1.1.2.9
  @@ -34,6 +34,7 @@
               <item name="Install" href="/start/install.html"/>
               <item name="Integrate" href="/start/integrate.html"/>
               <item name="Use" href="/start/use.html"/>
  +            <item name="Release Notes" href="/start/release-notes-rc4.html"/>
               <item name="Build" href="/start/bootstrap.html"/>
               <item name="Anakia Users" href="/start/anakia.html"/>
           </menu>
  
  
  
  1.33.4.11 +1 -1      maven/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/navigation.xml,v
  retrieving revision 1.33.4.10
  retrieving revision 1.33.4.11
  diff -u -r1.33.4.10 -r1.33.4.11
  --- navigation.xml	10 Jul 2004 01:24:24 -0000	1.33.4.10
  +++ navigation.xml	13 Jul 2004 12:08:50 -0000	1.33.4.11
  @@ -38,7 +38,7 @@
           <item name="Install"               href="/start/install.html"/>
           <item name="Integrate"             href="/start/integrate.html"/>
           <item name="Use"                   href="/start/use.html"/>
  -        <item name="Release Notes"         href="/start/release-notes.html"/>
  +        <item name="Release Notes"         href="/start/release-notes-rc4.html"/>
           <item name="Build"                 href="/start/bootstrap.html"/>
           <item name="Anakia Users"          href="/start/anakia.html"/>
         </item>
  
  
  
  1.2.10.2  +34 -42    maven/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/site.xml,v
  retrieving revision 1.2.10.1
  retrieving revision 1.2.10.2
  diff -u -r1.2.10.1 -r1.2.10.2
  --- site.xml	4 Mar 2004 17:45:56 -0000	1.2.10.1
  +++ site.xml	13 Jul 2004 12:08:50 -0000	1.2.10.2
  @@ -25,20 +25,19 @@
     </properties>
   
     <body>
  -
       <section name="Implementation">
  -    	<p>
  -	    	Create a single navigation.xml that contains the menu structure for
  -	    	the entire document tree.  Add all items and sub-items.
  -    	</p>
  -    	
  -    	<p> 
  -    		For items that can collapse when you are not browsing them, add <code>collapse="true"</code>
  -    		to the item declaration.
  -    	</p>
  -    	
  -    	<source><![CDATA[
  -    	<?xml version="1.0" encoding="ISO-8859-1"?>
  +      <p>
  +        Create a single navigation.xml that contains the menu structure for
  +        the entire document tree.  Add all items and sub-items.
  +      </p>
  + 
  +      <p> 
  +        For items that can collapse when you are not browsing them, add <code>collapse="true"</code>
  +        to the item declaration.
  +      </p>
  + 
  +      <source><![CDATA[
  +<?xml version="1.0" encoding="ISO-8859-1"?>
   <project name="Maven xdoc Plugin">
   
     <title>Maven xdoc Plugin</title>
  @@ -49,41 +48,34 @@
       </links>
       <menu>
         <item name="Alpha" href="/alpha/index.html">   
  -	      <item name="Alpha One" href="/alpha/one/index.html"/>
  -	      <item name="Alpha Two" href="/alpha/two/index.html"/>
  -	  </item>
  +        <item name="Alpha One" href="/alpha/one/index.html"/>
  +        <item name="Alpha Two" href="/alpha/two/index.html"/>
  +      </item>
         <item name="Beta" href="/beta/index.html" collapse="true">
  -	      <item name="Beta One" href="/beta/one/index.html" collapse="true"/>
  -	      <item name="Beta Two" href="/beta/two/index.html" collapse="true"/>
  -	  </item>
  +        <item name="Beta One" href="/beta/one/index.html" collapse="true"/>
  +        <item name="Beta Two" href="/beta/two/index.html" collapse="true"/>
  +      </item>
       </menu>
     </body>
  -</project>
  -    	]]>
  -    	</source>
  -    	
  -    	<p>
  -    		Now the menus will expand and collapse as you navigate through them.
  -    	</p>
  -    	
  -
  +</project>]]></source>
  + 
  +      <p>
  +        Now the menus will expand and collapse as you navigate through them.
  +      </p>
       </section>
       
       <section name="Caveats">
  -    	<ol>
  -    		<li>You must refer to subdirectories as /folder/index.html.  Navigation will get quite confused
  -    			if you refer to them as /folder/ or just /folder
  -    		</li>
  -    		<li>
  -    			If you have a sub-item with the same url as another item, the site navigation will
  -    			expand to display all items with that URL (when either is selected).  All instances 
  -    			of the item will be highlighted.
  -    		</li>
  -    	</ol>
  +     <ol>
  +       <li>
  +         You must refer to subdirectories as /folder/index.html.  Navigation will get quite confused
  +         if you refer to them as /folder/ or just /folder
  +       </li>
  +       <li>
  +         If you have a sub-item with the same url as another item, the site navigation will
  +         expand to display all items with that URL (when either is selected).  All instances 
  +         of the item will be highlighted.
  +       </li>
  +      </ol>
       </section>
  -    
  -    
  -
  -
     </body>
   </document>
  
  
  
  No                   revision
  No                   revision
  1.1.10.4  +1 -120    maven/xdocs/misc/tasks.xml
  
  Index: tasks.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/misc/tasks.xml,v
  retrieving revision 1.1.10.3
  retrieving revision 1.1.10.4
  diff -u -r1.1.10.3 -r1.1.10.4
  --- tasks.xml	23 Jun 2004 12:56:19 -0000	1.1.10.3
  +++ tasks.xml	13 Jul 2004 12:08:50 -0000	1.1.10.4
  @@ -26,15 +26,7 @@
   
     <body>
       <section name="Tasks">
  -      <p>
  -      </p>
  -
  -      <subsection name="Beta 9">
  -        <p>
  -          Try to fix as many issues as possible and get the documentation up to scratch. We
  -          are going to try and get this release out sooner rather than later.
  -        </p>
  -        
  +      <subsection name="Beyond 1.0">
           <p>
             <ul>
               <li>
  @@ -45,14 +37,6 @@
                 now busted. Users will need HEAD for some plugins to work which
                 is not good.
               </li>
  -          </ul>
  -        </p>
  -       </subsection>
  -
  -
  -      <subsection name="Beta 10">
  -        <p>
  -          <ul>
               <li>
                 Implement arbitrary artifact type handling. Michal Maczka (Mmaczka@cqs.ch)
                 had a very good solution but we didn't get around to getting it
  @@ -85,17 +69,6 @@
                 Addition of POM entries to allow anonymous checkout
               </li>
               <li>
  -              Test the http auth mode for repositories. Code is there just haven't
  -              tried it.
  -            </li>
  -          </ul>
  -        </p>
  -      </subsection>
  -
  -      <subsection name="Unassigned">
  -        <p>
  -          <ul>
  -            <li>
                 Roadmap document. (jvz)
               </li>
               <li>
  @@ -145,97 +118,5 @@
           </p>
         </subsection>
       </section>
  -
  -    <section name="Complete">
  -      <p>
  -        <ul>
  -          <li>
  -            JXR task needs to be modified so that XML is produced so that it
  -            can be transformed to into something that looks better.
  -          </li>
  -          <li>
  -            Formalize how jarResources elements are moved from the project
  -            directory layout into the classpath for testing and into the JAR
  -            that is packaged with the distribution.
  -          </li>
  -          <li>
  -            Generate xdoc from LICENSE.txt to show the project license and
  -            then link to it from the project info menu. Suggestion by Markus
  -            May that sounds good.
  -          </li>
  -          <li>
  -            Add support for the various coding specifications so that those properties
  -            can be applied to things like checkstyle and to create a document
  -            outlining the coding specification.
  -          </li>
  -          <li>
  -            Maven:deploy-dist needs to work. (jvz)
  -          </li>
  -          <li>
  -            Snapshot JARs need to be used for all versions of JARs that
  -            aren't released. So we can get rid of the update-jars
  -            functionalility.
  -          </li>
  -          <li>
  -            Minimal reactor. This includes the dep graph, central repository
  -            of deps and all that jazz.
  -          </li>
  -          <li>
  -            POM inheritance mechanism. Will wait for the switch to betwixt.
  -          </li>
  -          <li>
  -            Generation of a standard build.xml file.
  -          </li>
  -          <li>
  -            Script execution. Remove the requirement of the Ant execution
  -            environment. Along with this we'll get the exception handling
  -            we've been looking for.
  -          </li>
  -          <li>
  -            See if jxr can be configured to only generate one file.gif and
  -            folder.gif, rather than one per source folder (dIon)
  -          </li>
  -          <li>
  -            xref produces cross references for &lt;sourceDirectories&gt; and
  -            &lt;testSourceDirectories&gt;. javadoc produces html for
  -            &lt;sourceDirectories&gt; only.
  -          </li>
  -          <li>
  -            When we are dealing with non-distributable JARs we may have to
  -            give the user some additional info like telling them they have
  -            to rename a JAR. So add another field which would contain a
  -            message blurb to display to the user in these cases.
  -          </li>
  -          <li>
  -            A process for moving things from the task list to a list of items
  -            completed so they can be listed in documentation for a release
  -            automatically.
  -          </li>
  -          <li>
  -            Schema for project.xml (jvz)
  -          </li>
  -          <li>
  -            Maven POM updater: a reliable way to transform the project.xml file when
  -            changes are made. The coming changes to specification of tests will
  -            change the structure of the project.xml file and it should be easy
  -            for users to absorb these changes. They need to be notified, allowed
  -            to choose the changes when they wish and have the changes
  -            transparently applied.
  -          </li>
  -          <li>
  -            Make a document that displays the list of currently registered
  -            projects.
  -          </li>
  -          <li>
  -            Add a maven:xml-validate target which will validate all xml source
  -            against it's DTD (if present). Will most likely need a new element
  -            in project.xml (&lt;xmlSourceDirectories&gt;) similar to source
  -            directories. Any directory listed in an &lt;xmlSourceDirectory&gt;
  -            will be validated.
  -          </li>
  -        </ul>
  -      </p>
  -    </section>
  -
     </body>
   </document>
  
  
  
  No                   revision
  No                   revision
  1.29.2.7  +3 -3      maven/xdocs/reference/project-descriptor.xml
  
  Index: project-descriptor.xml
  ===================================================================
  RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
  retrieving revision 1.29.2.6
  retrieving revision 1.29.2.7
  diff -u -r1.29.2.6 -r1.29.2.7
  --- project-descriptor.xml	26 Apr 2004 21:50:03 -0000	1.29.2.6
  +++ project-descriptor.xml	13 Jul 2004 12:08:50 -0000	1.29.2.7
  @@ -37,9 +37,9 @@
         </p>
         <p>
           For reference, the XML schema used to validate the project
  -        descriptor is available in the <a
  -        href="http://cvs.apache.org/viewcvs.cgi/maven/src/xsd">CVS
  -        Repository</a>.  In addition, a sample project descriptor is
  +        descriptor is available at <a
  +        href="http://maven.apache.org/xsd/maven-project-3.0.0.xsd">http://maven.apache.org/xsd/maven-project-3.0.0.xsd</a>.
  +        In addition, a sample project descriptor is
           presented in the <a href="../start/integrate.html">Integration</a>
           document. For those wondering, yes, Maven's build system is built 
           by Maven (we believe in eating our own dog food :)
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org