OSSL Standards - Revision history

MakoBot: Robot: Cosmetic changes

2012-03-04T03:41:20Z

Robot: Cosmetic changes

MakoBot: Removed 'Template:' prefix from template includings and/or changed external-link into internal-link

2011-06-10T23:14:57Z

Removed 'Template:' prefix from template includings and/or changed external-link into internal-link

Makopoppo at 09:21, 4 June 2011

2011-06-04T09:21:05Z

Fritigern at 16:28, 13 December 2010

2010-12-13T16:28:58Z

Fritigern: /* Naming */

2010-12-10T23:07:11Z

‎Naming

Kcozens: Added note about preferred spelling. Minor formatting changes.

2010-12-10T20:46:53Z

Added note about preferred spelling. Minor formatting changes.

Revolution at 05:01, 31 January 2010

2010-01-31T05:01:29Z

Ideia Boa at 23:15, 21 May 2009

2009-05-21T23:15:35Z

Phrearch: New page: POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active. Base Syntax: osCategoryFunction() =Naming= Function should be clearly named & indicative of purp...

2008-02-06T15:42:10Z

New page: POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active. Base Syntax: osCategoryFunction() =Naming= Function should be clearly named & indicative of purp...

New page

POLICY PROPOSAL:
This document is a proposal for naming standards and is not yet active.

Base Syntax: osCategoryFunction()

=Naming=
Function should be clearly named & indicative of purpose, eg:

osSendAnnounce - Mediocre
osRegionAnnounce - Good
osRegionAnnouncement - Better

==Get/Set Functions==
Get/Set functions should be clearly named & use a common syntax for both Get and Set. In Get/Set examples, Get/Set are the first letters after 'os'.

Eg, llSetOffsetTexture and llTextureOffset are particularly good examples of how not to do it.

The Os() equivilent if they were to be created again should be something along the lines of

osGetTextureOffset()
osSetTextureOffset()

This could be complemented with:

osGetTextureURL()
osSetTextureURL()

etc.

==Category Examples==

* Region - region admin and region-wide scoped functions.
** osRegionAnnouncement()
** osRegionRestart()
* Permission - answers yes/no boolean questions as to whether the owner of the primitive, or the primitive has permission to do something.
** osGetPermissionEditLand()
* Texture - anything to do with textures on the primitive
** osGetTextureURL()
** osSetTextureText()
* Shape - anything to do with the primitives shape
** osSetShapePath()
** osSetShapePattern()
** osSetShapeColour()

etc.
[[Category:Development]]

@@ Line 9: / Line 9: @@
 Base Syntax: osCategoryFunction()
-=Naming=
+= Naming =
 Function and parameter names should use US English spelling. <!-- Why? What's the rationale behind this? Please explain. -->
@@ Line 18: / Line 18: @@
 osRegionAnnouncement - Better<br />
-==Get/Set Functions==
+== Get/Set Functions ==
 Get/Set functions should be clearly named & use a common syntax for both Get and Set. In Get/Set examples, Get/Set are the first letters after 'os'.
@@ Line 35: / Line 35: @@
 etc.
-==Category Examples==
+== Category Examples ==
 * Region - region admin and region-wide scoped functions.
@@ Line 55: / Line 55: @@
 * [[LSL Status|LSL/OSSL Status Page]]
 * OSSL
-** [[OSSL Status/Types |OSSL Types Status Page]]
+** [[OSSL Status/Types|OSSL Types Status Page]]
-** [[OSSL Status/Events |OSSL Events Status Page]]
+** [[OSSL Status/Events|OSSL Events Status Page]]
-** [[OSSL_Proposals | OSSL Proposed Functions]]
+** [[OSSL Proposals|OSSL Proposed Functions]]
-** [[OSSL_Implemented | OSSL Implemented Functions]]
+** [[OSSL Implemented|OSSL Implemented Functions]]
-** [[OSSL_Standards | OSSL Standards]]
+** [[OSSL Standards]]
 [[Category:Development]]
 [[Category:OSSL]]

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Template:Quicklinks}}
+{{Quicklinks}}
 <br />

@@ Line 54: / Line 54: @@
 = See Also =
 * [[LSL Status|LSL/OSSL Status Page]]
 * OSSL
 ** [[OSSL Status/Types |OSSL Types Status Page]]
@@ Line 67: / Line 60: @@
 ** [[OSSL_Implemented | OSSL Implemented Functions]]
 ** [[OSSL_Standards | OSSL Standards]]
 [[Category:Development]]
 [[Category:OSSL]]

← Older revision		Revision as of 16:28, 13 December 2010
Line 70:		Line 70:

	[[Category:Development]]		[[Category:Development]]
		+	[[Category:OSSL]]

@@ Line 10: / Line 10: @@
 =Naming=
-Function and parameter names should use US English spelling.
+Function and parameter names should use US English spelling. <!-- Why? What's the rationale behind this? Please explain. -->
 Function should be clearly named & indicative of purpose, eg:

@@ Line 10: / Line 10: @@
 =Naming=
 Function should be clearly named & indicative of purpose, eg:
-osSendAnnounce - Mediocre
+osSendAnnounce - Mediocre<br />
-osRegionAnnounce - Good
+osRegionAnnounce - Good<br />
-osRegionAnnouncement - Better
+osRegionAnnouncement - Better<br />
 ==Get/Set Functions==
@@ Line 23: / Line 25: @@
 The Os() equivilent if they were to be created again should be something along the lines of
-osGetTextureOffset()
+osGetTextureOffset()<br />
-osSetTextureOffset()
+osSetTextureOffset()<br />
 This could be complemented with:
-osGetTextureURL()
+osGetTextureURL()<br />
-osSetTextureURL()
+osSetTextureURL()<br />
 etc.

← Older revision		Revision as of 05:01, 31 January 2010
Line 49:		Line 49:

	etc.		etc.
		+
		+	= See Also =
		+	* [[LSL Status\|LSL/OSSL Status Page]]
		+	* LSL
		+	** [[LSL Status/Types\|LSL Types Status Page]]
		+	** [[LSL Status/Events\|LSL Events Status Page]]
		+	** [[LSL Status/Functions\|LSL Functions Status Page]]
		+	** [[LSL_Status/functions/summary \| LSL Functions Status Summary]]
		+	** [[LSL_Known_Issues\| LSL Known Issues]]
		+	** [[Kan-Ed_Tests\| Kan-Ed Tests]]
		+	* OSSL
		+	** [[OSSL Status/Types \|OSSL Types Status Page]]
		+	** [[OSSL Status/Events \|OSSL Events Status Page]]
		+	** [[OSSL_Proposals \| OSSL Proposed Functions]]
		+	** [[OSSL_Implemented \| OSSL Implemented Functions]]
		+	** [[OSSL_Standards \| OSSL Standards]]
		+	* [[Technical_Reference\|Technical Reference Page]]
		+
	[[Category:Development]]		[[Category:Development]]

← Older revision		Revision as of 23:15, 21 May 2009
Line 1:		Line 1:
		+	__NOTOC__
		+	{{Template:Quicklinks}}
		+	<br />
		+
	POLICY PROPOSAL:		POLICY PROPOSAL:
	This document is a proposal for naming standards and is not yet active.		This document is a proposal for naming standards and is not yet active.