Difference between revisions of "LSL Portal Guidelines"

From Second Life Wiki
Jump to navigation Jump to search
(Removing the footnote because what it referenced has changed... but there hasn't been a discussion of changing these. The Mission is what we do, the Goal is what we aim for.)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div style="float:right;">__TOC__</div>
{{LSL Header|ml=*}}
{{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"
<h4>Goal Statement</h4>
:"To provide documentation to help scripters of all skill levels."


== Guides ==
== Guides ==
Line 9: Line 17:
== Style ==
== Style ==


# [[LSL Category Style]] - Used for categorizing groups of LSL functions and other Tables of Contents.
* [[LSL Portal Style]]
# [[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.


'''Old Discussions'''
* [[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 ==
== Guidelines ==
Line 23: Line 33:
* 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.

Latest revision as of 03:29, 30 April 2009

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"

Goal Statement

"To provide documentation to help scripters of all skill levels."

Guides

Style

Old Discussions

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.