You are viewing a plain text version of this content. The canonical link for it is here.

Posted to users@maven.apache.org by Randall Fidler <ra...@testadvantage.com> on 2007/10/09 18:46:45 UTC

Where to put documents

Hello,

 

            Looking at the standard Maven directory layout
(http://maven.apache.org/guides/introduction/introduction-to-the-standar
d-directory-layout.html) I'm curious if there's a place to incorporate
non-source application documents, misc. flow diagrams for example.  I
would think that mapping them into /docs, as opposed to /src, would be
fine but if Maven has some pre-defined place for it and subsequently
that location feeds some plug-in or process, then I'd like to start out
on the right foot.

 

Thanks,

 

Randall

RE: Where to put documents

Posted by Randall Fidler <ra...@testadvantage.com>.

Thanks Sean... that seems to make sense.

Regards,

Randall

-----Original Message-----
From: Sean Hennessy [mailto:shennessy@astutenetworks.com] 
Sent: Tuesday, October 09, 2007 12:45 PM
To: Maven Users List
Subject: RE: Where to put documents

Hi Randal,

Given command line <command>mvn site</command>
and in the pom.xml there exists a pre-site phase to move/generate
proj.mgmt artifacts..
<!-- ==== snip pom.xml ===== -->
      <plugin>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
          <execution>
            <phase>pre-site</phase>
            <configuration>
<!-- ==== end snip pom.xml ===== -->

we place proj. mgt. artifacts in src/site/resources/yourProjDocs
they will find a home under target/site/yourProjDocs.

having made the corresponding changes to site.xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="yourProj WebPage">
  <bannerLeft>
    <name>yourProj</name>
    <src>./yourProjDocs/images/yourProjLogo.jpg</src>
    <href>http://yourProj.com/</href>
  </bannerLeft>
  <bannerRight>
    <src>./yourProjDocs/images/yourProjLogo2.jpg</src>
  </bannerRight>
   <!-- left navigation menu -->
    <menu name="1.0 Documentation">
      <item name="1.1 yourProjDocs" href="index.html" collapse="true" >
       <item name="1.1.1 SDP" href="./yourProjDocs/SDP.html"/>
       <item name="1.1.2 WBS" href="./yourProjDocs/WBS.html"/>
      </item>
      <item name="1.2 Work In Progress" href="index.html"
collapse="true" >
       <item name="1.2.1 Taking over the world"
href="./yourProjDocs/AllYouNeedIsLove.html" />
      </item>
    </menu>
	<!-- ${reports} -->

  </body>
</project>

Regards,
Sean

-----Original Message-----
From: Randall Fidler [mailto:randall.fidler@testadvantage.com] 
Sent: Tuesday, October 09, 2007 9:47 AM
To: users@maven.apache.org
Subject: Where to put documents


Hello,

 

            Looking at the standard Maven directory layout
(http://maven.apache.org/guides/introduction/introduction-to-the-standar
d-directory-layout.html) I'm curious if there's a place to incorporate
non-source application documents, misc. flow diagrams for example.  I
would think that mapping them into /docs, as opposed to /src, would be
fine but if Maven has some pre-defined place for it and subsequently
that location feeds some plug-in or process, then I'd like to start out
on the right foot.

 

Thanks,

 

Randall


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


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

RE: Where to put documents

Posted by Sean Hennessy <sh...@astutenetworks.com>.

Hi Randal,

Given command line <command>mvn site</command>
and in the pom.xml there exists a pre-site phase to move/generate
proj.mgmt artifacts..
<!-- ==== snip pom.xml ===== -->
      <plugin>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
          <execution>
            <phase>pre-site</phase>
            <configuration>
<!-- ==== end snip pom.xml ===== -->

we place proj. mgt. artifacts in src/site/resources/yourProjDocs
they will find a home under target/site/yourProjDocs.

having made the corresponding changes to site.xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="yourProj WebPage">
  <bannerLeft>
    <name>yourProj</name>
    <src>./yourProjDocs/images/yourProjLogo.jpg</src>
    <href>http://yourProj.com/</href>
  </bannerLeft>
  <bannerRight>
    <src>./yourProjDocs/images/yourProjLogo2.jpg</src>
  </bannerRight>
   <!-- left navigation menu -->
    <menu name="1.0 Documentation">
      <item name="1.1 yourProjDocs" href="index.html" collapse="true" >
       <item name="1.1.1 SDP" href="./yourProjDocs/SDP.html"/>
       <item name="1.1.2 WBS" href="./yourProjDocs/WBS.html"/>
      </item>
      <item name="1.2 Work In Progress" href="index.html"
collapse="true" >
       <item name="1.2.1 Taking over the world"
href="./yourProjDocs/AllYouNeedIsLove.html" />
      </item>
    </menu>
	<!-- ${reports} -->

  </body>
</project>

Regards,
Sean

-----Original Message-----
From: Randall Fidler [mailto:randall.fidler@testadvantage.com] 
Sent: Tuesday, October 09, 2007 9:47 AM
To: users@maven.apache.org
Subject: Where to put documents


Hello,

 

            Looking at the standard Maven directory layout
(http://maven.apache.org/guides/introduction/introduction-to-the-standar
d-directory-layout.html) I'm curious if there's a place to incorporate
non-source application documents, misc. flow diagrams for example.  I
would think that mapping them into /docs, as opposed to /src, would be
fine but if Maven has some pre-defined place for it and subsequently
that location feeds some plug-in or process, then I'd like to start out
on the right foot.

 

Thanks,

 

Randall


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