Additions:
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 >.
Variable types examples:
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"".<sString>
<iInteger>
<fFloat>
<tTable>
<oFunction>
Deletions:
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 should be placed between angle brackets: < and >.
Edited on 2006-04-24 00:14:43 by MiKail [fixed formatting]
Additions:
Variable Reference Formatting
<iInteger>
<fFloat>
<tTable>
<oFunction>
Deletions:
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 should be placed between angle brackets: < and >.
Edited on 2006-04-24 00:14:43 by MiKail [fixed formatting]
Additions:
Variable Reference Formatting
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 should be un-WikiNamed.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%%.
ThingToBuild = <sUnitName>
Deletions:
Variable Reference Template
Deletions:
Variable Reference Template
If you require that a pair of double-quotes (without any text between them) be displayed, use the entity literal " instead.
Blocks of code should be un-WikiNamed.
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%%.
ThingToBuild =
Edited on 2006-04-24 00:00:54 by MiKail [updated wikiname section to new wiki format. added a section on deprecated information.]
Additions:
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: ++.
Deletions:
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 (++).
Edited on 2006-04-23 23:59:31 by MiKail
Additions:
++This text is no longer informative.++
Deletions:
++This text is no longer informative.++
Edited on 2006-04-23 23:59:08 by MiKail
Additions:
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"".
Edited on 2006-04-24 00:00:54 by MiKail [updated wikiname section to new wiki format. added a section on deprecated information.]
Additions:
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: ++.
Deletions:
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 (++).
Edited on 2006-04-23 23:59:31 by MiKail
Additions:
++This text is no longer informative.++
Deletions:
++This text is no longer informative.++
Edited on 2006-04-23 23:59:08 by MiKail
Additions:
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"".
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 (++).
Edited on 2006-01-24 02:41:23 by MiKail
Deletions:
Blocks of code should be indented an additional level.
Edited on 2006-01-24 02:40:36 by MiKail
Additions:
%%
:
:
ScopeName
Deletions:
%%
<Argument>: <Description>
<Argument>: <Description>
<ScopeName>
Notes should be indented an additional level.
Edited on 2006-01-24 02:37:45 by MiKail
Additions:
Variable Reference Template
Notes and tips should be preceded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Deletions:
Variable Reference Templater
Notes and tips should be preceeded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Edited on 2006-01-24 02:35:36 by MiKail
Additions:
%%
Deletions:
%%
Edited on 2006-01-24 02:34:57 by MiKail
Additions:
<TextDescription>
<Argument>: <Description>
<Argument>: <Description>
Deletions:
:
Edited on 2006-01-24 02:33:42 by MiKail
Additions:
- <ScopeName>
Deletions:
Scope
Edited on 2006-01-19 15:50:07 by MiKail
Additions:
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.
Deletions:
Many of the pages here at Karos are formatted in this fashion. 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.
Edited on 2006-01-19 15:49:27 by MiKail
Deletions:
Discussion Links
Edited on 2006-01-19 15:48:41 by MiKail
Additions:
For more general wiki formatting instructions, visit the Wakka Formatting page.
Discussion Links++This text is no longer informative.++
results in:This text is no longer informative.
Deletions:
If a word, not followed by or containing any punctuation, has two or more non-consecutive capital letters (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 followed by a hyperlinked question mark. In order to un-WikiName a word, surround it with two pair of double-quotes: ""OneWord"".
Edited on 2006-04-21 23:37:07 by ThoughtProcess
Additions:
Deletions:
Edited on 2006-03-31 01:10:09 by MiKail
No differences.
Edited on 2006-03-31 01:09:51 by MiKail
Additions:
Images
You can now include images! like this:Deletions:
If a word, not followed by or containing any punctuation, has two or more non-consecutive capital letters (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 followed by a hyperlinked question mark. In order to un-WikiName a word, surround it with two pair of double-quotes: ""OneWord"".
Edited on 2006-04-21 23:37:07 by ThoughtProcess
Additions:
Deletions:
Edited on 2006-03-31 01:10:09 by MiKail
No differences.
Edited on 2006-03-31 01:09:51 by MiKail
Additions:
Images
{{Image url="http://site.org/image.png" link="http://site.org/" title="Alt Text"}}
For example:Edited on 2006-01-24 02:41:23 by MiKail
Deletions:
Blocks of code should be indented an additional level.
Edited on 2006-01-24 02:40:36 by MiKail
Additions:
%%
:
:
Deletions:
%%
<Argument>: <Description>
<Argument>: <Description>
Notes should be indented an additional level.Edited on 2006-01-24 02:37:45 by MiKail
Additions:
Variable Reference Template
Notes and tips should be preceded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Deletions:
Variable Reference Templater
Notes and tips should be preceeded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Edited on 2006-01-24 02:35:36 by MiKail
Additions:
%%
Deletions:
%%
Edited on 2006-01-24 02:34:57 by MiKail
Additions:
<TextDescription>
<Argument>: <Description>
<Argument>: <Description>
Deletions:
:
Edited on 2006-01-24 02:33:42 by MiKail
Additions:
- <ScopeName>
Deletions:
Scope
Edited on 2006-01-19 15:50:07 by MiKail
Additions:
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.
Deletions:
Many of the pages here at Karos are formatted in this fashion. 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.
Edited on 2006-01-19 15:49:27 by MiKail
Deletions:
Discussion Links
Edited on 2006-01-19 15:48:41 by MiKail
Additions:
For more general wiki formatting instructions, visit the Wakka Formatting
page.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.
Deletions:
Also, please add relevent discussion links to any new pages that you create.
For more general formatting instructions, visit the Wakka FormattingDeletions:
Also, please add relevent discussion links to any new pages that you create.
page.Edited on 2006-01-19 15:45:43 by MiKail
Additions:
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%%.
Program menu items should be in bold type and separated by a greater-than sign, >, that is not in bold type.
Edits should be followed by your name and (optionally) the date the edit was made.
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.
Deletions:
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 them between two pair of percent signs: %%code%%.
Program menu items should be in bold type and seperated by a greater-than sign, >, that is not in bold type.
Edits should be followed by your name and, optionally, the date the edit was made.
You do not have to surround a link with brackets. They're only necessary if the label (e.g. the displayed text) differs from the URL.
Edited on 2006-01-19 15:42:40 by MiKail
Additions:
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 them between two pair of percent signs: %%code%%.
Deletions:
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 and put it in monospace type, and preserves indentation. You do this by placing them between two pair of percent signs: %%code%%.
Oldest known version of this page was edited on 2006-01-19 15:42:03 by MiKail []
Edits should be followed by your name and (optionally) the date the edit was made.
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.
Deletions:
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 them between two pair of percent signs: %%code%%.
Program menu items should be in bold type and seperated by a greater-than sign, >, that is not in bold type.
Edits should be followed by your name and, optionally, the date the edit was made.
You do not have to surround a link with brackets. They're only necessary if the label (e.g. the displayed text) differs from the URL.
Edited on 2006-01-19 15:42:40 by MiKail
Additions:
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 them between two pair of percent signs: %%code%%.
Deletions:
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 and put it in monospace type, and preserves indentation. You do this by placing them between two pair of percent signs: %%code%%.
Oldest known version of this page was edited on 2006-01-19 15:42:03 by MiKail []
Page view:
Wakka Formatting Guidelines & SuggestionsMany of the pages here at Karos are formatted in this fashion. 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.
Also, please add relevent discussion links to any new pages that you create.
For more general formatting instructions, visit the Wakka Formatting
page.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.
For an example of what a function page should look like, see this page.
**""""** **Description** **Example** ##""""## **Arguments** **:** **Scope** **Related Pages:** - [[FunctionReference]]
Variable Reference Templater
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.
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 (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 followed by a hyperlinked question mark. In order to un-WikiName a word, surround it with two pair of double-quotes: ""OneWord"".
Example:
If you require that a pair of double-quotes (without any text between them) be displayed, use the entity literal " instead.
Example:
- quot;"
Blocks of Code
Blocks of code should be in monospace type.
Blocks of code should be un-WikiNamed.
Blocks of code should be indented an additional level.
Blocks of code should be un-WikiNamed.
Blocks of code should be indented an additional level.
Example:
{
Type = Ship,
ThingToBuild = "Hgn_IonTurret",
RequiredResearch = "PlatformIonWeapons",
RequiredShipSubSystems = "PlatformProduction",
DisplayPriority = 2,
DisplayedName = "$7064",
Description = "$7065",
},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 and put it in monospace type, and preserves indentation. You do this by placing them 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 should be placed between angle brackets: < and >.
Example:
ThingToBuild =
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.
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.
Filenames & Paths
Directory paths and filenames should be placed between three pair of double-quotes: """path""".
Example:
"C:\Program Files\Homeworld2"
"homeworld2.exe"
"homeworld2.exe"
Program Menus
Program menu items should be in bold type and seperated 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 preceeded by "Note:" or "Tip:" and surrounded by two pair of single-quotes: ''note''.
Notes should be indented an additional level.
Edits should be followed by your name and, optionally, the date the edit was made.
Notes should be indented an additional level.
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
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.
You do not have to surround a link with brackets. They're only necessary if the label (e.g. the displayed text) differs from the URL.
You do not have to surround a link with brackets. They're only necessary if the label (e.g. the displayed text) differs from the URL.
Related Pages:
