Difference between revisions of "LSL Editing Primer/pt"
(New page: {{Multi-lang}} {{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 ...) |
|||
Line 4: | Line 4: | ||
__TOC__ | __TOC__ | ||
Na área wiki do Portal LSL, existem vários gabaritos usados para padronizar a aparência e tornar a edição mais fácil. | |||
== | == Gabaritos de Uso Geral == | ||
Existem diversos gabaritos universais, com os nomes de gabarito mais usados sendo curtos, para facilitar a digitação. | |||
{|{{Prettytable}} | {|{{Prettytable}} | ||
! | !Nome | ||
! | !Descrição | ||
! | !exemplo | ||
|- | |- | ||
|<nowiki>{{</nowiki>[[Template:LSLC|LSLC]]<nowiki>|category|sort}}</nowiki> | |<nowiki>{{</nowiki>[[Template:LSLC|LSLC]]<nowiki>|category|sort}}</nowiki> | ||
| | |Adiciona uma página em um grupo<br/>Use no lugar de <nowiki>[[Category:LSL name|name]]</nowiki><br/>sort é opcional. | ||
| | | | ||
|- | |- | ||
|<nowiki>{{</nowiki>[[Template:LSLGC|LSLGC]]<nowiki>|category|text}}</nowiki> | |<nowiki>{{</nowiki>[[Template:LSLGC|LSLGC]]<nowiki>|category|text}}</nowiki> | ||
| | |Faz o link a uma categoria LSL<br/>Use no lugar de <nowiki>[[:Category:LSL category|text]]</nowiki><br/>se '''text''' é omitido, então o padrão é '''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>{{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> | |<nowiki>{{</nowiki>[[Template:HoverText|HoverText]]<nowiki>|word|description}}</nowiki> | ||
| | |Quando você move o cursor sobre a palavra, mostra um "box" contendo a descrição '''description'''. | ||
|<nowiki>{{HoverText| | |<nowiki>{{HoverText|macacos|Uma espécie de mamíferos}}</nowiki><br/>{{HoverText|macacos|Uma espécie de mamíferos}} | ||
|- | |- | ||
|<nowiki>{{</nowiki>[[Template:LSL Header|LSL_Header]]<nowiki>}}</nowiki> | |<nowiki>{{</nowiki>[[Template:LSL Header|LSL_Header]]<nowiki>}}</nowiki> | ||
| | |Usado para páginas que não usam um gabarito que as inclua. Como categorias e esta página. | ||
|<nowiki>{{LSL Header}}</nowiki> | |<nowiki>{{LSL Header}}</nowiki> | ||
|- | |- |
Revision as of 19:13, 29 August 2008
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Na área wiki do Portal LSL, existem vários gabaritos usados para padronizar a aparência e tornar a edição mais fácil.
Gabaritos de Uso Geral
Existem diversos gabaritos universais, com os nomes de gabarito mais usados sendo curtos, para facilitar a digitação.
Nome | Descrição | exemplo |
---|---|---|
{{LSLC|category|sort}} | Adiciona uma página em um grupo Use no lugar de [[Category:LSL name|name]] sort é opcional. |
|
{{LSLGC|category|text}} | Faz o link a uma categoria LSL Use no lugar de [[:Category:LSL category|text]] se text é omitido, então o padrão é category |
{{LSLGC|Math/3D|3D Math Functions}} 3D Math Functions {{LSLGC|Math}} Math |
{{HoverText|word|description}} | Quando você move o cursor sobre a palavra, mostra um "box" contendo a descrição description. | {{HoverText|macacos|Uma espécie de mamíferos}} macacos |
{{LSL_Header}} | Usado para páginas que não usam um gabarito que as inclua. Como categorias e esta página. | {{LSL Header}} |
{{LSL_Hex|hex|int}} | A HoverText for hex showing the int with a short standard description. If int is excluded or empty, then int is calculated from hex. |
{{LSL Hex|0x100|256}} 0x100 {{LSL Hex|0x100}} 0x100 |
{{!}} | Used instead of a | for when embedding them in templates parameters. | {{!}} | |
{{=}} | Used instead of a = for when you need a text equals sign that cannot interfere with templates parameters. | {{=}} = |
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 <table> & </table>, <tr> & </tr>, <th> & </th>, <td> & </td> 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 '{{!}}'
- Wrap the table with <div></div> tags (doesn't always work).
- Note that you may need to play with the whitespace to get MediaWiki to display it properly.
Before | After | Embedded | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{|{{Prettytable}} ! Permissions ! Value ! Description |- | [[PERM_ALL]] | {{LSL Hex|0x7FFFFFFF|2147483647}} | Move/Modify/Copy/Transfer permissions |- | [[PERM_COPY]] | {{LSL Hex|0x00008000|32768}} | Copy permission |- | [[PERM_MODIFY]] | {{LSL Hex|0x00004000|16384}} | Modify permission |- | [[PERM_MOVE]] | {{LSL Hex|0x00080000|524288}} | Move permission |- | [[PERM_TRANSFER]] | {{LSL Hex|0x00002000|8192}} | Transfer permission |} |
<table {{Prettytable}}><tr> <th> Permissions</th> <th> Value</th> <th> Description</th> </tr><tr> <td> [[PERM_ALL]]</td> <td> {{LSL Hex|0x7FFFFFFF|2147483647}}</td> <td> Move/Modify/Copy/Transfer permissions</td> </tr><tr> <td> [[PERM_COPY]]</td> <td> {{LSL Hex|0x00008000|32768}}</td> <td> Copy permission</td> </tr><tr> <td> [[PERM_MODIFY]]</td> <td> {{LSL Hex|0x00004000|16384}}</td> <td> Modify permission</td> </tr><tr> <td> [[PERM_MOVE]]</td> <td> {{LSL Hex|0x00080000|524288}}</td> <td> Move permission</td> </tr><tr> <td> [[PERM_TRANSFER]]</td> <td> {{LSL Hex|0x00002000|8192}}</td> <td> Transfer permission</td> </tr></table> |
Table in Table:
Table as template parameter:
|
Before | After | Embedded | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{|{{Prettytable}} ! Permissions ! Value ! Description |- | [[PERM_ALL]] | {{LSL Hex|0x7FFFFFFF|2147483647}} | Move/Modify/Copy/Transfer permissions |- | [[PERM_COPY]] | {{LSL Hex|0x00008000|32768}} | Copy permission |- | [[PERM_MODIFY]] | {{LSL Hex|0x00004000|16384}} | Modify permission |- | [[PERM_MOVE]] | {{LSL Hex|0x00080000|524288}} | Move permission |- | [[PERM_TRANSFER]] | {{LSL Hex|0x00002000|8192}} | Transfer permission |} |
{{{!}}{{Prettytable}} ! Permissions ! Value ! Description {{!}}- {{!}} [[PERM_ALL]] {{!}} {{LSL Hex|0x7FFFFFFF|2147483647}} {{!}} Move/Modify/Copy/Transfer permissions {{!}}- {{!}} [[PERM_COPY]] {{!}} {{LSL Hex|0x00008000|32768}} {{!}} Copy permission {{!}}- {{!}} [[PERM_MODIFY]] {{!}} {{LSL Hex|0x00004000|16384}} {{!}} Modify permission {{!}}- {{!}} [[PERM_MOVE]] {{!}} {{LSL Hex|0x00080000|524288}} {{!}} Move permission {{!}}- {{!}} [[PERM_TRANSFER]] {{!}} {{LSL Hex|0x00002000|8192}} {{!}} Transfer permission {{!}}} |
Table in Table:
Table as template parameter:
|
Before | After | Embedded | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{|{{Prettytable}} ! Permissions ! Value ! Description |- | [[PERM_ALL]] | {{LSL Hex|0x7FFFFFFF|2147483647}} | Move/Modify/Copy/Transfer permissions |- | [[PERM_COPY]] | {{LSL Hex|0x00008000|32768}} | Copy permission |- | [[PERM_MODIFY]] | {{LSL Hex|0x00004000|16384}} | Modify permission |- | [[PERM_MOVE]] | {{LSL Hex|0x00080000|524288}} | Move permission |- | [[PERM_TRANSFER]] | {{LSL Hex|0x00002000|8192}} | Transfer permission |} |
<div> {|{{Prettytable}} ! Permissions ! Value ! Description |- | [[PERM_ALL]] | {{LSL Hex|0x7FFFFFFF|2147483647}} | Move/Modify/Copy/Transfer permissions |- | [[PERM_COPY]] | {{LSL Hex|0x00008000|32768}} | Copy permission |- | [[PERM_MODIFY]] | {{LSL Hex|0x00004000|16384}} | Modify permission |- | [[PERM_MOVE]] | {{LSL Hex|0x00080000|524288}} | Move permission |- | [[PERM_TRANSFER]] | {{LSL Hex|0x00002000|8192}} | Transfer permission |} </div> |
Table in Table:
|
Functions
Besides the general templates there is only one function specific template.
Template:LSL Function
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 LSL_Function for a detailed explanation of it's syntax and attributes.
Base | Example: llFrand |
---|---|
{{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 }} |
{{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 |cat4 }} |
Events
Besides the general templates there is only one event specific template.
LSL_Event This template provides a structure to write the event documentation over; it includes several sections. Unused sections are typically hidden from view.
Please refer to LSL_Event for a detailed explanation of its syntax and attributes.
Constants
There is only one constant specific template.
LSL_Constant This template provides a structure to write constant documentation over; it includes several sections. Unused sections are typically hidden from view.
Please refer to LSL_Constant for a detailed explanation of its syntax and attributes.