Views

Converting Jajuk Manual wiki pages to raw HTML for JavaHelp

Contents

This section describes how to convert the current wiki pages of the Jajuk Manual to raw HTML, then to build JavaHelp package and finally how to commit the JavaHelp file to the SVN.

Remember: the manual (either the branch trunk or maintenance) is made with the current version of the manual pages in this wiki, they both share the same source to build the manual. Be careful to not rebuild the manual for the maintenance branch if a lot of changes have been made to the wiki and consequently are not related to the maintenance.

The following needs to be done on the Jajuk server:

[edit]

STEP 1: Are SVN Pictures in the wiki?

Make sure you have all the SVN pictures in the wiki. You can use Generating images list for the wiki to check (e.g.: Icons list 1.6 for Jajuk 1.6). Use Upload SVN pictures into the wiki to upload missing pictures.

[edit]

STEP 2: To convert the manual wiki pages to html

01_wiki2html_and_commit.sh will download the wiki pages of the manual, convert them to html and commit everything to the SVN.

  • Note: Tip of the day will be generated using text in Tip of the day and then be committed in SVN file /main/java/org/jajuk/i18n/jajuk.properties
  • You must do step 1 first, Use Upload SVN pictures into the wiki to upload missing pictures.
  • Look at the top of the file and check the configuration (specially trunk and maintenance path)

Example: 

cd /svn-jajuk
./01_wiki2html_and_commit.sh trunk default
[edit]

STEP 3: To build the JavaHelp manual

04_build_javahelp_and_commit.sh will build the JavaHelp manual using the ant script and upload the javahelp file to the SVN.

  • Look at the top of the file and check the configuration (specially trunk and maintenance path)
  • Make sure you have the last SVN tree

Example: 

cd /svn-jajuk
./02_get_last-svn.sh
./04_build_javahelp_and_commit.sh trunk default


[edit]

Other examples

  • to wiki2html and build the trunk fr manual: 
./01_wiki2html_and_commit.sh trunk fr
./02_get_last-svn.sh
./04_build_javahelp_and_commit.sh trunk fr
  • to wiki2html and build the maintenance default manual: 
./01_wiki2html_and_commit.sh maintenance default
./02_get_last-svn.sh
./04_build_javahelp_and_commit.sh maintenance default
  • to wiki2html and build the maintenance fr manual: 
./01_wiki2html_and_commit.sh maintenance fr
./02_get_last-svn.sh
./04_build_javahelp_and_commit.sh maintenance fr


[edit]

See also

Retrieved from "http://jajuk.info/index.php/Converting_Jajuk_Manual_wiki_pages_to_raw_HTML_for_JavaHelp"