| Author |
Post |
|
|
#1 Thu Sep 08, 2005 5:04 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
I got this idea yesterday... Currently, there are docs at the wiki at SF.net, however, there are a couple of problems: - Data can easily be altered and even deleted by vandals, of course there are backups, but still... - The docs are only available online - There is no difference between official docs (API's, ...) and tutorials, howto's, etc... Therefore I was asking myself if maintaining official documentation in the docs/ dir at CVS would be a good idea. - Docs can more easily be managed and be made in standard formats - The docs will come with UseBB itself, so no need to have an internet connection to the wiki - Vandals have no access at all to the official docs - A seperate system can be made for user-made tutorials, howto's, etc... Eventually at a seperate resource website. Give me your opinions!  « Last edit by Dietrich on Fri Sep 09, 2005 8:30 pm. » |
|
|
#2 Fri Sep 09, 2005 7:27 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
This is a possible solution:  |
|
|
#3 Fri Sep 09, 2005 8:32 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
Okay, hoping for any remarks or ideas... An important question is: which format? XML? or HTML? If XML is used, we can't put it in the UseBB CVS module directly, because the XML will need to be transformed every time. HTML would probably be the best solution (XHTML and CSS). Of course guidelines will need to be made for this. |
|
|
#4 Fri Sep 09, 2005 9:08 pm
|
|
Member
Registered: Jul 2005
Posts: 232
Location: Stockholm
|
So your meaning is to have a real documentation HQ ?
Or have i got it all wrong.?
|
|
|
#5 Fri Sep 09, 2005 9:39 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
No, official documentation needs to come in CVS and maintained by a team of documentors from UseBB. |
|
|
#6 Fri Sep 09, 2005 9:44 pm
|
|
Member
Registered: Jul 2005
Posts: 232
Location: Stockholm
|
so you wanna set up a team of documentatorswith more specified instructions on how to do different things in usebb... sorry if im slow  |
|
|
#7 Fri Sep 09, 2005 10:15 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
We need full documentation of every aspect in UseBB, because decent documentation is about non-existant right now except for some howto's. |
|
|
#8 Sat Sep 10, 2005 7:42 am
|
|
Member
Registered: Jul 2005
Posts: 232
Location: Stockholm
|
and all should be in the file you download instead of having it all online ?
|
|
|
#9 Sat Sep 10, 2005 10:34 am
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
Please, see the chart! :p |
|
|
#10 Sat Sep 10, 2005 10:39 am
|
|
Member
Registered: Jul 2005
Posts: 232
Location: Stockholm
|
oh yare yare... :p I guess i shoulden't interact so much in this
|
|
|
#11 Sat Sep 10, 2005 8:55 pm
|
|
Member
Registered: Mar 2005
Posts: 196
Location: Hungary
|
What about OASIS OpenDocument as format? (Frankly, it's XML.) _______________ Long Live Rock n' Roll! |
|
|
#12 Sun Sep 11, 2005 9:01 am
|
|
Member
Registered: Feb 2005
Posts: 82
Location: Russia
|
DocBook is the best _______________ [druidvav.info] [reloadcms.com] [linuxsuxx.org] [2:5025/2275.112] |
|
|
#13 Wed Sep 14, 2005 12:05 am
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
So, I'm going to comment the code so we can use phpDocumentor to create the API docs. The question still remains how the other general docs should be written. I have neither worked with Docbook or even XML/XSLT... I don't know what would be the best. |
|
|
#14 Thu Sep 15, 2005 8:14 pm
|
|
Developer
Registered: Apr 2004
Posts: 2216
Location: Belgium
|
API documentation: http://usebb.sourceforge.net/api-docs/It seems like phpDocumentor is also capable of managing normal documentation... I should look into that. |
