© 2015 X2Engine Inc.

Wiki Usage:For contributors

From X2Engine
Jump to: navigation, search

Bare Essentials

Edit/create a page
Search for it, and if it doesn’t exist you’ll see a link to create it.
Edit/create a category
Search for Category:{Category Name} and create it in much the same way as with creating a page.
Categorize a page
Place at the top of the page:
[[Category:{Category name}]]

Interwiki Links

Relevant page: The InterWiki manual. Interwiki links are a great way to quickly link to a page in another instance of MediaWiki without including the full URL. The syntax is:


Where the pipe is added at the end of the link to hide the interwiki prefix in the resulting link, which makes links look nicer in general. You can optionally set the link text manually by inserting it after the pipe.

For the list of Interwiki prefixes that are available in MediaWiki by default, see Interwiki in the MediaWiki documentation.

Extra InterWiki Prefixes

Prefixes have been added for common locations throughout this wiki;

The X2CRM Requirements Check Script

For the sake of making it easy to insert a link to the requirements checker, the interwiki prefix requirements: will insert a link to requirements.php. The following code will produce a link with the filename:



The X2CRM class reference

[[x2doc:{class name}|]]
becomes Contacts. You can also set link text to override the default (the "article name", which follows the colon) by putting it after the pipe in the interwiki code. Note, however, that because of the .html extension that is automatically appended, one cannot use this for referencing class properties. To do that, use "x2propdoc" interwiki alias;
[[x2propdoc{class name}.html#_{property name}|{link text}]]
becomes: Contacts::afterFind()

The Yii Framework class reference

[[yii:{class name}|]]
becomes: CActiveRecord

Also, if you wish to link to an attribute or method of a class, use the following syntax (the typical format of permalinks):

[[yii:{class name}#{property name}-detail|{class name}::{property name}]]
becomes: CController::render()

Pages in The Definitive Guide to Yii

[[yiiguide:{article ID}|{link text}]]

Article IDs will typically be a section and a page name in lower case, separated by a period, i.e. "basics.controller". You can also suffix the article ID with a hash fragment to jump to a section permalink. For example:

[[yiiguide:basics.convention#directory|Fundamentals: Conventions]]
becomes: Fundamentals: Conventions

Pages on x2engine.com

[[x2:{page name}|]]
Example: partners