Difference between revisions of "Template:LSL Generic"

From Second Life Wiki
Jump to navigation Jump to search
m
 
(74 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__ <noinclude>
__NOTOC__ <noinclude>
<pre>
See [[{{FULLPAGENAME}}/docs]] for documentation.{{#if:
{{LSL Generic
 
|name
{{#vardefine:also_header|header}}
|header_desc
{{#vardefine:also_events|{{!}}events}}
|header_footnote
{{#vardefine:also_tests|{{!}}tests}}
|deprecated
{{#vardefine:also_articles|{{!}}articles}}
|p1_type|p1_name|p1_desc
{{#vardefine:also_functions|{{!}}functions}}
|p2_type|p2_name|p2_desc
{{#vardefine:also_footer|footer}}
|p3_type|p3_name|p3_desc
{{#vardefine:examples|examples}}
|p4_type|p4_name|p4_desc
{{#vardefine:constants_nb|constants_nb}}
|p5_type|p5_name|p5_desc
{{#vardefine:notes|notes}}
|p6_type|p6_name|p6_desc
{{#vardefine:caveats|caveats}}
|p7_type|p7_name|p7_desc
{{#vardefine:spec|spec}}
|p8_type|p8_name|p8_desc
{{#vardefine:header_title|header_title}}
|p9_type|p9_name|p9_desc
{{#vardefine:header_text|header_text}}
|p10_type|p10_name|p10_desc
{{#vardefine:header_floater|header_floater}}
|p11_type|p11_name|p11_desc
{{#vardefine:search|search}}
|p12_type|p12_name|p12_desc
 
|return_type
<!-- -->
|return_text
 
|constants
}}</noinclude><onlyinclude>{{#if:
|spec
 
|caveats
{{#vardefine:t|{{#pos:{{lc:{{PAGENAMEE}}}}|{{lc:{{#var:name}}}}}}}}
|examples
 
|helpers
{{#vardefine:caveats|{{#if:{{#var:caveats}}|
|also_header
{{#var:caveats}}}}
|also_functions
{{#ifeq:{{#var:mode}}|user||{{#if:{{#var:bugs}}|<h3 style="display:inline; line-height:2em;">Important Issues </h3>{{#if:{{#var:search}}|~ {{JiraSearch/1|1={{#var:search}}|2=Search JIRA for related Bugs}}}}
|also_articles
{{{!}} style="font-size:80%; line-height:1.1em;"  
|also_footer
{{#var:bugs}}
|notes
{{!}}}|{{#if:{{#var:search}}|{{PBR}}{{JiraSearch/1|1={{#var:search}}|2=Search JIRA for related Bugs}}|}}}}}}}}
|mode
 
}}
}}{{#if:{{#var:P_Rendered}}||{{#ifexpr:not {{#if:{{#var:t}}|{{#var:t}}|-1}} and {{#ifeq:{{#sub:{{ucfirst:{{#var:name}}}}|0|1}}|{{#sub:{{#var:name}}|0|1}}|0|1}}|{{lowercase}}}}
</pre>
{{#vardefine:P_Rendered|t}} {{#if:{{#var:self}}|| __NOEDITSECTION__ }} {{#var:header}}
</noinclude><includeonly> {{#if:{{{self|}}}|| __NOEDITSECTION__ }} {{#if:{{{depreciated|}}}{{{deprecated|}}}|
{{RightToc|font-size:80%}}
<div id="box" style="background:red;">
<div id="box"><h2 style="display:none"> {{#if:{{#var:alt_title}}|{{#var:alt_title}}|{{#var:header_title}}}} </h2>{{#ifexpr:{{#var:BugCounter|0}} > 0|<div class="mw-headline" style="float:right; margin: 5px 0.5em 0 0.5em;">{{LSL_Bug_Icon}}</div>}}<span id="{{anchorencode:Description}}" style="display:none"></span><span id="{{anchorencode:Summary}}" class="mw-headline" style="display:block; padding-bottom:0.17em; padding-top:0.5em; background:transparent none repeat scroll 0% 0%; color:#546368; font-family:Arial,Helvetica,Sans-Serif; background-color:#F4F8FB; border-bottom:1px dotted #AAAAAA; font-size:120%; font-weight:bold; margin:0pt; padding:0.2em 0.5em; text-align:left;"> {{#var:header_title}} </span><div style="padding: 0.5em; min-height: 5em;">{{#if:{{#var:header_floater}}|<div id="box" style="float:right;">{{#var:header_floater}}</div>}}
&nbsp;&nbsp;'''Deprecated Function'''
{{#var:header_text}}
<div style="padding: 0.5em;background:#ffffff;">
</div></div>{{#if:{{#var:spec}}|<div id="box">
''(This {{{type}}} has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none|.|, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead.)}}''</div></div>{{#if:{{{self|}}}|| [[Category:LSL Deprecated]] }} |}}{{#ifeq:{{{mode|}}}|god|
<h2>Specification</h2>
<div id="box" style="background:yellow;">
&nbsp;&nbsp;'''Requires God Mode'''
<div style="padding: 0.5em;background:#ffffff;">
''(This {{{type}}} can only be executed in God Mode.)''</div></div>{{#if:{{{self|}}}|| [[Category:LSL_God_Mode]] }} |}}{{#if:{{{also|}}}|
<div id="box" style="background:yellow;">
&nbsp;&nbsp;''' 'also' Tag Removed'''
<div style="padding: 0.5em;background:#ffffff;">
''(Please use 'also_header', 'also_events', 'also_functions', 'also_articles', or 'also_footer')''</div></div>{{#if:{{{self|}}}|| [[Category:LSL FixMe]] }} }}{{#if:{{{return_text|}}}{{{func_desc|}}}||
<div id="box" style="background:yellow;">
&nbsp;&nbsp;''' 'return_text' and 'func_desc' can both not be undefined'''
<div style="padding: 0.5em;background:#ffffff;">
''(Please use 'return_text' or 'func_desc' to describe the {{{type}}}s actions.)''</div></div>{{#if:{{{self|}}}|| [[Category:LSL FixMe]] }} }} <!-- {{lowercase|{{{func}}}}} -->
{| width="100%"
|-
|valign="top"|
{{LSL_Function_Header|{{{name}}}|
|r={{{return_type|}}}
|rd={{{return_text|}}}
|re={{{return_end|}}}
|p1t={{{p1_type|}}}|p1={{{p1_name|}}}|p1d={{{p1_desc|}}}
|p2t={{{p2_type|}}}|p2={{{p2_name|}}}|p2d={{{p2_desc|}}}
|p3t={{{p3_type|}}}|p3={{{p3_name|}}}|p3d={{{p3_desc|}}}
|p4t={{{p4_type|}}}|p4={{{p4_name|}}}|p4d={{{p4_desc|}}}
|p5t={{{p5_type|}}}|p5={{{p5_name|}}}|p5d={{{p5_desc|}}}
|p6t={{{p6_type|}}}|p6={{{p6_name|}}}|p6d={{{p6_desc|}}}
|p7t={{{p7_type|}}}|p7={{{p7_name|}}}|p7d={{{p7_desc|}}}
|p8t={{{p8_type|}}}|p8={{{p8_name|}}}|p8d={{{p8_desc|}}}
|p9t={{{p9_type|}}}|p9={{{p9_name|}}}|p9d={{{p9_desc|}}}
|p10t={{{p10_type|}}}|p10={{{p10_name|}}}|p10d={{{p10_desc|}}}
|p11t={{{p11_type|}}}|p11={{{p11_name|}}}|p11d={{{p11_desc|}}}
|p12t={{{p12_type|}}}|p12={{{p12_name|}}}|p12d={{{p12_desc|}}}
|tb={{{header_desc|}}}
|te={{{header_footnote|}}}
}}
|-
|{{ #if: {{{spec|}}} |  
<div id="box">
== Specification ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{{spec}}}
{{#var:spec}}
</div>
</div></div>}}{{#if:{{#var:constants_nb}}{{#var:constants}}|
</div>
{{#var:constants_nb}}{{#if:{{#var:constants}}|  
| }}
<div id="box"><h2>{{#if:{{#var:T_Constants}}|{{#var:T_Constants}}|Constants}}</h2>
|-
{{#var:constants}}
|{{ #if: {{{constants|}}} |  
</div>}}}}{{#if:{{#var:caveats}}|
<div id="box">
<div id="box"><h2>Caveats</h2>
== Constants ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{{constants}}}
{{#var:caveats}}
</div>
</div></div>}}{{#if:{{#if:{{#var:deprecated}}||t}}{{#var:examples}}|
</div>
<div id="box"><h2>Examples</h2>
| }}
|-
|<div id="box">
== Caveats ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{#if:{{{depreciated|}}}{{{deprecated|}}}|* This {{{type}}} has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none||, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead}}.<br />|}}{{#ifeq:{{{mode|}}}|god|* This {{{type}}} can only be executed in God Mode.<br />|}}{{#if: {{{depreciated|}}}{{{deprecated|}}}{{{caveats|}}}{{#ifeq:{{{mode|}}}|god|god|}} | {{{caveats|}}} | * None known.}}
{{#var:examples}}
</div>
</div></div>}}{{#if:{{#var:helpers}}|
</div>
<div id="box"><h2>Useful Snippets</h2>
|-
|{{ #if: {{#if:{{{depreciated|}}}{{{deprecated|}}}||t}}{{{examples|}}} |
<div id="box">
== Examples ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{ #if: {{{examples|}}} | {{{examples|}}} | }}
{{#var:helpers}}
</div>
</div></div>}}{{#if:{{#var:notes}}|
</div>
<div id="box"><h2>Notes</h2>
|}}
|-
|{{ #if: {{{helpers|}}} |  
<div id="box">
== Helper Functions ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{{helpers}}}
{{#var:notes}}
</div>
</div></div>}}{{#if:{{#var:also_footer}}{{#var:also_functions}}{{#var:also_events}}{{#var:also_articles}}{{#var:also_tests}}{{#var:also_header}}|
</div>
<div id="box"><h2>See Also</h2>
| }}
|-
|{{ #if: {{#if:{{{depreciated|}}}{{{deprecated|}}}||t}}{{{notes|}}} |
<div id="box">
== Notes ==
<div style="padding: 0.5em">
<div style="padding: 0.5em">
{{ #if: {{{notes|}}} | {{{notes|}}} | }}
{{#if:{{#var:also_header}}|
</div>
{{#var:also_header}}}}{{#if:{{#var:also_events}}|
</div>
<h3>Events</h3>
|}}
{{{!}}
|-
{{#var:also_events}}
|{{ #if: {{{also_footer|}}}{{{related|}}}{{{also_functions|}}}{{{also_events|}}}{{{also_articles|}}}{{{also_header|}}} |  
{{!}}} }}{{#if:{{#var:also_functions}}|
<div id="box">
<h3>Functions</h3>
== See Also ==
{{{!}}
<div style="padding: 0.5em">
{{#var:also_functions}}
{{ #if: {{{also_header|}}} | {{{also_header}}}<br /> |}}{{ #if: {{{also_events|}}} |
{{!}}} }}{{#if:{{#var:also_articles}}|
<ul><li> Events </li></ul><dl><dd>
<h3>Articles</h3>
{{{also_events|}}}</dl> | }}{{ #if: {{{also_functions|}}} |
{{{!}}
<ul><li> Functions </li></ul><dl><dd>
{{#var:also_articles}}
{{{also_functions|}}}</dl> | }}{{ #if: {{{also_articles|}}} |
{{!}}} }}
<ul><li> Articles </li></ul><dl><dd>
{{#if:{{#var:also_footer}}|{{PBR}}{{#var:also_footer}}}}
{{{also_articles}}}</dl> | }} {{{also_footer|}}}
</div></div>}}
</div>
{{#if:{{#var:deepnotes}}{{#var:mono}}{{#var:lso}}{{#var:history}}{{#var:issues}}{{#var:search}}{{#var:location}}{{#var:also_tests}}{{#var:messaging}}{{#var:footnotes}}|<div id="box">
</div>
== Deep Notes ==
| }}
<div style="padding: 0.5em"><div>
|}
{{#var:deepnotes}}
{{ #if: {{{no_footer|}}} | |:<div style="font-size:x-small;">This page is based on information gathered from the Second Life client {{HoverText|source|'linden\indra\lscript\lscript_library\lscript_library.cpp'}}, and as such has additional [http://secondlife.com/developers/opensource/licenses licensing restrictions].</div> }}</includeonly>
</div>{{#if:{{#var:mono}}|
<h4> Mono VM Notes </h4><div>
{{#var:mono}}
</div>}}{{#if:{{#var:lso}}|
<h4> LSO VM Notes </h4><div>
{{#var:lso}}
</div>}}{{#if:{{#var:history}}|
<h4> History </h4><div>
{{#var:history}}
</div>}}{{#if:{{#var:issues}}|
<h4 style="display:inline; line-height:2em;">Issues </h4>{{#if:{{#var:search}}|~ {{JiraSearch/2|1={{#var:search}}|2=Search JIRA for related Issues}}}}
{{{!}} style="font-size:90%; line-height:1.1em;"
{{#var:issues}}
{{!}}}
|{{#if:{{#var:search}}|<h4>Issues</h4>
{{JiraSearch/2|1={{#var:search}}|2=Search JIRA for related Issues}}
}}}}{{#if:{{#var:also_tests}}|
<h3>Tests</h3>
{{{!}}
{{#var:also_tests}}
{{!}}}
}}{{#if:{{#var:location}}|
<h4> Source </h4><div>
{{#var:location}}
</div>}}{{#if:{{#var:messaging}}|
<h4> Messaging </h4><div>
{{#var:messaging}}
</div>}}{{#if:{{#var:footnotes}}|
<h4 style="margin-bottom:0;"> Footnotes </h4>
{{{{#if:{{#var:footnotes}}|Footnotes|!}}|}}
}}
</div></div>}}{{#if:{{#var:comments}}|<div id="box">
<h2>Comments</h2>
<div style="padding: 0.5em;">
{{#var:comments}}
</div></div>}}
{{#var:footer}}<span id="sort" style="visibility:hidden">{{#var:sort}}</span>}}</onlyinclude>

Latest revision as of 20:16, 17 December 2010

See Template:LSL Generic/docs for documentation.

header_title

header_title
header_floater

header_text

Specification

spec

constants_nb

Examples

examples

Notes

notes

See Also

header

Events

events

Functions

functions

Articles

articles

footer

Deep Notes

Issues

Search JIRA for related Issues

Tests

tests