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

Wiki usage



The default html output is a static web site. The web-site content is completely self-contained[1]
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


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

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[2]
    See HTTP Server for more information
The second option improves the Full text search feature.

Structure of the articles content

The content of each article html file (including the index) has the following elements:
overviewtop
  • 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[3]
    Note that the user can redimension the width of this menu
  • Optionally, A right menu can also be present

overviewbot
  • The bottom of the article content present the list of categories which are associated with the current article
  • The bottom of the page can present a bottom footer

Notes

  1. ^ 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
  2. ^ See HTTP Server for more information
  3. ^ Note that the user can redimension the width of this menu

See also


Categories: General

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.

Project Web Hosted by SourceForge.net Copyright 1999-2010 - Geeknet, Inc., All Rights Reserved About - Legal - Help