[slscripters] LP³: Improving LSL documentation readability

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[slscripters] LP³: Improving LSL documentation readability

Strife Onizuka
Hello. I'm Strife Onizuka, LSL Portal editor and scriptor. This being the start of the second quarter I come to you today to announce a new project I am spearheading, it's goal is to make the documentation more accessible to a larger portion of the SL community.

Long have we struggled with how to make the documentation more accessible. One of the most common complaints is that is simply too technical and we are hearing this more often than you would belief from one of SL's more traditional content creators: descriptive writers. So I am proud to announce that after many sleepless nights we have come up with a way to address this. As the core problem is that the documentation relies upon very specific, technical language we have come up with a way to bring more mundane verbiage into the documentation.

To achieve this end we are announcing the LSL Portal Poetry Project! The goal of the the LPPP (or LP³ as I like to think of it), is to provide poetry for every LSL Event, Function and Constant. More specifically, the form of poetry we have chosen is Haiku. Screen realistate being at a premium haiku requires the minimum amount of space while packing the greatest metaphorical punch.

To illustrate, here is the haiku for llParticleSystem:

Cherry blossom sprites
alight upon fickle breezes
to fall through the ground.

For myself I had to had to have this haiku explained to me. It's writer explained that the literary expert will be able to extract with great ease the following incites:
1) Particles in SecondLife are traditional 2D sprites often seen in may games.
2) That SecondLife not only has wind, which is a bit capricious, it has a full blown weather simulator.
3) That the particle system has no notion of clipping; particles will go through solid objects, including the ground.
4) The writer has a tabby that likes to sleep on the keyboard.

As always the LSL Portal needs volunteers. To give you an idea of what we need, some articles already have poems.

https://wiki.secondlife.com/wiki/Category:Articles_with_haiku

If you would like to help with this project, here are a list of LSL articles in need of haiku.

https://wiki.secondlife.com/wiki/Category:Articles_in_need_of_haiku

If writing haiku isn't where your strength lies (it sure isn't mine) maybe consider writing examples or just generally expanding on what has already been written:

https://wiki.secondlife.com/wiki/Category:LSL_Needs_Examples

For those interested, the runner up to Haiku was Limerick but we had trouble rhyming anything with llSetLinkPrimitiveParamsFast.

_______________________________________________
Click here to unsubscribe or manage your list subscription:
https://lists.secondlife.com/cgi-bin/mailman/listinfo/secondlifescripters
Reply | Threaded
Open this post in threaded view
|

Re: [slscripters] LP³: Improving LSL documentation readability

Glen Canaday
On 03/31/2014 11:18 PM, Strife Onizuka wrote:
Hello. I'm Strife Onizuka, LSL Portal editor and scriptor. This being the start of the second quarter I come to you today to announce a new project I am spearheading, it's goal is to make the documentation more accessible to a larger portion of the SL community.

Long have we struggled with how to make the documentation more accessible. One of the most common complaints is that is simply too technical and we are hearing this more often than you would belief from one of SL's more traditional content creators: descriptive writers. So I am proud to announce that after many sleepless nights we have come up with a way to address this. As the core problem is that the documentation relies upon very specific, technical language we have come up with a way to bring more mundane verbiage into the documentation.

To achieve this end we are announcing the LSL Portal Poetry Project! The goal of the the LPPP (or LP³ as I like to think of it), is to provide poetry for every LSL Event, Function and Constant. More specifically, the form of poetry we have chosen is Haiku. Screen realistate being at a premium haiku requires the minimum amount of space while packing the greatest metaphorical punch.

To illustrate, here is the haiku for llParticleSystem:

Cherry blossom sprites
alight upon fickle breezes
to fall through the ground.

For myself I had to had to have this haiku explained to me. It's writer explained that the literary expert will be able to extract with great ease the following incites:
1) Particles in SecondLife are traditional 2D sprites often seen in may games.
2) That SecondLife not only has wind, which is a bit capricious, it has a full blown weather simulator.
3) That the particle system has no notion of clipping; particles will go through solid objects, including the ground.
4) The writer has a tabby that likes to sleep on the keyboard.

As always the LSL Portal needs volunteers. To give you an idea of what we need, some articles already have poems.

https://wiki.secondlife.com/wiki/Category:Articles_with_haiku

If you would like to help with this project, here are a list of LSL articles in need of haiku.

https://wiki.secondlife.com/wiki/Category:Articles_in_need_of_haiku

If writing haiku isn't where your strength lies (it sure isn't mine) maybe consider writing examples or just generally expanding on what has already been written:

https://wiki.secondlife.com/wiki/Category:LSL_Needs_Examples

For those interested, the runner up to Haiku was Limerick but we had trouble rhyming anything with llSetLinkPrimitiveParamsFast.


llSetLinkPrimitiveParamsFast
Was the thought that I'd had last
When I clicked on my prim
The color went dim
But is was the delay that set me aghast.

--GC



_______________________________________________
Click here to unsubscribe or manage your list subscription:
https://lists.secondlife.com/cgi-bin/mailman/listinfo/secondlifescripters


_______________________________________________
Click here to unsubscribe or manage your list subscription:
https://lists.secondlife.com/cgi-bin/mailman/listinfo/secondlifescripters
Reply | Threaded
Open this post in threaded view
|

Re: [slscripters] LP³: Improving LSL documentation readability

Bryan Bateman

April Fools was yesterday.  A good effort though.

 

From: [hidden email] [mailto:[hidden email]] On Behalf Of GC
Sent: Tuesday, April 1, 2014 8:10 PM
To: [hidden email]
Subject: Re: [slscripters] LP³: Improving LSL documentation readability

 

On 03/31/2014 11:18 PM, Strife Onizuka wrote:

Hello. I'm Strife Onizuka, LSL Portal editor and scriptor. This being the start of the second quarter I come to you today to announce a new project I am spearheading, it's goal is to make the documentation more accessible to a larger portion of the SL community.

Long have we struggled with how to make the documentation more accessible. One of the most common complaints is that is simply too technical and we are hearing this more often than you would belief from one of SL's more traditional content creators: descriptive writers. So I am proud to announce that after many sleepless nights we have come up with a way to address this. As the core problem is that the documentation relies upon very specific, technical language we have come up with a way to bring more mundane verbiage into the documentation.

To achieve this end we are announcing the LSL Portal Poetry Project! The goal of the the LPPP (or LP³ as I like to think of it), is to provide poetry for every LSL Event, Function and Constant. More specifically, the form of poetry we have chosen is Haiku. Screen realistate being at a premium haiku requires the minimum amount of space while packing the greatest metaphorical punch.

To illustrate, here is the haiku for llParticleSystem:

Cherry blossom sprites
alight upon fickle breezes
to fall through the ground.


For myself I had to had to have this haiku explained to me. It's writer explained that the literary expert will be able to extract with great ease the following incites:
1) Particles in SecondLife are traditional 2D sprites often seen in may games.
2) That SecondLife not only has wind, which is a bit capricious, it has a full blown weather simulator.
3) That the particle system has no notion of clipping; particles will go through solid objects, including the ground.
4) The writer has a tabby that likes to sleep on the keyboard.

As always the LSL Portal needs volunteers. To give you an idea of what we need, some articles already have poems.

https://wiki.secondlife.com/wiki/Category:Articles_with_haiku

If you would like to help with this project, here are a list of LSL articles in need of haiku.

https://wiki.secondlife.com/wiki/Category:Articles_in_need_of_haiku

If writing haiku isn't where your strength lies (it sure isn't mine) maybe consider writing examples or just generally expanding on what has already been written:

https://wiki.secondlife.com/wiki/Category:LSL_Needs_Examples

For those interested, the runner up to Haiku was Limerick but we had trouble rhyming anything with llSetLinkPrimitiveParamsFast.

 


llSetLinkPrimitiveParamsFast
Was the thought that I'd had last
When I clicked on my prim
The color went dim
But is was the delay that set me aghast.

--GC





_______________________________________________
Click here to unsubscribe or manage your list subscription:
https://lists.secondlife.com/cgi-bin/mailman/listinfo/secondlifescripters

 


_______________________________________________
Click here to unsubscribe or manage your list subscription:
https://lists.secondlife.com/cgi-bin/mailman/listinfo/secondlifescripters