Template:Property: Difference between revisions
From Legacy Roblox Wiki
Jump to navigationJump to search
>JulienDethurens eerm.. |
>JulienDethurens Perhaps I fixed it? |
||
Line 10: | Line 10: | ||
{{!}}-style="background: {{color|blue|light}};" | {{!}}-style="background: {{color|blue|light}};" | ||
{{!}}style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold; border-bottom: solid 1px {{color|blue|dark}};"{{!}}Member of | {{!}}style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold; border-bottom: solid 1px {{color|blue|dark}};"{{!}}Member of | ||
{{!}}style="border-bottom: solid 1px {{color|blue|dark}}; border-top: solid 1px {{color|blue|dark}};"{{!}}{{if|{{{object|}}} | {{!}}style="border-bottom: solid 1px {{color|blue|dark}}; border-top: solid 1px {{color|blue|dark}};"{{!}}{{if|{{{object|}}}|[[RBX.lua.{{{object|}}} (Object)|{{{object|}}}]]|{{{objects|}}}}} | ||
{{!}}}</div></onlyinclude>|3=<p class="error">The description must be specified.</p>}}|3=<p class="error">The type must be specified.</p>}}|3=<p class="error">The name must be specified.</p>}}<noinclude>{{documentation}}</noinclude> | {{!}}}</div></onlyinclude>|3=<p class="error">The description must be specified.</p>}}|3=<p class="error">The type must be specified.</p>}}|3=<p class="error">The name must be specified.</p>}}<noinclude>{{documentation}}</noinclude> |
Revision as of 05:04, 9 April 2012
This template is used to document properties. It should only be used to document properties that are part of the ROBLOX API.
Usage
<onlyinclude>{{Property |name=name |type=type |description=description [|protected=bool] [|object=object] [|objects=objects] }}</onlyinclude>
Note: text between brackets ([ and ]) is optional, text in bold represents a certain value (something you must replace) and the rest represents things that must be present as-is.
Parameters
- name
- The name of the property.
- type
- The type of the property. Should be either a link to the page of the type, either be displayed through the {{type}} template.
- description
- A description of the property.
- protected
- If specified, the icon of the property will indicate that the property is protected.
- object
- The name of the object this property belongs to, if there is only one. Otherwise, use the objects argument.
- objects
- Links to the objects this property belongs to, if there are more than one. Otherwise, use the object argument.
Notes
- The property should always be at the top of the page.
- If you need to put things after the property, make sure to use the {{clear floats}} template between the property and the rest of the page.
- All properties should be categorized under the Properties category.