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

Output structure



The output structure of the wiki after the generation has the following files at the root of the generation directory:
  • An index.html file for the index article. This is the home directory of the wiki
  • A dictionary.html file for the dictionary
  • A categories.html file for the list of categories
  • A header.html file for the Header if the wiki has a header
  • A fullTextSearch.html file if the wiki support Full text search

Sub-directories

The wiki output also contains the following sub-directories:
  • The articles directory contains all the articles
  • The categories directory contains all the categories
  • The image directory contains all the image files references in the articles
  • The resources directory contains the css and javascript libraries used by the wiki, including the ones used for the search

Articles sub-directory

This sub-directory contains the html files for the articles (except the index article).

Categories sub-directory

This sub-directory contains the html files for the categories (escept for the categories list).

Image sub-directory

This sub-directory contains the html files for the image files.

Resources sub-directory

This sub-directory contains the css and javascript libraries used by the wiki, including the ones used for the search

Directory for hand-written html articles

If there are hand written articles, there is a rawArticles directory containiong these handw-written html files.

Other directories

There can be other directories for apis embarked in the wiki.

See also


Categories: structure

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