Karos Graveyard ::
Function Reference :: Scope Reference :: Variable Reference
Wakka Formatting Guidelines & Suggestions

Many of the pages here at Karos are formatted according to the guidelines, below. You can follow these guidelines, if you wish, in order to maintain consistency. Click on "Edit this page", at the bottom of this page, if you want to have a closer look at the syntax used.

For more general wiki formatting instructions, visit the Wakka Formatting
Function Reference Template

Before adding info, copy the following, when and where they apply, into any new pages that you create in the Function Reference.
For an example of what a function page should look like, see this page.

**""""**

**Description**


**Example**
	##""""##

**Arguments**
	****:
	****:

**Related Pages:**
	- [[FunctionReference]]
	- [[ScopePage ScopeName]] 

Variable Reference Formatting

The Variable Reference uses two main styles of formatting:
The first style is similar to that of the Function Reference, in that it is composed of different sections describing things like syntax and usage, as well as a bulletted list of variables.
The second style is similar to the source files, themselves. Variable keys are listed by themsleves, followed by a description in blue text. Unindexed sub-table are denoted using the "[" and "]" characters. Unindexed table entries are denoted using "[n]", where n is the position of the entry within the table.


WikiNames

If a word, not followed by or containing any punctuation, has two or more non-consecutive capital letters [Ed. except stuff like umlauts, I think.] in it and a WikiPage of the same name exists, then the word is converted into a hyperlink referencing that WikiPage. The word is then said to be WikiNamed. If a WikiPage of the same name does not exist, then the word is underscored with a red, dashed line. In order to un-WikiName a word, surround it with two pair of double-quotes: ""OneWord"".

Example (WikiNamed):


Example (un-WikiNamed):

FunctionReference
OneWord

If you require that a pair of double-quotes (without any text between them) be displayed, use the entity literal " instead.

Example: [Ed. this no longer seems to work since the switch to Wikka Wakka Wiki.]



Blocks of Code

Blocks of code should be in monospace type.
Blocks of code should be un-WikiNamed.

Example:
{
Type = Ship,
ThingToBuild = "Hgn_IonTurret",
RequiredResearch = "PlatformIonWeapons",
RequiredShipSubSystems = "PlatformProduction",
DisplayPriority = 2,
DisplayedName = "$7064",
Description = "$7065",
},

If blocks of code are really big, they could also be placed within their own inline frames. This saves the trouble of having to un-WikiName it and put it in monospace type. It also preserves indentation. You do this by placing your code between two pair of percent signs: %%code%%.


Placeholders

Placeholders are used when a variable or value can take many names or values. A placeholder represents a replaceable -- i.e., a value that must be replaced by a possible value. Placeholders begin with a lower-case letter indicating the type of variable. Placeholders should be surrounded by angle brackets: < and >.

Example:
ThingToBuild = <sUnitName>
ThingToBuild has a value of <sUnitName>, where <sUnitName> can be "Hgn_IonTurret" or "Hgn_Intercepter".
Rename the file to "<enter name here>.txt", where <enter name here> can be anything you want.

Variable types examples:
<sString>
<iInteger>
<fFloat>
<tTable>
<oFunction>

Filenames & Paths

Directory paths and filenames should be placed between three pair of double-quotes: """path""".

Example:
"C:\Program Files\Homeworld2"
"homeworld2.exe"


Program Menus

Program menu items should be in bold type and separated by a greater-than sign, >, that is not in bold type.

Example:
Click on File > Save... and save your file as a text file.


Notes, Edits & Tips

Notes and tips should be preceded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Edits should be followed by your name and (optionally) the date the edit was made.

Example:
Note: notes are in blue text.
Tip: tips are in blue text.
Edit: edits are in blue text. -Mikail, 12/19/05


Links

Links pointing to pages within the wiki should generally be listed first. Links pointing outside the wiki should be listed last.
It's not always necessary to surround a link with brackets. It's only necessary when the label (i.e., the displayed text) differs from the URL.


You can add relevent discussion links to any new pages that you create. You can list them after the page title, in blue text, and/or at the end of the page in the Related Pages section.


Images

You can now include images! like this:

{{Image url="http://site.org/image.png" link="http://site.org/" title="Alt Text"}}

For example:

image


Deprecated Information

From time to time, information, links or tools may become outdated or invalidated. They are then said to be deprecated. You can signify that a piece of information is deprecated by applting strike-through formatting. You do this by surrounding the text with double-plus: ++.

For example:

++This text is no longer informative.++

results in:

This text is no longer informative.


Related Pages:

There are 5 comments on this page. [Display comments]

:: ::