Raydium 3D Game Engine

Official forum for everything about Raydium, ManiaDrive, MeMak, ...
It is currently Thu Mar 28, 2024 4:30 pm

All times are UTC




Post new topic Reply to topic  [ 10 posts ] 
Author Message
 Post subject: Raydium doc in SGML?
PostPosted: Sat Jul 14, 2007 3:08 am 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
I was reading and maybe could be interesting to change the format of the comments(that make the documentation) to docgtk format.
In that way the resulting document will be in SGML format, and it can be directly passed to tools like Devhelp.

Just an idea.


Top
 Profile  
 
 Post subject:
PostPosted: Wed Aug 08, 2007 11:01 pm 
Offline
User avatar

Joined: Sun Mar 16, 2003 2:53 am
Posts: 2591
Location: gnniiiii (Scrat)
My point of vue : too much work and not for that much results :) Wiki syntax is quiet common, and there's probably some tools to convert this syntax to something else.


Top
 Profile  
 
 Post subject:
PostPosted: Wed Aug 15, 2007 2:51 pm 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
Finally i have found a utility but now i'm investigating about how it works.
How works the process to convert the sources code of raydium into a html page?
The process generates an intermediate document?
I'm not sure if i should process document per document (source code files) or if i should enter that "hipotetical" unificated file.

updated:
It didn't work, at least with raydium source code.


Top
 Profile  
 
 Post subject:
PostPosted: Wed Aug 15, 2007 3:12 pm 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
Can you take a look at this?
http://www.xs4all.nl/~rfsber/Robo/robodoc.html
Is GPL v3 licensed. It convert almost-wiki source code doc into robodoc format and it can convert it on SGML, XML, HTML and so. And it's easily configurable.

And looks like it create intermediate files with the doc before make the final conversion.

What do you think?


Top
 Profile  
 
 Post subject:
PostPosted: Wed Aug 15, 2007 7:27 pm 
Offline
User avatar

Joined: Sun Mar 16, 2003 2:53 am
Posts: 2591
Location: gnniiiii (Scrat)
I may have missed something, but the syntax seems quiet different from the wiki one : http://www.xs4all.nl/~rfsber/Robo/Manua ... #preparing

Do you have any reference for the almost wiki syntax ?

edit: Something like this is probably simplier for us, IMHO : http://www.phpclasses.org/browse/package/3111.html


Top
 Profile  
 
 Post subject:
PostPosted: Wed Aug 15, 2007 11:29 pm 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
I readed wrong about wiki format.

///

About php class. That could allows us to convert the wiki of the sources to plain html... and then we could convert that into other formats like sgml?


Top
 Profile  
 
 Post subject:
PostPosted: Thu Aug 16, 2007 6:28 pm 
Offline
User avatar

Joined: Sun Mar 16, 2003 2:53 am
Posts: 2591
Location: gnniiiii (Scrat)
Basically, It's (quiet) easy to update the raydoc.php to make it generate someting else than the current wiki syntax. The question remains: what's is better and simplier than the current method : we've online HTML doc (with chapters and function index) and PDF version (exported from a browser).


Top
 Profile  
 
 Post subject:
PostPosted: Fri Aug 17, 2007 8:58 am 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
Ok, but all this post started cause i just wanted to have the raydium API reference in my devhelp application :( And is not an easy task to make it devhelp compatible from current format.
Anyway, pdf and html formats are good enogh, at least till now :)


Top
 Profile  
 
 Post subject:
PostPosted: Fri Aug 17, 2007 12:43 pm 
Offline
User avatar

Joined: Sun Mar 16, 2003 2:53 am
Posts: 2591
Location: gnniiiii (Scrat)
DocBook XML (it seems that devhelp works with this format) can be a good idea in the long term, but doc generation will become a complex pipeline ...

For example, PDF Generation will look like source -> PHP Script -> DocBook XML -> XSL-FO pasrser (Java FOP for example) -> PDF. Quiet ... heavy :)


Top
 Profile  
 
 Post subject:
PostPosted: Fri Aug 17, 2007 4:04 pm 
Offline
User avatar

Joined: Thu Sep 29, 2005 2:59 pm
Posts: 828
Ok ok, we can follow as is


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

All times are UTC


Who is online

Users browsing this forum: No registered users and 36 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:  
cron
Powered by phpBB® Forum Software © phpBB Group