Documentation Databases
The Documentation window displays more than the documentation of Candy Dialogue Engine and Candy Dialogue Creator. Any documentation written as a database is displayed there: your game's writing guide, the reference of your own Commands, the notes of your team.
A database is a folder of text files. It uses the format of Candy Database, Candy Arts' documentation browser for the Godot editor, so the same database can be read in both.
Adding a Database
1. In the Documentation window, choose Documentation > Open Documentation Folder.
2. Place the database's folder in it.
3. Choose Documentation > Refresh.
The database is then offered in the Database picker of the window. Nothing is registered.
A Database's Folder
My_Game_Guide/
database.json
_header.txt optional
_images/ optional
1.0/ a version
English/ a language
01_Introduction.txt
02_Characters.txt
02_Characters/
01_Alice.txt
02_Bob.txt
- The database's folder contains a database.json file and one folder per version.
- A version's folder contains one folder per language.
- A language's folder contains the pages, and folders that sort them in categories.
- Folders whose name starts with
_ or a dot are skipped, so _images can contain pictures.
The window has a picker for the version and one for the language.
Pages
A page is a .txt file written in BBCode, the same tags a Spoken Line's text uses: [b], [i], [url], [table], [font_size] and so on.
| Rule | Description |
| Order | A number in front of the file name orders the pages: 01_Introduction.txt comes before 02_Characters.txt. The number isn't displayed. |
| Title | The file name without its number, with underscores displayed as spaces. A first line @title: My Title sets another. |
| Categories | A folder is a category of the page list. A page with the same name as a folder beside it is displayed as that category's own page. |
[url=page:Characters/Alice]Alice[/url]
[url=https://example.com]Our website[/url]
A page is named by its path from the language folder, without the numbers or the extension. Web pages open in the browser, after a confirmation.
Pictures
[img]_images/map.png[/img]
[img width=300]_images/map.png[/img]
A picture's path is relative to the page's folder, or to the language, version or database folder. Pictures are only read from inside the database's folder.
database.json
{
"title": "My Game Guide",
"description": "How we write dialogue for My Game",
"home": "Introduction",
"tags": {
"actor": { "color": "#be185d", "dark_color": "#ff4fa3", "bold": "1" }
}
}
Every key is optional, and every value is a text.
| Key | Description |
| title | The database's name in the picker. Without one, the folder's name. |
| description | A short description. |
| home | The page opened first. |
| default_language | The language opened when the reader has picked none. English when left out. |
| header | A BBCode file displayed above every page. _header.txt when left out. |
| header_scrolls | "1": the header scrolls with the page. "0": it stays above it. |
| tags | Tags of your own, to color kinds of words. See below. |
| theme_name | The id of a documentation theme to display the database with. |
| style, theme | The database's own colors, for its pages and for what surrounds them. |
actor tag above, a page writes [actor]Alice[/actor] to display "Alice" in that color.
| Key | Description |
| color | The color, as #rrggbb. |
| dark_color | The color on a dark page. |
| bold, italic | "1" to display the words in bold or italic. |
