User:Mattshu/sandbox

From Valve Developer Community
Jump to navigation Jump to search

Page Creation

Editing Toolbar

http://developer.valvesoftware.com/w/skins/common/images/button_bold.png Bold text
http://developer.valvesoftware.com/w/skins/common/images/button_italic.png Italic text
http://developer.valvesoftware.com/w/skins/common/images/button_link.png Adding internal links
http://developer.valvesoftware.com/w/skins/common/images/button_extlink.png Adding external links
http://developer.valvesoftware.com/w/skins/common/images/button_headline.png Adding a headline
http://developer.valvesoftware.com/w/skins/common/images/button_image.png Inserting a picture
http://developer.valvesoftware.com/w/skins/common/images/button_nowiki.png Ignore Wiki formatting
http://developer.valvesoftware.com/w/skins/common/images/button_sig.png Inserting your signature
http://developer.valvesoftware.com/w/skins/common/images/button_hr.png Horizontal lines

Formatting Pages

Page Templates

Specific Formatting Guidelines

Page Creation

You can start editing a non-existant page in several ways:

  • The easiest way is to type the exact name you want into the "Search" bar then hit "Go". If the page doesn't exist, you will be able to create it.
Warning.pngWarning:Make sure the subject of the page you have in mind isn't already on the wiki. For example, you want to create the page "Portal 2 Particles", but you didn't notice the List of Portal 2 Particles page.
For example, let's say you've typed "Foobar" in the search bar, then hit the "Go" button. Since the page doesn't exist, you are given this message:
There were no results matching the query.
Create the page "Foobar" on this wiki!
In this scenario, you are able to click the Foobar link and begin editing your new page.
Tip.pngTip:Red links are pages that have not been created yet, and blue links are pages that already exist.
  • You can can modify the URL in your address bar to go where you'd like (in this case using the address http://developer.valvesoftware.com/wiki/Foobar).
  • Some pages in the wiki contain many red links. If you are familiar with the subject matter of the non-existent page, feel free to create the new page by following the red link. Your contributions are greatly appreciated, and the more blue links, the better.

During the course of an edit, clicking Show preview (to the right of the Save page button) will help you determine if your edit looks good. This displays the final result of the edited page, but does not save it. This will avoid spamming the Recent changes page with saved edits, to the frustration of other editors.

When you are done editing, proofread it to make sure that the edit is final, and then click Save page to finally create the new page.

To test your editing skills, you can either use the public sandbox page, or create your own sandbox page on your User page by going to your user page and entering "/sandbox" in your address bar at the end of the URL, but be sure you're on your user page before creating it.

Creating a How-to Page

Insert guidelines for creating tutorial/how-to pages here

Creating a Mod Page

Please review the Mod page guidelines before creating a page for a Source/GoldSrc mod.

Creating an Entity Page

Insert guidelines for creating entity pages here

Creating Categories

Categories enable pages to be added to automatic listings. These help structure many pages by grouping them together around similar subjects. There may also be a section listing the subcategories of that category.

Category pages are usually created for the description of their existence. For example, Category:Blender is a category for all pages related to the free and open source 3D modeling package, Blender.

To add a page to a category, simply place at the bottom of the page. All pages that have the same category name will be listed automatically in the category.

For a list of all current categories, visit Special:Categories.

Creating User Pages

Your user page is your own personal editing venture. You are free to edit it with anything you desire. It is frowned upon by the Valve Developer Community to make direct edits to user pages that do not belong to you, unless the page contains media or external links relating to pornographic material, illegal warez/torrent sites, etc. If that is the case, you will risk your IP for permanent ban from the VDC.

To edit your user space, you must first have an account on the VDC. Registering is free and easy to do. Once you're logged in, click on your username at the very top-right of this page, or just copy this link and paste it into your address bar: http://developer.valvesoftware.com/wiki/User:YOUR USERNAME HERE

Creating Discussion Pages

Discussion (or talk) pages are for user discussions concerning the information contained in it's respective main page. It can also be used for requesting help.

To create a discussion page (if it is non-existent for a page), just click the "Discussion" tab above, next to the "Page" tab.

Tip.pngTip:You can also use the keystroke Alt+T to quickly switch to the discussion page, that is if your web browser/operating system allows it.

It is common courtesy to sign your comments with your username and the time/date of post. This is a simple process that only requires four characters. Four tildes (~~~~) will automatically be replaced with your public user information along with the time and date of the post. Signatures are explained further here.

Editing Guidelines

Insert a few details about editing guidelines. Since there aren't really any rules, other than warez/porn/span(etc), there should be a couple tips of common courtesy among other editors.

Editing Toolbar

http://developer.valvesoftware.com/w/images/1/1e/Mediawiki_editbuttons.png

Each button, when pressed, will paste a small example of the usage of a pace of special formatting. If you have text selected, pressing a button will format the text instead of pasting in sample code. For example, to make some text bold, simply select some text in the edit window and press the bold button (the first button on the editing bar).

Bold text http://developer.valvesoftware.com/w/skins/common/images/button_bold.png

Bold text is very simple. Put in three (3) single apostrophes before the section of text you wish to bold, and three (3) after.

Syntax: '''Bold text'''
Input: Remember to '''always''' brush your teeth.
Output: Remember to always brush your teeth.

Italicized text http://developer.valvesoftware.com/w/skins/common/images/button_italic.png

Italics are just as easy as bold text. Put in two (2) single apostrophes before the section of text you wish to italicize, and two (2) after.

Syntax: ''Italic text''
Input: The ''Queen Mary'' sailed last night.
Output: The Queen Mary sailed last night.

Internal links http://developer.valvesoftware.com/w/skins/common/images/button_link.png

If you want to link to another page that is in this particular wiki database, you simply need the title of the page. To link to the Main Page, you simply use "Main Page". Simple!

Syntax: [[Link title]]
Input: Click here to go to the main page: [[Main Page]]
Output: Click here to go to the main page: Main Page
Note.pngNote:Currently, spaces and underlines both work the same in internal links. You can use [[Main_Page]] as well.

You can also change the text of the link, without affecting what it links to. This is useful if you have to adjust for grammar.

Syntax: [[Link title|Text for link]]
Input: [[Main Page|Click here]] to go to the main page.
Output: Click here to go to the main page.

External links http://developer.valvesoftware.com/w/skins/common/images/button_extlink.png

Syntax: [http://www.example.com link title]

Adding a headline http://developer.valvesoftware.com/w/skins/common/images/button_headline.png

Syntax: == Headline text ==

Embedded pictures http://developer.valvesoftware.com/w/skins/common/images/button_image.png

Syntax: [[Image:Example.jpg]]

Ignore Wiki formatting http://developer.valvesoftware.com/w/skins/common/images/button_nowiki.png

Syntax: <nowiki>Insert non-formatted text here</nowiki>

Signature http://developer.valvesoftware.com/w/skins/common/images/button_sig.png

Syntax: --~~~~

Horizontal lines http://developer.valvesoftware.com/w/skins/common/images/button_hr.png

Syntax: ----

Formatting Pages

Bullet points

Numbered lists

Indenting

Redirecting pages

Adding tables

Categorizing pages

Syntax highlighting

Quick message boxes

Page Templates

Mark-up Templates

Maintenance Templates

Entity-specific Templates

Specific Formatting Guidelines

Mod Page Guidelines

Italics

Bolding

Code tag