Candy Database · Documentation
database.json inside.
My_Addon/
database.json
_header.txt (optional: shown above every page)
_footer.txt (optional: shown below every page)
_About/ (optional: the About menu's pages)
01_Credits.txt
1.0.0/
_About/
01_Change_Log.txt
English/
01_Getting_Started/
01_Introduction.txt
02_Installing.txt
02_Reference/
01_Functions.txt
Deutsch/
...
_images/
logo.png
2.0.0/
...- database.json describes the database (see database.json).
- Each version is a sub-folder of the database. Its name is what the version drop-down shows. Any sub-folder counts, except those starting with
.or_. - Each language is a sub-folder of a version. Its name is what the language drop-down shows, so write it as you want it read (
Español; underscores show as spaces). The same rule applies: folders starting with.or_are not languages. A version needs at least one. - Folders inside a language are categories. They can be nested.
txtfiles are pages (see Pages).- A page with the exact name of a folder next to it (
02_Reference.txtand02_Reference/) is that category: the page list shows it in the folder's place, with the folder's pages under it. Clicking it opens the page; like every category, it folds with its arrow. - Folders and files starting with
_are ignored as categories and pages, so you can keep images, the header, the footer and notes in them. - An
_Aboutfolder holds the pages of the About menu instead (see About menu).
1.10.0 is newer than 1.9.0. A leading v is ignored. Names that are not numbers sort alphabetically.
Language names
Languages are sorted alphabetically, after the reader's preferred languages. Which one opens first is explained in Databases, versions and languages; default_language in database.json sets the database's own choice.
Where to put it
In the library folder to use it in every project, or anywhere in a project. See Installing. If two databases have the same id, only the first is used, and the editor logs a warning.