---

Documentation Window

Help > Documentation, in the top bar, opens the documentation in a window of its own. It stays open beside your work, on another screen too, and reopens where it was left. The window displays documentation databases: this documentation, Candy Dialogue Engine's, and any other you add.

The Download The documentation doesn't ship with Candy Dialogue Creator: it's downloaded, so that it can be updated between versions of the application. The first time, the window displays "No documentation yet". Click Download the documentation there, or choose Documentation > Download Documentation. Candy Dialogue Creator downloads the documentation of Candy Dialogue Engine and of Candy Dialogue Creator from Candy Arts' official GitHub repository. Updates Once the documentation was downloaded, opening the window checks for a newer version, at most once a day. When there is one, a line under the page list reports it, with an Update button. Nothing is downloaded until you press it.

Documentation menu	What it does
Download Documentation / Update Documentation	Checks for newer documentation and downloads what changed.
Refresh	Reads the documentation folder again, after a database was added to it or changed.
Open Documentation Folder	Opens the folder the documentation is stored in.
Look for Updates Once a Day	Untick it to stop the daily check.

What a Download Does

• Nothing is asked of GitHub before you ask for the documentation.
• Each database is downloaded as one zip file, signed by Candy Arts. A zip whose signature isn't Candy Arts', or whose files don't match the list it was signed with, is refused, and nothing is written.
• A database is only downloaded when it was updated on GitHub, or when a file it installed is missing or was modified. Only the files that changed are written.
• Only pages, pictures, fonts and data files are ever written: never a program or a script.
• If you changed a downloaded file yourself, a copy of your version is saved in the Backups folder before it's replaced.
• Databases of your own are never modified.

Reading The Sidebar

Control	What it does
Search pages	Type to list the pages that contain a word.
Database	Which documentation is displayed.
Version	Which version of it. For Candy Dialogue Engine, the window opens the version your Godot project has installed, when it can identify it.
Language	Which language, when the documentation has several.
The page list	The pages, sorted in categories that fold. Click a page to open it.

A database's About pages, such as a change log or a license, are listed last, under "About". Pages Each page has a small bar with back and forward buttons, to move through the pages read. Links in a page open another page. A link to a web page asks before opening your browser. Two Pages Side by Side

• Ctrl+click a page in the list to open it in a second page, beside the first.
• Ctrl+click a link to open it in the other page.

The second page has a close button in its bar. With two pages, a guide can be followed in one while a reference stays open in the other. The View Menu

Item	What it does
The Documentation's Look	Displays each documentation as its authors styled it.
Candy DC's Look	Displays every documentation in the colors of your theme, from Settings > Theme.
Increase Text Size, Decrease Text Size	Enlarges or shrinks the pages' text.
Reset Text Size	Restores the size of Candy Dialogue Creator's own text.

The colored words of a documentation, such as the names of Commands and of keys, retain their colors in both looks. Documentation of Your Own Any folder written as a database and dropped in the documentation folder is listed in the window: a writing guide for your game, the reference of your own Commands. See Documentation Databases. In the Godot Editor The same documentation can be read inside the Godot editor, with Candy Arts' Candy Database plugin.