Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Pig Wiki" for change 
notification.

The following page has been changed by CorinneC:
http://wiki.apache.org/pig/HowToDocumentation

------------------------------------------------------------------------------
  == Forrest Files ==
  
  Forrest includes these files that you can modify for the Pig website docs or 
Pig user docs:
-    * forrest.properties – add plugins and set other properties here
+    * /src/docs/'''forrest.properties''' – add plugins and set other 
properties here
-    * skinconf.xml – add CSS style changes and set other switches here
+    * /src/docs/src/documentation/'''skinconf.xml''' – add CSS style changes 
and set other switches here
-    * site.xml – add or remove *.xml docs files here; controls which 
documents appear in the menu
+    * /src/docs/src/documentation//content/xdocs/'''site.xml''' – add or 
remove *.xml docs files here; controls which documents appear in the menu
-    * tab.xml – add or remove tabs here; controls which tabs appear on each 
page
+    * /src/docs/src/documentation//content/xdocs/'''tabs.xml''' – add or 
remove tabs here; controls which tabs appear on each page
  
  '''Note:''' Some *.xml files in the Pig user docs require the Forrest 
simplified Docbook plugin. In the forrest.properties file, the plugin entry has 
been updated to include the Docbook plugin: 
project.required.plugins=org.apache.forrest.plugin.output.pdf,org.apache.forrest.plugin.input.simplifiedDocbook
  
@@ -39, +39 @@

  
  To build the website doc using forrest:
     * Change to the directory that includes the forrest.properties file: 
site/author
-    * Run the "forrest" command (if the build fails due to broken links, the 
*.html/*.pdf files will still be generated).
+    * Run the "forrest" command (if the build fails due to broken links, the 
*.html and *.pdf ouptut will still be generated).
     * To check the *.html and *.pdf output, move to this output directory: 
/publish
  
  
@@ -59, +59 @@

  
  To build the user docs using forrest:
     * Change to the directory that includes the forrest.properties file: 
/trunk/scr/docs
-    * Run the "forrest" command (if the build fails due to broken links, the 
*.html/*.pdf files will still be generated).
+    * Run the "forrest" command (if the build fails due to broken links, the 
*.html and *.pdf ouptut will still be generated).
     * To check the *.html and *.pdf output, move to this directory : 
/trunk/scr/docs/build/site
  
  To build the user docs using ant:
     * Change to the top directory of your structure: /trunk
-    * Run the "ant docs" command
+    * Run the "ant docs" command: ant docs -Djava5.home=''java5_path'' 
-Dforrest.home=''forrest_path''
     * To check the *.html and *.pdf output, change to this directory: 
/trunk/docs
  

Reply via email to