Slick Forums
http://slick.ninjacave.com/forum/

Documentation effort...
http://slick.ninjacave.com/forum/viewtopic.php?f=11&t=902
Page 1 of 2

Author:  ajones [ Thu Mar 27, 2008 5:31 am ]
Post subject:  Documentation effort...

Slick is a great library. Kevin has put a lot of hard work into designing it, and even more working into the documentation for it. Documenting a project of this size is a lot of work for one person, and every hour he has to spend on that is another hour that he doesn't have to make Slick better. So, I'm asking anyone with a bit of free time to pitch in and help fill in the docs on the wiki.

Here's the current list of blank pages:

* Graphics Context
* Clipping
* Alpha Buffer
* Fills and Gradients

(Under Images)
* Rendering to an Image
* Saving

(Under Font Rendering)
* TrueType Font Support

(Under Input Handling)
* Abstract Input - Commands

(Under Geometry)
* Geometry Morphing
* Scalable Vector Graphics (SVG)

* Utilities
* Path Finding
* Buffered Image Utility

* Embedding in Swing

If you know anything about these topics, or think it's time to put yourself through a crash course and learn it, please help provide docs for the rest of us. Just in case you need to know you can find the documentation wiki here: http://slick.cokeandcode.com/wiki/doku.php

If you have any additional areas you want to see covered either put it up on the wiki or post a message hear about it.

Author:  Owen Butler [ Thu Mar 27, 2008 12:46 pm ]
Post subject: 

Great idea ajones.

I took a stab at the TrueTypeFont page.

Author:  Tommy [ Thu Mar 27, 2008 7:17 pm ]
Post subject: 

I will write something about "Rendering to an Image" as I just did that for my game.
But it will have to wait until next week - I'm off to vacation with one of my kids :D

Author:  Owen Butler [ Sun Mar 30, 2008 5:27 am ]
Post subject: 

I've added some very basic pages about the slick-util package and it's uses:

http://slick.cokeandcode.com/wiki/doku. ... d_location
http://slick.cokeandcode.com/wiki/doku. ... slick-util
http://slick.cokeandcode.com/wiki/doku. ... slick-util

Author:  ajones [ Sun Mar 30, 2008 4:52 pm ]
Post subject: 

Awesome work guys. Thanks for taking the time.

Author:  Tommy [ Wed May 07, 2008 6:44 pm ]
Post subject: 

Finally managed to write something for "Rendering to an Image" last night.

Have a read and improve it. Maybe some native english speaker might want to improve my germish :roll:

Have fun,
Tommy

Author:  twood [ Sun Jun 15, 2008 3:56 pm ]
Post subject: 

I've started the SVG wiki page.

http://slick.cokeandcode.com/wiki/doku.php?id=scalable_vector_graphics_svg

I'm not certain about what svg features are not currently supported, so anybody with more knowledge should feel free to fill that out!

Author:  TheMatrix154 [ Thu Jun 19, 2008 6:19 pm ]
Post subject: 

just added a page for XMLPacketSpriteSheet. it's a neat little feature for mac and *nix users :D

Author:  miked [ Sun Jun 22, 2008 9:27 pm ]
Post subject: 

Just completed my first attempt at a wiki page on Clipping. Hope its ok :D

MikeD

Author:  yotsumi [ Wed Sep 17, 2008 5:06 pm ]
Post subject: 

I began a French translation of the wiki, and i will write some new article. ( i'm bored to death during classes^^)

The homepage is here : http://slick.cokeandcode.com/wiki/doku.php?id=fr-wiki
Please do not remove it !

If you are interested and wish to help me, contact me !
[ Si vous êtes intéressés et souhaitez m'aider, contactez moi ! ]

Author:  kevglass [ Wed Sep 17, 2008 6:43 pm ]
Post subject: 

Thanks to everyone who's contributed so far, especially for the translation.

Great work!

Kev

Author:  Spiegel [ Wed Mar 18, 2009 9:45 am ]
Post subject: 

Hi,

Added some small info to stategames page.

Also about the tutorial page, I was thinking in dividing the wiki in two sections like this

* Overview
* Getting started and setup

* Tutorials
* Spiegel Tutorials

* User Manual
* Game containers
* Graphics Context
* ... the rest of the wiki

I was thinking in inserting the Tutorials at the bottom of the page, but It seemed to me in the preview that new comers would be likely to miss it.

Another option would be something like this

* Overview
* Getting started and setup
* User manual -> Would send the visitor to a page with the current contents of the wiki
* Tutorials -> would send the visitor to a page with a list of tutorials.

So tell me how should I put it?

Also I can start a translation to Portuguese, but only after I end the tutorials.

Author:  xshinex [ Wed Mar 18, 2009 4:59 pm ]
Post subject: 

Spiegel wrote:
Also I can start a translation to Portuguese, but only after I end the tutorials.


I can help in this too.

Author:  Spiegel [ Wed Mar 18, 2009 5:49 pm ]
Post subject: 

Well since no one replyed to my question I went ahead and made changes to the wiki like I said in the second example.

User Manual now has the old structure. Feel free to change it if you think Its was not a good choice.

Author:  manunderground [ Fri Mar 20, 2009 9:36 pm ]
Post subject: 

Spiegel I like your changes so far. They're well organized and the included assets are very useful. Why not include a link to a webtart, too, so that users can see what they are going to build before they start.

Page 1 of 2 All times are UTC
Powered by phpBB® Forum Software © phpBB Group
http://www.phpbb.com/