Difference between revisions of "LSL Portal Guidelines"
Jump to navigation
Jump to search
Asuka Neely (talk | contribs) m |
(I thought it was time we properly codified the mission and goal) |
||
Line 1: | Line 1: | ||
{{Multi-lang}} | {{Multi-lang}} | ||
{{LSL Header}} | {{LSL Header}} | ||
{{RightToc}} | |||
This page is to define and describe the specific editing and posting Guidelines for the LSL Wiki Portal. | This page is to define and describe the specific editing and posting Guidelines for the LSL Wiki Portal. | ||
== About The LSL Portal == | |||
<h4>Mission Statement</h4> | |||
:"To provide accurate documentation for the scripting language of Second Life: LSL"{{Footnote|Derived from the open sentances of the [[LSL Portal]].|handle=1}} | |||
<h4>Goal Statement</h4> | |||
:"To provide documentation to help scripters of all skill levels."{{Footnote/dup|1}} | |||
== Guides == | == Guides == | ||
Line 15: | Line 22: | ||
# [[LSL Topic Style]] - Used for topics of interest related to using LSL (XML-RPC, quaternions, etc). | # [[LSL Topic Style]] - Used for topics of interest related to using LSL (XML-RPC, quaternions, etc). | ||
# [[LSL Constants Style]] - Used for documenting constants. | # [[LSL Constants Style]] - Used for documenting constants. | ||
== Guidelines == | == Guidelines == | ||
Line 25: | Line 31: | ||
* When posting a script if it is a complete script, it should compile without error and be fully functional or marked otherwise. Code fragments should compile if properly installed into a script (no internal errors in the code fragments). | * When posting a script if it is a complete script, it should compile without error and be fully functional or marked otherwise. Code fragments should compile if properly installed into a script (no internal errors in the code fragments). | ||
* Scripts that are posted should have a consistent style through out the script; whitespace consistency is important. | * Scripts that are posted should have a consistent style through out the script; whitespace consistency is important. | ||
* Modern web browsers come with or have available spell checkers. All content should be spell checked. | * Modern web browsers come with or have available spell checkers. All content should be spell checked before being posted. | ||
== Footnotes == | |||
{{Footnotes}} |
Revision as of 11:49, 19 May 2008
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
This page is to define and describe the specific editing and posting Guidelines for the LSL Wiki Portal.
About The LSL Portal
Mission Statement
- "To provide accurate documentation for the scripting language of Second Life: LSL"[1]
Goal Statement
- "To provide documentation to help scripters of all skill levels."[1]
Guides
- LSL Editing Primer - Information about templates and syntax.
Style
- LSL Category Style - Used for categorizing groups of LSL functions and other Tables of Contents.
- LSL Function Style - Used for the full specification of all LSL functions.
- LSL Topic Style - Used for topics of interest related to using LSL (XML-RPC, quaternions, etc).
- LSL Constants Style - Used for documenting constants.
Guidelines
- Pages specific to the running of the LSL portal or category pages should be prefixed with 'LSL '.
- All other existing pages documenting LSL with the LSL prefix are to be moved out of the LSL prefix unless other arrangements have been agreed upon.
- Questions should be posted on talk/discussion pages and signed (use
-- ~~~~
to sign comments). - Before posting a feature suggestion on the wiki check to see if it has been suggested on Jira first.
- When posting a script if it is a complete script, it should compile without error and be fully functional or marked otherwise. Code fragments should compile if properly installed into a script (no internal errors in the code fragments).
- Scripts that are posted should have a consistent style through out the script; whitespace consistency is important.
- Modern web browsers come with or have available spell checkers. All content should be spell checked before being posted.
Footnotes
- ^ Derived from the open sentances of the LSL Portal.