geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hcun...@apache.org
Subject svn commit: r569621 - /geronimo/site/trunk/JavaDoc.readme
Date Sat, 25 Aug 2007 05:02:33 GMT
Author: hcunico
Date: Fri Aug 24 22:02:32 2007
New Revision: 569621

URL: http://svn.apache.org/viewvc?rev=569621&view=rev
Log:
added instructions for generating and updating the javadocs.

Added:
    geronimo/site/trunk/JavaDoc.readme

Added: geronimo/site/trunk/JavaDoc.readme
URL: http://svn.apache.org/viewvc/geronimo/site/trunk/JavaDoc.readme?rev=569621&view=auto
==============================================================================
--- geronimo/site/trunk/JavaDoc.readme (added)
+++ geronimo/site/trunk/JavaDoc.readme Fri Aug 24 22:02:32 2007
@@ -0,0 +1,124 @@
+			How to generate the JavaDocs with Maven 2
+			=========================================
+
+This process is to be repeated on every major release to generate a full new set of javadocs.
+
+
+1.- Checkout the "tag" you want to generate the javadocs from, for example
+
+	svn co https://svn.apache.org/repos/asf/geronimo/server/tags/2.0.1/  /Apache/tags-2.0.1
+
+2.- Create a style sheet file with the following content, for example /Apache/apidocs.css
+
+	/* Page background color */
+	body { background-color: #FFFFFF; font-family: Helvetica, Arial, sans-serif; }
+
+	/* Link colors */
+	A:link, A:visited, A:active, A:hover { color: #003366; }
+
+	/* Headings */
+	h1 { font-size: 20px; }
+	h2 { font-size: 18px; }
+	h3 { font-size: 14px; }
+	h4 { font-size: 12px; }
+
+	/* Table colors */
+	.TableHeadingColor     { background: #5FA3D6 } /* Light Blue	*/
+	.TableSubHeadingColor  { background: #F0F0F0 } /* Grey		*/
+	.TableRowColor         { background: #F3F4F5 } /* Lighter Grey	*/
+
+
+	/* Font used in left-hand frame lists */
+	.FrameTitleFont   { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
+	.FrameHeadingFont { font-size:  90%; font-family: Helvetica, Arial, sans-serif }
+	.FrameItemFont    { font-size:  90%; font-family: Helvetica, Arial, sans-serif }
+
+	/* Navigation bar fonts and colors */
+	.NavBarCell1    { background-color:#F3F4F5;} /* Lighter Grey	*/
+	.NavBarCell1Rev { background-color:#5FA3D6;} /* Light Blue	*/
+	.NavBarFont1    { font-family: Arial, Helvetica, sans-serif; color:#000000;}
+	.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
+
+	.NavBarCell2    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+	.NavBarCell3    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+
+
+3.- Generate javadocs with Maven 2 using the following command from the "tags/x.y.z" directory.
+    For example:
+  
+	/Apache/tags-2.0.1/>mvn javadoc:javadoc -Daggregate=true -Dstylesheetfile="/Apache/apidocs.css"
+
+4.- The previous command will generate a "target/site/apidocs" directory with all the generated
HTML javadocs.
+    On this directory create a "header.html" file with the following content.
+
+	<HTML>
+	<HEAD>
+	    <LINK type="text/css" rel="stylesheet" href="http://geronimo.apache.org/style/default.css">
+	    <LINK rel="SHORTCUT ICON" href="http://geronimo.apache.org/images/favicon.ico">
  
+	    <META http-equiv="Content-Type" content="text/html;charset=UTF-8">
+	</HEAD>
+	<BODY>
+	    <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://geronimo.apache.org/images/header_bg_1x86.gif">
+		<TR>
+		    <TD valing="top" align="left"><A href="http://geronimo.apache.org/" target="_top"><IMG
src="http://geronimo.apache.org/images/topleft_logo_437x64.gif" border="0"></A></TD>
+		    <TD width="100%">&nbsp;</TD><TD valign="bottom"></TD>
+		</TR>
+	    </TABLE>
+	    <TABLE border="0" cellpadding="2" cellspacing="0" width="100%">
+		<TR class="topBar">
+		    <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%">&nbsp;<A
href="http://geronimo.apache.org" title="Apache Geronimo" target="_top">Apache Geronimo</A></TD>
+		    <TD align="left" valign="middle" class="topBarDiv" nowrap="true"><A href="http://www.nabble.com/Apache-Geronimo---Users-f135.html"
target="_top">User List</A> | <A href="http://www.nabble.com/Apache-Geronimo---Dev-f136.html"
target="_top">Dev List</A> | <A href="http://cwiki.apache.org/geronimo" target="_top">Wiki</A>
| <A href="http://issues.apache.org/jira/browse/GERONIMO" target="_top">Issue Tracker</A>&nbsp;&nbsp;</TD>
+		</TR>
+	    </TABLE>
+	</BODY>
+	</HTML>
+
+5.- Modify the "index.html" frameset to include the header.html you just created. Here is
an example.
+
+	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
+	<!--NewPage-->
+	<HTML>
+	<HEAD>
+	<!-- Generated by javadoc on Fri Aug 24 14:10:17 EDT 2007-->
+	    <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+	    <TITLE>Geronimo 2.0.1 API</TITLE>
+	    <SCRIPT type="text/javascript">
+		targetPage = "" + window.location.search;
+		if (targetPage != "" && targetPage != "undefined")
+		   targetPage = targetPage.substring(1);
+		function loadFrames() {
+		    if (targetPage != "" && targetPage != "undefined")
+			 top.classFrame.location = top.targetPage;
+		}
+	    </SCRIPT>
+	    <NOSCRIPT>
+	    </NOSCRIPT>
+	</HEAD>
+	<FRAMESET rows="84px,*"frameborder="0" scrolling="no">
+	    <FRAME src="header.html" >
+	    <FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()">
+	    <FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()">
+		<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages">
+		<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces
(except non-static nested types)">
+	    </FRAMESET>
+	    <FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface
descriptions" scrolling="yes">
+	</FRAMESET>
+	<NOFRAMES>
+	<H2>
+	Frame Alert</H2>
+
+	<P>
+	This document is designed to be viewed using the frames feature. If you see this message,
you are using a non-frame-capable web client.
+	<BR>
+	Link to<A HREF="overview-summary.html">Non-frame version.</A>
+	</NOFRAMES>
+	</FRAMESET>
+	</HTML>
+
+6.- Create new directory on site trunk to these docs, for example:
+
+	/geronimo/site/trunk/docs/apidocs/2.0.1
+	
+    and copy the javadocs you just created there.
+
+7.- Do an svn add of all those files and directories and then commit the changes.
\ No newline at end of file



Mime
View raw message