Avorion Wiki
Advertisement

The Admin noticeboard is one way through which users can notify Administrators of issues needing administrative attention. While users are welcome to directly contact specific administrators (especially if they are seen to be active), posting here can be an easier and quicker way of ensuring that at least one admin will notice an issue and respond to it promptly. Remember to sign (using four tildes: ~~~~) when posting an issue.

Before posting an issue here, please consider the following:

  • This page is for reporting wiki issues. Please post discussions on the talk page.
  • Post only issues that require administrative action, i.e. blocking vandals, protecting pages, restoring deleted pages etc.
  • Do not post deletion requests here. Deletion requests should be made by adding {{delete|reason for deletion request}} to the top of the target page, which will then automatically mark the page as a candidate for deletion.
  • Do not post issues regarding content disputes. Try making a request for comment instead.
  • Mediation requests between users should only be made once a resolution could not be reached between users.
  • For issues regarding the use of this wiki, please see our help center.

In case of vandalism, posting about it here is low priority. Revert it first, anyone can do so. If the vandal created a new page, tag it for deletion. Assume good faith and consider leaving a message on that user's talk page to explain the reason. Post here only if the user has made several disruptive edits and/or persists despite a warning. Always avoid a revert war with the vandal; it is far better to wait until an admin has a chance to intervene. If a user must be reported here, please use {{user}}, preferably as the topic subject/headline.

Current Issues

API project

Hey there! So I've been "playing" Avorion for a little while now so of course I just must edit the wiki! (it's what I do, apparently) Seeing that the Avorion devs are shipping official scripting API documentation with the game warms my heart, but after looking at it, it looks like it could use some... sprucing up. I've already been transferring some of it over to the wiki, experimenting with different styles and such. But I was wondering if it would be agreeable to add a separate wiki namespace for all the API articles. I suggest: "API:". I've already added quite a few of the API classes to the wiki, as you can see at Category:API:Script_API.

If none of you are familiar with mediawiki namespaces, I'm talking about modifying LocalSettings.php, and then you'll have to move all the pages I created, or use the maintenance script NamespaceDupes.php to do that for you. Adding a separate wiki namespace would allow all those articles to be properly searchable, and sortable - so that their article name would be for example, "Material" in the "API" namespace, instead of named "API:Material" in the "main" namespace.

Note however that there's some things to consider - I've never suggested adding a separate namespace for a game's API, I've always done it in the main namespace on other wikis, but a lot of the class names conflict with in game concepts. I also know that mediawiki is not a platform designed for API documentation, let alone any documentation. I also realize that it seems as if most of the Avorion community, at least on the forums, somehow already know how all the scripting stuff works.

But there's things I think are really neat too! Adding the docs to the wiki will allow all the things to link together like a proper API documentation. It'll also come in with built-in searching and back referencing features, instead of using external tools. The whole community can pitch in and contribute to the API documentation too. They can keep on improving it even - perhaps by clarifying things that may be confusing at first to some people, or by adding example code snippits that will make things more understandable.

What do you admin people think about adding an "API:" namespace? :D

RE: API project

I don't think that it's a good idea to port the API to the media wiki. It would mean multiple copies of the same data, while the copy wasn't generated by an algorithm but by a human being which can make errors. If you have suggestions for improving the documentation, please tell me about it. The issue is, that once the API changes with a patch, and you don't immediately have time or have seen all the changes in the API, the Wiki will be outdated. Also, you'd have to guarantee for the rest of the development of Avorion that you'll always update the API on the Wiki entirely.

Advertisement