Forum:API event pages
Currently, API event links (like GROUP_JOINED) show up blue regardless of whether the event is documented (or acknowledged) because the link leads to a (potentially missing) section on the Events/G page. I don't like this: it isn't nice to follow a link only to find out that it leads nowhere, and editing the Events/X pages is a bit messy.
To fix that, I'm thinking about moving event documentation to separate pages (e.g. GROUP_JOINED) which would use a format similar to the current API function documentation, and making something like Events/Names a semi-authoritative list like Global functions. This would probably make the individual event documentation easier to edit, but may complicate things for existing bots. Any thoughts on any aspect of this plan?
— foxlit (talk) 20:14, 18 January 2013 (UTC)
- I see no issue, so long as a pseudo-namespace is not introduced unnecessarily. Should they really be in all caps though? That's kind of ugly, though I'm not too attached either way. --Sky (talk) 16:17, 20 January 2013 (UTC)
- There's also the usability concern of all caps. Again, not too worried about whichever is chosen. --Sky (talk) 16:23, 20 January 2013 (UTC)
Here is how things look at the moment:
- Events replaces Events/Names and is now the general equivalent of API and Global functions. Eventually, it'd be nice to get one-sentence descriptions added to events listed on that page.
- Events/A and other alphabet pages are deprecated; new documentation should be created in per-event articles under the event's name, e.g. COMBAT_LOG_EVENT. There's currently no boilerplate for those things; follow the general API one in as much as it makes sense.
- Events/Achievements and other category pages are deprecated in favor of Category:API events/Achievements; new documentation should categorize individual event pages in subcategories of Category:API events. This is somewhat lossy -- we no longer have a per-category overview of events coupled with descriptions (to be fair, these pages were bot-maintained to begin with, so they could be done in a similar fashion in the future).
- For events with a non-zero amount of documentation on Events/X pages, the EVENT_NAME page now redirects to the relevant Events/X section. Eventually, that documentation should move to the redirect article.
At some point in the future, it would be nice to have a more definite example of what an event-documenting article should look like; and a more visible deprecation notice on Events/X and related pages. — foxlit (talk) 22:27, 21 October 2013 (UTC)