View source for LSL Editing Primer

{{LSL Header}}

__TOC__

In the LSL Portal area of the wiki there are several templates in use for standardizing appearance and making editing easier.

== General Templates ==

There are several universal templates, the most used template names are short for ease of typing.

{|{{Prettytable}}
!Name
!Description
!example
|-
|<nowiki>{{</nowiki>[[Template:LSLG|LSLG]]<nowiki>|page|text}}</nowiki>
|Links between pages<br/>Use for pages in the LSL_ pseudo-namespace.<br/>if '''text''' is omitted then it defaults to '''page'''
|<nowiki>{{LSLG|llAbs|integer absolute value}}</nowiki><br/>{{LSLG|llAbs|integer absolute value}}<br/><nowiki>{{LSLG|llAbs}}</nowiki><br/>{{LSLG|llAbs}}
|-
|<nowiki>{{</nowiki>[[Template:LSLC|LSLC]]<nowiki>|page|sort}}</nowiki>
|Adds a page to a group<br/>Use instead of <nowiki>[[Category:LSL name|name]]</nowiki><br/>sort is optional, the template will try to calculate it.
|
|-
|<nowiki>{{</nowiki>[[Template:LSLGC|LSLGC]]<nowiki>|category|text}}</nowiki>
|Links to a LSL Category<br/>Use instead of <nowiki>[[:Category:LSL category|text]]</nowiki><br/>if '''text''' is omitted then it defaults to '''category'''
|<nowiki>{{LSLGC|Math/3D|3D Math Functions}}</nowiki><br/>{{LSLGC|Math/3D|3D Math Functions}}<br/><nowiki>{{LSLGC|Math}}</nowiki><br/>{{LSLGC|Math}}<br/>
|-
|<nowiki>{{</nowiki>[[Template:HoverText|HoverText]]<nowiki>|word|description}}</nowiki>
|When you move the cursor over this it shows a box containing '''description'''.
|<nowiki>{{HoverText|monkeys|A species of mammal}}</nowiki><br/>{{HoverText|monkeys|A species of mammal}}
|-
|<nowiki>{{</nowiki>[[Template:LSL Header|LSL_Header]]<nowiki>}}</nowiki>
|Used for pages that don't use a template that includes it. Like categories and this page.
|<nowiki>{{LSL Header}}</nowiki>
|-
|<nowiki>{{</nowiki>[[Template:LSL Hex|LSL_Hex]]<nowiki>|hex|int}}</nowiki>
|A HoverText for '''hex''' showing the '''int''' with a short standard description.<br/>If '''int''' is excluded or empty, then '''int''' is calculated from '''hex'''.
|<nowiki>{{LSL Hex|0x100|256}}</nowiki><br/>{{LSL Hex|0x100|256}}<br/><nowiki>{{LSL Hex|0x100}}</nowiki><br/>{{LSL Hex|0x100}}
|-
|<nowiki>{{</nowiki>[[Template:!|!]]<nowiki>}}</nowiki>
|Used instead of a {{HoverText|<nowiki>|</nowiki>|vertical pipe}} for when embedding them in templates parameters.
|<nowiki>{{!}}</nowiki><br/><nowiki>|</nowiki>
|}

==Embedding Tables==

One of the weaknesses in MediaWiki is the difficulty in embedding tables as parameters for templates. There are a few ways around this.

# Write the table in HTML using <nowiki><table> & </table>, <tr> & </tr>, <td> & </td></nowiki> tags. If you go this route you must close your tags properly (or MediaWiki will do strange things).
# Use MediaWiki syntax for tables and replace every occurrence (not being used as a template separator) of '|' with <nowiki>'{{!}}'</nowiki>
# Wrap the table with <nowiki><div></div></nowiki> tags (doesn't always work).

*Note that you may need to play with the whitespace to get MediaWiki to display it properly.



{|{{Prettytable}}
|+ '''HTML Method'''
!Before
!After
!Embedded
|-
|<pre>{|{{Prettytable}}
! Permissions
! Value
! Description
|- 
| {{LSLG|PERM_ALL}}
| {{LSL Hex|0x7FFFFFFF|2147483647}}
| Move/Modify/Copy/Transfer permissions
|- 
| {{LSLG|PERM_COPY}}
| {{LSL Hex|0x00008000|32768}}
| Copy permission
|- 
| {{LSLG|PERM_MODIFY}}
| {{LSL Hex|0x00004000|16384}}
| Modify permission
|- 
| {{LSLG|PERM_MOVE}}
| {{LSL Hex|0x00080000|524288}}
| Move permission
|- 
| {{LSLG|PERM_TRANSFER}}
| {{LSL Hex|0x00002000|8192}}
| Transfer permission
|}
</pre>
|<pre>
<table {{Prettytable}}><tr>
<th> Permissions</th>
<th> Value</th>
<th> Description</th>
</tr><tr>
<td> {{LSLG|PERM_ALL}}</td>
<td> {{LSL Hex|0x7FFFFFFF|2147483647}}</td>
<td> Move/Modify/Copy/Transfer permissions</td>
</tr><tr>
<td> {{LSLG|PERM_COPY}}</td>
<td> {{LSL Hex|0x00008000|32768}}</td>
<td> Copy permission</td>
</tr><tr>
<td> {{LSLG|PERM_MODIFY}}</td>
<td> {{LSL Hex|0x00004000|16384}}</td>
<td> Modify permission</td>
</tr><tr>
<td> {{LSLG|PERM_MOVE}}</td>
<td> {{LSL Hex|0x00080000|524288}}</td>
<td> Move permission</td>
</tr><tr>
<td> {{LSLG|PERM_TRANSFER}}</td>
<td> {{LSL Hex|0x00002000|8192}}</td>
<td> Transfer permission</td>
</tr></table>
</pre>
|
Table in Table:
<table {{Prettytable}}><tr>
<th> Permissions</th>
<th> Value</th>
<th> Description</th>
</tr><tr>
<td> {{LSLG|PERM_ALL}}</td>
<td> {{LSL Hex|0x7FFFFFFF|2147483647}}</td>
<td> Move/Modify/Copy/Transfer permissions</td>
</tr><tr>
<td> {{LSLG|PERM_COPY}}</td>
<td> {{LSL Hex|0x00008000|32768}}</td>
<td> Copy permission</td>
</tr><tr>
<td> {{LSLG|PERM_MODIFY}}</td>
<td> {{LSL Hex|0x00004000|16384}}</td>
<td> Modify permission</td>
</tr><tr>
<td> {{LSLG|PERM_MOVE}}</td>
<td> {{LSL Hex|0x00080000|524288}}</td>
<td> Move permission</td>
</tr><tr>
<td> {{LSLG|PERM_TRANSFER}}</td>
<td> {{LSL Hex|0x00002000|8192}}</td>
<td> Transfer permission</td>
</tr></table>
Table as template parameter:
<div>
{{Simple|in=<table {{Prettytable}}><tr>
<th> Permissions</th>
<th> Value</th>
<th> Description</th>
</tr><tr>
<td> {{LSLG|PERM_ALL}}</td>
<td> {{LSL Hex|0x7FFFFFFF|2147483647}}</td>
<td> Move/Modify/Copy/Transfer permissions</td>
</tr><tr>
<td> {{LSLG|PERM_COPY}}</td>
<td> {{LSL Hex|0x00008000|32768}}</td>
<td> Copy permission</td>
</tr><tr>
<td> {{LSLG|PERM_MODIFY}}</td>
<td> {{LSL Hex|0x00004000|16384}}</td>
<td> Modify permission</td>
</tr><tr>
<td> {{LSLG|PERM_MOVE}}</td>
<td> {{LSL Hex|0x00080000|524288}}</td>
<td> Move permission</td>
</tr><tr>
<td> {{LSLG|PERM_TRANSFER}}</td>
<td> {{LSL Hex|0x00002000|8192}}</td>
<td> Transfer permission</td>
</tr></table>}}</div>
|}

{|{{Prettytable}}
|+'''Pipe Replacement Method'''
!Before
!After
!Embedded
|-
|<pre>{|{{Prettytable}}
! Permissions
! Value
! Description
|- 
| {{LSLG|PERM_ALL}}
| {{LSL Hex|0x7FFFFFFF|2147483647}}
| Move/Modify/Copy/Transfer permissions
|- 
| {{LSLG|PERM_COPY}}
| {{LSL Hex|0x00008000|32768}}
| Copy permission
|- 
| {{LSLG|PERM_MODIFY}}
| {{LSL Hex|0x00004000|16384}}
| Modify permission
|- 
| {{LSLG|PERM_MOVE}}
| {{LSL Hex|0x00080000|524288}}
| Move permission
|- 
| {{LSLG|PERM_TRANSFER}}
| {{LSL Hex|0x00002000|8192}}
| Transfer permission
|}
</pre>
|<pre>{{{!}}{{Prettytable}}
! Permissions
! Value
! Description
{{!}}- 
{{!}} {{LSLG|PERM_ALL}}
{{!}} {{LSL Hex|0x7FFFFFFF|2147483647}}
{{!}} Move/Modify/Copy/Transfer permissions
{{!}}- 
{{!}} {{LSLG|PERM_COPY}}
{{!}} {{LSL Hex|0x00008000|32768}}
{{!}} Copy permission
{{!}}- 
{{!}} {{LSLG|PERM_MODIFY}}
{{!}} {{LSL Hex|0x00004000|16384}}
{{!}} Modify permission
{{!}}- 
{{!}} {{LSLG|PERM_MOVE}}
{{!}} {{LSL Hex|0x00080000|524288}}
{{!}} Move permission
{{!}}- 
{{!}} {{LSLG|PERM_TRANSFER}}
{{!}} {{LSL Hex|0x00002000|8192}}
{{!}} Transfer permission
{{!}}}
</pre>
|
Table in Table:
{{{!}}{{Prettytable}}
! Permissions
! Value
! Description
{{!}}- 
{{!}} {{LSLG|PERM_ALL}}
{{!}} {{LSL Hex|0x7FFFFFFF|2147483647}}
{{!}} Move/Modify/Copy/Transfer permissions
{{!}}- 
{{!}} {{LSLG|PERM_COPY}}
{{!}} {{LSL Hex|0x00008000|32768}}
{{!}} Copy permission
{{!}}- 
{{!}} {{LSLG|PERM_MODIFY}}
{{!}} {{LSL Hex|0x00004000|16384}}
{{!}} Modify permission
{{!}}- 
{{!}} {{LSLG|PERM_MOVE}}
{{!}} {{LSL Hex|0x00080000|524288}}
{{!}} Move permission
{{!}}- 
{{!}} {{LSLG|PERM_TRANSFER}}
{{!}} {{LSL Hex|0x00002000|8192}}
{{!}} Transfer permission
{{!}}}
Table as template parameter:
<div>
{{Simple|in={{{!}}{{Prettytable}}
! Permissions
! Value
! Description
{{!}}- 
{{!}} {{LSLG|PERM_ALL}}
{{!}} {{LSL Hex|0x7FFFFFFF|2147483647}}
{{!}} Move/Modify/Copy/Transfer permissions
{{!}}- 
{{!}} {{LSLG|PERM_COPY}}
{{!}} {{LSL Hex|0x00008000|32768}}
{{!}} Copy permission
{{!}}- 
{{!}} {{LSLG|PERM_MODIFY}}
{{!}} {{LSL Hex|0x00004000|16384}}
{{!}} Modify permission
{{!}}- 
{{!}} {{LSLG|PERM_MOVE}}
{{!}} {{LSL Hex|0x00080000|524288}}
{{!}} Move permission
{{!}}- 
{{!}} {{LSLG|PERM_TRANSFER}}
{{!}} {{LSL Hex|0x00002000|8192}}
{{!}} Transfer permission
{{!}}}}}
</div>
|}

{|{{Prettytable}}
|+'''Div Tag Method''' (doesn't always work)
!Before
!After
!Embedded
|-
|<pre>{|{{Prettytable}}
! Permissions
! Value
! Description
|- 
| {{LSLG|PERM_ALL}}
| {{LSL Hex|0x7FFFFFFF|2147483647}}
| Move/Modify/Copy/Transfer permissions
|- 
| {{LSLG|PERM_COPY}}
| {{LSL Hex|0x00008000|32768}}
| Copy permission
|- 
| {{LSLG|PERM_MODIFY}}
| {{LSL Hex|0x00004000|16384}}
| Modify permission
|- 
| {{LSLG|PERM_MOVE}}
| {{LSL Hex|0x00080000|524288}}
| Move permission
|- 
| {{LSLG|PERM_TRANSFER}}
| {{LSL Hex|0x00002000|8192}}
| Transfer permission
|}
</pre>
|<pre><div>
{|{{Prettytable}}
! Permissions
! Value
! Description
|- 
| {{LSLG|PERM_ALL}}
| {{LSL Hex|0x7FFFFFFF|2147483647}}
| Move/Modify/Copy/Transfer permissions
|- 
| {{LSLG|PERM_COPY}}
| {{LSL Hex|0x00008000|32768}}
| Copy permission
|- 
| {{LSLG|PERM_MODIFY}}
| {{LSL Hex|0x00004000|16384}}
| Modify permission
|- 
| {{LSLG|PERM_MOVE}}
| {{LSL Hex|0x00080000|524288}}
| Move permission
|- 
| {{LSLG|PERM_TRANSFER}}
| {{LSL Hex|0x00002000|8192}}
| Transfer permission
|}
</div>
</pre>
|
Table in Table:
<div>
{|{{Prettytable}}
! Permissions
! Value
! Description
|- 
| {{LSLG|PERM_ALL}}
| {{LSL Hex|0x7FFFFFFF|2147483647}}
| Move/Modify/Copy/Transfer permissions
|- 
| {{LSLG|PERM_COPY}}
| {{LSL Hex|0x00008000|32768}}
| Copy permission
|- 
| {{LSLG|PERM_MODIFY}}
| {{LSL Hex|0x00004000|16384}}
| Modify permission
|- 
| {{LSLG|PERM_MOVE}}
| {{LSL Hex|0x00080000|524288}}
| Move permission
|- 
| {{LSLG|PERM_TRANSFER}}
| {{LSL Hex|0x00002000|8192}}
| Transfer permission
|}
</div>
|}

==Functions==
Besides the general templates there is only one function specific template.

[[Template:LSL Function]]<br/>
This template provides a structure to write the functions documentation over; it includes several sections.

*Please do not remove information.
*Order of variables does not matter.
*Most variables if not set will cause the applicable section to hide (not all sections hide).
*Unused variables do not need to be included but it is better to not removed unused variables to aid future editors.
*Please head all messages generated by the template.
*If you think a section should be added please add it to [[LSL Function Style]] (and they will shortly be added to the template).

Please refer to [[Template:LSL Function|LSL_Function]] for a detailed explanation of it's syntax and attributes.

{|{{Prettytable}}
!Base
!Example: {{LSLG|llFrand}}
|-
|<pre>
{{LSL_Function
|func
|func_id
|func_sleep
|sort
|func_desc
|func_footnote
|return_type
|return_text
|p1_type|p1_name|p1_desc
|p2_type|p2_name|p2_desc
|p3_type|p3_name|p3_desc
|p4_type|p4_name|p4_desc
|p5_type|p5_name|p5_desc
|p6_type|p6_name|p6_desc
|p7_type|p7_name|p7_desc
|p8_type|p8_name|p8_desc
|p9_type|p9_name|p9_desc
|p10_type|p10_name|p10_desc
|p11_type|p11_name|p11_desc
|p12_type|p12_name|p12_desc
|constants
|spec
|caveats
|examples
|helpers
|also_header
|also_functions
|also_tests
|also_articles
|also_events
|also_footer
|notes
|mode
|deprecated
|permission
|negative_index
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
|location
}}
</pre>
|<pre>
{{LSL_Function
|sort=Frand
|func=llFrand
|func_id=8
|func_sleep=0.0
|func_energy=10.0
|p1_type=float
|p1_name=mag
|p1_desc=Any valid float value
|return_type=float
|return_text=that is pseudo random number in the range [0.0,mag) or (mag, 0.0].
|spec=returns a pseudo random number in range [0.0, mag) or (mag, 0.0], depending upon the sign of mag.
|caveats=The random number generator is not a source of entropy.
|examples=<lsl>
default
{
    touch_start(integer total_number)
    {
        // When touched, say "Heads" with probability 0.5, 
        // otherwise, say "Tails."
        if ( llFrand(1.) < .5)
            llSay(0, "Heads");
        else
            llSay(0, "Tails");
    }
}
</lsl>
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes=
The random number generator is not a source of entropy.

The sequence of random numbers are shared across the entire process, and not independently seeded.
Therefore, the pseudo random number generation is not suitable for any application which requires
completely predictable or completely unpredictable results.
|cat1=Math
|cat2
|cat3
}}
</pre>
|}

==Events==

Besides the general templates there is only one event specific template.

[[Template:LSL Event|LSL_Event]]
This template provides a structure to write the event documentation over. It provides several sections. Unused sections are typically are hidden from view.

Please refer to [[Template:LSL Event|LSL_Event]] for a detailed explanation of it's syntax and attributes.

==Constants==

No constant specific template has been written yet, the style is still being sorted out.