Это старая версия (1.3) ПравилаРазметки.

Содержание

Правила вики-разметки

На этой странице даётся краткое описание разметки, используемой на этой вики. Она не сложна и быстро запоминается; в разметке нет ничего лишнего. Аскетичная разметка должна способствовать составлению простого и ясного текста без лишних украшательств.

Вики-страницы

Название вики-страницы (статьи) обязательно состоит как минимум из двух слов, начинающихся с большой буквы, набранных слитно без пробела. Например, НоваяСтраница? или ВикиРазметка?. Если имя термина или явления состоит только из одного слова, то тогда название вики-страницы рекомендуется составлять из имени с префиксом, относящимся к разделу или классификации. Например, к именам языков программирования добавляется префикс «Язык», т. о. страница, посвящённая языку AWK, именуется ЯзыкAWK. Ссылка не формируется на СтраницуВики, если слово заключено в шесть одиночных кавычек.

Типографические соглашения

На этой вики приняты следующие типографические соглашения по оформлению статей:

  1. Имена путей к файлам и каталогам, названия утилит пишутся курсивом.
  2. Если утилита упоминается в контексте ссылки, то в скобках, набранных прямым шрифтом, указывают номер раздела man-справочника.
  3. Имена функций в контексте примеров набираются курсивом, и оканчиваются парой круглых скобок, набранных прямым шрифтом.
  4. Путь к каталогу или имя каталога должны заканчиваться косой чертой (прямой слеш для ОС Unix, или иной в соответствии с соглашениями ОС).
  5. Команды внутри основного текста или ввод пользователя набирается моноширинным шрифтом, т. е. когда внутри текста упоминается нечто набираемое пользователем в командной строке или текстовом редакторе.
  6. Если даётся пример команд с выводом, то ввод пользователя выделяется жирным.
  7. Примеры с вводом пользователя и выводом набираются с символами приглашения интерпретатора или среды исполнения так, чтобы было понятно где начинался и заканчивался ввод-вывод утилит, команд, примеров. Пропущенный текст вывода заменяют на <...>.
  • В: Иногда в тексте к ссылке на страницу может присутствовать префикс или суффикс, не являющийся частью имени, например, МояСтраницаВики или ЯзыкAWK-подобный. Стоит ли доработать немного парсер, чтобы такие случаи тоже корректно обрабатывались и отображались? -- СиткаревГригорий.

Заголовки

Заголовки формируют структуру текста, иерархию между разделами. Заголовки в вики-разметке выделяются так: 

 - Заголовок первого уровня
 -- Заголовок второго уровня
 --- Заголовок третьего уровня

Текст этого примера выглядит так:

Заголовок первого уровня

Заголовок второго уровня

Заголовок третьего уровня

Текстовые выделения

Для выделения жирным текст заключают в тройные одиночные кавычки, для выделения курсивом текст заключают в двойные одиночные кавычки. Текст может быть набран жирным курсивом, для этого его заключают в пять одиночных кавычек. `Моноширинный текст` внутри основного текста заключается в одиночные обратные кавычки.

Специальные символы

Специальные символы вводятся 16-ричными кодами Unicode. Так в большинстве приложений тулкита GTK+ в Unix/Linux поддерживается специальная комбинация: одновременно нажимают и удерживают клавиши Ctrl и Shift, не отпуская их нажимают «u», после чего вводят 16-ричные разряды кода символа. После окончания ввода клавиши Ctrl и Shift отпускают.

  • Символ табуляции вводится как комбинация «Ctrl+Shift+U 09».
  • Открывающая кавычка-ёлочка „»“ вводится кобминацией «Ctrl+Shift+U ab».
  • Закрывающая кавычка-ёлочка „»“ вводится комбинацией «Ctrl+Shift+U bb».
  • Тире «—» вводится комбинацией «Ctrl+Shift+U 2012».

Литеральный блок

Примеры кода, команд, исходного текста вводятся с отступом в пробел. 

  Моноширинный текст, команды, код.

Горизонтальная черта

Горизонтальная черта используется для отделения блоков текста друг от друга. Например, обсуждения на вики-страницах отделяются снизу и сверху горизонтальной чертой. А текст обсуждений формирует иерархию с использованием списков.

  • В: Пример обсуждения на вики-странице.
    • O: Ответ или предложение на предыдущий пункт.
Текст обсуждения может быть подписан. -- АвторТекста?.

Вставка изображений и гиперссылок

Для вставки изображения достаточно поместить её URL в тексте; распознаются изображения в форматах *.jpg, *.png, *.gif и *.bmp.

Гиперссылки вставляются буквально http://wiki.amplab.ru/resources/. Распознаются и адреса электронной почты, такие как anonymous@nonet.no.

Списки

Списки используются для оформления перечислений в тексте. Не стоит ими злоупотреблять. Вики разметка позволяет формировать списки с маркерами списков (буллетами), а также автоматически нумеровать пункты. Следует отметить, что в русской типографике традиционно в качестве маркера использовался знак тире «—».

  • первый;
  • второй;
  • третий.

Списки могут быть вложенными на произвольную глубину.

  • первый;
    • вложенный элемент;
    • ещё вложенный элемент;
      • третий уровень вложенности.
    • последний вложенный элемент.
  • второй;
  • третий.

Для автоматической нумерации элементов списка перед именем элемента ставят цифру «1». Парсер автоматически распознаёт и нумерует элементы такого списка. Поддерживается смешанный список как с нумерованными так и маркированными буллетами.

  1. раз;
  2. два;
    1. два с половиной;
    2. два с четвертью;
      • два семьдесят шесть;
      • два семьдесят семь.