Difference between revisions of "Help:Editing:ru"

From Valve Developer Community
Jump to: navigation, search
 
Line 212: Line 212:
 
==== Маленький ====
 
==== Маленький ====
 
* Пример заголовка S
 
* Пример заголовка S
== Embedded pictures https://developer.valvesoftware.com/w/skins/common/images/button_image.png ==
+
== Встроенные картинки 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]].
+
Чтобы загрузить изображение, посетите [[Special: Upload]].
{{warning|Please read the [[Valve_Developer_Community:Image_use_policy|image use policy]] before uploading images.}}
+
 
 +
{{warning|Пожалуйста, прочитайте [[Valve_Developer_Community: Image_use_policy | политику использования изображений]] перед загрузкой изображений.}}
 
{{syntax2
 
{{syntax2
 
|syn=<nowiki>[[Image:Filename.png]]</nowiki>
 
|syn=<nowiki>[[Image:Filename.png]]</nowiki>
Line 221: Line 222:
 
|out=[[Image:Steam_available.png]]
 
|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:
+
The <code><nowiki>[[Image:Filename.png]]</nowiki></code> Синтаксис имеет несколько опций, которые вы можете использовать. Он может был размещен в качестве опции в любом месте строки:
 
:{| class=standard-table
 
:{| class=standard-table
 
! Option || Example || Description
 
! Option || Example || Description
Line 232: Line 233:
 
|}
 
|}
  
== Ignore Wiki formatting https://developer.valvesoftware.com/w/skins/common/images/button_nowiki.png ==
+
== Игнорировать форматирование Вики 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
 
{{syntax2
 
|syn=<nowiki><nowiki>Insert non-formatted text here</nowiki></nowiki>
 
|syn=<nowiki><nowiki>Insert non-formatted text here</nowiki></nowiki>
Line 240: Line 241:
 
}}
 
}}
  
== Signature https://developer.valvesoftware.com/w/skins/common/images/button_sig.png ==
+
== Подпись 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]].
+
Подпись вставляет ваше имя пользователя, которое ссылается на вашу страницу пользователя, и отметку времени, которая отмечает точное время, когда вы отправили свои изменения. Это в основном используется для "подписи" ваших сообщений при вставке комментариев на страницы обсуждения (обсуждения). Распространено любезно подписывать ваши комментарии на страницах "Talk". Вы можете изменить то, что появляется в вашей подписи, перейдя в [[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.}}
 
{{tip|The syntax includes two hyphens (--), but you really only need four tildes (<nowiki>~~~~</nowiki>) to insert a signature.}}
 
:{{syntax2
 
:{{syntax2
Line 249: Line 250:
 
}}
 
}}
  
== Horizontal lines https://developer.valvesoftware.com/w/skins/common/images/button_hr.png ==
+
== Горизонтальные линии https://developer.valvesoftware.com/w/skins/common/images/button_hr.png ==
 
{{syntax2
 
{{syntax2
 
|syn=<nowiki>----</nowiki>
 
|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.
+
Горизонтальные линии обычно используются только в конце большого раздела одной страницы. Используйте их с осторожностью, так как слишком многие делают страницу уродливой. Правильное использование [[#Adding_a_headline | headlines]] может сделать это ненужным.
 
 
 
{{backtotop|align=right}}
 
{{backtotop|align=right}}
= Formatting Pages =
+
= Форматирование страницы =
  
 
== Bullet points ==
 
== Bullet points ==
This function can create unordered lists. Bullet points are useful for listing multiple items that fall into a similar category.
+
Эта функция может создавать неупорядоченные списки. Точки можно использовать для перечисления нескольких элементов, которые попадают в аналогичную категорию.
 
{{syntax2
 
{{syntax2
 
|syn=
 
|syn=

Latest revision as of 18:31, 30 January 2019

English Русский 简体中文


Создание страниц

Панель редактирования

button_bold.png Полужирный текст
button_italic.png Курсив
button_link.png Добавление внутренних ссылок
button_extlink.png Добавление внешних ссылок
button_headline.png Добавление заголовка
button_image.png Вставка изображения
button_nowiki.png Игнорировать Wiki форматирование
button_sig.png Установка вашей подписи
button_hr.png Горизонтальные линии

Форматирование страниц

Шаблоны страниц

Руководство по специальному форматированию

Создание страниц

Вы можете начать редактирование несуществующей страницы несколькими способами:

  • Самый простой способ это ввести точное требующееся Вам название в "Строку поиска" затем нажать кнопку "Перейти". Если страница не существует, то Вы сможете её создать.

Warning: Удостоверьтесь, что страница, которую Вы имеете в виду, уже не присутствует на Wiki. Например, вы хотите создать страницу "Portal 2 Particles", но Вы не заметили страницу List of Portal 2 Particles.

Например, предположим, что Вы набрали "Foobar" в строку поиска, а затем нажали кнопку "Перейти". Так как страница не существует, Вы увидите следующее сообщение:
Результаты по данному запросу отсутствуют.
Создайте страницу "Foobar" в этой wiki!
В этом случае, Вы можете нажать на ссылку Foobar и начать редактирование новой страницы.
Tip:Красные ссылки - страницы, которые еще не были созданы, и синие ссылки - страницы, которые уже существуют.
  • Вы можете изменить URL в адресной строке для перехода туда, куда Вы хотели (в этом случае используя адрес https://developer.valvesoftware.com/wiki/Foobar).
  • Некоторые страницы в Wiki содержат много красных ссылок. Если Вы знакомы с темой несуществующей страницы, не стесняйтесь создавать новую страницу, перейдя по красной ссылке. Ваши вклады высоко ценятся, и чем более синих ссылок, тем лучше.

В ходе редактирования, нажатие кнопки Предварительный просмотр (справа от кнопки Записать страницу ) поможет определить, выглядит ли Ваше редактирование хорошо. Это показывает окончательный результат отредактированной страницы, не сохраняя его. Это позволит избежать спама Последние изменения с сохраненными изменения, к разочарованию других редакторов.

Когда вы закончите редактирование, корректируйте его, чтобы удостовериться, что редактирование окончательное, и затем щелкните Записать страницу, чтобы, наконец, создать новую страницу.

Тестовые страницы (Sandbox)

Чтобы проверить свои навыки редактирования, вы можете использовать публичную тестовую страницу, или создать свою. Тестовую страницу можно создать с помощью пользовательской страницы, где в адресной строке в конце URL-строки просто добавьте "/Sandbox". Перед созданием убедитесь, что вы находитесь на своей собственной странице.

Опытные редакторы страниц, которые желают дальше продвигать свои навыки редактирования в шаблонах, могут использовать Template: TestTemplate страницу, чтобы проверить их шаблон кода.

[Back to top]

Создание страниц "Как сделать..."

Основные рекомендации по написанию обучающих страниц.

  • Перед тем как начинать, убедитесь, что вы полностью понимаете тему о которой хотите написать. Очень трудно написать что-то информативное, если вы не знаете подробности этой темы.
  • Решите, какую обучающую страницу вы делаете. Это базовое руководство для людей, которые не часто пользуются Hammer? Или эта страница больше подходит для продвинутых пользователей?
  • Хороший туториал представляет собой информацию которую интересно читать:
    • Перед тем как начать, добавьте краткое описание о чем ваша страница.
    • Разбейте его на этапы. Если эта страница для начинающих, не бойтесь описывать каждый шаг.
    • Разбейте всё на группы шагов, которые все вместе достигают одной цели.
    • Добавляйте картинки. Изображение может описать то, что не нуждается в пояснениях. Тем не менее, не переполняйте страницу. Используйте изображения тогда, когда это улучшает текст.
    • Добавляйте таблицы при объяснении ввода и вывода поведения энтити. Это становится проще, если таблица совпадает с флагами вывода в Хаммере уже наполненного информацией. Читатель может просто скопировать его или перепроектировать, понять почему это должно быть сделано так, а не иначе.
  • При написании обучающей страницы, имейте в виду, что есть люди которые не знакомы с большинством энтити и различных инструментов Хаммера. Не пытайтесь объяснять что-то, что уже есть в Wiki, используйте перенаправляющиеся ссылки, для ознакомления читателя с этим материалом.
  • Пытайтесь описывать шаги в логической последовательности. После прочтения вашего туториала люди будут делать так, как делали вы.
  • Сделайте хорошее резюме в конце страницы.

Теперь создайте sandbox страницу и начните писать!

Создание страниц о моде

Пожалуйста ознакомьтесь с рекомендациями перед созданием страницы о Source/GoldSrc моде.

Создание страниц об энтити

Смотрите шаблон для создания страниц о энтити.

Создание Категорий

Категории позволяют страницам добавлять автоматически списки. Эти структуры помогают группировать страницы аналогичной тематики. Там также может быть раздел со списком подкатегорий этой категории.

Страницы категорий обычно создаются для описания. Например, Категория:Blender является категорией для всех страниц, связанных с пакетом 3D моделирования и с открытым исходным кодом, Blender.

Чтобы добавить страницу в категорию, просто разместите [[Category:'''ИМЯ КАТЕГОРИИ''']] в нижней части страницы. Все страницы, которые имеют одинаковое название категории будут отображаться автоматически.

Для получения списка всех текущих категорий, посетите Категории.

[Back to top]

Создание страницы пользователя

Вы можете редактировать свою личную страницу. Запрещается редактировать страницы других пользователей, оставлять ссылки на сайты с порнографией, торрент ссылки и т.д. Если вы это нарушите,то получите бан по IP навсегда.

Чтобы создать страницу пользователя вы должны сначала зарегистрироваться на VDC.Зарегистрироваться. После того как вы зарегистрировались и вошли в аккаунт, нажмите на имя пользователя в самом верхнем правом углу.

[Back to top]

Создание страниц-обсуждений

Вы можете создать страницы для обсуждения вопросов, содержание которых должно соответствовать названию страницы. Он также может быть использован для запроса помощи.

Чтобы создать или отредактировать страницу для обсуждения, просто нажмите на вкладку "Обсуждение" выше, рядом с вкладкой "Статья".

Совет:
Вы также можете использовать сочетание клавиш Alt+T для быстрого перемещения на страницу обсуждения, если ваш браузер/ОС позволяет это.


Страницы обсуждения имеют специальный поток. Когда вы комментируете посты на странице обсуждения, используются отступы, чтобы ответить на комментарии.Смотрите ниже для получения дополнительной информации.

Чтобы подписать ваши комментарии с вашим именем и дате/времени поста нужно использовать четыре символа. Четыре тильды (~~~~) будут автоматически заменяться общедоступной информацией пользователя вместе с датой и временем поста. Подписи объясняются далее.

[Back to top]

Указания по редактированию

Хотя это не правила, но они являются необходимыми руководящими принципами, которые каждый пользователь должен соблюдать.

  • Страница пользователя - это личное пространство пользователя. Старайтесь не вносить изменения в страницу пользователя без согласия владельца страницы.
  • Используйте кнопку Предварительный просмотр при редактировании страницы. Это покажет вам, как именно будет выглядеть страница после сохранения ваших изменений. Это поможет сохранить страницу Недавние изменения для чистой и удобной для навигации.

Editing Toolbar

Mediawiki_editbuttons.png

При нажатии каждой кнопки будет вставлен небольшой пример использования темпа специального форматирования. Если у вас выделен текст, нажатие кнопки отформатирует текст вместо вставки в пример кода. Например, чтобы сделать текст жирным, просто выделите текст в окне редактирования и нажмите кнопку жирного шрифта (первая кнопка на панели редактирования).

Bold text button_bold.png

Жирный текст очень просто сделать. Поместите три (3) одиночных апострофа перед разделом текста, который вы хотите выделить жирным шрифтом, и три (3) после.

 
   Syntax '''Жирный текст''' 
 Example Remember to '''always''' brush your teeth. 
   Results Remember to always brush your teeth.

Курсив button_italic.png

Курсив так же просто сделать, как и жирный текст. Вставьте два (2) одиночных апострофа перед тем разделом текста, который вы хотите выделить курсивом, и два (2) после.

 
   Syntax ''Курсив'' 
 Example The ''Queen Mary'' sailed last night. 
   Results The Queen Mary sailed last night.

Внутренние ссылки 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!

 
   Syntax [[Link title]] 
 Example Click here to go to the main page: [[Main Page]] 
   Results Click here to go to the main page: Main Page
Note:Spaces are automatically converted to underlines for internal links. [[Main_Page]] is equivalent to [[Main Page]], 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.

 
   Syntax [[Link title|Text for link]] 
 Example [[Main Page|Нажми здесь]] чтобы перейти на главную страницу. 
   Results Click here чтобы перейти на главную страницу.
Tip: К любому заголовку на странице можно «перейти», добавив хеш-тег и имя заголовка в конце заголовка ссылки. Например: [[Help:Editing#Internal_links|Jump to "Internal links"]].

Внешняя ссылка button_extlink.png

Внешние ссылки используются для ссылки на веб-страницы, которых нет в этой вики. Любая ссылка со значком external-link-ltr-icon.png означает, что она является внешней, а любая ссылка - https://developer.valvesoftware.com. Значок /w/skins/vector/images/lock-icon.png означает, что это безопасная ссылка.

 
   Syntax [http://www.example.com link title] 
 Example [http://www.valvesoftware.com/jobs/ Нажми здесь] чтобы узнать больше о применении в Valve. 
   Results Нажми здесь чтобы узнать больше о применении в Valve.
 
 Example [https://plus.google.com Google+ (secure link)] 
   Results Google+ (secure link)

Добавление заголовка button_headline.png

Заголовки используются для разделения статьи на значимые разделы. Вы можете изменить размер заголовка, изменив количество знаков равенства (=), чтобы изменить размер заголовка. Это позволяет очень легко классифицировать страницы, создавая чистый и эффективный способ поиска информации. Кроме того, с несколькими заголовками, вики-движок в конечном итоге добавит поле «Содержание» в начало страницы, позволяя зрителю мгновенно перейти к нужной теме на странице. На стандартных страницах следует использовать заголовки второго уровня (Большие). Очень большие заголовки зарезервированы для заголовка страницы.

 
   Syntax = Extra-Large Headline =

== Большой заголовок ==
=== Средняий заголовок ===
==== Маленький заголовок ====

Очень большой

  • Пример заголовка XL (не должен использоваться)

Большой

  • Пример заголовка L (используйте его в качестве первого заголовка на странице)

Средний

  • Пример заголовка М

Маленький

  • Пример заголовка S

Встроенные картинки button_image.png

Встроенные изображения - это изображения, которые были загружены в Вики и теперь размещаются на ней. Чтобы загрузить изображение, посетите Special: Upload.

Warning: Пожалуйста, прочитайте политику использования изображений перед загрузкой изображений.

 
   Syntax [[Image:Filename.png]] 
 Example [[Image:Steam_available.png]] 
   Results Steam available.png

The [[Image:Filename.png]] Синтаксис имеет несколько опций, которые вы можете использовать. Он может был размещен в качестве опции в любом месте строки:

Option Example Description
thumb [[Image:Filename.png|thumb]] Produces a framed thumbnail version of the image.
###px (size) [[Image:Filename.png|300px|thumb|This is an example image]] Changes the pixel size of the images.
left (right, center) [[Image:Filename.png|thumb|150px|right]] Controls the alignment of the image on the page

Игнорировать форматирование Вики button_nowiki.png

Эту кнопку можно нажимать редко, так как ее можно использовать только для описания изменений для технического обслуживания или написания страниц, подобных этой, здесь. Он игнорирует все вики-форматирование между гнездами и возвращает только простой текст.

 
   Syntax <nowiki>Insert non-formatted text here</nowiki> 
 Example <nowiki>This is '''bold''' text.</nowiki> 
   Results This is '''bold''' text.

Подпись button_sig.png

Подпись вставляет ваше имя пользователя, которое ссылается на вашу страницу пользователя, и отметку времени, которая отмечает точное время, когда вы отправили свои изменения. Это в основном используется для "подписи" ваших сообщений при вставке комментариев на страницы обсуждения (обсуждения). Распространено любезно подписывать ваши комментарии на страницах "Talk". Вы можете изменить то, что появляется в вашей подписи, перейдя в Special: Preferences.

Tip:The syntax includes two hyphens (--), but you really only need four tildes (~~~~) to insert a signature.
 
   Syntax --~~~~ 
 Example This discussion page may need archived soon. --~~~~ 
   Results This discussion page may need archived soon. --FakeUser23 21:38, 17 October 2011 (PDT)

Горизонтальные линии button_hr.png

 
   Syntax ----

Горизонтальные линии обычно используются только в конце большого раздела одной страницы. Используйте их с осторожностью, так как слишком многие делают страницу уродливой. Правильное использование headlines может сделать это ненужным.

[Back to top]

Форматирование страницы

Bullet points

Эта функция может создавать неупорядоченные списки. Точки можно использовать для перечисления нескольких элементов, которые попадают в аналогичную категорию.

 
   Syntax * Item 1

* Item 2
* etc...
 

 Example * Red

* Blue
* Green
 

   Results
  • Red
  • Blue
  • Green
Tip:Increasing the number of asterisks (*) 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.

 
   Syntax # Item 1

# Item 2
# etc...
 

 Example # This is the first step.

# This is the second step.
 

   Results
  1. This is the first step.
  2. This is the second step.

Definition lists

You can also create definition lists equivalent to the <dl>, <dt>, and <dd> HTML tags.

 
   Syntax ;Item 1

:About Item 1
;Item 2
:About Item 2
 

 Example ;Center

:A point equidistant from all points on the surface of a sphere. 

   Results
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 Tab key.

 
 Example :This line will be indented once.

::This line will be indented twice.
:::This line will be indented thrice.
 

   Results  
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? --jd650

:Yes. Actually, I've bred a couple of them. --MarcusTwain
::Really? Do you have photos? --jd650
::I, too, am interested in these photos. --Halifax
:::I, err.. don't have a camera.. --MarcusTwain
:No, I don't believe in unicorns. --ChOcObO_23
::Why not? --jd650

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.

 XHTMLWiki
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
|}

Syntax highlighting

To enable syntax highlighting for blocks of code, the syntax is pretty simple.

Note:This new syntax replaces the <source> tag, because XML uses that tag in some scripts.
 
   Syntax <syntaxhighlight lang="cpp">C++ source code</syntaxhighlight> 
 Example <syntaxhighlight lang="cpp">(Insert FireBullets() method here)</syntaxhighlight> 
   Results
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
        //...
}

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

 
   Syntax #REDIRECT [[new_page]]

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 #REDIRECT 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.

 
   Syntax  Insert text after the space. 
 Example  There is a space at the beginning of this line. 
   Results
There is a space at the beginning of this line.

You can also use the <pre> tag for a message box. Just use <pre>Message box.</pre>.

Categorizing pages

If you'd like a page to show up in the automatically generated category tables (full category list found here) like on the category page Category:Level_Design, you will need to append the [[Category:name]] at the bottom of the page.

For an example of how pages can be categorized, the bottom of this page have the following [[Category]] tags:

[[Category:Tutorials]]
[[Cateogry:Wiki]]
[[Category:Help]]

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.


[Back to top]

Page Templates

Click here to view the extensive list of templates available for use.

[Back to top]

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

To do: 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 brushes, 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: hl2.exe +map mapname -dev
  • Can be combined with "<" and ">" for parameters with longer names: hl2.exe -game <game directory>
  • 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.

<code> тег

  • Предпочтительно к использованию, т.к. нет другой вики разметки с такими же функциями.
  • Параметры командной строки: c:\program files\valve\steam\
  • Переменные в коде или текстовых файлах: $staticprop или m_nCounter
  • Консольные команды: mat_wireframe 1
  • Имена файлов: bspzip.exe
  • Имена энтитей: info_player_start
  • Другие игровые или Hammer данные, такие как имена текстур, имена input и output и т.д.

See also

Wikipedia has excellent resources on text formatting available here. The information is referential of the Wikipedia site, but is applicable to all MediaWiki powered sites, including the Valve Developer Community.

[Back to top]