Team Wiki
From Multiverse
Team Wiki is an informal group of Multiverse developers who are interested in contributing to, refining, and developing the Multiverse Developer Wiki. We encourage participation at all levels, from contributing entire tutorials to making minor corrections in existing articles.
Multiverse publications manager C.rand coordinates Team Wiki.
Contents |
Admins and team members
All Multiverse employees are admins, by default.
Admins from the developer community:
- quamquam
Policies and procedures
The Style Guide contains lots of useful information.
Only admins (sysops) can delete articles. The Deletion Policy explains how and when to delete articles.
Projects
Here is the official list of documentation priorities: Documentation Priorities.
These are some other ongoing areas that need help:
- Transfer tutorials from the forums: see the list in Documentaion Priorities
- Example code testing and verification
- Categorization
- Enforcing the style guide
Test example code
The amount of code (both that developed by Multiverse and by external developers) on the wiki makes it difficult to ensure that all the code always works with the latest release.
To help with this process, we created a special template specifically for articles containing example code: Template:Code Example. Basically, it's just a spot to record when the code was originally contributed, by whom, when it was last tested, on which version, and by whom.
Here is an example of how the template is used: Example of a Basic Server Plugin. Always put it at the very top of an article.
Filling in the template is pretty self-explanatory. Here is the wiki source from the article above:
{{Code Example|author=Multiverse|date=17 Sep 07|tester=[[User:C.rand|C.rand]]|version=1.0}}
The example above displays the following:
| Contributed by: Multiverse | Last Tested: 17 Sep 07 | Tested By: C.rand | Tested With: 1.0 |
The code example template is intended to be used at the very top (beginning) of an article.
Just replace the information in the example as follows:
- author=name - Whoever originally wrote the code. Use forum/wiki user name, if known. Use "Multiverse" if the code came from Multiverse engineering or technical publications.
- date=dd Month yy the code was last tested. Use the specified date format for consistency and to ensure the date is easily understandable by both US and non-US readers.
- tester=name - user name of the person who tested it. If desired, link to your wiki user page as illustrated above.
- version=num - Version number of the platform on which the code was last tested.
Categorize articles
NOTE: Much of this has now been done.
Mediawiki categories are a special mechanism to organize wiki articles. Categories provide automatic indexes that are useful as tables of contents.
To put an article into a category, add a category tag to the page (by convention, at the end of the page), for example:
[[Category:Category name]]
Substitute the actual name of the category in place of Category name. So, for example, to put an article into the "Client" category, add
[[Category:Client]]
at the bottom of the page.
An article can belong to any number of categories. Mediawiki supports the notion of subcategories.
To see a list of all categories defined, view the special categories page: Special:Categories
For more information on Mediawiki categories, see http://meta.wikimedia.org/wiki/Help:Category.
How you can help: Go through the list of uncategorized pages, Special:Uncategorizedpages, and add them to the appropriate category. If necessary, add a new category or subcateory for the article.
Enforce the style guide
We can always use help with editing articles to ensure that they follow the Style Guide. Some of the most common mistakes that people make are:
- Grammar and spelling errors
- Capitalization errors
- Formatting errors, e.g. not putting inline code inside <code> tags, not formatting code blocks properly.
- Organizational issues.
Also, add cross-references, and links from the main Server, Client, Tools, How To... and Quick Links pages.
Technical review
When you encounter something in a wiki article that seems wrong, questionable, or just confusing, flag it with a "ReviewNote", like this: This section is confusing. What do you mean by xyz?? Add a review note as follows:
{{ReviewNote|Whatever you want to say}}
As much as possible, be specific. Vague comments like "This is wrong" are not useful.
Whenever a review note like this is used, the article will automatically be categorized under the "Articles needing review" category. Furthermore, whenever the mvdraft template is used, the article will automatically be categorized within the "Unfinished articles" category. Used together, these should help the wiki editors and MV engineers quickly find articles that need updates.
The wiki also provides a page listing all articles that contain review notes, if the categories are not preferred: Special:Whatlinkshere/Template:ReviewNote
...and pages that contain draft messages:Special:Whatlinkshere/Template:mvdraft
Page cleanup
If you find a page that is empty or superseded by a different article, please consider adding it to the Articles for deletion page, including your reasoning for why this article should be removed.
Similarly, if you find two pages that contain similar data, consider adding an entry to the Articles to be merged page.
