Write Documentation
This page should help you learn what you need to know in order to write HTML5 Builder documentation. This page covers the technical part, make sure you read how to contribute documentation before you actually contribute any documentation.
Contents
Links
| Code | Content | Description |
| {{ComponentLink}} | [[{{{1}}}|{{{1}}}]] | Link to component page in the wiki. It can also be used in the page of the component itself. |
| {{CordovaReference}} | {{{1}}} at PhoneGap API Documentation. | Link to PhoneGap 2.8.0 API Documentation about given top-level class. |
Lists
| Code | Content | Description |
| {{ThirdPartySoftware}} |
|
Unordered list item to display third party software name and version in the list from the Release Notes. |
| {{CordovaReference}} | {{{1}}} at PhoneGap API Documentation. | Link to PhoneGap 2.8.0 API Documentation about given top-level class. |
Pages
Manual Updates
These pages content must be manually updated.
- Release Notes (must redirect to latest published update).
Paths
Menu Paths
When you write menu paths in HTML5 Builder Documentation, you should put them inside a {{Menu}} template, and separate each menu item with a >, surrounded by white spaces. For example, {{Menu|File > New}} your render as File > New.
You should include tab names and treeview items inside menu paths, and menu paths can go through new windows. For example, when you click Home > Options, a new dialog window pops up, and this window has a treeview through which you can browse the different option pages. If you wanted to point the user to the subitem Color, under the item Editor Options, in the treeview of the Options dialog you access from Home > Options, you should write this as one path: Home > Options > Editor Options > Color.
For mono-element paths, you should use surround the menu item with ''' instead. For example, you would use {{Menu|Home > Options}} for Home > Options, but '''Tools''' for Tools alone.
System Paths
When you write system paths in HTML5 Builder Documentation, you should put them inside a {{Path}} template. For example, {{Path|C:\Program Files}} your render as C:\Program Files.
You should also use {{Path}} template for individual files or folders, like unit.php file or Demos folder.
Tables
Table Rows
These are predefined row styles for tables in Mediawiki code.
| Code | Description |
| {{TemplateRow}} | Row describing a template (code, content and description). |
| {{TemplateRow2}} | Row describing a template (code and description). |
Table Styles
Styles to be used on tables. Its code should be placed at the beginning of a table in Mediawiki code, right after {|.
| Code | Content | Description |
| {{TableStyle}} | border="1px" class="standard" | Default table style. |
Syntax Highlight
These templates are used to highlight code. For an up-to-date list, check out the Syntax Highlight Templates category.
| Code | Description |
| {{CSS}} | Inline CSS code. |
| {{HTML}} | Inline HTML code. |
| {{INI}} | Inline INI code. |
| {{JavaScript}} | Inline JavaScript code. |
| {{JavaScriptBlock}} | Block JavaScript code. |
| {{PHP}} | Inline PHP code. |
| {{PHPBlock}} | Block PHP code. |
| {{SQL}} | Inline SQL code. |
| {{XML}} | Inline XML code. |
Variables
In this wiki, we try to use variables for any value that might need to be changed or updated in the future. Variables are just common wiki templates.
| Code | Content | Description |
| {{ApacheVersion}} | 2.2.15 | Apache version included in HTML5 Builder XE5. |
| {{JQueryMobileVersion}} | 1.3.1 | JQuery Mobile version included in HTML5 Builder XE5, used for example in references to rpcl\jquerymobile\css\jquery.mobile-1.3.1.css. |
| {{Library}} | RPCL | The name of the main HTML5 Builder library. |
| {{LibraryMajorVersion}} | 5 | RPCL major version number. |
| {{LibraryMinorVersion}} | 0 | RPCL minor version number. |
| {{LibraryVersion}} | 5.0 | RPCL version. |
| {{CordovaVersion}} | 2.8.0 | Cordova version included in HTML5 Builder XE5, used in links to PhoneGap online documentation. |
| {{PHPVersion}} | 5.3.6 | PHP version included in HTML5 Builder XE5. |
| {{Product}} | HTML5 Builder | Product name. |
| {{ProductAndVersion}} | HTML5 Builder XE5 | Name and version (if any) of the latest HTML5 Builder version available. |
| {{ProductNoSpaces}} | HTML5Builder | Product name without spacies. |
| {{Version}} | XE5 | Latest HTML5 Builder version available. Empty is current version has no version string. |
| {{VersionNumber}} | 6.0 | HTML5 Builder XE5 numeric code, to be used for paths. |
| {{WikiURL}} | http://docwiki.embarcadero.com/HTML5_Builder/en | URL to the HTML5 Builder wiki. |
| {{ZendFrameworkDocumentationVersion}} | 1.11 | Zend Framework version to be used when linking to the official documentation. |