Style Guide for FutureBASIC Documentation
When contributing, follow as closely as possible the conventions stated in the chapter titled "Introduction to the FB Language." These conventions include the following:
- Items in
italicsrepresent placeholders which should be replaced as indicated in the description;
- Items in
bold textrepresent literal text that you should enter exactly as shown;
- Items in
plain non-italic textrepresent literal text that you should usually enter exactly as shown.
Please adhere to the following coding standards:
- FB keywords: lower case (
- The mixed-case format is preferred.
- Please do not color code the Wikibook text.
- When we export to HTML or HTML Help, a CSS "class" will be added (<code class="keyword">) to control the appearance of keywords.
It should be noted that WIkibooks do not support CSS.
- Toolbox calls: Apple's naming convention
- User functions: capitalized (fn MyFunction())
- Variables: start with a lowercase letter (x, myVariable)
- Globals: start with lowercase g (gSomeGlobal)
Code within Text
The <code> tag is supported by Wikibooks. This tag renders enclosed text in a monospace font, usually Courier or Courier New. Unfortunately, the text is not always easy to read, so please avoid using italics or other effects unless absolutely essential.
Blocks of Code
Use a <pre> (pre-formatted) tag for large blocks of code:
// This is sample code
The <PRE> tag places example code within a box. It also preserves formatting by rendering the code in a monospace font.
When documents can be organized in folders (directories), the following standards are used:
- Language: An Overview of Syntax, Organized by Functionality
- Intro: An Introduction to Programming in FutureBASIC (Note: please compose content for true beginning programmers)
- Programming: Intermediate to Advanced Programming Topics
- FBtoC: An Explanation of FBtoC
- Tutorials: Programming Examples and More
- Appendix: Additional Information
Folder names are in lowercase when appearing in Wikibook links. These folders are divided further into specific topics. Always consult the table of contents before creating sub-folders (sub-sections) for this text. The Wikibook entries are linked from FutureBASIC → "Major Section" → "Sub-section" and this organization will be automatically recreated when a Wikibook is exported. Since the Wikibook is our central repository for content, please maintain the organization. Reorganizing a Wikibook requires copying pages to new locations and then deleting the originals.