svn commit: r1424016 [1/3] - in /isis/site/trunk/content: contributors/recreating-the-applib-docs.md core/guides/ core/guides/isis-applib.html core/guides/isis-applib.pdf documentation.md

[da...@apache.org]

Author: danhaywood
Date: Wed Dec 19 18:41:18 2012
New Revision: 1424016

URL: http://svn.apache.org/viewvc?rev=1424016&view=rev
Log:
isis site - uploading applib guides

Added:
    isis/site/trunk/content/contributors/recreating-the-applib-docs.md
    isis/site/trunk/content/core/guides/
    isis/site/trunk/content/core/guides/isis-applib.html
    isis/site/trunk/content/core/guides/isis-applib.pdf   (with props)
Modified:
    isis/site/trunk/content/documentation.md

Added: isis/site/trunk/content/contributors/recreating-the-applib-docs.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/recreating-the-applib-docs.md?rev=1424016&view=auto
==============================================================================
--- isis/site/trunk/content/contributors/recreating-the-applib-docs.md (added)
+++ isis/site/trunk/content/contributors/recreating-the-applib-docs.md Wed Dec 19 18:41:18 2012
@@ -0,0 +1,71 @@
+Title: Recreating the Applib Documentation
+
+
+
+
+### Prerequisites
+
+Apache Isis currently use the JIMI jar to generate documentation. Previously this file was hosted at Sun's [Jimi page](http://java.sun.com/products/jimi/), however since Oracle's acquisition the download is somewhat more difficult to locate.
+
+Once you have downloaded the file (`jimi_1.0.jar`), unzip it and locate in turn the `JimiProClasses.zip` file.  This is the JAR that needs to be installed. Make a note of its location.
+
+To install into your local Maven repository, use:
+
+<pre>
+mvn install:install-file       \
+    -D groupId=com.java        \
+    -D artifactId=jimi         \
+    -D version=1.0             \
+    -D packaging=jar           \
+    -D file=/path/to/JimiProClasses.zip
+</pre>
+
+### Generate documentation
+
+In the following instructions:
+
+* `$SITE` represents the directory where the [site's `trunk` directory](https://svn.apache.org/repos/asf/isis/site/trunk) has been checked out to.
+* `$CODE` represents the directory where the [Isis codebase](https://git.apache.org/repos/asf/isis.git) has been cloned to.
+
+
+To generate the documentation:
+<pre>
+cd $CODE/core/applib
+mvn clean docbkx:generate-html docbkx:generate-pdf
+</pre>
+
+Copy over to the site:
+<pre>
+cp target/docbkx/html/guide/isis-applib.html $SITE/content/core/guides/.
+cp target/docbkx/pdf/isis-applib.pdf         $SITE/content/core/guides/.
+</pre>
+
+<!--
+<pre>
+cd $SITE/core/applib/docs
+touch nowfile
+cp -R $CODE/core/applib/target/... .
+</pre>
+
+Check any new files into the site:
+<pre>
+svn add `svn st | grep ^? | awk '{print $2}'`
+</pre>
+
+
+Remove files that haven't been updated
+
+<pre>
+ls -lrt `find . -type f -not -newer nowfile` >/tmp/x
+for a in `cat /tmp/x`; do
+    svn info $a >/dev/null 2>&1
+    if [ $? == 0 ]; then
+        svn delete $a
+    fi
+done
+</pre>
+
+<pre>
+rm nowfile
+</pre>
+-->
\ No newline at end of file