Write Documentation

This page should help you learn what you need to know in order to write RadPHP documentation. This page covers the technical part, make sure you read how to contribute documentation before you actually contribute any documentation.

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.
{{PhoneGapReference}}	{{{1}}} at PhoneGap API Documentation.	Link to PhoneGap 1.3.0 API Documentation about given top-level class.

Lists

Code	Content	Description
{{ThirdPartySoftware}}	{{{1}}} {{{2}}}	Unordered list item to display third party software name and version in the list from the Release Notes.
{{PhoneGapReference}}	{{{1}}} at PhoneGap API Documentation.	Link to PhoneGap 1.3.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 RadPHP 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 Tools > 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 Tools > Options…, you should write this as one path: Tools > Options… > Editor Options > Color.

For mono-element paths, you should use surround the menu item with ''' instead. For example, you would use {{Menu|Tools > Options…}} for Tools > Options…, but '''Tools''' for Tools alone.

System Paths

When you write system paths in RadPHP 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"	Default table style.

Syntax Highlight

These templates are used to highlight code.

Code	Description
{{PHP}}	Inline PHP code.	{{PHPDocInline}}	Inline PHPDoc code.	{{SQL}}	Inline SQL 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
{{Product}}	RadPHP	Product name. It changed in the past, you never know.
{{Version}}	XE2	Latest RadPHP version available.
{{VersionNumber}}	4.0	RadPHP XE2 numeric code, to be used for paths.
{{LatestUpdate}}	4	RadPHP XE2 latest update number.
{{JQueryMobileVersion}}	1.0	JQuery Mobile version included in RadPHP XE2, used for example in references to rpcl\jquerymobile\css\jquery.mobile-1.0.css.
{{PhoneGapVersion}}	1.3.0	PhoneGap version included in RadPHP XE2, used in links to PhoneGap online documentation.