OoTMM Wiki:Contributing
Anyone with an account can edit this wiki.
This wiki is still in its early stages. As such, any contribution that you make is useful even if it is written poorly or quickly.
You do not have to read a style guide to contribute. Write in your own style.
You do not have to read this guide to contribute, but it may help.
Content Contributions you can make to existing pages
Adding your expertise
We have a template that is useful for prompting knowledgeable users to edit this wiki (Template:Please Explain)). This template adds a category to any page it's in.
This category lists all the pages that need your expertise:
Add new dev branch changes
When new content is added to the dev branch, we can document it on the wiki using this template: Template:Version Differences
This template clearly marks difference between different versions of OoTMM. It is also fantastic for maintenance: when a new OoTMM stable release is made, we can instantly change the text in articles to reference the new stable release.
Pruning old Version Differences templates
When a release is one month old, the version differences template automatically hides text relevant to old versions of OoTMM. At this point, the template should be removed from the wiki since its presence is invisible and it longer serves any purpose.
The version differences templates assign categories to the pages they're in:
- Category:Pages affected by upcoming changes
- Category:Pages affected by recent changes
- Category:Pages with removable Version Differences templates <-- if there are any pages in this category, then there are templates that need pruning.
Pages we need made
Any red links shown on the main page navboxes are pages that should be created. Please create these pages if you have information that you can write in them.
Creating region pages
There is an ongoing project to construct region pages for every region.
You can see which pages need to be created here: Template:Regions Footer
These pages need the following templates added:
- Template:Region Infobox - data about the region
- Template:Regions Footer - links to other regions
One use case for these region pages is to document strats/tricks/glitches. You can do this using Template:Strat
Here is an example of a well-filled out page: Forest Temple
Please add one of the following to a page if you haven't completed it:
{{stub}}
{{Incomplete}}
Broader Contributions you can make
This section lists projects that this wiki would benefit from
Button Artwork
Wiki.gg has an extension that displays controller buttons. Example:
It doesn't support Nintendo 64 Buttons. It would be nice if support could be added for that.(either upstream or here, somehow).
Data processor for checks
OoTMM has thousands of checks. Most players don't know all the checks. The wiki should document them, sometimes with images and a location guide. But where? We have:
- pages for specific shuffles
- pages for specific regions.
- a (well hidden and out-of-date) article with Every Check In OoTMM
Ideally all these articles would have check lists/guides, but that creates maintenance issues. It's inefficient to have the same information duplicated across multiple articles, because:
- when new checks are added, they would have to be added across multiple region pages as well as on the specific shuffle page.
- when someone edits a check on one page (say to add a guide or correct misinformation), then the other pages will still have old information.
What we need is a data processor that:
- automatically (or semi-automatically) shares data across relevant articles
- can cope with new checks being added
- still allows users an easy method of updating the check guide.
Eedefeed: I've developed a Lua Script that can handle CSV/JSON queries, but the script uses too much memory (owing to JOINs) and will not run. I've considered other options but I don't think they're workable. If you want to help, please ask me.
Web CSS Styles
The following templates could do with improved styling
Contributions requiring additional permissions
Regular users cannot fix these issues:
On mobile, navboxes disappear. This means that the wiki's main page doesn't link to any of the wiki's content
Apparently there's a solution to this: https://support.wiki.gg/wiki/Navigation_boxes#Troubleshooting
The solution is CSS editing, regular users don't have permissions
Don't know if we should edit it either; maybe there's a reason for the default setting being like it is?
Theming improvements
Someone with access to edit CSS could contribute the following improvements
- (subjective, maybe needs discussion) - increase the size/prominence of titles/subtitles. Articles can be hard to read because once titles get to level 4/5 they are hard to distinguish from both each other and from just bold content text.
- We have several templates that apply inline CSS styles to every div box. Once these are stable, they should probably be folded inside a site-wide CSS stylesheet. Template examples:
Our Custom Templates
Major
- Template:Strat - for documenting techniques/glitches/tricks
- Template:Version Differences - for marking and automated maintenance of version differences
- Template:IandE - (see Changes to Vanilla Behaviour for example usage) short for Information and Explanation. It makes the information big and eye catching whilst diminishing the full explanation.
- This template helps readers parse an article that contains a lot of information quickly. Readers can choose read only the headlines (information) and then check out the clarifying remarks (explanation) if they really need to.
- Template:Gossip Box - for placing a large styled text box as if it were an in-game gossip text box. Consider using Template:GTColor alongside it.
Minor
- Template:GTColor - set text colour to match the colour codes used in OoT and MM text boxes. (use very sparingly and always set a contrasting background colour! Consider night themes, for example!)
- Linking to OoTMM stuff: please use these instead of direct links in case we need to change the links sitewide
- Template:Discord Link - Links to OoTMM discord server
- Template:Change Log Link - Links to OoTMM change log
Infoboxes
These are boxes on the side of an article that have quick facts in them
These are large boxes that show links to articles.
Ideally, every page has at least one at its bottom.
These form the main page categories on the site.