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

Содержание

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

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

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

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

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

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

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

Категорирование

Вики-статьи помещаются в категории автоматически. Место генерации списка страниц, относящихся к категории, отмечается знаком «##». Для добавления статьи в соответствующую категорию внизу страницы после знака «#» перечисляют категории, в которые входит данная статья. Категории отделяют друг от друга знаком вертикальной черты (|), например, вот так: 

 # КатегорияЯзыкиПрограммирования | КатегорияОболочки

Заголовки

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

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

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

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

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

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

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

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

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

Специальные символы вводятся 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.

Существует второй вариант синтаксиса для создания гиперссылок, ссылок на внутренние страницы и изображений. Необходимый URL пишется внутри удвоенных квадратных скобок. 

 [[URL|description]]
 Для изображений можно указать необязательний модификатор размера
 [[URL|description|modifier]]

Например 

[[google.ru|Поисковичок]]
[[ya.ru]]
[[ГлавнаяСтраница]]
[[http://opennet.ru|новостной сайт]]
[[http://wiki.amplab.ru/resources/site-logo.png||50px]]
преобразуется в:

Поисковичок

ya.ru

ГлавнаяСтраница

новостной сайт

Следует помнить что пробелы между разделительным знаком |, перед началом сслыки и в самом конце игнорируются, поэтому следующие 2 записи эквивалентны 

[[ google.ru | поисковый сайт ]]
[[google.ru|поисковый сайт]]

Если в статье понадобится последовательность символов [[ между двумя скобками можно вставить «невидимый» символ разделения записей (record separator), он вводится кобминацией «Ctrl+Shift+U 1E».;

Списки

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

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

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

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

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

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

Термины и определения

Описание терминов, специальных символов, синтаксических конструкций удобно выполнять в виде специальных параграфов. Термин набирается с отступом в один знак табуляции, а определение после двоеточия (:), перед и после двоеточия ставится один или несколько пробелов, например, вот так: 

 <tab>Термин : Длинное определение термина, которое может набираться в несколько строк.

Предыдущий пример отображается на вики странице следующим образом:

Термин
Длинное определение термина, которое может набираться в несколько строк.

Библиографический список

Все библиографические ссылки в тексте должны быть оформлены следующим образом:

  • Начало и конец библиографического списка помещается внутри пары тегов %R( и %R). До этих последовательностей в строке не должно быть пробелов.
  • Библиографический список состоит из одной или нескольких записей, разделённых пустыми строками.
  • На странице может присутствовать более одного библиографического списка.
  • Записи состоят из нескольких описывающих её ключей.

Ключи библиографической записи

%A
Автор. Можно указывать более одного ключа %A.
%Q
Информация об авторе, если автор не физическое лицо. Используется если в записи не было определено ни одного ключа %A.
%I
Информация об издателе.
%D
Дата издания.
%C
Город.
%T
Название книги (если оформляется запись на статью в книге или журнале — название статьи).
%B
Если запись оформляется на статью или журнал, то это название книги или сборника.
%P
Количество страниц в книге или область страниц от — до, на которые оформляется запись.
%U
Ссылка на электронный ресурс, если таковая имеется.
%s
Название сайта, если запись оформляется на электронный ресурс.

Пример оформления библиографического списка

 %R(

 %A Paradis E.
 %T R for beginners
 %U http://cran.r-project.org/doc/manuals/R-intro.pdf
 %D 2004

 %A Norman Matloff
 %T The Art of R Programming
 %D 2009

 %A Lipin B. R.
 %A Sitkarev G. A.
 %B AM&P Lab reports
 %T The Beginner's Guide to Art of Bad Code and Ugly Style
 %D 2015
 %R)

При добавлении список, указанный выше, на вики-странице отображается так:

  1. Paradis, E. R for beginners / E. Paradis. — 2004. — http://cran.r-projec....
  2. Norman, M. The Art of R Programming / Matloff Norman. — 2009.
  3. Lipin, B. R. The Beginner's Guide to Art of Bad Code and Ugly Style / B. R. Lipin, G. A. Sitkarev // AM&P Lab reports. — 2015.

Область неформатированного ввода

Большие блоки неформатированного текста (например исходного кода) помещаются внутри блока из трёх знаков равно (===).

Пример оформления неформатированного блока

 ===
 #include <stdio.h>
 
 int
 main(int argc, const char *argv[])
 {


 	return 0;
 }
 ===

При добавлении блок, указанный выше, на вики-странице отображается так: 

#include <stdio.h>

int
main(int argc, const char *argv[])
{
	
	return 0;
}

Соглашения записи математических формул

  • вектор и его элементов: bold x = (x sub 1 , x sub 2 , ldots , x sub n ),
  • элемент a sub ij матрицы A находится на её пересечение i-ой строки и j-го столбца, пороизведение матриц A B = C, произведение матрицы на вектор A bold b = bold c