User:PhantomX50
Guide for Contributing to the Wiki
- How can you help develop the wiki? #
Anyone is allowed to develop the wiki at https://terrariamods.wiki.gg/wiki/Metroid_Mod and community effort is the best tool for making a great wiki, so never be afraid to help! You can sign up for an account (which is free and very easy!) which helps you keep track of things and for collaborating with other editors.
- How to edit/create a page? ###
First, by clicking on any redlink you find on the wiki, you will immediately be directed to the editor for making that page. Alternatively, if you look on the box to the left of the wiki called Tools, there's a link to New page which will send you to a special page where you can determine the type and name of the page you want to make. For our purposes, most of the time the type of page will be a Main page and you will want to start the name off with ``Metroid Mod/`` in order to keep it within our mod's wiki.
To edit an existing page, at the top of the page you should see a tab that says Edit. Just click on that and you can start editing!
- Ok, but how do I actually write the page? ###
The editor can seem a little overwhelming at first, or perhaps too barebones to really do anything beyond simple text. However, there are a lot of tools to make things easier, like linking to other pages, items, recipes, and more. Here are some simple tools to get started:
``text`` will create a link to any page on the entire wiki. The text field is what plaintext is shown on the actual hyperlink. The text field is optional. ``text`` will create a link to another page in this mod's wiki. The text field is what plaintext is shown on the actual hyperlink. The text field is optional. ``/namename`` will make a link to a page and include its picture next to it. The picture must be uploaded to the wiki AND have the same name as the item for it to show up (details more on that later).
.png){kind=link}
``
|
`` will list all the recipes that will craft ``item``. ``
|
will list all recipes that use that item as an ingredient.
There are plenty of other useful tools like these, called Templates, which smarter people have made for us to use on the wikis. Additionally, they tend to have other parameters so you can configure them as you want. It's good to know as much about these templates as you can because they are the bread and butter of editing. Lookup ``Template:Item infobox`` in the search bar and click on it to read documentation. Feel free to look at other wikis to get an idea of how to use them. Just be warned, the Terraria wiki is very advanced and they have some templates auto-complete, or entire templates that only exist on that wiki, so try checking other mod wikis like Calamity for resources. Lastly, never be afraid to ask others for help, or to even try googling. You may want to use the term ``MediaWiki`` instead of ``Terraria wiki`` or just wiki because that's the backbone of these wikis.
- How do I upload images and media? ###
Similarly to making normal pages, you may come across redlinks which ask for images for specific things. This will bring you to a page where you can simply upload a file and it should immediately put the correct name needed on the destination file for it to go where it needs to. However, there are some stipulations for uploading that the greater Terraria Mods wiki asks. Firstly, all files need to be in the form of ``File Name (Metroid Mod).ext`` so that we can differentiate our media from other mods (.ext depends on what you're uploading, of course). For example, if I wanted to upload a file for the Arm Cannon, i would need to make sure the destination file (not the source file that im uploading to the wiki) says ``Arm_Cannon_(Metroid Mod).png`` in order for it to automatically work when I use it for editing anything related to the Arm Cannon. Other than that, just make sure that when you upload the file, you go to the editor for that page and put ``[Category:Metroid Mod/Images]] or [Category:Metroid Mod/Demonstration animations]]`` in there so that it goes to the mod's correct media page. This makes it easier to access for updating sprites and whatnot.
Lastly, don't be worried! You can look at other pages on this wiki or even other wikis such as the Terraria wiki or Calamity wiki for examples on how to write pages. However, this doesn't mean you need to copy their formats or styles 1-to-1. It takes a lot of effort to make high-quality and easily readable pages, and most pages should realistically go through an iterative process before they're even close to being "finished". At this current stage of the wiki, I believe a focus on creating simple and digestible pages which easily allow users to either find what they're looking for easily or to understand the topic of a page without overwhelming either the editor or the user is a good goal.
Metroid Mod Wiki Roadmap
- Fill out item pages
- Addons first
- Mod Progression Guide