Documentation Standards
Last updated
Last updated
1) Please use the standard way of writing documentation using Markdown, and review the existing XOOPS Documents as examples
2) Please consider making your documents Multi-lingual from the very beginning
3) Please use following standards for Info/Tips:
TIP: These images below do NOT have tool tip information.
NOTE: These images below do NOT have tool tip information.
WARNING: These images below do NOT have tool tip information.
IMPORTANT: These images below do NOT have tool tip information.
4) When creating a XOOPS Tutorial in GitBook, please call it: "XOOPS XYZ Module", replacing the "XYZ" with the name of the module, e.g. "XOOPS Protector Module"
5) Directory structure
Above you can see the typical directory structure for a Gitbook document. Within the /book folder, you can have additional folders if needed (e.g. for individual chapters)
For Multi-lingual documents, the top structure will look like this:
with the LANGS.md file containing list of languages which you can activate or deactivate:
Please note that the active languages will then show up as selection for the user when they come to read the document.
5) Please note that the structure for each Book is as follow:
README.md is the file with Introduction
SUMMARY.md is the Table of Contents, which is used on the left-hand side providing you with links to the content.
