LSL 101/Built-in Functions in Focus - Revision history

Toady Nakamura: header fix

2012-07-08T06:53:13Z

header fix

← Older revision		Revision as of 23:53, 7 July 2012
Line 1:		Line 1:
	~~[[Category:LSL 101]]~~
	~~{{NavNextPrev\|prev=Functions\|next=LSL 101/Functions That Return a Value}}~~
	{{LSL Wikibook Index}}		{{LSL Wikibook Index}}

	Contents were moved to and expanded on the [[LSL 101/Functions \| Functions Page]].		Contents were moved to and expanded on the [[LSL 101/Functions \| Functions Page]].

Toady Nakamura: redirect

2012-07-08T05:13:01Z

redirect

← Older revision	Revision as of 22:13, 7 July 2012
Line 1:	Line 1:
		[[Category:LSL 101]]
		{{NavNextPrev\|prev=Functions\|next=LSL 101/Functions That Return a Value}}
		{{LSL Wikibook Index}}

		Contents were moved to and expanded on the [[LSL 101/Functions \| Functions Page]].

Toady Nakamura: editing... see discussion

2012-07-08T05:10:19Z

editing... see discussion

← Older revision		Revision as of 22:10, 7 July 2012
Line 1:		Line 1:
	~~{{NavNextPrev\|prev=Language Topics in Focus\|next=Putting It All Together}}~~
	~~{{LSL Wikibook Index}}~~

	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:
	~~# 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.~~
	~~# 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 which if you don't read you will likely get a nasty surprise later.~~
	~~# (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.~~
	~~# Specification - For when Caveats isn't enough and Notes is too general.~~

	Caveats and Specification aren't always geared towards new users, the documentation also servers as reference and refresher material for advanced users. It's best to come back to these sections once you have an idea of what the function does. The layout is very much a balancing act of divergent interests.

	There are some other sections, Deep Notes for example contains everything that really isn't all that important to the functionality. Typically technical implementation notes, only useful when discussing changing the implementation.

Omei Turnbull at 19:46, 1 June 2009

2009-06-01T19:46:26Z

← Older revision		Revision as of 12:46, 1 June 2009
Line 1:		Line 1:
	{{NavNextPrev\|prev=Language Topics in Focus\|next=Putting It All Together}}		{{NavNextPrev\|prev=Language Topics in Focus\|next=Putting It All Together}}
			{{LSL Wikibook Index}}

	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:		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:

Omei Turnbull at 15:59, 1 June 2009

2009-06-01T15:59:43Z

← Older revision		Revision as of 08:59, 1 June 2009
Line 1:		Line 1:
	{{NavNextPrev\|prev=Language Topics in Focus\|next=}}		{{NavNextPrev\|prev=Language Topics in Focus\|next=Putting It All Together}}

	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:		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:

Strife Onizuka at 15:03, 22 May 2009

2009-05-22T15:03:05Z

← Older revision		Revision as of 08:03, 22 May 2009
Line 1:		Line 1:
	{{NavNextPrev\|prev=\|next=}}		{{NavNextPrev\|prev=Language Topics in Focus\|next=}}

	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:		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:

Strife Onizuka at 14:57, 22 May 2009

2009-05-22T14:57:00Z

← Older revision		Revision as of 07:57, 22 May 2009
Line 1:		Line 1:
			{{NavNextPrev\|prev=\|next=}}

	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:		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:
	# Description - Contains a basic description		# 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.		# 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.
	# Examples - Contains examples of how to use the function.		# 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.		# Caveats - Contains a list of edge cases (where things may break) and what happens when things break. This is the fine print which if you don't read you will likely get a nasty surprise later.
	# (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.		# (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.		# 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.		# See Also - Links to other articles, functions, events etc.
	There are other sections:		# Specification - For when Caveats isn't enough and Notes is too general.
	* 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~~.
			Caveats and Specification aren't always geared towards new users, the documentation also servers as reference and refresher material for advanced users. It's best to come back to these sections once you have an idea of what the function does. The layout is very much a balancing act of divergent interests.

			There are some other sections, Deep Notes for example contains everything that really isn't all that important to the functionality. Typically technical implementation notes, only useful when discussing changing the implementation.

Strife Onizuka: New page: 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 n...

2009-05-22T14:18:13Z

New page: 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 n...

New page

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:
# 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.
# 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.