Help:Editing Toolbar: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Unicodifying, replaced: {{ModernWarning| → {{warning|, See Also → See also)
(Put many things in a table to organize the many headlines that only have little text below. To me, the page now looks better, but not finished yet. Maybe the table about tables can have its own page?)
Line 3: Line 3:
For information on tables of contents, see [[Help:Table of Contents]].
For information on tables of contents, see [[Help:Table of Contents]].
==Top bar==
==Top bar==
===Bold===
 
This button lets you make bold text.
{|class=standard-table
{|class=standard-table
! Input||Output
! Button || Input || Output || Notes
 
|-
|-
|<pre>'''bold text''' not bold</pre>||'''bold text''' not bold
!
|}
===Bold===
Should not be used excessively. Commonly used on button labels (like '''Apply''') or keyvalue names (like '''Name''').
|<pre>'''bold text''' not bold</pre>
|     '''bold text''' not bold
| Should not be used excessively. Commonly used on button labels (like '''Apply''') or keyvalue names (like '''Name''').<br>You can quickly bold an entire line of text by putting <code>;</code> at the start of the line, see [[#Indenting]] below.


You can quickly bold an entire line of text by putting <code>;</code> at the start of the line.
|-
!
===Italic===
|<pre>''italic text'' not italic</pre>
|    ''italic text'' not italic
| Also should not be used excessively. Sometimes used when quoting someone, or property/flag names (like ''Play Everywhere'').


===Italic===
This button lets you make italic text.
{|class=standard-table
! Input||Output
|-
|-
|<pre>''italic text'' not italic</pre>||''italic text'' not italic
!
|}
===Link===
Also should not be used excessively. Sometimes used when quoting someone, or property/flag names (like ''Play Everywhere'').
|<pre>[[Main Page]]</pre>
|     [[Main Page]]
| This lets you create links to other pages. See [[Help:Linking]] for more info on etiquette and uses.


===Link===
This lets you create links to other pages. See [[Help:Linking]] for more info on etiquette and uses.
{|class=standard-table
! Input||Output
|-
|-
|<pre>[[Main Page]]</pre>||[[Main Page]]
!
|}
===Image===
|<pre>[[File:Example.jpg|300px|thumb|example caption.]]</pre>
|     [[File:Example.jpg|300px|thumb|example caption.]]
| This lets you put images into a page. See [[Help:Images]] for more info on etiquette and uses.


===Image===
This lets you put images into a page. See [[Help:Images]] for more info on etiquette and uses.
{|class=standard-table
! Input||Output
|-
|-
|<pre>[[File:Example.jpg|300px|thumb|example caption.]]</pre>||[[File:Example.jpg|300px|thumb|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.
|}
|}
===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==
==Advanced bar==
Click the '''Advanced''' button on the top bar to access these buttons.
Click the '''Advanced''' button on the top bar to access these buttons.


{|class=standard-table
! Button || Input || Output || Notes
|-
!
===Heading===
===Heading===
Insert headings of various sizes to better organize pages. See [[Help:Table of Contents]] for examples and more info on etiquette and uses.
| <pre>=== Heading ===</pre>
| ''the leftmost cell is the result''
| Insert headings of various sizes to better organize pages. See [[Help:Table of Contents]] for examples and more info on etiquette and uses.
The number of equal signs determines the heading level. The spaces are optional. This must be at the beginning of a line in wikitext.


|-
!
===Unordered List===
===Unordered List===
Makes a list using bullet points. Should not be used for giving instructions or any other thing with a clear order.
{|class=standard-table
! Input||Output
|-
|<pre>*An item.
|<pre>*An item.
*Another item.
*Another item.
*All of these could be in any order you want.</pre>||
*All of these could be in any order you want.</pre>
|
*An item.
*An item.
*Another item.
*Another item.
*All of these could be in any order you want.
*All of these could be in any order you want.
|}
| Makes a list using bullet points. Should not be used for giving instructions or any other thing with a clear order.


|-
!
===Ordered List===
===Ordered List===
Makes a list using numbers.
{|class=standard-table
! Input||Output
|-
|<pre>#Open Hammer.
|<pre>#Open Hammer.
#Make a map.
#Make a map.
#Compile the map.
#Compile the map.
#Test it in the game.</pre>||
#Test it in the game.</pre>
|
#Open Hammer.
#Open Hammer.
#Make a map.
#Make a map.
#Compile the map.
#Compile the map.
#Test it in the game.
#Test it in the game.
|}
| Makes a list using numbers.


|-
!
===Wiki Formatting===
===Wiki Formatting===
Prevents text from being formatted by the wiki in some manner.


Without wiki formatting:
|<pre>''{{restart}}''
{|class=standard-table
 
! Input||Output
&lt;nowiki&gt;''{{restart}}''&lt;/nowiki&gt;</pre>
 
|''{{restart}}''
 
<nowiki>''{{restart}}''</nowiki>
 
| Everything between &lt;nowiki&gt;...&lt;/nowiki&gt; tags is not formatted by the wiki parser. Note how the template {{T|restart}} is not expanded in the second example.
{{note|To display &lt;nowiki&gt; and &lt;/nowiki&gt; tags on a page, you must escape them in some way, otherwise simply do what they are supposed to do. One way is to escape the "lower than" and "greater than" brackets using HTML entities, such as {{code|&amp;lt;nowiki&amp;gt;}} and {{code|&amp;lt;/nowiki&amp;gt;}}.}}
 
|-
|-
|<pre><nowiki><nowiki></nowiki>''{{restart}}''<nowiki></nowiki></nowiki></pre>||<nowiki>''{{restart}}''</nowiki>
!
|}
===Line===
With wiki formatting:
|
{|class=standard-table
<pre>One
! Input||Output
Two
 
Three<br>
Four
</pre>
 
|
One
Two
 
Three<br>
Four
 
| Newlines can be inserted using '''two''' newlines in the wikitext or using &lt;br&gt;. Note that the former method begins a new paragraph with some extra space between the lines while the latter doesn't add extra space. A single newline in wikitext is nothing more than a space but there are exceptions.
 
|-
|-
|<pre>''{{restart}}''</pre>||''{{restart}}''
!
|}
===Big Text and Small Text===
{{note|To display <nowiki><nowiki></nowiki> tags on a page, you must put them in their own <nowiki><nowiki></nowiki> tags, like this: <pre><nowiki><nowiki></nowiki><nowiki><nowiki></nowiki></nowiki>unformatted text<nowiki><nowiki></nowiki></nowiki><nowiki></nowiki></nowiki></pre>Without that, formatting may break unintentionally. (Look at the page code for a fun time.)}}
|
<pre>Normal text. <big>Big text. <big>Bigger text.</big></big>
 
Normal text. <small>Small text. <small>Smaller text.</small></small></pre>
 
|
Normal text. <big>Big text. <big>Bigger text.</big></big>
 
Normal text. <small>Small text. <small>Smaller text.</small></small>
 
| 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.


===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.
{|class=standard-table
! Input||Output
|-
|-
|<pre>First Line<br />
!
Second Line</pre>||First Line<br />
===Superscript and Subscript===
Second Line
|
|}
<pre>Normal text. <sup>High text. <sup>Higher text.</sup></sup>
{|class=standard-table
 
! Input||Output
Normal text. <sub>Low text. <sub>Lower text.</sub></sub></pre>
|-
|<pre>First Line


Second Line</pre>||First Line
|
Normal text. <sup>High text. <sup>Higher text.</sup></sup>


Second Line
Normal text. <sub>Low text. <sub>Lower text.</sub></sub>
|}


===Big Text and Small Text===
| 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.
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.
{|class=standard-table
! Input||Output
|-
|<pre>Normal text. <big>Big text. <big>Bigger text. <big>Even bigger text. </big></big></big></pre>||Normal text. <big>Big text. <big>Bigger text. <big>Even bigger text. </big></big></big>
|}
{|class=standard-table
! Input||Output
|-
|<pre>Normal text. <small>Small text. <small>Smaller text. <small>Even smaller text. </small></small></small></pre>||Normal text. <small>Small text. <small>Smaller text. <small>Even smaller text. </small></small></small>
|}


===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.
{|class=standard-table
! Input||Output
|-
|-
|<pre>Normal text. <sup>High text. <sup>Higher text. <sup>Even higher text.</sup></sup></sup></pre>||Normal text. <sup>High text. <sup>Higher text. <sup>Even higher text.</sup></sup></sup>
!
|}
{|class=standard-table
! Input||Output
|-
|<pre>Normal text. <sub>Low text. <sub>Lower text. <sub>Even Lower text.</sub></sub></sub></pre>||Normal text. <sub>Low text. <sub>Lower text. <sub>Even Lower text.</sub></sub></sub>
|}
 
===Gallery===
===Gallery===
Good for inserting many images into a page. See [[Help:Images]] for more information and examples.
|<pre><gallery>
File:IMAGENAME1.ext|Caption 1
File:IMAGENAME2.ext|Caption 2
</gallery></pre>
| -
| Good for inserting many images into a page. See [[Help:Images]] for more information and examples.


|-
!
===Redirect===
===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]].
|<pre>#REDIRECT [[Doors]]</pre>
| -
| 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. The example on the left is the entire code for the page [[Door]].


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. For example, the following is the entire code for the page [[Door]]:
<pre>#REDIRECT [[Doors]]</pre>
A redirect code should be the only thing on that page, otherwise it may work incorrectly. Redirects can be used on [[Help:Templates|templates]] and [[Help:Categories|categories]] as well, and a redirect itself can be categorized.
A redirect code should be the only thing on that page, otherwise it may work incorrectly. Redirects can be used on [[Help:Templates|templates]] and [[Help:Categories|categories]] as well, and a redirect itself can be categorized.


{{warning|'''Take care to not redirect to another redirect.''' When this happens it is called a ''[[Special:DoubleRedirects|double redirect]]''. MediaWiki code does not properly handle these instances and a user will end up being stuck at the first redirect until further action is taken.}}
{{warning|'''Take care to not redirect to another redirect.''' When this happens it is called a ''[[Special:DoubleRedirects|double redirect]]''. MediaWiki code does not properly handle these instances and a user will end up being stuck at the first redirect until further action is taken.}}
|}


===Tables===
===Tables===
Line 266: Line 288:


==Other formatting features==
==Other formatting features==
{|class=standard-table
! || Input || Output || Notes
|-
!
===Horizontal Lines===
===Horizontal Lines===
<code><nowiki>----</nowiki></code> makes a line like this:
|
<pre>Before horizonzal line
----
----
They can be used to split things into sections, but usually that should be done with [[Help:Table of Contents|headers]].
After horizontal line</pre>


|
Before horizonzal line
----
After horizontal line
| <code><nowiki>----</nowiki></code> makes a line. They can be used to split things into sections, but usually that should be done with [[Help:Table of Contents|headers]].
|-
!
===Indenting===
===Indenting===
You can indent text by putting <code>:</code> at the start of a line.
|
{|class=standard-table
<pre>Unindented text.
! Input||Output
: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.</pre>
|<pre>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.</pre>||Unindented text.
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.
: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.
 
| You can indent text by putting one or multiple <code>:</code> at the start of a line. This generates the HTML tag &lt;dd&gt;. The indented paragraph ends at the next newline in the wikitext, so if you need a newline without ending the indented paragraph, you can use &lt;br&gt;. The same applies to the indented paragraphs of (un)ordered lists using <code>#</code> and <code>*</code>.
|}
|}



Revision as of 09:23, 12 September 2024

English (en)Русский (ru)Translate (Translate)
Edit-copy.png
This is a help page
That means that this article contains information intended to advise or aid on the functions of the wiki, on how to use the wiki, or on general recommendations for users of the wiki.

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

Top bar

Button Input Output Notes

Bold

'''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, see #Indenting below.

Italic

''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

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

Image

[[File:Example.jpg|300px|thumb|example caption.]]
example caption.
This lets you put images into a page. See Help:Images for more info on etiquette and uses.

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.

Button Input Output Notes

Heading

=== Heading ===
the leftmost cell is the result Insert headings of various sizes to better organize pages. See Help:Table of Contents for examples and more info on etiquette and uses.

The number of equal signs determines the heading level. The spaces are optional. This must be at the beginning of a line in wikitext.

Unordered List

*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.
Makes a list using bullet points. Should not be used for giving instructions or any other thing with a clear order.

Ordered List

#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.
Makes a list using numbers.

Wiki Formatting

''{{restart}}''

<nowiki>''{{restart}}''</nowiki>
Requires restart to take effect.

''{{restart}}''

Everything between <nowiki>...</nowiki> tags is not formatted by the wiki parser. Note how the template {{restart}} is not expanded in the second example.
Note.pngNote:To display <nowiki> and </nowiki> tags on a page, you must escape them in some way, otherwise simply do what they are supposed to do. One way is to escape the "lower than" and "greater than" brackets using HTML entities, such as &lt;nowiki&gt; and &lt;/nowiki&gt;.

Line

One
Two

Three<br>
Four

One Two

Three
Four

Newlines can be inserted using two newlines in the wikitext or using <br>. Note that the former method begins a new paragraph with some extra space between the lines while the latter doesn't add extra space. A single newline in wikitext is nothing more than a space but there are exceptions.

Big Text and Small Text

Normal text. <big>Big text. <big>Bigger text.</big></big>

Normal text. <small>Small text. <small>Smaller text.</small></small>

Normal text. Big text. Bigger text.

Normal text. Small text. Smaller 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.

Superscript and Subscript

Normal text. <sup>High text. <sup>Higher text.</sup></sup>

Normal text. <sub>Low text. <sub>Lower text.</sub></sub>

Normal text. High text. Higher text.

Normal text. Low text. Lower text.

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.

Gallery

<gallery>
File:IMAGENAME1.ext|Caption 1
File:IMAGENAME2.ext|Caption 2
</gallery>
- Good for inserting many images into a page. See Help:Images for more information and examples.

Redirect

#REDIRECT [[Doors]]
- 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. The example on the left is the entire code for the page Door.

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.

Warning.pngWarning:Take care to not redirect to another redirect. When this happens it is called a double redirect. MediaWiki code does not properly handle these instances and a user will end up being stuck at the first redirect until further action is taken.

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.pngNote: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

Input Output Notes

Horizontal Lines

Before horizonzal line
----
After horizontal line

Before horizonzal line


After horizontal line

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

Indenting

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.
You can indent text by putting one or multiple : at the start of a line. This generates the HTML tag <dd>. The indented paragraph ends at the next newline in the wikitext, so if you need a newline without ending the indented paragraph, you can use <br>. The same applies to the indented paragraphs of (un)ordered lists using # and *.

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. {{code|<text>}} template have more multiple styles with optional text selection mode.

Input Output
<code>code text</code> not code
code text not code
{{code|code text}} 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.

{{pre|<text>}} can be also used, which have dark modes and more options, but <nowiki> must be included for this one in order to avoid breaking it.

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.pngNote: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.pngTip: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