GuideReadme

How to build the jUDDI Guide Book in Docbook format?

This jUDDI wiki is the source of the jUDDI Guide document. The directory layout of the wiki in this example is

├── Guide
│   └── en-US
│       ├── Guide-docinfo.xml
│       ├── Guide.asciidoc
│       ├── GuideDatabase-Connection-Setup.asciidoc
│       ├── GuideReadme.asciidoc
│       └── _Sidebar.asciidoc
├── Home.md
├── JUDDI.asciidoc
├── Readme.asciidoc
├── images
└── pom.xml

The Guide document is based on the Asciidoc book.txt example, and a Guide-docinfo.xml include file to support more then one author. The AsciiDoctor maven plugin converts the asciidoc files into an intermediate Docbook format (Guide.xml), which then is used as input for maven-jdocbook-plugin to create HTML and PDF versions. If you want to build these yourself you need to check out the repository locally using:

git clone [email protected]/KurtStam/juddi.wiki.git

and run:

mvn clean install

and it will build HTML and PDF versions in the target/docbook/publish/en-US directory.

Q&A

1. I spotted a typo, can I fix it?

   Yes please help us maintain the documentation. Simpy update the appropriate page right on github. Our nightly build will distribute the changes to docbook and the html and pdf versions.

2. How do I add an image?

   Images can not be uploaded through the github UI. Instead you need to add them to the images directory in the root of the s-ramp.wiki repo and then push it up to github. You can then reference your image on the page using image::images/<myimage>.ext. NOTE: Make sure to add an empty line before and after this image reference.

3. How do add a numbering and references?

   You should add a label -we use the convention <type>-<chapter>-<label>, i.e. [[figure-gs-screenshot-of-the-s-ramp-ui]]- , a title i.e. .Welcome screen of the s-ramp-ui. and then the thing itself -for an image use something like image::images/srampui.png[Screenshot of the s-ramp-ui]. The label figure-gs-screenshot-of-the-s-ramp-ui can be used to link to this figure using <<figure-gs-screenshot-of-the-s-ramp-ui>>. The GuideExampleChapter contains an example.

4. How do I add a chapter to the book in docbook?

   We add chapters as different files, and then include them in the Guide.asciidoc file. At docbook generation time it will pull in the chapter into the Guide.xml file. Also we add a link in the _Sidebar.asciidoc page to have a link when looking at it at Github in wiki style.

5. Why are all the files prefixed with Guide?

   The GitHub wiki flattens out the directory structure on the Pages page. So in order to group all the files of the Guide together we decided to prefix them all with Guide.