Hello there, and welcome to the AQ3D Wiki. For those of you who don't know who I am, I'm Rickyb20, the current lead of the AQ3D Wiki. I will be your guide as we take a look at how to create and edit pages on the wiki.
This is a guide to hopefully help most users, new and old, get the hang of editing pages on this wiki. This guide basically covers most of the practical stuff. Includes screenshots and such to help you understand things.
As always, the Wiki Rules apply here, and everywhere else on this wiki.
Quick links to each section
- Creating/Editing a Page
- Templates (Work in Progress)
Creating/Editing a Page
The first step is creating a page, and there are two ways of doing so:
1. Type in the page name you want in the textbox on the sidebar (beside the 'new page' button)
2. Type in the page name you want in the address bar
(i.e. http://aq-3d.wikidot.com/whatever-page-name-you-want <- Do NOT use this link, it's just an example. Dashes can be replaced by spaces as they work the same way)
If you want to edit a page that's already been created, find that wiki page and scroll down to the bottom of it. There should be an "Edit" button (click here to see it; it's circled in red). Click on the Edit button in order to edit the page.
Please keep in mind that there are some pages (such as the sidebar, the Site Members page, the homepage, etc.) that cannot be edited by normal wiki editors. Please feel free to PM a staff member if you're unsure.
Now, onto how the editing window works.
Editing Window (Part 1)
Here's an image showing each important part of the editing window with a different colored box around it and where it can be found (Anything else that isn't circled, feel free to ignore it):
Firstly, I will try to explain what the first 3 boxes are and how they work to the best of my ability:
- The area in the red box is the page title. As simple as it sounds, this is where the name of your page goes. A couple things to note:
- If you create a page using the address bar that has an apostrophe in it, (like, for example, Gaz's Shop), the title will remove the apostrophe (it will start off looking like 'Gaz S Shop'). You'll see that both links work as they're both legit, although the second one just looks very odd. Make sure to fix that when you're creating the page because Wikidot treats all apostrophes, dashes, etc. as spaces. Don't ask me why.
- Changing the page title does not actually rename the page URL. If you need to actually rename a page (because the URL has a typo in it or for another reason), exit the page and create a new page with the correct name/URL (if you're creating the page), or PM a staff member on the Site Members page to get the page renamed (if the page has already been created).
- The area in the blue box is the "initial content" section where the preset templates are. See where it says "no template (blank page)" with a little down arrow () next to it? Clicking on that arrow will show a drop-down menu showing all the preset templates. Here is what that looks like (click here). Clicking on one of the templates will automatically load up that template in the editing window. We ask everybody to please use the templates, as doing so will help prevent mistakes, and there's less hassle for everybody.
- Please note that all items categories (aside from Classes) are using the same template: the Item Template. This is because there isn't many differences between these item categories that warrants them having different templates. We figured it would be easier just to have one template for all of them instead of dozens of individual ones.
- The neon-green box is the editing window. This is pretty much where you do the majority of your editing. The only things you can't edit in the editing window is the tags and the parents; those will be explained later on in the guide.
The other colored boxes will be explained later on in the guide.
Now comes the fun part: making the body of the wiki page.
Templates (Work In Progress)
(Note: This section of the guide is still a Work in Progress. The templates themselves should be pretty easy to figure out as is, but I'm creating this section for those who are still having a hard time understanding. I will try to finish up this section of the guide as quickly as I can, so thank you for your patience. If you have any questions about the templates, please feel free to PM a staff member.)
Below are a list of all the templates, broken down in order to make things easier to understand. Click on the collapsibles to show the content of each template:
- Anything in between a set of three brackets *[[[like this]]]* is a link. Make sure all links are spelled correctly when typing them in. Links that are broken (or example links in this guide) will appear orange, links that are working will appear as red. Use this as a guideline to make sure that any links you put in are spelled correctly.
- I'm not going to include [[include image-tags]] in any of the templates. They do not need to be touched.
- Please record any typos you see in-game, whether it be in NPC dialogue, item names/descriptions, etc. We record everything exactly as it is on the wiki.
- For image guidelines, please see the Image Submission Guidelines thread.
- For notes, please see the Note Consistency thread.
Editing Window (Part 2)
Now, back to this image. I will try to explain what the last 2 colored boxes in the editing are and how they work to the best of my ability:
- The orange box basically describes itself: it's is a little text box where you can describe the changes you made to the page (for example, if you fixed a typo. say "fixed a typo *here*", or if you're adding in new information, say "added new information *here*", etc.). If your description ends up being more than 200 characters, you can post in one of the proper forum threads provided instead. I recommend using this feature when editing large wiki pages with lots of text, as it makes finding changes easier for others and the wiki staff.
- Finally, there's the pink box. This is where you preview and save your page, among other things. I will explain each button to the best of my ability:
- The Cancel button pretty much explains itself. Opposite to the Save button, it cancels the wiki page and exits you out of the editing window on a wiki page. If you're editing a page you're about to create and decide you don't want to create the page, or if you're in the middle of editing a page and decide that you didn't want/need to edit it, then hit the Cancel button.
- The Preview button lets you preview the page. In other words, it lets you see what the page would look like before you save/create it. This button is incredibly useful as it makes correcting mistakes easier. Please use this button whenever possible.
- I'm going to skip the Save Draft button as I have found it does not work for me when creating pages. The button DOES work after the page has already been created, but I don't recommend it since if you save your draft and leave the page, other people might enter the page and delete your draft by mistake. If you need to save your work while you're in the middle of editing, save the work in a program like Microsoft Word or Notepad, or use an external site such as pastebin.com.
- The Save button pretty much explains itself. Opposite to the Cancel button, it saves your wiki page and creates it. Please use this button when you want to create your wiki page.
- Please remember to use either the Cancel or Save button (depending on the situation) if you wish to exit the editing window on a wiki page. Do not close the browser/tab window, as this will create what I like to call a ghost lock. A ghost lock is where it appears as if you're editing (it will show a page lock to others who try to edit the page) even though you're not. And since we have a rule about force-locking others, this causes people wanting to create/edit a page to wait until the person save and/or exit the page. This can cause quite a bit of confusion and delay, so please be careful.
If you have followed all of the instructions above, and you feel that your wiki page is complete, please click the Save button in order to create your wiki page.
Congratulations! You have now made a wiki page. Don't think you are done yet though. You still have to tag and parent your page, both of which are explained below.
But before we get to that, there is one more thing I would like to note.
After creating a page, if you go into the editing window again, a few more buttons will show up at the bottom of the page (click here to see them). I would like to take a minute to explain them to you:
- The Show Changes button shows any changes you made to the page while currently editing. I'll use the Cysero wiki page as an example, with the code on the page looking like this (click here). For example, let's say that he moved to a new location (Doomwood Forest) and his appearance changed. I would add the new location in and update the page to show his new appearance while keeping his old one. Here's what the code on the page looks like now: click here. And here's what the changes look like when clicking the "Show Changes" button (with stuff in blue being added in, and stuff in red being removed): click here. The button is great to use if you can't remember what information you added in and/or removed.
- The Save and Continue button is like the Save button, except it saves the page and keeps you in the editing window instead of exiting you out of the editing window. It pretty much explains itself.
Now, onto tags and parenting!
If you don't know what tags are, feel free to read the first post of the Tag Discussion thread.
Tagging pages is very important, as it helps keep the wiki organized, and tags help play in a role in making some of our automatically-updating pages, index lists, and other functions around the wiki work. This section will be explaining how it's done.
The first thing you'll want to do is scroll down to the bottom of the page and click the "Tags" button (image if you're not sure where it is). Now this is where some users find it difficult, as they don't know what tags to add. I have taken the liberty of writing down what pages need what tags, to reduce headaches. All you have to do is click on one of the collapsibles below.
Parenting pages (like tags) helps keep the wiki organized, and they also play in a role in making some of our automatically-updating pages, index lists, and other functions around the wiki work. This section will be explaining how it's done.
To set a parent on a page, do the following steps:
A couple things to note:
- You can only parent to pages that currently exist, so be careful of any typos you might make.
- Try to follow the same parent path as other pages in said category.
Here is a list of all the index pages that can be parented to (the red links being the pages you parent to):
armors » Armors
belts » Belts
boots » Boots
capes » Capes
classes » Classes
craft-shops » Craft Shops
cutscenes » Cutscenes
dungeons » Dungeons
gloves » Gloves
helmets-hoods » Helmets/Hoods
locations » Locations
misc-items » Misc. Items
monsters » Monsters
npcs » NPCs
quests » Quests
shops » Shops
shoulders » Shoulders
use-menu-items » Use Menu Items
weapons » Weapons
This is a quick and short list of things to look out for when making or fixing pages.
1. Page Link + Title
- Pages should be named exactly how it is in-game. This includes typos. If you forgot, or if you made a typo in the wiki page's title that doesn't reflect how it appears in-game, notify a staff member.
2. Correct Templates
- Make sure the template you used was the correct one.
3. Tags and Parenting
- There have been a lot of cases where an item is missing tags/parenting. These are vital to pages, especially if the name of an item doesn't exactly make it obvious what it is. So when you create a page, please remember to tag and parent it to the appropriate page after you're finished creating it. If you don't know how to do these things, feel free to post in the Wiki How-to Q&A thread, or ask a staff member.
4. Format + Spelling
- There should be appropriate capitalization, spacing, etc. Wikidot code should be typed in correct, without any errors. Feel free to refer to Wikidot's Quick Reference page if you do not know how to type a specifc piece of Wikidot code.
- If you need to know how to bold, strikethrough, put in an invisible comment or put colored text on a page, please refer to this page.
- If you need to know how to type out tabs, please refer to this page.
- If you need to know how to type out collapsibles, please refer to this page.
- If you meed to know how to type out a specific link, please refer to this page.
- (Optional) I recommend that you also look through the Wiki Syntax section provided by Wikidot. This isn't required to edit on the wiki, but it does talk about other kinds of Wikidot code that may help you out with this wiki, or other wikis as well.
5. The Info
- Last (well technically should be FIRST if you're the one creating a page), simply check to make sure everything is what it should be. If you see a location picture on a helm page, there's a problem. So use the Preview button often, as said in the first post, and double check your work.
That's it for now. We hope this guide has helped explain to you the basics of the wiki.
Once again, if you have any questions or concerns, please don't hesitate to contact a staff member, as we'll be glad to assist you.
Thank you for choosing to help out the AQ3D Wiki, and Battle-on!