Candy Database · Documentation

Pages A page is a 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.txt is 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.
The same goes for folders: 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.
These lines are read and not shown. Use them when a file name can not say what you want, such as a title with punctuation. Page ids and links Every page has an id: its path in the language folder, without numbers or extension. 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]
Ids are case sensitive, and belong to a version and language: a link can not jump to another version, language or database. If the id does not exist, the page says so. Good habits
  • 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.