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

Category: structure


Deals about the wiki structure

A

Articles : Article files are XML files which define the articles in the wiki

C

Categories : This article explains the concept of categories
Categories description : This article explains the concent of categories description files
Chapters and titles : Chapters and titles allow to define sections in the articles ("<Hi>" html tag)

D

Dictionary : The wiki generator automatically generates a dictionary of all the articles
Disambiguation articles : Disambiguation articles allow to specify an article which will point to several articles of approaching names
doc files : This article is about the doc-files directories which contain resource files
doc-files : This article is about the doc-files directories which contain resource files

E

Element names unicity : This article is about the element names unicity
Enforcing packages dependencies : This article explains how to enforce package dependencies

F

Fallback articles : Fallback articles allow to specify articles which will be used where a reference to another article point to an article which does not exist
Footer : This article is about the Footer and Header specifications
Footer and header files : This article is about the Footer and Header specifications

G

Glossary : This article explains the glossary

H

Hand-written articles : A raw html article is not using the docGenerator syntax, but is a hand-written html file
Hand-written html articles : A raw html article is not using the docGenerator syntax, but is a hand-written html file
Header : This article is about the Footer and Header specifications

I

Image definition : This article is about specifying and using image files
Image files : This article is about specifying and using image files
Index : This article explains the concept of the articles index
Index article : This article explains the concept of the articles index
Infobox definition : This article explains how to specify infobox templates
Infobox template : This article explains how to specify infobox templates

L

Linking to local resources : This article explains how to link to local resources (which can be images, files, or APIs)

M

Manual glossary : This article explains the glossary manual policy

N

Naming constraints : This article is about the naming constraints of the articles
Naming unicity : This article is about the element names unicity

O

Output structure : This article presents the output structure of the wiki

P

Packages : This article explains how to use the generator with more than one root directory
Packages dependencies : This article explains how to enforce package dependencies

R

Raw html article : A raw html article is not using the docGenerator syntax, but is a hand-written html file
Redirect articles : Redirect articles allow to create an article with a redirection to another article or even a title or anchor in another article
References : This article explains the concept of inter-wiki links
Regular article : Regular articles are the pages composing the wiki, similar to Wikipedia articles
Resource files : This article is about specifying and using resource files
Root directories and packages : This article explains how to use the generator with more than one root directory
Root directory : This article explains how to use the generator with more than one root directory

S

Specifying the index : This article explains the use case of specifying the index in the configuration

T

Templates : A template is similar to a regular article but has the top-level element "template"
Types of files : This article explains the types of files which can be found in the wiki input

U

Usage of packages : This article explains how the use cases of packages

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