Spring command doc

Agon · Post by **Agon** » 28 Jul 2007, 18:47

Requesting a documentation for all lua, cobs and so on, commands.
Something like this:
http://www.go-mono.com/docs/
Why? Easier and faster to find a command. Searching is possible. Reducing "silly" question about: Is where a command for that thing?

Post by **Tim Blokdijk** » 28 Jul 2007, 22:43

I guess it would be possible to add it to the 'new' site at some point.
I do have a few questions.

Do you have the time/interest to drive this?
Can you develop/maintain this yourself? (can you code?)
What (open source) documentation software is available for this? And what would you suggest to use?
Can this be a part of Doxygen?

Agon · Post by **Agon** » 29 Jul 2007, 01:05

Do you have the time/interest to drive this?
A: If it does not take long time, yes. And interest: I have some.

Can you develop/maintain this yourself? (can you code?)
A: I can code. But I├é┬┤m not a friend of php.

What (open source) documentation software is available for this?
A:The one from mono: Monodoc
It is based on asp.net and gtk#. Means you can run it in you webbrowser or as an application under Linux/Windows and I think Mac, too.
After 30 min search I found no over open source public available "api doc".
The most projects have made there own "api doc".

And what would you suggest to use?
A: A new developed one or monodoc. (Did not found one more, that could be used)

Can this be a part of Doxygen?
A: Do not know this. I think no.

AF · Post by AF » 29 Jul 2007, 05:53

Actually its just a matter off adding an entry and starting a page in the wiki

Post by **Tim Blokdijk** » 29 Jul 2007, 12:42

@Agon
You would have to drive it to some extend as I lack the time to drive this myself.
Using the MediaWiki installation has some big advantages (good idea AF) as it's in place and being maintained and people already know how to use it.
Can it be used or adapted for this?

Developing something new would take a dedicated coder I don't know who would be willing to put in the time.
MonoDoc is already done and development is external so it won't take us that much time, that it depends on asp is not that handy for maintenance.

I personally like the MediaWiki route.

Agon · Post by **Agon** » 29 Jul 2007, 14:07

Monodoc needs a apache server and the apache mono module and some dependence, but not much ~8.

Media Wiki would be a alternative but I prefer the monodoc. But some on needs to setup the apache server.

Pressure Line · Post by **Pressure Line** » 29 Jul 2007, 14:20

Agon wrote:Monodoc needs a apache server and the apache mono module and some dependence, but not much (~10).

Media Wiki would be a alternative but I prefer the monodoc. But some on needs to setup the apache server.

we already have a wiki set up. all we need is someone like Flozi, trepan, Argh, Zpock or Zwzsg to start dumping knowledge into there.

some examples of commonly used code wouldnt hurt either

Agon · Post by **Agon** » 29 Jul 2007, 15:29

I know that we have a wiki but do you think a wiki is good for code examples and a list of hundred of commands?
Take a example from other projects they are not using a wiki for where api documentation.
I prefer a api documentation software. But I only found one public available.

Spring RTS Engine

Spring command doc

Spring command doc