Writing an article
If you want to write an article on this wiki, you'll have to stick to this wiki's style and formatting. This guide will attempt to cover most of the questions related to that.
Contents
Infoboxes
The little boxes on the right you see on some articles are called Infoboxes. They're used to provide some additional info about the article you're reading. Currently we have set up these infoboxes:
- Trick infobox - used for pages about tricks/glitches.
- Map infobox - used for pages about maps.
- Speedrun infobox - used for pages about speedruns. It contains a video player and takes up full page width.
- Chamber/Portal map infobox - used for Portal Test chambers/maps
- CVAR Infobox - used for pages about Console Variables.
Categories
In this wiki you can write articles about maps, tricks/glitches, speedruns and any other speedrun-related articles such as Guides or various uses of game-mechanics.
For glitch/trick articles we have sub-categories for each game engine:
- GoldSrc Glitch - glitches available on games running GoldSrc games.
- Source Glitch - glitches available on the Source Engine (pre-OrangeBox).
- OrangeBox Glitch - glitches available on OrangeBox Engine versions of the game.
- Portal Glitch - Portal glitches.
- Black Mesa Glitch - Black Mesa glitches.
Good article about game-mechanics: FPS Effects
Linking to other pages
When writing an article, you can make links to specific articles by using these tags: [[name]] (replace "name" with page name).
Maps
Map pages must contain both segmented and Single-Segment (if any) speedrun routes and/or strats. If there's an exclusive trick/event in the map - explain how it's done too. A map article must start with a brief description of it. You may also want to use the map infobox for additional info.
Once you're done with the description, you can start writing the routes. To do that, open a section using a tag: ==Route==. Use a separate section for each speedrun category - Inbounds routes, OoB routes, single-segment strats and so on.. You can create a sub-category using 3 equals signs instead of two. Use them to explain a certain trick in your route or to describe alternate routes. You can upload pictures to describe the route better.
Good map articles: c1a0e, d1_trainstation_01, d2_coast_07.
Tricks/Glitches
Same formatting applies for trick pages, as well as the other category pages: start off with a brief description and provide info where the trick could be used. Trick articles must have detailed explanations and how-to's on trick executions.
You may also include pictures of graphs or stats if there are any.
Good trick articles: Accelerated Back Hopping, Flying.
Setting Categories
Every page must be categorized. To do that, simply add a link to a category at the end of the article, like so:
[[Category: Map]] [[Category: Half-Life]]
This means that the article is about a map from Half-Life.