Skip to content

Commit

Permalink
Move documentation up to parent module
Browse files Browse the repository at this point in the history
  • Loading branch information
adangel committed Oct 3, 2014
1 parent c1c6f71 commit c214c1b
Show file tree
Hide file tree
Showing 69 changed files with 202 additions and 125 deletions.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions pmd-dist/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# PMD Distribution Packages

This is the maven module, which generates the binary and source packages of PMD.
12 changes: 12 additions & 0 deletions pmd-dist/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<project
xmlns="http://maven.apache.org/DECORATION/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd"
name="PMD Distribution">

<body>
<menu ref="parent"/>

</body>
</project>
5 changes: 5 additions & 0 deletions pmd-java/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PMD Java

Contains the PMD implementation to support the Java programming language.

For the available rules, see <a href="rules/index.html">rulesets index</a> page.
23 changes: 23 additions & 0 deletions pmd-java/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<project
xmlns="http://maven.apache.org/DECORATION/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd"
name="PMD Java">

<body>
<menu ref="parent"/>

<!-- The rulesets part of navigation will be added during pre-site and the
list is build dynamically based on rulesets folder directory layout -->


<menu name="Rule Sets"/>


<!-- *********** -->

<menu ref="reports"/>

</body>
</project>
53 changes: 1 addition & 52 deletions pmd/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,51 +59,6 @@
<goal>run</goal>
</goals>
</execution>
<execution>
<id>generate-ruleset-as-xdocs</id>
<phase>pre-site</phase>
<configuration>
<target>
<echo>PMD specific tasks: generating xdocs from rulesets</echo>
<mkdir dir="${project.build.directory}/generated-xdocs/" />
<copy toDir="${project.build.directory}/generated-xdocs/" overwrite="true" verbose="true">
<fileset dir="${src.xdocs.dir}" />
<filterset>
<filter token="VERSION" value="${project.version}" />
</filterset>
</copy>
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
<execution>
<id>move-index-and-delete-generated-xdocs</id>
<phase>pre-site</phase>
<configuration>
<target>
<echo>PMD site specific tasks</echo>
<echo>1. Copying missing images to site directory.</echo>
<copy todir="${project.build.directory}/site/images/">
<fileset dir="${src.xdocs.dir}/images/" includes="**/*.*" />
</copy>
<echo>2. Adding missing text files to site.</echo>
<copy todir="${project.build.directory}/site/">
<fileset dir="${src.xdocs.dir}/" includes="**/*.txt" />
</copy>
<echo>3. Deleting useless generated files.</echo>
<delete quiet="true">
<fileset dir="${src.xdocs.dir}/rules" includes="**/*.xml" />
<fileset dir="${src.xdocs.dir}/" includes="mergedruleset.xml" />
<fileset dir="${project.build.directory}" includes="site/mergedruleset.html" />
</delete>
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
<execution>
<id>pmd-clean</id>
<phase>clean</phase>
Expand Down Expand Up @@ -160,13 +115,6 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<configuration>
<xdocDirectory>${project.build.directory}/generated-xdocs</xdocDirectory>
</configuration>
</plugin>

<plugin>
<groupId>net.sourceforge.pmd</groupId>
Expand All @@ -175,6 +123,7 @@
<rulesetsDirectory>${basedir}/src/main/resources/rulesets</rulesetsDirectory>
<siteXml>${basedir}/src/site/site.pre.xml</siteXml>
<siteXmlTarget>${basedir}/src/site/site.xml</siteXmlTarget>
<target>${basedir}/src/site/xdoc/rules</target>
</configuration>
<executions>
<execution>
Expand Down
3 changes: 3 additions & 0 deletions pmd/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# PMD

Contains the core packages and API needed to implement support for specific languages.
47 changes: 4 additions & 43 deletions pmd/src/site/site.pre.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@

<bannerLeft>
<name>pmd-logo</name>
<src>images/pmd_logo_small.png</src>
<src>../images/pmd_logo_small.png</src>
<href>http://pmd.sourceforge.net/</href>
</bannerLeft>
<bannerRight>
<name>SourceForge</name>
<src>images/sflogo.png</src>
<src>../images/sflogo.png</src>
<href>http://sourceforge.net/</href>
</bannerRight>

Expand All @@ -52,47 +52,8 @@
<item href="http://pmd.sourceforge.net/" name="PMD"/>
</breadcrumbs>

<menu name="Overview">
<item href="https://sourceforge.net/projects/pmd/files/pmd/${version}/" name="Download PMD ${version}"/>
<item href="/changelog.html" name="What's new in PMD ${version}"/>
<item href="/changelog-old.html" name="Previous versions"/>
<item href="/news.html" name="PMD in the news"/>
<item href="/products.html" name="PMD-related products and books"/>
<item href="/bestpractices.html" name="Best practices"/>
<item href="/future.html" name="Future directions"/>
<item href="/similar-projects.html" name="Similar projects"/>
<item href="/credits.html" name="Credits"/>
<item href="/license.html" name="License"/>
<item href="/meaning.html" name="What does 'PMD' mean?"/>
</menu>
<menu name="Usage">
<item href="/installing.html" name="Installation"/>
<item href="/running.html" name="Command line usage"/>
<item href="/ant-task.html" name="Ant task usage"/>
<item href="/maven-plugin.html" name="Maven plugin usage"/>
<item href="/mvn-plugin.html" name="Mvn plugin usage"/>
<item href="/integrations.html" name="IDE plugin usage"/>
<item href="/suppressing.html" name="Suppressing warnings"/>
<item href="/cpd-usage.html" name="Finding duplicated code"/>
<item href="/jspsupport.html" name="JSP support"/>
</menu>
<menu name="Customizing PMD">
<item href="/compiling.html" name="Compiling PMD"/>
<item href="/howtowritearule.html" name="How to write a rule"/>
<item href="/xpathruletutorial.html" name="Writing XPath rules"/>
<item href="/howtomakearuleset.html" name="How to make a rule set"/>
<item href="/howitworks.html" name="How it works"/>
<item href="/rule-guidelines.html" name="Rule guidelines"/>
<item href="/pmd-developer.html" name="PMD developers information"/>
<item href="/pmd-release-process.html" name="PMD Release Process"/>
<item href="/new-language.html" name="New Language"/>
</menu>
<menu name="For example">
<item href="../scoreboard.html" name="Run PMD on a Sourceforge project"/>
</menu>
<menu name="Misc.">
<item href="http://webhostinggeeks.com/science/xpath-sourceforge-ka" name="XPath tutorial (Gregorian)"/>
</menu>
<menu ref="parent"/>

<!-- The rulesets part of navigation will be added during pre-site and the
list is build dynamically based on rulesets folder directory layout -->

Expand Down
Binary file removed pmd/src/site/xdocs/images/pmd-button-animated.gif
Binary file not shown.
Binary file removed pmd/src/site/xdocs/images/pmd-icon-16.gif
Binary file not shown.
Binary file removed pmd/src/site/xdocs/images/pmd-icon-32.gif
Binary file not shown.
Binary file removed pmd/src/site/xdocs/images/pmd-logo.gif
Binary file not shown.
Binary file removed pmd/src/site/xdocs/images/pmd_top_10.png
Binary file not shown.
Binary file removed pmd/src/site/xdocs/images/ultralog.gif
Binary file not shown.
20 changes: 20 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,12 @@
<url>https://github.com/pmd/pmd</url>
<tag>HEAD</tag>
</scm>
<distributionManagement>
<site>
<id>local</id>
<url>file:///tmp/pmd-site</url>
</site>
</distributionManagement>
<organization>
<name>InfoEther</name>
<url>http://pmd.sourceforge.net/</url>
Expand Down Expand Up @@ -425,6 +431,20 @@
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<executions>
<execution>
<id>attach-site-descriptor</id>
<goals>
<goal>attach-descriptor</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

<dependencyManagement>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
Binary file added src/site/resources/images/pmd_logo_small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
101 changes: 101 additions & 0 deletions src/site/site.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="UTF-8"?>
<project
xmlns="http://maven.apache.org/DECORATION/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd"
name="PMD">

<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
</skin>

<custom>
<fluidoSkin>
<topBarEnabled>true</topBarEnabled>
<sideBarEnabled>true</sideBarEnabled>
</fluidoSkin>
</custom>

<bannerLeft>
<name>pmd-logo</name>
<src>images/pmd_logo_small.png</src>
<href>http://pmd.sourceforge.net/</href>
</bannerLeft>
<bannerRight>
<name>SourceForge</name>
<src>images/sflogo.png</src>
<href>http://sourceforge.net/</href>
</bannerRight>

<poweredBy>
<logo name="Maven"
alt="Built by Maven"
href="http://maven.apache.org/"
img="http://maven.apache.org/images/logos/maven-feather.png"/>
<logo name="SourceForge.net"
alt="SourceForge.net. Fast, secure and Free Open Source software downloads"
href="http://sourceforge.net/"
img="http://sflogo.sourceforge.net/sflogo.php?group_id=56262&amp;type=10"
width="80" height="15"/>
</poweredBy>

<body>
<links>
<item href="http://sourceforge.net/projects/pmd" name="SourceForge.net Project Page"/>
<item href="http://sourceforge.net" name="Hosted by SourceForge"/>
</links>

<breadcrumbs>
<item href="http://www.sourceforge.net/" name="SourceForge"/>
<item href="http://pmd.sourceforge.net/" name="PMD"/>
</breadcrumbs>

<menu ref="modules" />

<menu name="Overview">
<item href="https://sourceforge.net/projects/pmd/files/pmd/${version}/" name="Download PMD ${version}"/>
<item href="/overview/changelog.html" name="What's new in PMD ${version}"/>
<item href="/overview/changelog-old.html" name="Previous versions"/>
<item href="/overview/news.html" name="PMD in the news"/>
<item href="/overview/products.html" name="PMD-related products and books"/>
<item href="/overview/bestpractices.html" name="Best practices"/>
<item href="/overview/future.html" name="Future directions"/>
<item href="/overview/similar-projects.html" name="Similar projects"/>
<item href="/overview/credits.html" name="Credits"/>
<item href="/overview/license.html" name="License"/>
<item href="/overview/meaning.html" name="What does 'PMD' mean?"/>
</menu>
<menu name="Usage">
<item href="/usage/installing.html" name="Installation"/>
<item href="/usage/running.html" name="Command line usage"/>
<item href="/usage/ant-task.html" name="Ant task usage"/>
<item href="/usage/maven-plugin.html" name="Maven plugin usage"/>
<item href="/usage/mvn-plugin.html" name="Mvn plugin usage"/>
<item href="/usage/integrations.html" name="IDE plugin usage"/>
<item href="/usage/suppressing.html" name="Suppressing warnings"/>
<item href="/usage/cpd-usage.html" name="Finding duplicated code"/>
<item href="/usage/jspsupport.html" name="JSP support"/>
<item href="/usage/ci-plugins.html" name="CI Plugins"/>
<item href="/usage/faq.html" name="FAQ"/>
</menu>
<menu name="Customizing PMD">
<item href="/customizing/compiling.html" name="Compiling PMD"/>
<item href="/customizing/howtowritearule.html" name="How to write a rule"/>
<item href="/customizing/xpathruletutorial.html" name="Writing XPath rules"/>
<item href="/customizing/howtomakearuleset.html" name="How to make a rule set"/>
<item href="/customizing/howitworks.html" name="How it works"/>
<item href="/customizing/rule-guidelines.html" name="Rule guidelines"/>
<item href="/customizing/pmd-developer.html" name="PMD developers information"/>
<item href="/customizing/pmd-release-process.html" name="PMD Release Process"/>
<item href="/customizing/new-language.html" name="New Language"/>
</menu>
<menu name="For example">
<item href="../scoreboard.html" name="Run PMD on a Sourceforge project"/>
</menu>
<menu name="Misc.">
<item href="http://webhostinggeeks.com/science/xpath-sourceforge-ka" name="XPath tutorial (Gregorian)"/>
</menu>
</body>
</project>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ You'll need to either check out the source code or download the latest source re
<source>
[tom@hal building]$ ls -l
total 5716
-rw-rw-r-- 1 tom tom 5837216 Jul 17 13:09 pmd-src-@VERSION@.zip
[tom@hal building]$ unzip -q pmd-src-@VERSION@.zip
-rw-rw-r-- 1 tom tom 5837216 Jul 17 13:09 pmd-src-${project.version}.zip
[tom@hal building]$ unzip -q pmd-src-${project.version}.zip
[tom@hal building]$
</source>
</p>
<p>
Now cd down into the <code>pmd</code> directory:
<source>
[tom@hal building]$ cd pmd-src-@VERSION@
[tom@hal pmd-src-@VERSION@]$ ls -l | grep pom.xml
[tom@hal building]$ cd pmd-src-${project.version}
[tom@hal pmd-src-${project.version}]$ ls -l | grep pom.xml
-rw-rw-r-- 1 tom tom 29357 Jan 31 20:00 pom.xml
[tom@hal pmd-src-@VERSION@]$
[tom@hal pmd-src-${project.version}]$
</source>
</p>
<p>
That's the project configuration for maven... let's compile!
<source>
[tom@hal pmd-src-@VERSION@]$ mvn clean package
[tom@hal pmd-src-${project.version}]$ mvn clean package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building PMD @VERSION@
[INFO] Building PMD ${project.version}
[INFO] ------------------------------------------------------------------------
[INFO]
...
Expand All @@ -52,15 +52,15 @@ Tests run: 829, Failures: 0, Errors: 0, Skipped: 9

[INFO]
[INFO] --- maven-jar-plugin:2.3.1:jar (default-jar) @ pmd ---
[INFO] Building jar: target/pmd-@VERSION@.jar
[INFO] Building jar: target/pmd-${project.version}.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1:41.062s
[INFO] Finished at: Mon Apr 30 09:36:12 CEST 2012
[INFO] Final Memory: 13M/187M
[INFO] ------------------------------------------------------------------------
[tom@hal pmd-src-@VERSION@]$
[tom@hal pmd-src-${project.version}]$
</source>
</p>
<p>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions pmd/src/site/xdocs/index.xml → src/site/xdoc/index.xml.vm
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
</ul>

<h3>Download</h3>
<p>You can <b><a href="https://sourceforge.net/projects/pmd/files/@VERSION@/">download everything from here</a></b>, and you can get an overview of all the rules at the <a href="rules/index.html">rulesets index</a> page.</p>
<p>You can <b><a href="https://sourceforge.net/projects/pmd/files/${project.version}/">download everything from here</a></b>, and you can get an overview of all the rules at the <a href="rules/index.html">rulesets index</a> page.</p>
<p>PMD is <a href="integrations.html">integrated</a> with JDeveloper, Eclipse, JEdit, JBuilder, BlueJ, CodeGuide, NetBeans/Sun Java Studio Enterprise/Creator, IntelliJ IDEA, TextPad, Maven, Ant, Gel, JCreator, and Emacs.</p>

<h3>Changelog</h3>
<ul>
<li>See <a href="changelog.html">What's new in PMD @VERSION@</a></li>
<li>See <a href="changelog.html">What's new in PMD ${project.version}</a></li>
<li>Older versions: <a href="changelog-old.html">Old Changelogs</a></li>
</ul>

Expand Down
File renamed without changes.
Loading

0 comments on commit c214c1b

Please sign in to comment.