You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2006/11/01 14:07:02 UTC
svn commit: r469896 - in /maven/jxr/trunk: pom.xml src/site/apt/examples/
src/site/apt/examples/java.apt src/site/apt/index.apt
src/site/apt/links.apt src/site/fml/ src/site/fml/faq.fml
src/site/resources/ src/site/site.xml
Author: vsiveton
Date: Wed Nov 1 05:07:01 2006
New Revision: 469896
URL: http://svn.apache.org/viewvc?view=rev&rev=469896
Log:
JXR-19: More info on the website
o added documentation and examples
o removed unused resources and updated the navigation
o Updated pom:
- bumped to maven-parent:4
- review ML
- using maven-site-plugin:2.0-beta-5
Added:
maven/jxr/trunk/src/site/apt/examples/
maven/jxr/trunk/src/site/apt/examples/java.apt (with props)
maven/jxr/trunk/src/site/apt/links.apt (with props)
maven/jxr/trunk/src/site/fml/
maven/jxr/trunk/src/site/fml/faq.fml (with props)
Removed:
maven/jxr/trunk/src/site/resources/
Modified:
maven/jxr/trunk/pom.xml
maven/jxr/trunk/src/site/apt/index.apt
maven/jxr/trunk/src/site/site.xml
Modified: maven/jxr/trunk/pom.xml
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/pom.xml?view=diff&rev=469896&r1=469895&r2=469896
==============================================================================
--- maven/jxr/trunk/pom.xml (original)
+++ maven/jxr/trunk/pom.xml Wed Nov 1 05:07:01 2006
@@ -1,11 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ ~ Copyright 2004-2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.maven</groupId>
<artifactId>maven-parent</artifactId>
- <version>1</version>
+ <version>4</version>
<relativePath>../pom/maven/pom.xml</relativePath>
</parent>
<groupId>org.apache.maven</groupId>
@@ -14,17 +31,45 @@
<version>1.1-SNAPSHOT</version>
<description>Source cross reference library</description>
<url>http://maven.apache.org/jxr/</url>
+
<issueManagement>
<system>jira</system>
<url>http://jira.codehaus.org/browse/JXR</url>
</issueManagement>
+
+ <scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/maven/jxr/trunk</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/maven/jxr/trunk</developerConnection>
+ <url>http://svn.apache.org/viewvc/maven/jxr/trunk/</url>
+ </scm>
+
+ <distributionManagement>
+ <site>
+ <id>apache.website</id>
+ <url>scp://minotaur.apache.org/www/maven.apache.org/jxr/</url>
+ </site>
+ </distributionManagement>
+
+ <contributors>
+ <contributor>
+ <name>Fabrice Bellingard</name>
+ <email>bellingard@gmail.com</email>
+ <timezone>+1</timezone>
+ </contributor>
+ </contributors>
+
<mailingLists>
+ <!-- duplication from components - temporary until the site layout is clearer -->
<mailingList>
<name>Maven User List</name>
<subscribe>users-subscribe@maven.apache.org</subscribe>
<unsubscribe>users-unsubscribe@maven.apache.org</unsubscribe>
<post>users@maven.apache.org</post>
<archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
+ <otherArchives>
+ <otherArchive>http://www.mail-archive.com/users@maven.apache.org/</otherArchive>
+ <otherArchive>http://www.nabble.com/Maven---Users-f178.html</otherArchive>
+ </otherArchives>
</mailingList>
<mailingList>
<name>Maven Developer List</name>
@@ -33,19 +78,37 @@
<post>dev@maven.apache.org</post>
<archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
</mailingList>
+ <mailingList>
+ <name>Maven Commits List</name>
+ <subscribe>commits-subscribe@maven.apache.org</subscribe>
+ <unsubscribe>commits-unsubscribe@maven.apache.org</unsubscribe>
+ <post>commits@maven.apache.org</post>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
+ </mailingList>
+ <!-- duplication from parent pom - temporary until they inherit properly -->
+ <mailingList>
+ <name>Maven Announcements List</name>
+ <post>announce@maven.apache.org</post>
+ <subscribe>announce-subscribe@maven.apache.org</subscribe>
+ <unsubscribe>announce-unsubscribe@maven.apache.org</unsubscribe>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-announce/</archive>
+ </mailingList>
+ <mailingList>
+ <name>Maven Issues List</name>
+ <post>issues@maven.apache.org</post>
+ <subscribe>issues-subscribe@maven.apache.org</subscribe>
+ <unsubscribe>issues-unsubscribe@maven.apache.org</unsubscribe>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-issues/</archive>
+ </mailingList>
+ <mailingList>
+ <name>Maven Notifications List</name>
+ <post>notifications@maven.apache.org</post>
+ <subscribe>notifications-subscribe@maven.apache.org</subscribe>
+ <unsubscribe>notifications-unsubscribe@maven.apache.org</unsubscribe>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-notifications/</archive>
+ </mailingList>
</mailingLists>
- <contributors>
- <contributor>
- <name>Fabrice Bellingard</name>
- <email>bellingard@gmail.com</email>
- <timezone>+1</timezone>
- </contributor>
- </contributors>
- <scm>
- <connection>scm:svn:http://svn.apache.org/repos/asf/maven/jxr/trunk</connection>
- <developerConnection>scm:svn:http://svn.apache.org/repos/asf/maven/jxr/trunk</developerConnection>
- <url>http://svn.apache.org/viewcvs.cgi/maven/jxr/trunk</url>
- </scm>
+
<dependencies>
<dependency>
<groupId>junit</groupId>
@@ -75,10 +138,13 @@
<version>1.4</version>
</dependency>
</dependencies>
- <distributionManagement>
- <site>
- <id>website</id>
- <url>scpexe://minotaur.apache.org/www/maven.apache.org/jxr/</url>
- </site>
- </distributionManagement>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.0-beta-5</version>
+ </plugin>
+ </plugins>
+ </build>
</project>
Added: maven/jxr/trunk/src/site/apt/examples/java.apt
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/src/site/apt/examples/java.apt?view=auto&rev=469896
==============================================================================
--- maven/jxr/trunk/src/site/apt/examples/java.apt (added)
+++ maven/jxr/trunk/src/site/apt/examples/java.apt Wed Nov 1 05:07:01 2006
@@ -0,0 +1,73 @@
+ ------
+ Maven JXR - Using in Java
+ ------
+ Vincent Siveton
+ ------
+ October 2006
+ ------
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Using Maven JXR in Java
+
+ The cross-referencing API is pretty basic. You could generate xref for a given Java package or single Java source
+ class. The whole generated file is xref'd by line number.
+
+* Transforming Java Packages
+
+ JXR handles several options like an input/output encoding. See the {{{../apidocs/org/apache/maven/jxr/JXR.html}API}}
+ for more informations.
+
++------+
+JXR jxr = new JXR();
+jxr.setDest( "/target/jxr" );
+jxr.setLog( new DummyLog() );
+
+jxr.xref( Collections.singletonList( "/src/main/java/" ), "templateDir",
+ "WindowsTitle", "DocTitle", "Bottom" );
++------+
+
+ <<Note>>: the <templateDir> is a directory with several {{{http://jakarta.apache.org/velocity/}Velocity}} templates.
+ Maven JXR uses its own {{{https://svn.apache.org/repos/asf/maven/jxr/trunk/src/main/resources/templates}templates}}.
+
+ The generated JXR structure should be like the following:
+
++------+
+/target/jxr
+ |- allclasses-frame.html
+ |- index.html
+ |- overview-frame.html
+ |- overview-summary.html
+ ...
++------+
+
+* Transforming Single Java Source File
+
+ You could transform a single Java source file with the following:
+
++------+
+File sourceFile = new File( "/src/main/java/Test.java" );
+
+PackageManager packageManager = new PackageManager( new DummyLog(),
+ new FileManager() );
+JavaCodeTransform codeTransform = new JavaCodeTransform( packageManager );
+
+codeTransform.transform( sourceFile.getAbsolutePath(), "/target/jxr/Test.html",
+ Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "" );
++------+
Propchange: maven/jxr/trunk/src/site/apt/examples/java.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/jxr/trunk/src/site/apt/examples/java.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/jxr/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/src/site/apt/index.apt?view=diff&rev=469896&r1=469895&r2=469896
==============================================================================
--- maven/jxr/trunk/src/site/apt/index.apt (original)
+++ maven/jxr/trunk/src/site/apt/index.apt Wed Nov 1 05:07:01 2006
@@ -2,10 +2,42 @@
Maven JXR
------
Jason van Zyl
+ Vincent Siveton
------
- 25 October 2005
+ October 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
Maven JXR
- JXR is a source cross referencing tool.
+ JXR is a source cross reference generator. It analyzes a set of Java source files and produce HTML files
+ that shows annotated source code.
+
+ Take a look at the {{{xref/index.html}JXR report}} to see a result.
+
+ The orignal JXR code was merged in 2004 with the Javasrc project from
+ {{{http://jakarta.apache.org/alexandria}Jakarta Alexandria}} project.
+
+* Examples
+
+ The following example show how to use Maven JXR in more advanced usecases:
+
+ * {{{examples/java.html}Using Maven JXR in Java}}
+
Added: maven/jxr/trunk/src/site/apt/links.apt
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/src/site/apt/links.apt?view=auto&rev=469896
==============================================================================
--- maven/jxr/trunk/src/site/apt/links.apt (added)
+++ maven/jxr/trunk/src/site/apt/links.apt Wed Nov 1 05:07:01 2006
@@ -0,0 +1,41 @@
+ ------
+ Maven JXR - Further Links
+ ------
+ Vincent Siveton
+ ------
+ October 2006
+ ------
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Further Links
+
+* Articles
+
+ * {{{http://java.sun.com/developer/technicalArticles/J2SE/xref/}Cross-Referencing HTML the Tiger Way}}
+
+* Related Softwares
+
+ * {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linksource}Javadoc linksource option}}:
+ Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML
+ documentation.
+
+ * {{{https://sorcerer.dev.java.net/}Sorcerer}}: Sorcerer is a source code cross reference generator for JDK 6.
+
+ * {{{http://www.java2html.de/}Java2html}}: Java2Html converts Java source code to HTML, RTF, TeX and XHTML.
Propchange: maven/jxr/trunk/src/site/apt/links.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/jxr/trunk/src/site/apt/links.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/jxr/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/src/site/fml/faq.fml?view=auto&rev=469896
==============================================================================
--- maven/jxr/trunk/src/site/fml/faq.fml (added)
+++ maven/jxr/trunk/src/site/fml/faq.fml Wed Nov 1 05:07:01 2006
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="Is it possible to convert other source files that Java to HTML">
+ <question>Is it possible to convert other source files that Java to HTML?</question>
+ <answer>
+ <p>
+ Not yet but it is on the roadmap.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Propchange: maven/jxr/trunk/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/jxr/trunk/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/jxr/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/src/site/site.xml?view=diff&rev=469896&r1=469895&r2=469896
==============================================================================
--- maven/jxr/trunk/src/site/site.xml (original)
+++ maven/jxr/trunk/src/site/site.xml Wed Nov 1 05:07:01 2006
@@ -1,23 +1,81 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
<project name="JXR">
<bannerLeft>
<name>JXR</name>
- <src>http://maven.apache.org/maven2/images/apache-maven-project-2.png</src>
+ <src>http://maven.apache.org/images/apache-maven-project-2.png</src>
<href>http://maven.apache.org/jxr</href>
</bannerLeft>
<bannerRight>
- <src>http://maven.apache.org/maven2/images/maven-logo-2.gif</src>
+ <src>http://maven.apache.org/images/maven-logo-2.gif</src>
</bannerRight>
+ <publishDate format="dd MMM yyyy" />
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-stylus-skin</artifactId>
+ </skin>
<body>
<links>
<item name="Apache" href="http://www.apache.org/"/>
<item name="Maven 1.x" href="http://maven.apache.org/maven-1.x"/>
<item name="Maven 2.x" href="http://maven.apache.org/"/>
+ <item name="Archiva" href="http://maven.apache.org/archiva"/>
<item name="Continuum" href="http://maven.apache.org/continuum"/>
<item name="SCM" href="http://maven.apache.org/scm"/>
<item name="Wagon" href="http://maven.apache.org/wagon"/>
<item name="JXR" href="http://maven.apache.org/jxr"/>
+ <item name="Doxia" href="http://maven.apache.org/doxia"/>
</links>
+
+ <head>
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+ </script>
+ <script type="text/javascript">
+ _uacct = "UA-140879-1";
+ urchinTracker();
+ function expand( item ) {
+ var expandIt = document.getElementById( item );
+ if( expandIt.style.display == "block" ) {
+ expandIt.style.display = "none";
+ expandIt.parentNode.className = "collapsed";
+ } else {
+ expandIt.style.display = "block";
+ expandIt.parentNode.className = "expanded";
+ }
+ }
+ </script>
+ </head>
+
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="FAQ" href="faq.html"/>
+ <item name="Further Links" href="links.html"/>
+ </menu>
+
+ <menu name="Maven plugins">
+ <item name="Maven 1" href="http://maven.apache.org/maven-1.x/plugins/jxr/"/>
+ <item name="Maven 2" href="http://maven.apache.org/plugins/maven-jxr-plugin/"/>
+ </menu>
+
+ <menu name="Examples">
+ <item name="Using Maven JXR in Java" href="/examples/java.html"/>
+ </menu>
${reports}
</body>
</project>