Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
Wiki usage
Tutorials
FAQ
License

Overview

    1 Input format
       1.1 Example
    2 Output format
    3 Incremental generation
       3.1 Structure of the html output
    4 Usage of the wiki
    5 Notes
    6 See also

The docJGenerator project allows to generate a html site with a list of XML files defining a documentation. It allows to produce an offline wiki-like site.

Input format

The default input format is a a list of XML files defining a documentation. It is also possible to configure the tool to parse files with the mediawiki syntax or the markdown syntax.

You should use the xml extension for your file, not html. Also you don't need to put any html construct such as "html", "header", "body", etc... in your file. The source files are NOT html files but xml files.

The name of the files have no meaning, and also where you put the files is not important either.

Example

The following file is incorrect:

   <html>
     <body>      
       <article desc="first article">
   The content of the first article.
       </article>
     </body>           
   </html>

The correct file is:

   <article desc="first article">
   The content of the first article.
   </article>

Output format

The tool produce by default an offline html site. It is also possible to generate a PDF file, Word file, or even a Epub file rather than a web site.

Incremental generation

The generation can be performed in an incremental mode.

Structure of the html output

Main Article: Wiki output overview

The default html output is a static web site. The web-site content is completely self-contained

The wiki is accessible through an index.html page which is directly in the output directory.

Usage of the wiki

Main Article: Wiki usage

There are two ways to open the wiki:

By double clicking on the index.html page
By double clicking on the server.bat console file (or server.sh on Linux or MacOS X) and browse the content of the wiki at the http://localhost:8080/ address. This second option improves the Full text search feature.

The top of the page can present a left and right header
A search box allows to search for a particular article, title, of text
A left menu allows to navigate in the wiki^[2]
Note that the user can redimension the width of this menu

By default the Full text search will not present the context of the article in which the Search term is used. To be able to see the context, you must use the HTTP Server (and double click on the server.bat console file to start the HTTP server).

Notes

^ Except if you make explicit references to external resources of course. It means that you can copy the files of the directory which contains the wiki everywhere you want, and it will still work
^ Note that the user can redimension the width of this menu