Slick Forums

Discuss the Slick 2D Library
It is currently Sat Dec 16, 2017 2:40 pm

All times are UTC




Post new topic Reply to topic  [ 7 posts ] 
Author Message
PostPosted: Fri Feb 03, 2012 4:50 pm 
Offline
Oldbie
User avatar

Joined: Thu Jan 13, 2011 4:42 pm
Posts: 349
One of the most attractive features of slick is that, for all of it's power, complexity, and extensibility, slick is still easy to learn and use. This ease of use is made possible by clean code, good API documentation, an active forum, and a good user manual. Our user manual has good guides on a great number of topics, but these topics have become so numerous that they are beginning to clutter up the manual page, making it just a bit more difficult to find what you're looking for. I propose that we reorganize the manual so that all of the topics are organized into six sub categories: Slick-Framework, Graphics, Input-Handling, Sound-and-Music, Saving-Local-Settings, and utilities. These six categories do not evenly distribute the manual pages (graphics would have 38 sub-pages, while Saving-Local-Settings would have only 1), but I believe that they are the easiest to navigate.

I have attached a file that contains my proposition for new sub pages and the overarching user manual.

the main menu would be formatted like this:

Code:
==== Slick2D user Manual ====

  * [[Slick Framework]]

  * [[Graphics]]

  * [[Input Handling]]

  * [[Sounds and Music]]

  * [[Saving Local Settings]]

  * [[Utilities]]


I could implement this now, but I want to get an opinion from other users before making such a large change. Should the manual be reorganized? If so, is this a good way to organize it? If it should be reorganized differently, how?


Attachments:
AlternateSlickUserManual.zip [1.84 KiB]
Downloaded 180 times

_________________
"Artificial intelligence will never be a match for human stupidity" - "Jamos Kennedynos"


Last edited by Mr. Kenkron on Tue Feb 07, 2012 12:18 am, edited 1 time in total.
Top
 Profile  
 
PostPosted: Fri Feb 03, 2012 5:03 pm 
Offline
Slick Zombie

Joined: Sat Jan 27, 2007 7:10 pm
Posts: 1482
As long as pages aren't removed, I am in favour of making it more organized and easier to navigate. After all, most of the people visiting the wiki will be new to slick and looking for the bare essentials of the library.


Top
 Profile  
 
PostPosted: Sun Feb 05, 2012 4:12 pm 
Offline
Oldbie
User avatar

Joined: Thu Jan 13, 2011 4:42 pm
Posts: 349
A few days have passed, and everyone seems cool with it, do I updated the user manual as described above with slight alterations to the organization of the input handling page. Because an input handling age exists already, the new subcategory is called input, and input handling has been added to the list of input pages wit (overview) following it.

_________________
"Artificial intelligence will never be a match for human stupidity" - "Jamos Kennedynos"


Top
 Profile  
 
PostPosted: Sun Feb 05, 2012 6:45 pm 
Offline
Game Developer

Joined: Sun Nov 12, 2006 11:18 pm
Posts: 890
Location: Germany
Nice :D

Looks good, Mr. Kenkron. Thanks for that update!

_________________
Right Angle Games | Marte Engine
Back to the past | Star Cleaner | SpiderTrap


Top
 Profile  
 
PostPosted: Sun Feb 05, 2012 7:11 pm 
Offline
Slick Zombie

Joined: Wed Apr 02, 2008 1:32 pm
Posts: 1339
Location: Italy
I like this re-organization, more clear and simple!

_________________
Blog | Last game A droid story


Top
 Profile  
 
PostPosted: Tue Feb 07, 2012 12:16 am 
Offline
Oldbie
User avatar

Joined: Thu Jan 13, 2011 4:42 pm
Posts: 349
Thanks, your support means a lot. :)
Did I handle the subject line correctly?

_________________
"Artificial intelligence will never be a match for human stupidity" - "Jamos Kennedynos"


Top
 Profile  
 
PostPosted: Thu Feb 09, 2012 6:02 am 
Offline
Game Developer
User avatar

Joined: Wed Feb 17, 2010 12:24 am
Posts: 598
looking good!


Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 7 posts ] 

All times are UTC


Who is online

Users browsing this forum: No registered users and 0 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Group