Help:Editing Toolbar

From Valve Developer Community
Jump to: navigation, search
Help:Editing

For information on tables of contents, see Help:Table of Contents.

Top bar

Bold

This button lets you make bold text.

Input Output
'''bold text''' not bold
bold text not bold

Should not be used excessively. Commonly used on button labels (like Apply) or keyvalue names (like Name).

You can quickly bold an entire line of text by putting ; at the start of the line.

Italic

This button lets you make italic text.

Input Output
''italic text'' not italic
italic text not italic

Also should not be used excessively. Sometimes used when quoting someone, or property/flag names (like Play Everywhere).

Link

This lets you create links to other pages. See Help:Linking for more info on etiquette and uses.

Input Output
[[Main Page]]
Main Page

Image

This lets you put images into a page. See Help:Images for more info on etiquette and uses.

Input Output
[[File:Example.jpg|300px|thumb|example caption.]]
example caption.

Reference

Used to make the little "[1]" things you see on other wikis like Wikipedia. We don't use it much on this wiki because most of our information is original research; our references are the users. A proper example of usage is unavailable because the website does not have the code for references.

Advanced bar

Click the Advanced button on the top bar to access these buttons.

Heading

Insert headings of various sizes to better organize pages. See Help:Table of Contents for examples and more info on etiquette and uses.

Unordered List

Makes a list using bullet points. Should not be used for giving instructions or any other thing with a clear order.

Input Output
*An item.
*Another item.
*All of these could be in any order you want.
  • An item.
  • Another item.
  • All of these could be in any order you want.

Ordered List

Makes a list using numbers.

Input Output
#Open Hammer.
#Make a map.
#Compile the map.
#Test it in the game.
  1. Open Hammer.
  2. Make a map.
  3. Compile the map.
  4. Test it in the game.

Wiki Formatting

Prevents text from being formatted by the wiki in some manner.

Without wiki formatting:

Input Output
<nowiki>''{{restart}}''</nowiki>
''{{restart}}''

With wiki formatting:

Input Output
''{{restart}}''
Requires restart to take effect.
Note:To display <nowiki> tags on a page, you must put them in their own <nowiki> tags, like this:
<nowiki><nowiki></nowiki>unformatted text<nowiki></nowiki></nowiki>
Without that, formatting may break unintentionally. (Look at the page code for a fun time.)

Line

Usually we only use this when absolutely necessary (so, very rarely). The same effect as this is achieved simply by pressing your Enter/Return key twice.

Input Output
First Line<br />
Second Line
First Line

Second Line

Input Output
First Line

Second Line
First Line

Second Line

Big Text and Small Text

Makes text bigger or smaller. The more times it's applied to text, the more the size changes. Do not use big text as a substitute for bolding text.

Input Output
Normal text. <big>Big text. <big>Bigger text. <big>Even bigger text. </big></big></big>
Normal text. Big text. Bigger text. Even bigger text.
Input Output
Normal text. <small>Small text. <small>Smaller text. <small>Even smaller text. </small></small></small>
Normal text. Small text. Smaller text. Even smaller text.

Superscript and Subscript

These buttons make text smaller and then shift it up or down. Like the Big/Small buttons, the more times applied, the greater the effect.

Input Output
Normal text. <sup>High text. <sup>Higher text. <sup>Even higher text.</sup></sup></sup>
Normal text. High text. Higher text. Even higher text.
Input Output
Normal text. <sub>Low text. <sub>Lower text. <sub>Even Lower text.</sub></sub></sub>
Normal text. Low text. Lower text. Even Lower text.

Gallery

Good for inserting many images into a page. See Help:Images for more information and examples.

Redirect

Redirects are a special kind of page. When a person clicks on a link to a redirect page, they will automatically be forwarded to a different page. These are most commonly used for plural words, like Door, which redirects to Doors.

To make a redirect, just click the button with the paper and arrow on it, and insert the name of the page you wish to redirect to. A redirect code should be the only thing on that page, otherwise it may work incorrectly. Redirects can be used on templates and categories as well, and a redirect itself can be categorized.

Take care to not redirect to another redirect. It will not work correctly.

Tables

The syntax for wiki tables closely follows that of HTML tags.

 HTMLWiki
Table <table></table>
{|
|}
Styles <table class="standard-table"></table>
{| class=standard-table
{| class=wikitable
Header cell <th>heading</th>
! heading
Row <tr></tr>
|-
Data cell

<td>cell1</td>
<td>cell2</td>

| cell1
| cell2
Data cell <td>cell1</td> <td>cell2</td> <td>cell3</td>
| cell1 || cell2 || cell3
Sample table
<table>
   <tr>
      <td>1</td>
      <td>2</td>
   </tr> 
   <tr>
      <td>3</td>
      <td>4</td>
   </tr>
   <tr>
      <td>5</td>
      <td>6</td>
   </tr>
</table>
{| 
| 1 || 2 
|- 
| 3 || 4 
|- 
| 5 || 6 
|}
Sample table
<table>
   <tr>
      <th>Quantity</th>
      <th>Grocery Item</th>
   </tr>
   <tr>
      <td>4</td>
      <td>Apples</td>
   </tr>
   <tr>
      <td>3</td>
      <td>Oranges</td>
   </tr>
   <tr>
      <td>12</td>
      <td>Eggs</td>
   </tr>
   <tr>
      <td>9</td>
      <td>Bananas</td>
   </tr>
</table>
{|
! Quantity || Grocery Item
|-
| 4 || Apples
|- 
| 3 || Oranges
|- 
| 12 || Eggs
|-
| 9 || Bananas
|}
Note:Some other formatting may break in tables. If something isn't working right, try to experiment with it. If you still have issues, try asking for help on New Help Desk.

Special Characters bar

This button gives you access to a wide range of non-standard characters you can use.

Help bar

This button gives you quick examples on most formatting features available on the wiki.

Other formatting features

Horizontal Lines

---- makes a line like this:


They can be used to split things into sections, but usually that should be done with headers.

Indenting

You can indent text by putting : at the start of a line.

Input Output
Unindented text.
:Welcome to the Valve Developer Community. Whether you're building a "Triple-A" commercial project or a mod for Half-Life® 2, you'll want to sign up as a Valve developer today. It's free to join, and open to anyone working with the Source Engine and the Source SDK.
Unindented text.
Welcome to the Valve Developer Community. Whether you're building a "Triple-A" commercial project or a mod for Half-Life® 2, you'll want to sign up as a Valve developer today. It's free to join, and open to anyone working with the Source Engine and the Source SDK.

Signifying Code

Console commands, code, and filepaths are just some of the things we frequently format to be monospaced.

<code> tags are the cleanest and most common method.

Input Output
<code>code text</code> not code
code text not code

<pre> tags are much more common when code takes up multiple lines. These are the white boxes on this page.

A <pre> box can also be made by putting a space at the start of the line, but it looks weird in code.

Input Output
<pre>
buildcubemaps
mat_hdr_level 0 (to go to LDR)
restart (to reload map)
buildcubemaps
mat_hdr_level 2 (to go back to HDR)
restart (to reload map)
</pre>
buildcubemaps
mat_hdr_level 0 (to go to LDR)
restart (to reload map)
buildcubemaps
mat_hdr_level 2 (to go back to HDR)
restart (to reload map)

<syntaxhighlight> will make a <pre> but will also color certain pieces of text based on language.

Input Output
<syntaxhighlight lang="cpp">
void CBaseEntity::FireBullets( const FireBulletsInfo_t &info )
{
	static int	tracerCount;
	trace_t		tr;
	CAmmoDef*	pAmmoDef	= GetAmmoDef();
	int			nDamageType	= pAmmoDef->DamageType(info.m_iAmmoType);
	int			nAmmoFlags	= pAmmoDef->Flags(info.m_iAmmoType);
        //...
        //remainder omitted
        //...
}
</syntaxhighlight>
void CBaseEntity::FireBullets( const FireBulletsInfo_t &info )
{
	static int	tracerCount;
	trace_t		tr;
	CAmmoDef*	pAmmoDef	= GetAmmoDef();
	int			nDamageType	= pAmmoDef->DamageType(info.m_iAmmoType);
	int			nAmmoFlags	= pAmmoDef->Flags(info.m_iAmmoType);
        //...
        //remainder omitted
        //...
}
Note:Some characters may break the formatting in a pre or syntaxhighlight. Try substituting the characters with their HTML escape entities

See Help:Syntax Highlighting for more information on languages.

Tip:Use the Template we call ent to quickly make something in <code> tags and a link. See the page for it for more uses.

See Also