Difference between revisions of "Help:Editing"

From Valve Developer Community
Jump to: navigation, search
m (Nowiki'd Category example; I'm assuming secure links aren't specially tagged with a lock icon--removed example.)
(removed the namespaces from displayed text)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{otherlang2
+
{{lang|Help:Editing}}
|zh-cn=Help:Editing:zh-cn
+
{{back|Help:Contents}}
|ru=Help:Editing:ru
+
*[[Help:Page Creation|Page Creation]] - Information about creating pages.
}}
+
*[[Help:Editing Toolbar|Editing Toolbar]] - Details about the features you have available to you when editing.
__NOTOC__
+
*[[Valve Developer Community:Alternative Languages|Alternative Languages]] - Check here if you are translating a page to a different language.
{{category header|background-color=#E0E0E0|border-color=lightgray}}
+
*[[Help:Etiquette|Etiquette]] - Guidelines you should follow so that everyone has a good wiki experience.
{{category newcolumn|rowspan=5|width=50%|background-color=#F7F7F7|border-color=lightgray}}
+
*[[Help:Templates|Templates]] - How to use and make templates.
 +
*[[Help:Images|Images]] - How to upload and add images.
 +
*[[Help:Linking|Linking]] - Help with making links to other pages.
 +
*[[Help:Table of Contents|Table of Contents]] - How to manipulate tables of contents and headings.
 +
*[[Help:Categories|Categories]] - Information about categories.
 +
*[[Help:Cleanup|Cleanup]] - Information about problematic pages.
 +
*[[Help:Special Pages|Special Pages]] - Full list of useful pages generated by the website.
 +
*[[Help:Stubs|Stubs]] - Small pages that should be expanded on.
  
== Page Creation ==
+
==See also==
* [[Help:Editing#Creating_a_How-to_Page|How-to pages]]
+
*[[New Help Desk]]
* [[Help:Editing#Creating_a_Mod_Page|Mod pages]]
+
*[[Wikipedia:Wikipedia:How to edit a page|How to edit a page]], a Wikipedia guide.
* [[Help:Editing#Creating_an_Entity_Page|Entity pages]]
 
* [[Help:Editing#Creating_Categories|Categories]]
 
* [[Help:Editing#Creating_User_Pages|User pages]]
 
* [[Help:Editing#Creating_Discussion_Pages|Discussion pages]]
 
* [[Help:Editing#Editing_Guidelines|'''Editing Guidelines''']]
 
 
 
== Editing Toolbar ==
 
 
 
https://developer.valvesoftware.com/w/skins/common/images/button_bold.png [[Help:Editing#Bold_text|Bold text]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_italic.png [[Help:Editing#Italicized_text|Italic text]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_link.png [[Help:Editing#Internal_links|Adding internal links]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_extlink.png [[Help:Editing#External_links|Adding external links]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_headline.png [[Help:Editing#Adding_a_headline|Adding a headline]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_image.png [[Help:Editing#Embedded_pictures|Inserting a picture]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_nowiki.png [[Help:Editing#Ignore_Wiki_formatting|Ignore Wiki formatting]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_sig.png [[Help:Editing#Signature|Inserting your signature]]<br />
 
https://developer.valvesoftware.com/w/skins/common/images/button_hr.png [[Help:Editing#Horizontal_lines|Horizontal lines]]<br />
 
 
 
{{category newcolumn|rowspan=1|width=50%|background-color=#FBF7EA|border-color=#E4DCCD}}
 
 
 
== Formatting Pages ==
 
* [[Help:Editing#Bullet_points|Bullet points]]
 
* [[Help:Editing#Numbered_lists|Numbered lists]]
 
* [[Help:Editing#Definition_lists|Definition lists]]
 
* [[Help:Editing#Indenting|Indenting]]
 
* [[Help:Editing#Redirecting_pages|Redirecting pages]]
 
* [[Help:Editing#Adding_tables|Adding tables]]
 
* [[Help:Editing#Categorizing_pages|Categorizing pages]]
 
* [[Help:Editing#Syntax_highlighting|Syntax highlighting for script/code]]
 
* [[Help:Editing#Message_boxes|Message boxes]]
 
 
 
{{category cell|width=50%|background-color=white|border-color=lightgray}}
 
 
 
== Page Templates ==
 
* [[Help:Editing/Page_Templates#Markup_Templates|Markup templates]]
 
* [[Help:Editing/Page_Templates#Maintenance_Templates|Maintenance templates]]
 
* [[Help:Editing/Page_Templates#Formatting_Templates|Formatting templates]]
 
* [[Help:Editing/Page_Templates#Entity-specific_Templates|Entity-specific templates]]
 
** [[Help:Editing/Page_Templates#Valve_Game_Icons|Valve Game Icons]]
 
{{category cell|width=50%|background-color=white|border-color=lightgray}}
 
 
 
== Specific Formatting Guidelines ==
 
* [[Help:Editing#Mod_Page_Guidelines|Mod Page Guidelines]]
 
* [[Help:Editing#Italics|Italics]]
 
* [[Help:Editing#Bolding|Bolding]]
 
* [[Help:Editing#Code_tag|<nowiki><code></nowiki> tag]]<br />
 
 
 
* [[Help:Editing#See_also|See also]]
 
 
 
{{category end}}
 
 
 
= Page Creation =
 
You can start editing a non-existent 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|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.}}
 
: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 "<span style="color:#C20;">Foobar</span>" on this wiki!'''
 
:In this scenario, you are able to click the <span style="color:#C20;">Foobar</span> link and begin editing your new page.
 
{{tip|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 ''<nowiki>https://developer.valvesoftware.com/wiki/Foobar</nowiki>'').
 
* 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.
 
 
 
=== Sandboxes ===
 
To test your editing skills, you can either use the public [[Valve Developer Community:Sandbox|Sandbox]] page, or create your own sandbox page. You can create your own sandbox by navigating to your user page, then adding "/Sandbox" in your address bar at the end of the URL. Be sure you're on your user page before creating it.
 
 
 
Seasoned editors who wish to further advance their editing skills in Templates can use the [[Template:TestTemplate]] page to test their template code.
 
{{backtotop|align=right}}
 
 
 
== Creating a How-to Page ==
 
 
 
There are some basic guidelines on writing your own tutorial and how-to pages.
 
 
 
* Most importantly, before you start, make sure you fully understand the subject you want to write a tutorial about. It can be very hard to write something informative if you're not sure how to do it yourself.
 
* Decide what kind of tutorial you are making. Is it a basic tutorial for people who haven't used [[Valve Hammer Editor|Hammer]] much, like how to use the texture browser? Or is it a tutorial explaining how to create complex scenarios with-in a game, more suited for advanced users?
 
* A good tutorial is a tutorial that is fun to read:
 
** Before you start, add a brief description of what the tutorial will be about.
 
** Split it into steps, each with one very specific key feature. If it is a beginner tutorial, do not be afraid to include every step.
 
** Group sets of steps which all together achieve one through the other a goal. For example, if you are writing a tutorial about a collapsing elevator, group the steps explaining how to create an elevator frame, animated door model, and invisible entities into one group. The next group of steps in the tutorial can explain how to make the elevator collapse using entity inputs and outputs. Finally, describe how to connect everything together.
 
** Add pictures. An image can describe something that is not self-explanatory. However, don't overflow the tutorial with them: use images when it will improve the text.
 
** Add charts, when explaining entity input and output behaviors. It's easier to follow if there's a chart identical to the Output flag in Hammer already filled with the information. The reader can just copy it or reverse engineer it to see why it should be done like this and not differently.
 
* When writing a tutorial, keep in mind people who may not be familiar with most of the uncommon entities in Hammer. When listing one, [[Help:Editing#Internal_links|link]] it to the page describing it. Don't try to explain what it is, or how generally it should be used if it's already explained on the entity page.
 
* Try to connect steps with a logical order that other people will understand. After reading your tutorial they will do that action as you did it. If they can't understand what they did they can't improve upon it.
 
* Make a good summary at the end of the tutorial to make it obvious to the reader had done all the steps necessary in order to achieve the goal.
 
 
 
Now create a [[Help:Editing#Sandboxes|sandbox page]] and start writing!
 
 
 
== Creating a Mod Page ==
 
Please review the [[Help:Mod_Profiles|Mod page guidelines]] before creating a page for a Source/GoldSrc mod.
 
 
 
== Creating an Entity Page ==
 
See [[Entity Article Template]] for help creating entity pages.
 
 
 
== Creating Categories ==
 
[[Special: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 <code><nowiki>[[Category:'''CATEGORY NAME''']]</nowiki></code> 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]].
 
{{backtotop|align=right}}
 
 
 
== 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 [https://developer.valvesoftware.com/w/index.php?title=Special:UserLogin&type=signup free and easy to do.]
 
Once you're logged in, click on your username at the very top-right of this page.
 
{{backtotop|align=right}}
 
 
 
== Creating Discussion Pages ==
 
{{note|Please do not add to a discussion page when you are making a minor edit as they do not contribute to the page discussion. The reasoning for your change can just be placed in the ''Summary'' box.}}
 
Discussion (or talk) pages are for user discussions concerning the information contained in its respective main page. It can also be used for requesting help. Talk pages (even your own) should not be used for sandboxes. Doing so does not leave a proper place for discussion.
 
 
 
To create or edit a discussion page, just click the "Discussion" tab above, next to the "Page" tab.
 
{{tip|You can also use the keystroke {{key|Alt}}+{{key|T}} to quickly switch to the discussion page, that is if your web browser/operating system allows it.}}
 
 
 
Discussion pages have a special flow. When you are commenting on posts in a discussion page, indents are used to reply to comments. [[Help:Editing#Indenting|See below]] for more information on this technique.
 
 
 
It is important to sign your comments with your username and the time/date of the post. This is a simple process that only requires four characters. Four tildes (<nowiki>~~~~</nowiki>) will automatically be replaced with your public user information along with the time and date of the post. Signatures are explained further [[Help:Editing#Signature|here]].
 
{{backtotop|align=right}}
 
 
 
== Editing Guidelines ==
 
<!-- More guidelines would be helpful -->
 
Although these aren't rules, they are necessary guidelines that each user should acquire and respect.
 
* A user page is a user's own personal space. Try not to make edits to a user page without consent of the page's owner.
 
* Make use of the {{key|Show preview}} button when editing a page. This will show you exactly how the page will look after saving your changes. It will help keep the [[Special:RecentChanges|Recent changes]] page clean and easier to navigate.
 
 
 
= Editing Toolbar =
 
https://developer.valvesoftware.com/w/images/1/1e/Mediawiki_editbuttons.png{{clr}}
 
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 https://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.
 
{{syntax2
 
|syn=<nowiki>'''Bold text'''</nowiki>
 
|in=<nowiki>Remember to '''always''' brush your teeth.</nowiki>
 
|out=Remember to '''always''' brush your teeth.
 
}}
 
 
 
== Italicized text https://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.
 
{{syntax2
 
|syn=<nowiki>''Italic text''</nowiki>
 
|in=<nowiki>The ''Queen Mary'' sailed last night.</nowiki>
 
|out=The ''Queen Mary'' sailed last night.
 
}}
 
 
 
== Internal links https://developer.valvesoftware.com/w/skins/common/images/button_link.png ==
 
If you want to link to another page that is in this particular wiki, you simply need the title of the page. To link to the Main Page, you simply use "Main Page". Easy!
 
{{syntax2
 
|syn=<nowiki>[[Link title]]</nowiki>
 
|in=<nowiki>Click here to go to the main page: [[Main Page]]</nowiki>
 
|out=Click here to go to the main page: [[Main Page]]
 
}}
 
{{note|Spaces are automatically converted to underlines for internal links. <nowiki>[[Main_Page]]</nowiki> is equivalent to <nowiki>[[Main Page]]</nowiki>, but you should use the latter.}}
 
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.
 
{{syntax2
 
|syn=<nowiki>[[Link title|Text for link]]</nowiki>
 
|in=<nowiki>[[Main Page|Click here]] to go to the main page.</nowiki>
 
|out=[[Main Page|Click here]] to go to the main page.
 
}}
 
{{tip|Any header on a page can be "jumped to" by including a hash tag and header name at the end of the link title. For example: <code><nowiki>[[Help:Editing#Internal_links|Jump to "Internal links"]]</nowiki></code>.}}
 
 
 
== External links https://developer.valvesoftware.com/w/skins/common/images/button_extlink.png ==
 
External links are used to link to web pages that are not in this wiki. Any link with the https://developer.valvesoftware.com/w/skins/vector/images/external-link-ltr-icon.png icon means it's an external link that will redirect you from the wiki.
 
{{syntax2
 
|syn=<nowiki>[http://www.example.com link title]</nowiki>
 
|in=<nowiki>[http://www.valvesoftware.com/jobs/ Click here]</nowiki> to learn more about applying to Valve.
 
|out=[http://www.valvesoftware.com/jobs/ Click here] to learn more about applying to Valve.
 
}}
 
{{syntax2
 
|in=<nowiki>[https://plus.google.com Google+ (secure link)]</nowiki>
 
|out=[https://plus.google.com Google+ (secure link)]
 
}}
 
 
 
== Adding a headline https://developer.valvesoftware.com/w/skins/common/images/button_headline.png ==
 
Headlines are used to subdivide an article into meaningful sections. You can change headline sizes by varying the number of equals signs (=) to change the size of the headline. This makes it very easy to categorize a page, creating a clean, efficient way to find information. Additionally, with multiple headlines, the wiki engine will eventually add a Table of Contents box to the beginning of the page, allowing a viewer to instantly hop to the subject they want on the page. On standard pages, second level (Large) headlines should be used. Extra-Large headlines are reserved for the page title.
 
 
 
{{syntax2
 
|syn=<nowiki>= Extra-Large Headline =</nowiki><br />
 
<nowiki>== Large Headline ==</nowiki><br />
 
<nowiki>=== Medium Headline ===</nowiki><br />
 
<nowiki>==== Small Headline ====</nowiki>
 
}}
 
 
 
= Extra-large =
 
* Example of an XL headline (use sparingly)
 
== Large ==
 
* Example of a L headline (use this as the first headline on a page)
 
=== Medium ===
 
* Example of a M headline
 
==== Small ====
 
* Example of a S headline
 
 
 
== Embedded pictures https://developer.valvesoftware.com/w/skins/common/images/button_image.png ==
 
Embedded pictures are pictures that have been uploaded to the wiki and are now directly hosted by it.
 
To upload a picture, visit [[Special:Upload]].
 
{{warning|Please read the [[Valve_Developer_Community:Image_use_policy|image use policy]] before uploading images.}}
 
{{syntax2
 
|syn=<nowiki>[[Image:Filename.png]]</nowiki>
 
|in=<nowiki>[[Image:Steam_available.png]]</nowiki>
 
|out=[[Image:Steam_available.png]]
 
}}
 
The <code><nowiki>[[Image:Filename.png]]</nowiki></code> syntax has a few options that you can use. These can be placed as an option anywhere in the line:
 
:{| class=standard-table
 
! Option || Example || Description
 
|-
 
| ''thumb'' || <code><nowiki>[[Image:Filename.png|thumb]]</nowiki></code> || Produces a framed thumbnail version of the image.
 
|-
 
| ''###px'' (size) || <code><nowiki>[[Image:Filename.png|300px|thumb|This is an example image]]</nowiki></code> || Changes the pixel size of the images.
 
|-
 
| ''left (right, center)'' || <code><nowiki>[[Image:Filename.png|thumb|150px|right]]</nowiki></code> || Controls the alignment of the image on the page
 
|}
 
 
 
== Ignore Wiki formatting https://developer.valvesoftware.com/w/skins/common/images/button_nowiki.png ==
 
This button may rarely be pressed, as the only time this may be used are for making descriptions for maintenance edits or writing pages like this one here. It will ignore all wiki formatting between the nests and only returns plain and simple text.
 
{{syntax2
 
|syn=<nowiki><nowiki>Insert non-formatted text here</nowiki></nowiki>
 
|in=<nowiki><nowiki>This is '''bold''' text.</nowiki></nowiki>
 
|out=<nowiki>This is '''bold''' text.</nowiki>
 
}}
 
 
 
== Signature https://developer.valvesoftware.com/w/skins/common/images/button_sig.png ==
 
Inserts your user name, which links back to your user page, and a time stamp, which marks the exact time you submitted your edit. This is mainly used to "sign" your posts when inserting comments on Talk (discussion) pages. It is common courtesy to sign your comments on Talk pages. You can change what appears in your signature by going to [[Special:Preferences#mw-htmlform-signature|Special:Preferences]].
 
{{tip|The syntax includes two hyphens (--), but you really only need four tildes (<nowiki>~~~~</nowiki>) to insert a signature.}}
 
:{{syntax2
 
|syn=<nowiki>--~~~~</nowiki>
 
|in=<nowiki>This discussion page may need archived soon. --~~~~</nowiki>
 
|out=This discussion page may need archived soon. --[[User:FakeUser23|FakeUser23]] 21:38, 17 October 2011 (PDT)
 
}}
 
 
 
== Horizontal lines https://developer.valvesoftware.com/w/skins/common/images/button_hr.png ==
 
{{syntax2
 
|syn=<nowiki>----</nowiki>
 
}}
 
Horizontal lines are usually only used at the end of a large section of a single page. Use them sparingly, as too many make a page look ugly. Proper use of [[#Adding_a_headline|headlines]] can render these unnecessary.
 
 
 
{{backtotop|align=right}}
 
 
 
= Formatting Pages =
 
 
 
== Bullet points ==
 
This function can create unordered lists. Bullet points are useful for listing multiple items that fall into a similar category.
 
{{syntax2
 
|syn=
 
<nowiki>* Item 1</nowiki><br />
 
<nowiki>* Item 2</nowiki><br />
 
<i>* etc...</i>
 
|in=
 
<nowiki>* Red</nowiki><br />
 
<nowiki>* Blue</nowiki><br />
 
<nowiki>* Green</nowiki>
 
|out=<br />
 
* Red
 
* Blue
 
* Green
 
}}
 
{{tip|Increasing the number of asterisks (<nowiki>*</nowiki>) increases the indent of the item.}}
 
 
 
== Numbered lists ==
 
You can create ordered lists using this syntax. Numbered lists automatically number items according to their placement in the page.
 
{{syntax2
 
|syn=
 
<nowiki># Item 1</nowiki><br />
 
<nowiki># Item 2</nowiki><br />
 
<i># etc...</i>
 
|in=
 
<nowiki># This is the first step.</nowiki><br />
 
<nowiki># This is the second step.</nowiki><br />
 
|out=<br />
 
# This is the first step.
 
# This is the second step.
 
}}
 
 
 
== Definition lists ==
 
You can also create definition lists equivalent to the <nowiki><dl>, <dt>, and <dd></nowiki> HTML tags.
 
{{syntax2
 
|syn=<nowiki>;Item 1</nowiki><br />
 
<nowiki>:About Item 1</nowiki><br />
 
<nowiki>;Item 2</nowiki><br />
 
<nowiki>:About Item 2</nowiki>
 
|in=<nowiki>;Center</nowiki>
 
<nowiki>:A point equidistant from all points on the surface of a sphere.</nowiki>
 
|out=<br />
 
;Center
 
:A point equidistant from all points on the surface of a sphere.
 
}}
 
 
 
== Indenting ==
 
Indenting is more commonly used when responding to discussion posts. A colon character (:) is placed at the beginning of the line. The more placed, the further the indent. This indents a line of text about the same length as if you pressed the {{key|Tab}} key.
 
{{syntax2
 
|in=<nowiki>:This line will be indented once.</nowiki><br />
 
<nowiki>::This line will be indented twice.</nowiki><br />
 
<nowiki>:::This line will be indented thrice.</nowiki>
 
|out=&nbsp;
 
:This line will be indented once.
 
::This line will be indented twice.
 
:::This line will be indented thrice.
 
}}
 
 
 
This format is commonly used in discussion pages. When a user makes a post, it is common to indent your response. See the fake discussion below for an example of how to properly flow talk pages with indents. The colons only appear as an example.
 
 
 
Anybody else believe unicorns exist? --<span style="color:#8BB9E0;">jd650</span>
 
:<b><nowiki>:</nowiki></b>Yes. Actually, I've bred a couple of them. --<span style="color:#8BB9E0;">MarcusTwain</span>
 
::<b><nowiki>::</nowiki></b>Really? Do you have photos? --<span style="color:#8BB9E0;">jd650</span>
 
::<b><nowiki>::</nowiki></b>I, too, am interested in these photos. --<span style="color:#8BB9E0;">Halifax</span>
 
:::<b><nowiki>:::</nowiki></b>I, err.. don't have a camera.. --<span style="color:#8BB9E0;">MarcusTwain</span>
 
:<b><nowiki>:</nowiki></b>No, I don't believe in unicorns. --<span style="color:#8BB9E0;">ChOcObO_23</span>
 
::<b><nowiki>::</nowiki></b>Why not? --<span style="color:#8BB9E0;">jd650</span>
 
 
 
== Adding tables ==
 
Tables are a diverse way to lay out information on a page. Because they can be very specific, the table below shows a quick how-to when creating Wiki tables as opposed to standard XHTML tables.
 
 
 
<table class="wikitable">
 
<tr><th>&nbsp;</th><th>XHTML</th><th>Wiki</th>
 
 
 
<tr>
 
<th>Table</th>
 
<td><nowiki><table></table></nowiki>
 
<td><pre><nowiki>{|
 
|}</nowiki></pre>
 
<tr>
 
<th>Styles</th>
 
<td><nowiki><table class="standard-table"></table></nowiki></td>
 
<td><pre><nowiki>{| class=standard-table</nowiki>
 
<nowiki>{| class=wikitable</nowiki></pre></td>
 
<tr>
 
<th>Header cell</th>
 
<td><nowiki><th>heading</th></nowiki></td>
 
<td><pre><nowiki>! heading</nowiki></pre></td>
 
<tr>
 
<th>Row</th>
 
<td><nowiki><tr></tr></nowiki></td>
 
<td><pre><nowiki>|-</nowiki></pre></td>
 
<tr>
 
<th>Data cell</th>
 
<td>
 
<nowiki><td>cell1</td></nowiki><br>
 
<nowiki><td>cell2</td></nowiki>
 
</td>
 
<td>
 
<pre><nowiki>| cell1
 
| cell2</nowiki></pre>
 
</td>
 
</tr>
 
<tr>
 
<th>Data cell</th>
 
<td><nowiki><td>cell1</td> <td>cell2</td> <td>cell3</td></nowiki></td>
 
<td><pre><nowiki>| cell1 || cell2 || cell3</nowiki></pre></td>
 
</tr>
 
<tr>
 
<th>Sample table</th>
 
<td><pre><nowiki>
 
<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>
 
</nowiki></pre></td>
 
<td><pre><nowiki>
 
{|
 
| 1 || 2
 
|-
 
| 3 || 4
 
|-
 
| 5 || 6
 
|}</nowiki></pre></td>
 
</tr>
 
<tr>
 
<th>Sample table</th>
 
<td><pre><nowiki>
 
<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>
 
</nowiki></pre></td>
 
<td><pre><nowiki>
 
{|
 
! Quantity || Grocery Item
 
|-
 
| 4 || Apples
 
|-
 
| 3 || Oranges
 
|-
 
| 12 || Eggs
 
|-
 
| 9 || Bananas
 
|}</nowiki></pre></td>
 
</tr>
 
</table>
 
 
 
== Syntax highlighting ==
 
To enable syntax highlighting for blocks of code, the syntax is pretty simple.
 
{{note|This new syntax replaces the <code><nowiki><source></nowiki></code> tag, because XML uses that tag in some scripts.}}
 
{{syntax2
 
|syn=<nowiki><syntaxhighlight lang="cpp">C++ source code</syntaxhighlight></nowiki>
 
|in=<nowiki><syntaxhighlight lang="cpp"></nowiki><i>(Insert [[FireBullets()]] method here)</i><nowiki></syntaxhighlight></nowiki>
 
|out=<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>
 
}}
 
 
 
For a list of supported languages, see [[Help:Syntax Highlighting]] for more information.
 
 
 
== Redirecting pages ==
 
Sometimes you'll come across pages that are named incorrectly, or improperly named. You can redirect pages to their intended destination by a couple different methods.
 
 
 
The easiest way to redirect a page that already contains data is to click the https://developer.valvesoftware.com/w/skins/vector/images/arrow-down-icon.png icon next to the search box above the page, then selecting Move Page. Follow instructions carefully before you decide to move a page.
 
 
 
The manual way to redirect a page is to use the following syntax:
 
{{syntax2
 
|syn=<nowiki>#REDIRECT [[new_page]]</nowiki>
 
}}
 
{{warning|This method can only be used if the page is empty. If you are manually moving a page, copy the edit source of the page and paste it into the new page. Then the original page can be replaced with the <code><nowiki>#REDIRECT</nowiki></code> tag.}}
 
 
 
You can go back to a Redirect and edit it by clicking the link underneath the new page's title.
 
 
 
== Message boxes ==
 
To make a portion of text standout from the rest, you can place them in preformatted boxes by simply placing a single space at the beginning of a line.
 
{{syntax2
 
|syn=<nowiki>&nbsp;Insert text after the space.</nowiki>
 
|in=<nowiki>&nbsp;There is a space at the beginning of this line.</nowiki>
 
|out=<pre>There is a space at the beginning of this line.</pre>
 
}}
 
You can also use the <code><nowiki><pre></nowiki></code> tag for a message box. Just use <code><nowiki><pre>Message box.</pre></nowiki></code>.
 
 
 
== Categorizing pages ==
 
If you'd like a page to show up in the automatically generated category tables (<i>full category list [[Special:Categories|found here]]</i>) like on the category page [[:Category:Level_Design]], you will need to append the <code><nowiki>[[Category:name]]</nowiki></code> at the bottom of the page.
 
 
 
For an example of how pages can be categorized, the bottom of this page have the following <code><nowiki>[[Category]]</nowiki></code> tags:
 
<nowiki>[[Category:Tutorials]]</nowiki>
 
<nowiki>[[Cateogry:Wiki]]</nowiki>
 
<nowiki>[[Category:Help]]</nowiki>
 
 
 
Go ahead and scroll down to the bottom of the page. You'll notice the three categories that were just listed are available at the bottom.
 
 
 
{{backtotop|align=right}}
 
= Page Templates =
 
[[Help:Editing/Page_Templates|Click here]] to view the extensive list of templates available for use
 
 
 
= Specific Formatting Guidelines =
 
There are no hard rules for specific formatting, other than keeping HTML at a bare minimum. There are some generally accepted styles you can use, though.
 
== Mod Page Guidelines ==
 
{{todo|Condense [[Help:Mod_Profiles]] for quick list of tips.}}
 
== Italics ==
 
* Should in general follow standard English usage -- italics are meant for ''slight'' emphasis. Italics should ''not'' be used for full sentences, as that is not minor emphasis and actually makes the emphasis unintelligible.
 
* Newly defined words in a sentence. For example: "Levels are created with a series of blocks, called ''[[brush]]es'', which can be created in all manner of sizes. Brushes are the basic components of levels". After the first italicized instance, the word is no longer italicized. If the newly defined word has an article, make it a link as well.
 
* Parameters in a command-line that are to be replaced by the user: <code>hl2.exe +map ''mapname'' -dev</code>
 
* Can be combined with "<" and ">" for parameters with longer names: <code>hl2.exe -game ''<game directory>''</code>
 
* Other standard uses in English can be found at [[Wikipedia:Italic_type]].
 
 
 
== Bolding ==
 
* Strong emphasis: "Using this command may cause hard drives to '''explode'''." Like italics, over-use of bolding renders the emphasis unintelligible.
 
* Menu commands and other program UI: "First, go to the '''File''' menu and choose '''Map Properties''' to bring up the '''Object Properties''' dialog box. Click the '''Skybox Texture Name''' field."
 
* If the word is a wiki link, it does not require to be bold.
 
 
 
== <nowiki><code> tags</nowiki> ==
 
* Are fine to use, as there is no other wiki markup equivalent.
 
* Command-line statements: <code>c:\program files\valve\steam\</code>
 
* Variables in code or text files: <code>$staticprop</code> or <code>m_nCounter</code>
 
* In-game console commands: <code>mat_wireframe 1</code>
 
* Filenames: <code>bspzip.exe</code>
 
* Entity names: <code>info_player_start</code>
 
* Other in-game or Hammer data, such as texture names, input and output names, etc.
 
 
 
== See also ==
 
*[[Help:Contents]]
 
*[[Help:Cleanup]]
 
*[[:Category:Cleanup]]
 
*[[Valve Developer Community:About]]
 
*[[Valve Developer Community:Terms of use]]
 
Wikipedia has excellent resources on text formatting available [[Wikipedia:Wikipedia:How to edit a page|here]]. The information is referential of the Wikipedia site, but is applicable to all MediaWiki powered sites, including the Valve Developer Community.
 
{{backtotop|align=right}}
 
[[Category:Tutorials]]
 
 
[[Category:Wiki]]
 
[[Category:Wiki]]
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 08:04, 21 August 2018

Русский 简体中文 
Help:Contents
  • Page Creation - Information about creating pages.
  • Editing Toolbar - Details about the features you have available to you when editing.
  • Alternative Languages - Check here if you are translating a page to a different language.
  • Etiquette - Guidelines you should follow so that everyone has a good wiki experience.
  • Templates - How to use and make templates.
  • Images - How to upload and add images.
  • Linking - Help with making links to other pages.
  • Table of Contents - How to manipulate tables of contents and headings.
  • Categories - Information about categories.
  • Cleanup - Information about problematic pages.
  • Special Pages - Full list of useful pages generated by the website.
  • Stubs - Small pages that should be expanded on.

See also