Candy Database · Documentation
txt file written in BBCode (see BBCode).
Titles and order
The page list shows, for each page, a title, and sorts pages and categories by an order number.
- Title: the file name, without its number or extension, with underscores turned into spaces.
02_Installing_It.txtis Installing It. - Order: the number at the start of the file or folder name. Items without a number come after the numbered ones, in alphabetical order.
01_Getting_Started is the category Getting Started, shown first.
Setting them by hand
A page can start with lines that set its title or order, before anything else:
@title: What's new in 2.0
@order: 5
Text of the page starts here.02_Reference/01_Functions.txt has the id Reference/Functions.
Link to a page from another with its id, in a url tag:
[url=page:Reference/Functions]the function list[/url]- Start a page with a title, such as
[font_size=32][b]Title[/b][/font_size]. Candy Database does not add one. - Keep one subject per page, so search and links stay useful.
- Numbers in file names leave room to add pages later: use 10, 20, 30.