Difference between revisions of "Talk:LSL Function Style"

From Second Life Wiki
Jump to navigation Jump to search
 
(67 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Coding Standards?==
== Old Talk ==
Is there going to be any debate regarding the use of CamelCase, javaCase, or coding standards? Thoughts? Opinions? Flames >> /dev/null [[User:Talarus Luan|Talarus Luan]] 18:28, 24 January 2007 (PST)


:Use the style guide from the old wiki [[User:Gigs Taggart|Gigs Taggart]] 15:38, 25 January 2007 (PST)
[[{{FULLPAGENAME}}/Original Design Discussions]] -- All the conversations we had when things were first being made. Much of it not applicable since the style morphed to include some of the presented concerns.
::Anyone wanna volunteer to write our own sanitized version of that? ;) [[User:Talarus Luan|Talarus Luan]] 19:03, 25 January 2007 (PST)


== Specification ==
== Style ==
<div style="padding: 0.5em">
returns random number in range [0,mag)
{|
|-
| [[LSL_Energy|Energy]]:
| 10.0
|-
| [[LSL_Sleep|Sleep]]:
| 0.0
|-
| [[LSL_Function_ID|Function ID]]:
| 8
|}
</div>
[[User:Dimentox Travanti|Dimentox Travanti]] 08:09, 25 January 2007 (PST)


:Now is the time if you want me to change the formating of that table, i've already generated the tables for all 328 functions. [[User:Strife Onizuka|Strife Onizuka]] 10:46, 25 January 2007 (PST)
There has been some discussion on Jira about the style and the writing and it's been suggested that the style could use some tweaking. Since it's been over a year I thought it would be a great idea if we took the time to discuss the shortfalls and successes of the style along with any new ideas. What ever is decided I'll endeavor to implement be that a small rework or an entire refit. -- [[User:Strife Onizuka|Strife Onizuka]] 07:08, 17 May 2008 (PDT)
:Actually Looks good with that.. [[User:Dimentox Travanti|Dimentox Travanti]] 10:53, 25 January 2007 (PST)


== Looks good ==
==Deep Notes==


Seems to work well. it flows, and concise info.
Deeps notes would be an section with advanced information about implementations, specifications, and highly technical details; not to mention tracking the history of the function and the state of specific bugs.
[[User:Dimentox Travanti|Dimentox Travanti]] 08:11, 25 January 2007 (PST)
 
== Helper Functions ==
I added a "Helper Function" section, these are a bit like examples, but are complete functions that encapsulate or use the function in question.
If they had pages to themselves they would be linked through "See Also"[[User:Strife Onizuka|Strife Onizuka]] 10:50, 25 January 2007 (PST)
 
== Short Description ==
I didn't see much point to the short description. That sort of thing really belongs in the specification section.
 
== Templates? ==
I see that MediaWiki supports some kind of templating system. Is there a way we can use it to define a template for this page type and parameterize the content to it? Would make it easy later to change the template instead of changing hundreds of function pages. Probably can use this for all of the page types which will specify a standardized format for more than a handful of pages.
[[User:Talarus Luan|Talarus Luan]] 11:03, 25 January 2007 (PST)
:I have made up a test template for functions, hence: [[Template:LSL_Function]] [[User:Talarus Luan|Talarus Luan]] 12:44, 25 January 2007 (PST)
 
Creating it as a template is a good idea.  And parts can be sub-templated out.
--[[User:Thraxis Epsilon|Thraxis Epsilon]] 12:51, 25 January 2007 (PST)
:Please feel free to attack it; you've got a lot more experience than me, as I'm rather new at this MediaWiki stuff. :P [[User:Talarus Luan|Talarus Luan]] 14:17, 25 January 2007 (PST)
 
The template is looking really good. What about moving the "See also" section down below the "Notes" section? [[User:Talarus Luan|Talarus Luan]] 19:05, 25 January 2007 (PST)
 
:I was thinking of doing that, I will do it now. [[User:Strife Onizuka|Strife Onizuka]] 23:48, 25 January 2007 (PST)
 
Oh I should have said earlier, I've made a template, and I've just finished making stub pages for ever single function. Your template  seems to be based on an earlier version of mine (while i was playing with the first pages it was under heave development)[[User:Strife Onizuka|Strife Onizuka]] 23:46, 25 January 2007 (PST)
:Well, I started out with something from scratch, based on the experimental page layout at the time, and Thraxis has been updating and trying some things using your Specification Template. It looks like he is having a problem doing conditionals in Template parameter passing, so I don't know if we can get away with it or not. Look at an earlier revision of that page for the one I originally created. It was designed to do the whole page, though I am not sure if that is the best way to attack it or not. [[User:Talarus Luan|Talarus Luan]] 23:55, 25 January 2007 (PST)
:Couple more things: Was it wise creating stub pages already? I was under the impression that someone was looking into getting the LSL namespace assigned for us to use. Will that affect the page locations? IE, would they need to all be moved? Also, your template has a minor grammatical issue in the return value specification. If the return type is "integer", it reads "Returns a integer". Can you conditionally select a word based on the value of a parameter being a specific value? I couldn't find any doc on the #if conditional anywhere myself. [[User:Talarus Luan|Talarus Luan]] 00:10, 26 January 2007 (PST)
:~grumbles~ I was hoping nobody would notice that, yes it can be fixed, it's a bit of a hack (I'll see what i can do; hopefully I'll be able to pick off the first character and compare it otherwise it will be a comparison for just integers ~_~). If we did get the LSL namespace, we would have problems with forced leading caps. About the #if documentation, I spent a few hours experimenting. I personally don't mind having to append LSL_ to the front of pages, good place to use a template. [[User:Strife Onizuka|Strife Onizuka]] 01:08, 26 January 2007 (PST)
::You should count on us picking nits. :P Is there any problem with people typing a function name in the Search box and searching for its corresponding page? [[User:Talarus Luan|Talarus Luan]] 10:29, 26 January 2007 (PST)
:::None that I know of since the function names are in the template header they show up in a search. Know if someone wants to do a good thing they can make redirect pages for ever LSL function. [[User:Strife Onizuka|Strife Onizuka]] 14:51, 26 January 2007 (PST)
 
Documentation on the #if (and other commands) is available here [http://meta.wikimedia.org/wiki/ParserFunctions ParserFunctions]
--[[User:Thraxis Epsilon|Thraxis Epsilon]] 03:52, 26 January 2007 (PST)
:Thankies, Thraxis! :D Are there any more good help pages which we should be referring to besides the ones available at the main MediaWiki help page? [http://www.mediawiki.org/wiki/Help:Contents] [[User:Talarus Luan|Talarus Luan]] 10:29, 26 January 2007 (PST)
 
Check the [[Special:Version]] page from time to time so you can see when new plugins are added and what documentation they have linked.
--[[User:Thraxis Epsilon|Thraxis Epsilon]] 10:50, 26 January 2007 (PST)
:I've posted a suggestion, hopefully they will consider [https://jira.secondlife.com/browse/WEB-23 Jira:WEB-23], it's for 1.9.x & StringFunctions [[User:Strife Onizuka|Strife Onizuka]] 15:13, 27 January 2007 (PST)
 
== Small issue with the LSLG template ==
 
go here: [https://wiki.secondlife.com/wiki/LSL_llShout]
 
Then click on llInstantMessage under related.  It goes to a page called lllInstantMessage.  Hope this is the right place to point this out. :)  [[User:Darien Caldwell|Darien Caldwell]] 13:13, 26 January 2007 (PST)
:Actually, you can put it in the Talk page for that function or, better yet, make the edit yourself. ;) [[User:Talarus Luan|Talarus Luan]] 13:32, 26 January 2007 (PST)
 
==See Also / Related Functions Redundancy==
There seems to be a bit of overlap with these two sections. Should we keep both, or consolidate to one or the other? [[User:Talarus Luan|Talarus Luan]] 13:35, 26 January 2007 (PST)
:When I was making the template, the See Also section didn't seem specific enough, I saw it more for external links and keyword documentation. We use to have things similarly organized on the old wiki (rarely would you need both sections). I'll make the See Also section evaporate (hide it by default).[[User:Strife Onizuka|Strife Onizuka]] 14:40, 26 January 2007 (PST)
::Hmmm.. how about "Related Functions" being a sub-subsection of "See also"? Would have to play around with the formatting a bit to make it concise, but that's an option. [[User:Talarus Luan|Talarus Luan]] 18:34, 26 January 2007 (PST)
:::Thats not a bad idea. Could subdivide it into various sub-sections. I'll get on it. [[User:Strife Onizuka|Strife Onizuka]] 15:08, 27 January 2007 (PST)
 
== LSL Syntax Template? ==
 
Any word on when we might see this implemented? [[User:Talarus Luan|Talarus Luan]] 19:49, 27 January 2007 (PST)
:Knock on wood, I hope before the Havok upgrade (would it be Havok 3 or Havok 4?).[[User:Strife Onizuka|Strife Onizuka]]
 
== LSL Function Template borked? ==
 
What happened to the LSL Function Template? I'm getting red and yellow errors now. "Template:LSLFunctionAll has been replaced by Template:LSL_Function", "sort value not defined", etc. Whazzup wid dat? Also, how can we embed tables into the template? Would I need to make a template of the table itself? (The pipe chars are throwing the parser) [[User:Talarus Luan|Talarus Luan]] 12:48, 28 January 2007 (PST)
 
It's not that the template is borked I'm trying to get all the pages consistent along with cleaning up the mess I made in the Template namespace. I abstracted the function template enough to use it for events as well. Then I made LSLFunctionAll just a pointer to LSL_Function. The 'sort' variable is used to put your function in [[:Catagory:LSL Functions]]. This way we don't need to make our own giant table at the top. If we had StringFunctions extension this could be done automatically with the use of a template (and would be really slick). The other warning about using the func_desc (or header_desc) has to do with using the proper fields. The footnote was really reserved for short notes about the function and the desc field for the actual function description. I did all this to motivate the pages to be gone through and updated; to fix the bugs I introduced when I created the first templates. So I added the error messages to the template to show what needed to be done with the pages. [[User:Strife Onizuka|Strife Onizuka]] 15:40, 28 January 2007 (PST)

Latest revision as of 06:11, 17 May 2008

Old Talk

Talk:LSL Function Style/Original Design Discussions -- All the conversations we had when things were first being made. Much of it not applicable since the style morphed to include some of the presented concerns.

Style

There has been some discussion on Jira about the style and the writing and it's been suggested that the style could use some tweaking. Since it's been over a year I thought it would be a great idea if we took the time to discuss the shortfalls and successes of the style along with any new ideas. What ever is decided I'll endeavor to implement be that a small rework or an entire refit. -- Strife Onizuka 07:08, 17 May 2008 (PDT)

Deep Notes

Deeps notes would be an section with advanced information about implementations, specifications, and highly technical details; not to mention tracking the history of the function and the state of specific bugs.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Talk:LSL_Function_Style&oldid=67774"