YoYoGames Wiki:Article formatting/variables
From YoYoGames Wiki
Game Maker variable articles have a separate article formatting guideline which will be explained in detail in this page.
Contents |
General Format
{{GMvar|
title=variable_title
|description=a short description/explanation.
|scope=Global/Local
|type=real/string
|editable=Yes/No
}}
==Explanation==
A further explanation section of the variable that describes
it in further detail. If there is no explanation available,
the section would be omitted. Adding an explanation section is
'''greatly recommended''' since the description is only a
single sentence for variable articles.
==Examples==
Some code examples on the uses of the variable. Do as much as you want.
If there are a lot of examples you can add "===Subsections===".
==Remarks==
Can this variable only be used in registered versions of Game
Maker? etc. Write any extra remarks about the variable here
if they exist.
==See Also==
*[[similar variables]]
*[[etc]]
==External Links== [optional]
*[http://some site]
Description
The {{GMvar}} Template
The {{GMvar}} template contains some of the basic information that is included in most Game Maker variable pages.
For more information about the GMvar template, please see its documentation.
Explanation
The explanation section includes any further explanation that is too long to be included under the "description" variable of the {{GMvar}} template. While this is optional, it is much recommended that it is included as a single sentence for the description is not sufficient to explain a variable.
Examples
Here, code examples are used to further illustrate some information about the variable. This includes information on how to use it, certain occasions where it is useful, and using examples to further illustrate a use of the variable that is vague when mentioned in its explanation.
Remarks
Further remarks ore only written if there are any. Not all pages need to have remarks. A remark does not explain the variable in itself or what it does, but usually outlines its limitation, etc. This includes saying that the variable only works on the pro version of Game Maker 7.0, or that the it was introduced in Game Maker 6.0, etc.
See Also and External Links
The See Also and External Links sections are typical sections found in other articles as well. The See Also section provides links to other variables that are either similar, or variables which work together, complement each other, or are inter-dependent. Links to functions can also be added if they are related to variable's article. External links are only included if necessary.
Other Sections?
In general, we do not recommend adding addition high-level sections to the function page. This means that no "==Heading==" should be added, but should rather be incorporated in other locations. This includes adding it to one of the sections that exist after the template (e.g. Explanation).
Sub sections of the existing sections, however, can be added if necessary. So, if a lot of text can be included under the "Explanation", it might be wise to divide it to sub sections. The same applies to examples.
Categorization
While there is no apparent categorization in the actual format you write, using the {{GMvar}} template will automatically categorize the article under the Game Maker Variables category.
