Template:Osslfunc
From OpenSimulator
(Difference between revisions)
m |
m (some cleanup & improving readability) |
||
| Line 2: | Line 2: | ||
If you wish to change the template, Please read [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions]. | If you wish to change the template, Please read [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions]. | ||
And note that osFunctions specification is still in development and may have big change. Don't create too severe format to put them into existing specification. | And note that osFunctions specification is still in development and may have big change. Don't create too severe format to put them into existing specification. | ||
| − | --></noinclude><includeonly>{{quicklinks}} | + | --></noinclude><includeonly>{{quicklinks}}[[Category:OSSL Functions]] |
| − | {| | + | {| |
| − | | colspan="2" | + | |colspan="2"|{{#if:{{{function_syntax|}}}|'''{{{function_syntax}}}'''|''No function syntax provided'' [[Category:OSSL_functions_without_function_syntax]]}} |
|- valign="top" | |- valign="top" | ||
| − | | | + | |colspan="2"|{{#if:{{{description|}}}|{{{description}}}|''No descriptions provided'' [[Category:OSSL_functions_without_descriptions]]}} |
| − | | | + | |
| − | | | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | }} | + | |
| − | + | ||
|- valign="top" | |- valign="top" | ||
| − | |''' | + | |'''Threat Level'''||{{#if:{{{threat_level|}}}|{{{threat_level}}}|''No threat level specified'' [[Category:OSSL_functions_without_threat_level]]}} |
| − | {{# | + | {{#if:{{{lps|}}}| |
| − | |- valign="top" | + | {{!}}- valign="top"{{!}}'''LPS'''{{!}}{{{lps}}}|}} |
| − | + | {{#if:{{{ossl_example|}}}| | |
| − | {{ | + | {{!}}- valign="top" |
| + | {{!}}colspan="2"{{!}}'''Example(s)''' | ||
| + | {{!}}- valign="top" | ||
| + | {{!}}colspan="2"{{!}}{{{ossl_example}}}|[[Category:OSSL_functions_without_example]]}} | ||
| + | {{#if:{{{additional_info|}}}| | ||
| + | {{!}}- valign="top" | ||
| + | {{!}}colspan="2"{{!}}'''Notes''' | ||
| + | {{!}}- valign="top" | ||
| + | {{!}}colspan="2"{{!}}{{{additional_info}}}|[[Category:OSSL_functions_without_notes]]}} | ||
|} | |} | ||
| − | + | {{#switch:{{{threat_level|}}} | |
| − | {{# | + | | None = [[Category:OSSL Functions/ThreatLevel:None]] |
| − | [[Category:OSSL Functions]] | + | | Nuisance = [[Category:OSSL Functions/ThreatLevel:Nuisance]] |
| + | | VeryLow = [[Category:OSSL Functions/ThreatLevel:VeryLow]] | ||
| + | | Low = [[Category:OSSL Functions/ThreatLevel:Low]] | ||
| + | | Moderate = [[Category:OSSL Functions/ThreatLevel:Moderate]] | ||
| + | | High = [[Category:OSSL Functions/ThreatLevel:High]] | ||
| + | | VeryHigh = [[Category:OSSL Functions/ThreatLevel:VeryHigh]] | ||
| + | | Severe = [[Category:OSSL Functions/ThreatLevel:Severe]] | ||
| + | }} | ||
</includeonly> | </includeonly> | ||
<noinclude> | <noinclude> | ||
This template is to be used as follows (copy and paste the following into a new page): | This template is to be used as follows (copy and paste the following into a new page): | ||
| − | + | <pre> | |
| − | + | {{osslfunc | |
| − | + | |function_syntax= | |
| − | + | |description= | |
| − | + | |threat_level= | |
| − | + | |lps= | |
| − | + | |ossl_example= | |
| − | + | |additional_info= | |
| − | + | }} | |
| − | + | </pre> | |
| + | |||
| + | {|border="1" cellspacing="0" width="80%" | ||
| + | |- style="background-color:#DDDDFF;" | ||
| + | |Property||Description||Required | ||
| + | |- | ||
| + | |function_syntax||syntax||Yes | ||
| + | |- | ||
| + | |description||definitions or descriptions||Yes | ||
| + | |- | ||
| + | |threat_level||[[Threat level]]||Yes | ||
| + | |- | ||
| + | |lps||LPS||No | ||
| + | |- | ||
| + | |ossl_example||sample codes||No | ||
| + | |- | ||
| + | |additional_info||notes, hints or so||No | ||
| + | |} | ||
| + | |||
| + | You can find some infomation about OSSL functions within IOSSL_Api.cs or OSSL_Api.cs. If you unsure what to fill in, feel free to leave it empty and wait for experts shown up:) | ||
| − | + | If you add some additional common facilities like threat level or LPS, feel free to add it to this template. | |
Features of this template: | Features of this template: | ||
* Includes the <nowiki>{{quicklinks}}</nowiki> template | * Includes the <nowiki>{{quicklinks}}</nowiki> template | ||
* Automatically adds the article to all the relevant categories | * Automatically adds the article to all the relevant categories | ||
| − | * Displays a placeholder text when | + | * Displays a placeholder text when required information is missing, and adds the article to the relevant "missing" category/categories. |
For deprecated functions, use [[:Template:Osslfunc/Deprecated]] instead of this template. | For deprecated functions, use [[:Template:Osslfunc/Deprecated]] instead of this template. | ||
</noinclude> | </noinclude> | ||
Revision as of 17:59, 1 July 2011
This template is to be used as follows (copy and paste the following into a new page):
{{osslfunc
|function_syntax=
|description=
|threat_level=
|lps=
|ossl_example=
|additional_info=
}}
| Property | Description | Required |
| function_syntax | syntax | Yes |
| description | definitions or descriptions | Yes |
| threat_level | Threat level | Yes |
| lps | LPS | No |
| ossl_example | sample codes | No |
| additional_info | notes, hints or so | No |
You can find some infomation about OSSL functions within IOSSL_Api.cs or OSSL_Api.cs. If you unsure what to fill in, feel free to leave it empty and wait for experts shown up:)
If you add some additional common facilities like threat level or LPS, feel free to add it to this template.
Features of this template:
- Includes the {{quicklinks}} template
- Automatically adds the article to all the relevant categories
- Displays a placeholder text when required information is missing, and adds the article to the relevant "missing" category/categories.
For deprecated functions, use Template:Osslfunc/Deprecated instead of this template.
