WIKI editing rules

[Iyanga]

I'm wondering if there are any rules or guidelines regarding the Wiki.

For example, I wanted to add the information that SetAnchor _adds_ an anchor.

Usually I would create pages and links like:

Controls -> Control -> Control:SetAnchor
and have the information written on Control:SetAnchor.

But as it's here a rather flat hierarchy still, I'm creating inconsistency with that and a sentence does not really justify a page, does it? But then again, it's done this way with some Events...

Comments?

[Brainling]

I'd like to see a standard template created for deep-documenting functions. That template should have a notes section where things like this can be added.

I think looking at something like MSDN is a great place to start, in terms of a nice, developer friendly, format for deep-documentation.

Another options is to look in to something like LuaDoc, and create a LuaDoc proxy file for the ZO API and just generate from that using a fancy template. In fact, maybe if we're really nice, ZO will LuaDoc the API for us and just let us generate from their documentation proxy (the RIFT developers did something like this and it was wicked handy).

[Dolby]

I guess right now there aren't really any standards set. My wiki skills are not all that great other than supporting the backend for it. Is there a normal standard other wikis follow?

[Stormknight]

Normally you'd have a template for specific types of pages.

It would be awesome to have a standard one for API functions, then that way if people have useful info to add, they can do so.

Take a look at some wowwiki pages for example (two with varying amounts of useful info):
http://www.wowwiki.com/API_GetCategoryInfo
http://www.wowwiki.com/API_SendChatMessage

Even just as simple as specifying sections and navigation would be handy. In the example above, sections could be: Syntax, Parameters, Results, Details, Example.

You could get fancy and divide things up into sections, but not sure that's really needed.

edit: Whilst there is a function for defining templates in mediawiki, you don't need to go as far as doing that. You can just specify, "please copy this text for your page before starting to edit" or something.

[Iyanga]

Hm.

I started now using this layout:
http://wiki.esoui.com/Control:SetAnchor

[Xrystal]

Originally Posted by Iyanga Hm. I started now using this layout: http://wiki.esoui.com/Control:SetAnchor

That looks pretty cool. And didn't realise how easy it was to use = to create headings etc.

[Stormknight]

Wiki page formatting is pretty easy to do.