fbdoc Action Information


The {{fbdoc}} action is used throughout the online documentation in the wakka script and serves several purposes:


Syntax:
{{fbdoc item="item" [ value="value" ] }}

Where item and value are used as follows:

item="title" value="page title"
Used for page titles. This is normally found first and only once on each page.

item="section" value="section title"
Inserts a section title on a page. Normally only used on category pages (pages beginning with CatPg)

item="subsect" value="sub-section title"
Inserts a sub-section title on a page. Normally only used on category pages (pages beginning with CatPg)

item="keyword" value="WikiPageName|Display text"
Inserts a keyword link to WikiPageName and displays Display Text. In the online version, this method of linking to a keyword page is not much different than using the [[|]] tags for a page links. It has special meaning to the document converters when found on a category page (pages beginning with CatPg), when automatically building a table of contents from the online documentation.

item="syntax"
Inserts a Syntax: section header on a page

item="usage"
Inserts a Usage: section header on a page

item="param"
Inserts a Parameters: section header on a page

item="ret"
Inserts a Return Value: section header on a page

item="desc"
Inserts a Description: section header on a page

item="ex"
Inserts an Examples: section header on a page

item="lang"
Inserts a Dialect Differences: section header on a page

item="target"
Inserts a Platform Differences: section header on a page

item="diff"
Inserts a Differences from QB: section header on a page

item="see"
Inserts a See Also: section header on a page

item="back" value="WikiPageName|Display text"
Inserts a Back to link to WikiPageName and displays Display Text.

item="filename" value="filename"
Indicates the filename to be used for the following %%(qbasic) or %%(freebasic) code example.

item="tag" value="tag-information"
A general purpose tag used to indicate special formatting information to the documentation converters

Examples:

{{fbdoc item="title" value="My Page Title"}}

My Page Title



{{fbdoc item="section" value="Section"}}
Section

{{fbdoc item="subsect" value="Sub-section"}}
Sub-section

{{fbdoc item="keyword" value="KeyPgDim|Dim"}}
Dim

{{fbdoc item="syntax"}}
Syntax:

{{fbdoc item="usage"}}
Usage:

{{fbdoc item="param"}}
Parameters:

{{fbdoc item="ret"}}
Return Value:

{{fbdoc item="desc"}}
Description:

{{fbdoc item="ex"}}
Examples:

{{fbdoc item="lang"}}
Dialect Differences:

{{fbdoc item="target"}}
Platform Differences:

{{fbdoc item="diff"}}
Differences from QB:

{{fbdoc item="see"}}
See also:

{{fbdoc item="back" value="FBWikiHelp|FB Wiki - Help"}}
Back to FB Wiki - Help



Back to FB Wiki - Help

Valid XHTML :: Valid CSS: :: Powered by WikkaWiki



sf.net phatcode