Hi !
As committed into the Changes_v1_1 file, here's some info about Maven
and how to build a DbForms / Maven web site...
--- --- ---
started the "Mavenization" process for the the current DbForms web site.
See http://jakarta.apache.org/turbine/maven/ for further informations
about theJakarta Turbine-Maven project.
- started the porting of the actual web site documentation to the xdoc
format;
- added the "site.xml" ant build file that can be used to build a
preview of the "xdoc documentation" - Maven "site:generate" target is
quite an heavy beast !! ;^)
SITE PREVIEW
------------
To generate a *preview* of the web site documentation, follow those steps:
> cd $DBFORMS_HOME
$DBFORMS_HOME > ant -buildfile site.xml
Ant will build the $DBFORMS_HOME/xdocs_target directory; it will
contains the new html documentation that uses the "jakarta-site2" look
http://jakarta.apache.org/site/jakarta-site2.html
MAVEN SITE GENERATION
---------------------
a) get and install the latest Turbine-Maven distribuition
http://jakarta.apache.org/turbine/maven/
b.0) put $MAVEN_HOME/bin directory into your system PATH;
b.1) put your cvs.exe client program into your system PATH;
c) > cd $DBFORMS_HOME
$DBFORMS_HOME > maven site:generate
d) wait a bit... ;^)
A successfull Maven build process creates the $DBFORMS_HOME/target/docs
directory; to view the new site load the
$DBFORMS_HOME/target/docs/index.html file into your web browser.
WIN32: MAVEN CVS operations on SourceForge and SSH
--------------------------------------------------
To generate some "Project Reports" tasks (i.e.: ChangeLog, Developer
Activity, etc), your CVS client must get a connection to the
SourceForge's CVS server. If you are a developer with CVS access,
probably you have got a SSH cvs access - and you want to use it ! ;^).
To let Maven access to SourceForge's CVS using an SSH connection on
win32 platforms, you could:
- use the Putty package
http://www.chiark.greenend.org.uk/~sgtatham/putty/
- set the CVS_RSH env var to:
<my_path_to_putty_directory>\plink.exe
Example:
CVS_RSH = D:\progs\putty\plink.exe
That's all !
MAVEN changes report
--------------------
Maven can generate a nice changes report for DbForms.
Here's the plugin's doc:
http://jakarta.apache.org/turbine/maven/reference/plugins/xdoc/changes-report.html
I put a $DBFORMS_HOME/xdocs/changes.xml "empty example" that can be
arranged and extended to generate the related page.
TO DO LIST
----------
- finish to port the site documentation to xdocs format;
- fill the project.xml file descriptor with all the developers informations;
- decide the links of the left menu' of the Maven web site, avoiding
duplications with Maven's custom links (i.e.: javadocs, cvs info, etc);
- add other useful links, as:
- powered by
- developers' nice faces ;^)
- etc
- get the integration with a working Docbook plugin !! ;^)
Regards,
Luca
-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com
_______________________________________________
DbForms Mailing List
http://www.wap-force.net/dbforms
