|
|
| (6 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| Before we start looking at any LSL Functions, it is imperative that we discuss how the LSL documentation is laid out. There are distinct sections for different types of information, as a new user the sections you will want to read are:
| | {{LSL Wikibook Index}} |
| # Description - Contains a basic description
| | |
| # Newbie Notes - Contains a description and examples intended for new users - very few articles have this section, we haven't found anyone to write them.
| | Contents were moved to and expanded on the [[LSL 101/Functions | Functions Page]]. |
| # Examples - Contains examples of how to use the function.
| |
| # Caveats - Contains a list of edge cases (where things may break) and what happens when things break. This is the fine print.
| |
| # (Important) Issues - A list of LSL bugs (and feature requests) reported on JIRA. The list is likely incomplete but should give you a taste as to what might be wrong with the function.
| |
| # Notes - Much more detailed description of edge cases and how to use the function. Examples will show you how, but Notes will describe when, why and more of the how.
| |
| # See Also - Links to other articles, functions, events etc.
| |
| There are other sections:
| |
| * Deep Notes - Contains everything that really isn't all that important to the functionality but might be interesting. Mostly it's unimportant implementation notes (like when and where it is in the source). It's useful when discussing the reasons behind a functions design; which is really only useful when discussing changing how it functions.
| |