Difference between revisions of "Template talk:LSL Function"

From Second Life Wiki
Jump to navigation Jump to search
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== TODO ==
== TODO ==
While this todo list is specific for LSL Functions, it doubles as the suggestion table for LSL Events, Constants and Conditionals.


* Move all parameters to variables to work around 1.12 parser changes. (remove workaround for issues)
* See Also-Examples should be moved into Examples section -- Will need better name.
* fix func-id for pre-release documentation & LSL_Functions/ID sort.
* Split Issues into Issues and Bugs, put bugs into Caveats - Done for functions & constants.
* Rename Caveats to "Take Note" or "Be Aware"
* Promote Issues subsction into Notes. -- Easy
* JIRA Search link. In notes? -- Easy - done for functions & constants.
* #var:type collision between templates, causes errors in the documentation. Rename variable -- Half Done
* New hidden category sorting LSL topics by bug count. -- Easy (Done for functions)
* Common Mistakes section?
* Common Mistakes section?
* Disable category inclusion for requests
* Disable category inclusion for requests?
* Get/Set Caveat separation for sub-templates #var:caveats_set, #var:caveats_get, will aid in using the templates for constants.
* Get/Set Caveat separation for sub-templates #var:caveats_set, #var:caveats_get, will aid in using the templates for constants. -- Tedious
* Change History section to a table?
* Change History section to a table? - Tedious. History section format and layout needs standardizing first.
* Generic: Setup bug counting in category thingy
* TODO: make sure #var:name isn't used by other templates.


== LSLwiki.net ==
== Issues ==
I had a discussion with [[User:Gally Young|Gally]] today and we came to the following conclusion:<br>Since we're not able to copy content from [http://www.lslwiki.net lslwiki.net] and vice versa - because of licensing problems - we might benefit from linking related articles of both wikis. So users can easily switch from one Wiki to the other and find the information most helpful for them. There shouldn't be a rivalry between these two documentation projects. They should benefit from each other. Therefor, we're adding a link to the related LSLwiki.net article to this template. I hope it's ok.<br>
*Hover & Description for parameters - If a template sets both the hover & description but the user only supplies a description (which is appended to the end of the templates description), it will not be copied over to the hover (which is contrary to how descriptions usually work). If the user supplies both a hover and description but the template only supplies a description, the templates description will not be copied over and only the user's hover will be displayed. This is solvable but time consuming.
Something else on the same topic: It seems to be(come) quite popular in Wiki culture to double-license the own contributions, in order to make them easier to share. Wikis of interest for us:
* The Second Life Wiki (of course): [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-Share Alike 3.0]
* The [http://www.lslwiki.net LSLwiki.net]: an [http://lslwiki.net/lslwiki/wakka.php?wakka=LSLwikicopyright implicit copyright model]
* The [http://secondlife.wikia.com/wiki/Main_Page SecondLife Wikia]: [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License]
Please consider to double-license your contributions to this (or other) Wikis in order to make them easier to share, by writing a statemanet about double licensing on your userpage. You can also use one of [[User:SignpostMarv Martin|Marv]]'s templates: [[Template:Re-license contributions]] as well as [[Template:License]].<br>
This is just a ''suggestion'' of course. Just do it, in case you want to do it.<br>
Greetz, [[Image:Zai_signature.png|45px]] '''[[User:Zai Lynch|Lynch]]''' <sup><small>([[User talk:Zai Lynch|talk]]|[[Special:Contributions/Zai Lynch|contribs]])</small></sup> 20:14, 9 September 2008 (PDT)


:I would have liked a little discussion on the wiki before the template change. Now someone is going to have to go back and tweak the change so it only applies to articles that don't set "self" or use mode=request or mode=user. I'll put it on the ToDo list (which is there to give people an opportunity to comment on ideas). I've been kinda busy but I'll get to it and a couple others this week. -- '''[[User:Strife_Onizuka|Strife]]''' <sup><small>([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])</small></sup> 22:03, 9 September 2008 (PDT)


::Sorry, I didn't realize that userfunctions were using this template as well (x_x). I just tested it [http://wiki.zeitenwerk.de/index.php/Template:LSL_Function in a sandbox] to ensure I wasn't braking more. But you're right, a discussion here would have been appropriate nevertheless. Sorry again for that... And thanks for fixing!
::[[Image:Zai_signature.png|45px]] '''[[User:Zai Lynch|Lynch]]''' <sup><small>([[User talk:Zai Lynch|talk]]|[[Special:Contributions/Zai Lynch|contribs]])</small></sup> 11:58, 10 September 2008 (PDT)


:::No need to apologize, nothing broken and the update is painless. -- '''[[User:Strife_Onizuka|Strife]]''' <sup><small>([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])</small></sup> 12:07, 10 September 2008 (PDT)
----


:::TY =) [[Image:Zai_signature.png|45px]] '''[[User:Zai Lynch|Lynch]]''' <sup><small>([[User talk:Zai Lynch|talk]]|[[Special:Contributions/Zai Lynch|contribs]])</small></sup> 13:41, 10 September 2008 (PDT)
An item may live on the list for a long time because
# It's half baked. These are marked with question marks. Typically there are good reasons not to implement them, there are many ways of implementing it, or there isn't a pressing need.
# It would take a lot of work to implement. Some items may involve editing hundreds of pages.


::::I've done a number of small updates. -- '''[[User:Strife_Onizuka|Strife]]''' <sup><small>([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])</small></sup> 08:03, 18 September 2008 (PDT)
Changes to the uniform style are typically tried out on the Events first, there aren't that many of them and making multiple changes doesn't hurt the wiki as much as making a change to either Functions or Constants. Conditionals is often forgotten during the update cycle.
 
----
 
==Please post your suggestions here==
 
=== Modules ===
 
Since the template uses only variables. Why not convert the sections into their own little template modules? It would make maintaining the various templates much easier. To implement new features just modify the module then expose the features to the templates that use them. The advantage is two fold, it ensures consistent implementation across the templates and changes propagate instantly. This has already turned out to be very useful with the caveats section. More sections could benefit from this.
 
Then again, this is essentially what the [[Template:LSL Generic]] was meant to do though it went too far. It was too hard to use. This module approach may be a good compromise. -- '''[[User:Strife_Onizuka|Strife]]''' <sup><small>([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])</small></sup> 07:43, 16 May 2010 (UTC)
 
== mode=user ==
 
Parameter mode=user is making the function signature blank. It should either be removed or correctly filled, but not blanked. [Edit: see [[Ord]] as an example] --[[User:Pedro Oval|Pedro Oval]] 11:47, 14 May 2014 (PDT)
 
:~_~ I'll fix it. -- '''[[User:Strife_Onizuka|Strife]]''' <sup><small>([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])</small></sup> 11:22, 15 May 2014 (PDT)

Latest revision as of 11:22, 15 May 2014

TODO

While this todo list is specific for LSL Functions, it doubles as the suggestion table for LSL Events, Constants and Conditionals.

  • See Also-Examples should be moved into Examples section -- Will need better name.
  • Split Issues into Issues and Bugs, put bugs into Caveats - Done for functions & constants.
  • Rename Caveats to "Take Note" or "Be Aware"
  • Promote Issues subsction into Notes. -- Easy
  • JIRA Search link. In notes? -- Easy - done for functions & constants.
  • #var:type collision between templates, causes errors in the documentation. Rename variable -- Half Done
  • New hidden category sorting LSL topics by bug count. -- Easy (Done for functions)
  • Common Mistakes section?
  • Disable category inclusion for requests?
  • Get/Set Caveat separation for sub-templates #var:caveats_set, #var:caveats_get, will aid in using the templates for constants. -- Tedious
  • Change History section to a table? - Tedious. History section format and layout needs standardizing first.
  • Generic: Setup bug counting in category thingy
  • TODO: make sure #var:name isn't used by other templates.

Issues

  • Hover & Description for parameters - If a template sets both the hover & description but the user only supplies a description (which is appended to the end of the templates description), it will not be copied over to the hover (which is contrary to how descriptions usually work). If the user supplies both a hover and description but the template only supplies a description, the templates description will not be copied over and only the user's hover will be displayed. This is solvable but time consuming.



An item may live on the list for a long time because

  1. It's half baked. These are marked with question marks. Typically there are good reasons not to implement them, there are many ways of implementing it, or there isn't a pressing need.
  2. It would take a lot of work to implement. Some items may involve editing hundreds of pages.

Changes to the uniform style are typically tried out on the Events first, there aren't that many of them and making multiple changes doesn't hurt the wiki as much as making a change to either Functions or Constants. Conditionals is often forgotten during the update cycle.


Please post your suggestions here

Modules

Since the template uses only variables. Why not convert the sections into their own little template modules? It would make maintaining the various templates much easier. To implement new features just modify the module then expose the features to the templates that use them. The advantage is two fold, it ensures consistent implementation across the templates and changes propagate instantly. This has already turned out to be very useful with the caveats section. More sections could benefit from this.

Then again, this is essentially what the Template:LSL Generic was meant to do though it went too far. It was too hard to use. This module approach may be a good compromise. -- Strife (talk|contribs) 07:43, 16 May 2010 (UTC)

mode=user

Parameter mode=user is making the function signature blank. It should either be removed or correctly filled, but not blanked. [Edit: see Ord as an example] --Pedro Oval 11:47, 14 May 2014 (PDT)

~_~ I'll fix it. -- Strife (talk|contribs) 11:22, 15 May 2014 (PDT)