New Wiki UnitDef Tag Documentation

[hoijui]

yes, DoxyGen is the C++ equivalent of JavaDoc, and works very similarly.
Tobi and abma are the chiefs of DoxyGen uploads... i don't know where the latest one is, but i found an old one:
http://springrts.com/doxygen/da/d7c/structUnitDef.html
(linked to on this page: http://springrts.com/wiki/Development_IDEs#Notes)

This whole thing has a bit too much info, even for my taste, but keep in mind that output generated by doxygen can be limited. Ah .. and of course you will not find much info for mod devs there, as stuff is not documented in the code.

[Jools]

I think this is a good piece of documentation. What I missed when designing was some piece of general information, especially how unifdefs relates to other containers hierarchically, for example to UnitDefnames. It's not totally clear to me whether the one is the child object of the other or not.

[FLOZi]

http://springrts.com/wiki/Units-UnitDefs

Now essentially complete. Decided to go with external links to public game source repositories for the examples, seen as there are literally so many examples accessible from just one link, and 'real' examples are usually more use than 'artificial' ones. That and the page is the 5th longest (http://springrts.com/wiki/Special:LongPages) on the wiki already.

Many thanks to everyone who helped, particularly DeadnightWarrior, kloot, lurker, and I'm sure I'm forgetting several people. Gnome, Forb, jK?

Next up is featuredefs which shouldn't take too long. WeaponDefs I am putting off for a while.

[SanadaUjiosan]

Colossal work to everyone involved. Very happy to see this!

One note, pretty sure its a typo:

pushResistant - type: bool - default: false
Can the unit be pushed around by other units? Turning it on doesn't remove all pushing but is a marked improvement.
Can the unit be issued Guard orders?

Only one I saw, but I was only reading pushResistant because I didn't know it existed

[FLOZi]

Fixed, cheers

[Forboding Angel]

oh and +1 for wiki subforum. There are often some global issues...ie why does the google search disappear when logged in?

Well instead of using my commit (in which the search didn't look like shit either), someone decided to reinvent the wheel and do it badly. But hey, at least it's there. Only took fucking 2 years.

[FLOZi]

With much help from Beherith:

http://springrts.com/wiki/Units-FeatureDefs

[knorke]

nice.
But why Units-FeatureDefs and not Features-FeatureDefs?

I added http://springrts.com/wiki/Units-UnitDefs#sounds btw, though I was not sure on all that.
ie what effect gamedata\sounds.lua has on defaults.

[FLOZi]

Well, I was working under 'Units-' being a sort of catch-all term for game development, but maybe you are right. I'm a bit unsure about naming scheme myself.

I originally put in sounds subtable then removed it when I couldn't find it in unitdef.cpp, doh!

[AF]

[knorke]

whats that?

[AF]

Well it kind of does the same job as the wiki page discussed in this thread BUT....

• Searchable listings
• Organise by category
• Organise by tag type ( e.g. show all attack tags)
• Organise by data type
• Tree view of tags
• Supports functions and tags
• Expandable to non Lua and Gadget APIs
• Threaded Commenting
• Further expandable with more taxonomies e.g. I could add a taxonomy indicating the version of spring in which a tag was added
• Full fluid width site layout with native responsive layout that adjusts all the way from iphone/Android to full res 1080p+
• RSS Feeds for additions to the docs
• Trackbacks for blogposts and threads linking to the docs

The expanded structure means we can do PHP and JQuery style documentation, so rather than the one liners we have in the wiki, instead we can show related tags, and have full code examples for gadget/engine APIs, and pictures and videos demonstrating what functionality is provided.

All built on Wordpress 3.1+

Things I intend to add but may not make it:

• I wanted to add a feature where you could click a bar and it would expand like an accordion and show you units that use that tag, but that would require something like trademarks modinfo sites code. I couldnt find any APIs that would let me pull a list of units with their games, thumbnails, unit names and links to the units modinfo page, though I didn't look very hard
• http://www.jqapi.com/ style searching, where it autosearches and shows a list of matches underneath
• Frontend tagging

I've built this off of a longterm project I have to build wordpress themes, so it should include a hefty amount of optimisations, features, and fancy stuff right out the box, a lot of JQuery enhancements and UI tweaks such as proper gallerys with commentable pictures and navigation that vanilla wordpress themes lack is in there.

[knorke]

so rather than the one liners we have in the wiki, instead we can show related tags, and have full code examples for gadget/engine APIs, and pictures and videos demonstrating what functionality is provided.

That sounds all fancy and stuff but who is going to create the content for it?
http://springrts.com/wiki/Special:ActiveUsers -> there are 30 active users and that is counting Emmanuel.

The wiki has one liners because nobody got around to write more on it, not because of technical limits.
Lua synthax highlighting, less fail layout, etc., that would be all nice to have but most of these other things seem kind of unnessecary to me.
I'd rather have a wiki with hundreds of pages on the level of this UnitDef page then a wiki that is all super and viewable on iPhone but only has a dozen of pages.

I mean, you mention "pictures and videos demonstrating what functionality is provided", that is just not realistic. Who would make those videos?

[AF]

Its merely an example of what can be done. A lot of images and details can be lifted straight from the posts announcing new tags etc.

I also have things in mind for encouraging users to contribute, but alas that's something else I shall speak about announce some other time.

Eitherway if it held exactly the same data as that wiki page it would be just as useful if not more, as it could show it in the same format, and plenty of others.

For example, instantly from this system you can start attributing tags to authors documenters/developers, and you can easily tie in existing threads and pages, so the relevant wiki pages and forum threads would be shown, as would the git commits that added those tags if added, and the files the tags are used in ( pretty easy for unitdef and featuredef )

[AF]

Currently working on adding the wiki pages into my Spring Docs site, is everything in there atm? Or are there more tags that need adding? I've added 113 entries so far to my own setup

[FLOZi]

Everything that should be there is (couple of deprecated tags not included), but the sounds subtable section needs some correction.

[smoth]

whats that?

ugly

[AF]

Are you calling my new site fugleh?!

[smoth]

for something like the spring documentation. Yes.

I would bother to discuss all my issues with it but honestly you don't listen to many people about layout.

[AF]

If you have a suggestion, please feel free to comment. You may even have your suggestion already, afterall I've only posted the one screenshot, at a point where I'd only placed 2-5 tags in the system.

Keeping in mind so far the points levelled at me in this community about web layouts are:

• Make the menu prettier
• Why is the logo green
• yay roflcopter
• Why Dokuwiki