You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2003/09/07 16:50:33 UTC

cvs commit: maven/src/plugins-build/xdoc/xdocs faq.fml navigation.xml

dion        2003/09/07 07:50:33

  Modified:    src/plugins-build/xdoc project.properties project.xml
               src/plugins-build/xdoc/xdocs navigation.xml
  Added:       src/plugins-build/xdoc/xdocs faq.fml
  Log:
  Move xdoc FAQs from Wiki to site docs
  
  Revision  Changes    Path
  1.4       +1 -1      maven/src/plugins-build/xdoc/project.properties
  
  Index: project.properties
  ===================================================================
  RCS file: /home/cvs/maven/src/plugins-build/xdoc/project.properties,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- project.properties	19 Mar 2003 06:01:19 -0000	1.3
  +++ project.properties	7 Sep 2003 14:50:33 -0000	1.4
  @@ -5,4 +5,4 @@
   maven.xdoc.version=${pom.currentVersion}
   #maven.xdoc.developmentProcessUrl=http://maven.apache.org/development-process.html
   maven.license.licenseFile=${basedir}/../../../LICENSE.txt
  -
  +maven.checkstyle.header.file=${basedir}/../../../LICENSE.txt
  
  
  
  1.26      +16 -0     maven/src/plugins-build/xdoc/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/maven/src/plugins-build/xdoc/project.xml,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- project.xml	6 Sep 2003 07:28:55 -0000	1.25
  +++ project.xml	7 Sep 2003 14:50:33 -0000	1.26
  @@ -124,4 +124,20 @@
         <version>1.0.b2</version>
       </dependency>
     </dependencies>
  +  <reports>
  +    <report>maven-jdepend-plugin</report>
  +    <report>maven-checkstyle-plugin</report>
  +    <report>maven-changes-plugin</report>
  +    <report>maven-changelog-plugin</report>
  +    <report>maven-findbugs-plugin</report>
  +    <report>maven-file-activity-plugin</report>
  +    <report>maven-developer-activity-plugin</report>
  +    <report>maven-javadoc-plugin</report>
  +    <report>maven-jxr-plugin</report>
  +    <report>maven-junit-report-plugin</report>
  +    <report>maven-tasklist-plugin</report>
  +    <report>maven-pmd-plugin</report>
  +    <report>maven-simian-plugin</report>
  +    <report>maven-faq-plugin</report>
  +  </reports>
   </project>
  
  
  
  1.3       +1 -0      maven/src/plugins-build/xdoc/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/maven/src/plugins-build/xdoc/xdocs/navigation.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- navigation.xml	19 Mar 2003 05:54:16 -0000	1.2
  +++ navigation.xml	7 Sep 2003 14:50:33 -0000	1.3
  @@ -11,6 +11,7 @@
         <item name="Goals"             href="/goals.html"/>   
         <item name="Properties"        href="/properties.html"/>
         <item name="Changes report"    href="/changes-report.html"/>
  +      <item name="FAQs"              href="/faq.html"/>
       </menu>
     </body>
   </project>
  
  
  
  1.1                  maven/src/plugins-build/xdoc/xdocs/faq.fml
  
  Index: faq.fml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <faqs title="Frequently Asked Questions">
  
    <part id="general">
      <title>General</title>
     
      <faq id="footer-company">
        <question>
          On the footer that Maven adds with the company name ... 
          is there any way I can make the company name a hyperlink to 
          copyright info for the company?
        </question>
        <answer>Not at the moment</answer>
      </faq>
  
      <faq id="footer-position">
        <question>
          Can I specify to have the Maven footer (2002-2003 company name) 
          just below the line "Last Published ..." ? rather than 
          at the foot of the page ? What is the property entry for this?
        </question>
        <answer>Not at the moment</answer>
      </faq>
  
      <faq id="powered-by">
        <question>How can I change the powered by logo?</question>
        <answer>
          <source>
  # The logo to show on the generated site. No default at present 
  maven.xdoc.poweredby.image = maven-bolt.png 
  maven.xdoc.poweredby.title = Bolted together with Maven 
  maven.xdoc.poweredby.url = http://maven.apache.org/ 
          </source>
        </answer>
      </faq>
  
      <faq id="description-html">
        <question>How do I put HTML in my description?</question>
        <answer>Use html escape notion. e.g: &amp;amp;gt;</answer>
      </faq>
  
      <faq id="own-index">
        <question>
          Can I create my own index page rather than using the 
          autogenerated page from the description?
        </question>
        <answer>Create an index.xml file in the xdocs directory.</answer>
      </faq>
    </part>
    
    <part id="navigation">
      <title>Navigation</title>
  
      <faq id="navigation-add-menu">
        <question>
          I've discovered the navigation.xml file and 
          can now add links and menu items. How do I add a menu 'header'
          to navigation.xml in the same style as the generated 
          'Project Documentation' header (which comes out in HTML within STRONG tags) ?
        </question>
        <answer>
          To add a new menu, use the 
          <source>&lt;menu name="Menu Name"&gt;</source> element.
          Each linkable entry underneath is its own item.      
        </answer>
      </faq>
      
      <faq id="navigation-move-project-info">
        <question>
          Is there any way I can specify whereabouts in the navigation.xml 
          Maven adds the 'Project Information' block or is it always at the foot?
        </question>
        <answer>Not at the moment</answer>
      </faq>
  
      <faq id="navigation-images">
        <question>How can I add images to the navigation?</question>
        <answer>
          Add an img attribute to the item element.
          <source>
  &lt;item name="The Site" href="http://www.thesite.net/" img="http://www.thesite.net/thesite.png"/&gt;
          </source>
        </answer>
      </faq>
  
      <faq id="navigation-collapse">
        <question>How do I create collapsible items?</question>
        <answer>
          Add a collapse="true" attribute, e.g.
          <source>
  &lt;item name="Design" href="/design.html" collapse="true"&gt;
          </source>
        </answer>
      </faq>
  
      <faq id="navigation-google">
        <question>How do I add the Google search to my pages?</question>
        <answer>
          Add a &lt;search/&gt; element to your navigation.xml file. e.g:
          <source>
  &lt;project name="foo"&gt;
    &lt;body&gt; 
      &lt;menu name="bar"&gt;
         ..   
      &lt;/menu&gt;
   
      &lt;search/&gt;
  &lt;/project&gt;
          </source>
        </answer>
      </faq>
    </part>
  
    <!--
      <faq id="">
        <question></question>
        <answer>
        </answer>
      </faq>
    -->
  </faqs>
     
  
  

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


RE: cvs commit: maven/src/plugins-build/xdoc/xdocs faq.fml navigation.xml

Posted by di...@multitask.com.au.
"Michal Maczka" <mm...@raay-cqs.com> wrote on 08/09/2003 07:03:12 PM:

> I am not complaing :) ... but wouldn't it be better to 
> to solve this issue by inheriting
> 
> maven.license.licenseFile
> and 
> maven.checkstyle.header.file
> 
> from parent project for all plugins?
> 
> We need to implement this feature (afaik properties were not inherited
> some time ago) before 1.0 goes out.
If you've got the time, feel free to do it now.

I don't at the moment, this is all I have the time to do :-)
--
dIon Gillard, Multitask Consulting
Blog:      http://blogs.codehaus.org/people/dion/


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


RE: cvs commit: maven/src/plugins-build/xdoc/xdocs faq.fml navigation.xml

Posted by Michal Maczka <mm...@raay-cqs.com>.

> -----Original Message-----
> From: dion@apache.org [mailto:dion@apache.org]
> Sent: Sunday, September 07, 2003 4:51 PM
> To: maven-cvs@apache.org
> Subject: cvs commit: maven/src/plugins-build/xdoc/xdocs faq.fml
> navigation.xml
> 
> dion        2003/09/07 07:50:33
> 
>   Modified:    src/plugins-build/xdoc project.properties project.xml
>                src/plugins-build/xdoc/xdocs navigation.xml
>   Added:       src/plugins-build/xdoc/xdocs faq.fml
>   Log:
>   Move xdoc FAQs from Wiki to site docs
> 
>   Revision  Changes    Path
>   1.4       +1 -1      maven/src/plugins-build/xdoc/project.properties
> 
>   Index: project.properties
>   ===================================================================
>   RCS file:
/home/cvs/maven/src/plugins-build/xdoc/project.properties,v
>   retrieving revision 1.3
>   retrieving revision 1.4
>   diff -u -r1.3 -r1.4
>   --- project.properties	19 Mar 2003 06:01:19 -0000	1.3
>   +++ project.properties	7 Sep 2003 14:50:33 -0000	1.4
>   @@ -5,4 +5,4 @@
>    maven.xdoc.version=${pom.currentVersion}
>
#maven.xdoc.developmentProcessUrl=http://maven.apache.org/development-
> process.html
>    maven.license.licenseFile=${basedir}/../../../LICENSE.txt
>   -
>   +maven.checkstyle.header.file=${basedir}/../../../LICENSE.txt
> 
> 
> 
>   1.26      +16 -0     maven/src/plugins-build/xdoc/project.xml

I am not complaing :) ... but wouldn't it be better to 
to solve this issue by inheriting

maven.license.licenseFile
and 
maven.checkstyle.header.file

from parent project for all plugins?

We need to implement this feature (afaik properties were not inherited
some time ago) before 1.0 goes out.


Michal



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