Page Structure[edit | edit source]
Pages are generally structured by section headers, and a table of contents that lets the user quickly find the section they're looking for. When you create new pages or edit existing ones, try keeping the general layout the same, namely:
- Product / Guide Introduction
- Main Problem Table for the product
- Links to other resources / guides on the wiki.
New Page[edit | edit source]
To write a new article; enter the article title in the box below (or on the homepage) to create a page with a preselected boilerplate.
Make sure to include the full device name & model number in the title when appropriate. (Example: A2159 2019 13" MacBook Pro)
If you don't finish it, insert {{Stub}}
at the top of the page to signify it's a work in progress.
Move[edit | edit source]
If a page has an incorrect title, you can move it:
- Mouseover the
More
tab in the top right and clickMove
. - Give the page a
New title
and clickMove page
. - For normal pages, don't change the default namespace (Main).
- Note that if you move a category page, pages belonging to it will need to be recategorized manually.
Delete[edit | edit source]
Ask one of the wiki admins in the Discord.
Other options:[edit | edit source]
- If you don't want to have it truly deleted (to come back later to work on or archive it), or can't wait, then give the page a title that's not in use nor will be found. Just be sure to add the link of the page in the
discussion
tab of the place it got moved from, so people know it's still there if it was decided on being moved. - You can also add it to the Stub category by inserting
{{Stub}}
at the top of the page too for the off-chance someone else can grow it. Visit Stub Pages to help out those with the most need of contribution.
Minor changes[edit | edit source]
Once on a page, click Edit
or Edit Source
(recommended) in the top right of it to begin editing.
Everyone starts small! If you want to add some information, fix typos or add a few links, go ahead.
Table of Contents[edit | edit source]
Table of Contents (TOC) is inserted automatically on articles with more than three section headers.
You can move the TOC somewhere else by inserting __TOC__
on the page in the source editor.
To align the TOC to the right, insert the Template {{TOC Right}}
instead at the top of the page, right underneath the first header.
To disable the TOC on the page, insert __NOTOC__
Section level headers[edit | edit source]
From the Edit Source
tab:[edit | edit source]
Section headers are added by using equal signs. Each indentation to a new level gets an extra equals sign surrounding the name (i.e. Level 2 gets 2 equals signs on each side, Level 3 gets 3, etc.).Level 1 headers are reserved for the title and should not be used (i.e. =Example=).
==Level 2 header== ===Level 3 header=== Text
From the Edit
tab:[edit | edit source]
First, highlight the word you want to become a section. Then click on the paragraph
dropdown menu. There you can see the hierarchy of section levels and select the one you want. It's also possible to make use of the shortcuts listed after highlighting. Section order (from highest to lowest): Page Title
-> Heading
-> Subheading (1 -> 4)
-> paragraph
Categories[edit | edit source]
Source Editor[edit | edit source]
The source editor is recommended in general, but especially for adding categories. Simply add [[Category:_____]]
at the bottom for your product page.
If you're using the page creation box, you will see [[Category:Name]]
preloaded in the editor. Replace "Name" with your own category.
Visual Editor[edit | edit source]
To categorize a page using the visual editor, go to Edit
, then the triple stacked bars (i.e. page options) and click on Categories
. Under add a category to this page
, start typing in the category you would like to see this page under. If the category already exists, select that one. If not, you can create a new category (which will have its own, unique URL for this). If you want it in a subcategory, type in the category that is a subcategory.
When you're finished, click on the name of the category. To add another category, type another one in and repeat. There's no limit to the number of categories a page can be under. To delete a category created, click on the category name. There will be a trash can icon to click on. Click save changes
once done. To see the page under the category, go to the category URL and it will be seen under Pages in category "_____"
. This will be separated from the subcategories (as pages aren't categories, only categories are).
Hierarchy[edit | edit source]
The standard category format is [[Category:Brand_Product Type]].
Only add one or two categories per page, and make sure a relevant category doesn't already exist before you create new ones.
All product type categories should be a subcategory of Category:Product Repair Guides.
Say you're making a repair guide for the new MacBook Pro, you'll want to add the article to the [[Category:Apple Laptops]] category.
But since Apple has many lines / series of laptops, you'll want to specify further by adding the [[Category:MacBook Pro]] category as well.
If a brand does not have a wide product stack, further categorization is not necessary.
If your article applies to more than one or few products, it likely belongs in Category:Board Repair Guides.
If it's even more general than that, it belongs in Category:General Repair Guides.
Notes:[edit | edit source]
- Once you save a category, changing it becomes cumbersome, so make sure you get it right. New subcategories can be added however.
- Often a category will have a separate gateway article with links to specific products. Check the URL to make sure you're on the right page.
- If a link to your page doesn't show up, try clearing the cache:
Firefox / Safari: Ctrl-R (⌘-R on a Mac)
Google Chrome: Ctrl-Shift-R (⌘-Shift-R on a Mac)
- If a link to your page doesn't show up, try clearing the cache: