You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ka...@apache.org on 2003/02/04 04:59:31 UTC

cvs commit: jakarta-turbine-maven/src/plugins-build/xdoc/src/plugin-resources site.jsl

kaz         2003/02/03 19:59:31

  Modified:    src/plugins-build/xdoc plugin.jelly plugin.properties
               src/plugins-build/xdoc/src/plugin-resources site.jsl
  Log:
  Added a new property that enables a user to disable the inclusion of the
  "Project Documentation" section of the navbar (i.e. the Maven generated
  stuff).  This is useful for documentation sites only.  The new property
  is:
  
      maven.xdoc.generateProjectDocumentation = yes
  
  If you want to disable the generation, set this value to 'no' in your
  project.properties.
  
  Revision  Changes    Path
  1.7       +5 -0      jakarta-turbine-maven/src/plugins-build/xdoc/plugin.jelly
  
  Index: plugin.jelly
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/xdoc/plugin.jelly,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- plugin.jelly	4 Feb 2003 00:18:11 -0000	1.6
  +++ plugin.jelly	4 Feb 2003 03:59:31 -0000	1.7
  @@ -263,6 +263,11 @@
       <j:set 
         var="reports"
         value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('reports')}"/>
  +
  +    <!-- Does the user want the maven-generated docs on their site? -->
  +    <j:set 
  +      var="generateProjectDocumentation" 
  +      value="${maven.xdoc.generateProjectDocumentation}"/>
       
       <!-- Need the escaper to html output. -->
       <j:useBean var="escape" class="org.apache.velocity.anakia.Escape"/>
  
  
  
  1.3       +1 -0      jakarta-turbine-maven/src/plugins-build/xdoc/plugin.properties
  
  Index: plugin.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/xdoc/plugin.properties,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- plugin.properties	28 Jan 2003 06:44:41 -0000	1.2
  +++ plugin.properties	4 Feb 2003 03:59:31 -0000	1.3
  @@ -10,6 +10,7 @@
   maven.gen.docs = ${maven.build.dir}/generated-xdocs
   
   maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/turbine/maven/development-process.html
  +maven.xdoc.generateProjectDocumentation = yes
   
   #
   # DATE Preferences
  
  
  
  1.3       +6 -0      jakarta-turbine-maven/src/plugins-build/xdoc/src/plugin-resources/site.jsl
  
  Index: site.jsl
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/xdoc/src/plugin-resources/site.jsl,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- site.jsl	31 Jan 2003 18:25:28 -0000	1.2
  +++ site.jsl	4 Feb 2003 03:59:31 -0000	1.3
  @@ -143,6 +143,11 @@
                   <!-- Standard Maven Navigation -->
                   <j:set var="fileName">${file}</j:set>
   
  +                <!-- 
  +                 ! Check to see if the user wishes to include the
  +                 ! maven-generated docs on their site.
  +                 !-->
  +                <j:if test="${generateProjectDocumentation.equals('yes')}">
                   <div>
                     <strong>Project Documentation</strong>
                     <div>
  @@ -349,6 +354,7 @@
                       </div>
                     </j:if>
                   </div>
  +              </j:if>
                   <j:if test="${context.findVariable('maven.xdoc.date') == 'navigation-bottom'}">
                     <div>
                       <small>Last published: ${build.date}</small>