Syntax Project - 3DGS Wiki

Hello,

in the last time I have been working on preparing a project on the 3dgs Wiki. The name is "Syntax" and is at first a port of the 3dgs syntax reference into the wiki, but afterwards, I hope that by the help of users the information provided there will be extended and kept up to date.

We all know that the manual provided by Conitec has little mistakes everywhere, but what if we could correct those mistakes within a matter of seconds and make them visible to the everyone?

So I really hope that some enthusiast 3DGS users will participate here, and if not - I will make a complete reference, though I dont know how many decades I will need.

Anyway, any help is welcome!

More information about the project:
http://www.coniserver.net/wiki/index.php/Syntax:Index

The guidelines for new articles:
http://www.coniserver.net/wiki/index.php/Syntax:Guidelines

And an index of all articles right now(well, only two - as I didnt have too much time aswell):
http://www.coniserver.net/wiki/index.php/Category:Syntax

With this I hope I can bring a new wind into the 3dgs wiki, as I have also spend a lot of time into integrating new articles in the wiki about basic topics. But honestly, the Wiki is a mess and there would be some cleaning up needed.

Cheers
Mike

I once started such a project under "Documentation":
http://www.coniserver.net/wiki/index.php/Documentation

But I'm happy that someone else has this idea too and is putting some effort into this, I'd be glad to help.

edit: Yours looks much better than my attempt

We need a better TOC design here. I highly recommend to write functions as they have to be written in LiteC (it is not C_Trace, but c_trace). The info box is poorly designed, too, because the whole function signature should be visible in one line without any line feeds. Better use a monospace font for the function syntax rather than a TTF. With a proper (bigger) info box, the definition and parameters section can be abandoned. The tables with parameter and return specifications are very hard to read in my oppinion.

Please put the related functions together in one line rather than having a list. Imagine dozens of related functions.. That would be a long list.

Remember: making a documentation is not easy. The user has to have fast and an easy to navigable access to the information. Deep and more info should be optional but always not a obstacle to the way a user reads the manual. Please do not consider to make it too different from the original manual: I think the current manual is very well done in terms of navigability and information access.

Maybe you can add a "DEP" image for "deprecated" like ent_remove, etc. and a reference to the new instruction (ptr_remove in this case).

For the examples I would consider making a snippets pool in which examples can be inserted. On a page for an instruction this example can be linked with a URL rather than placing the whole example on the page, because if users add mutliple examples, the page can be increased up to an enormous length.

I think the Parameter-section is bad structured. I would prefer some kind of table here

Well, it's a Wiki, collaborate as much as you want here

Just a little bump.

Xarthor has been doing a great(!!) work the last days, I literally said "wow" when I saw all the pages he has added! A big thanks for helping here.

Aswell this post is to get some more users into trying out to collaborate here.

A bit sad that not so many are participating here, while on one had complaining that there is not enough informative stuff on the wiki and on the other hand not doing anything to improve this. Cut yourself's a slice off from Xarthor and help building up this whole thing

Once again, big thanks to Xarthor