Комментарии

Строки файла, начинающиеся с символа "#" считаются комментарием и игнорируются. При этом после символа "#" не должно быть пробела и символов "#", "*", ":", иначе строка будет интерпретирована как элемент нумерованного списка (для совместимости с mediawiki). Также комментариями не считаются директивы препроцессора #warn, #define, #if, #else, #endif, #raw, #endraw, #include.

При необходимости "закомментировать" большой многострочный фрагмент текста можно воспользоваться директивами препроцессора #if 0 и #endif:

#if 0
текст,
который нужно закомментировать
#endif

Абзацы и переносы строк

Для разделения абзацев используется пустая строка, точно так же как в разметке mediawiki или LaTeX.

Если необходимо начать новую строку, не прерывая абзац, используется символ "~" в начале строки, например:

В этом абзаце
осуществляется перевод строки здесь:
~продолжение абзаца на новой строке.

Это — начало нового абзаца

Строки входного файла можно "склеивать" в одну строку, размещая символ \ в конце первой и последующих строк. Например, текст элемента списка должен располагаться на одной строке входного файла.

* длинный элемент \
списка не поместился \
на одной строке
* второй элемент

Заголовки

Заголовки и подзаголовки выделяются символами "=". Чем больше символов "=", тем более вложен подзаголовок. Например:

= Заголовок книги =
== Заголовок главы ==
=== Подзаголовок ===

В отличие от mediawiki, закрывающие символы "=" ставить необязательно.

Заголовок должен распологаться на одной строке входного файла. При необходимости переноса строк во входном файле можно использовать символ \ в конце строки:

== Длинный заголовок \
не поместился \
на одной строке

Заголовок первого уровня (определённый с одним символом "=") не включается в оглавление, формируемое командой ${tableofcontents}, но устанавливает переменную ${title}, которая используется при формировании заголовка в формате HTML и титульного листа в формате LaTeX.

Возможно задание подзаголовка без формирования раздела:

~~ Подзаголовок ~~

Завершающие символы "~~" также необязательны.

Альтернативный способ задания подзаголовка:

=== Заголовок ===
===~ Подзаголовок ~===

Подзаголовок первого уровня (определённый последовательностью "=~") устанавливает переменную ${subtitle}, которая используется при формировании заголовка в формате HTML и титульного листа в формате LaTeX.

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

Полужирный и курсивный текст кодируется различным количеством апострофов, так же как в mediawiki.

'''полужирный текст'''
''курсив''
'''''полужирный курсив'''''

Существует альтернативная возможность для обозначения полужирного, курсивного, подчёркнутого, перечёркнутого и моноширинного текста:

{*полужирный текст*}
{/курсив/}
{_подчёркивание_}
{-перечёркивание-}
{|моноширинный текст|}

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

{_подчёркивание}

Верхние и нижние индексы задаются комбинациями ^{индекс} и _{индекс} соответственно, например:

L_{Iso}=2×10^{50} erg/s

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

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

Неразрывный пробел обозначается символом "~", аналогично TeX'у. При необходимости вставить в текст сам символ "~", необходимо его заэкранировать: \~. В некоторых случаях mwiki самостоятельно заменяет пробел на неразрывный (см. раздел ???). Также в качестве неразрывного пробела можно использовать символ с кодом U+00A0.

Преформатированный текст

Также как и в mediawiki, пробел в начале строки обозначает преформатированный моноширинный текст. При необходимости вставить пустую строку в преформатированный текст, используйте строку из символа "~":

 Это первая строка преформатированного текста.
 Это вторая строка.
 ~
 Это строка после пустой строки.

Внутри блока преформатированного текста не работают никакие команды форматирования, кроме подстановки значений переменных.

Ссылки

Гиперссылки задаются двойными квадратными скобками. При необходимости можно задать текст ссылки:

[[URL]]
[[URL Текст ссылки]]

Существует сокращённый формат ссылок на статьи Википедии и Луркморе. При этом необязательный текст ссылки отделяется вертикальной чертой.

[[:w:Wikipedia article|текст ссылки]]
[[:r:Статья в русской википедии]]
[[:l:Статья на lurkmore|текст ссылки]]

Можно задавать ссылки на внешние ресурсы в одинарных квадратных скобках (для совместимости с mediawiki), но при этом обязательно указывать протокол http:, ftp: или mailto:

[http://www.wikipedia.org Википедия]
[ftp://ftp.sunet.se]

Списки

Поддерживаются нумерованные, ненумерованные списки, списки с отступом, списки определений, совместимые с mediawiki. Поддерживается неограниченная вложенность списков. Текст нумерованного списка должен быть отделён от значка "#" хотя бы одним пробелом, чтобы он не посчитался комментарием.

* Ненумерованный
* Список

# Нумерованный
# Cписок

* Вложенные списки
*# Номер 1
*# Номер 2
* Второй вложенный список
*# Номер 1
*# Номер 2

;Термин:Определение
: Просто строка с отступом
:: С двойным отступом

Текст элемента списка должен распологаться на одной строке входного файла. При необходимости переноса строк во входном файле можно использовать символ \ в конце строки:

* длинный элемент \
списка не поместился \
на одной строке

Нумерованные заголовки и абзацы

Используя сочетание символа "%" и точек можно задать автоматическую нумерацию заголовков и подзаголовков. Каждый символ "%" будет заменён на соответствующее число. Если не ставить точку после символа "%", то после номера раздела точки не будет (ГОСТ 2.105-95 Общие требования к текстовым документам).

== %. Нумерованый заголовок
=== %.%. Подзаголовок
== % Заголовок без точки после номера

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

== % Заголовок (1)
% Нумерованный абзац (1.1)
=== %.% Подзаголовок (1.2)
% Нумерованный абзац (1.2.1)
% Нумерованный абзац (1.2.2)
%.% Подпункт (1.2.2.1)

При этом нумерация абзацев (пунктов) и заголовков сквозная, а к номеру пункта автоматически добавляется номер соответсвующего заголовка.

Между символами % ставить точки необязательно. Важно только количество символов % и наличие или отсутствие точки в конце номера, чем определяется, будет ли поставлена точка после номера в выходном файле. Таким образом, следующие две записи эквивалентны:

== %.% Заголовок
== %% Заголовок

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

При ссылке на нумерованный заголовок или абзац в текст ссылки автоматически вставляется номер заголовка или абзаца (без конечной точки), например приведённая ниже ссылка даст на выходе "Смотри п.1.1 в разделе 1".

== %. Заголовок ${label sec}
%. Пункт ${label point}
Смотри п.${ref point} в разделе ${ref sec}.

Картинки

Картинки задаются в квадратных скобках. Если картинка не является фотографией из альбома, то перед именем файла картинки необходимо поставить один из символов "!", ",", ";", ">". После имени файла можно опционально указать ссылку, по которой будет осуществлять переход по клику на картинке.

Просто картинка:

[!image.png url/link.html]

Картинка снабжается подписью с номером рисунка (только в режиме LaTeX, иначе аналогично "!"):

[,image.png]

Картинка растягивается по ширине колонки текста (только в режиме LaTeX, иначе аналогично "!"):

[;image.png]

Картинка, выровненная по правому краю:

[>image.png]

Препроцессор

#warning Output format is html.

#define sun Солнце
#define var1 Пусть всегда светит ${sun}
#define var2

#if 0
  строка
  строка
#endif

Переменные

#define name value

mwiki -D var1=value1 -D var2=1 -D var3=value3

#if html
#if $var{html}

Примеры использования препроцессора и переменных

#if html
<img src="smile.png" />
#else
#warn Ошибка в файле ${filename} в строке ${linenumber}
#endif

Экранирование

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

• Обратная косая черта (\) требует экранирования всегда.
• Одиночные фигурные скобки ({, }) требуют экранирования только в конструкциях выбора типа шрифта ({/, {*, {_, {|, {-) и верхних и нижних индексов (_{}, ^{}), причём в последнем случае достаточно заэкранировать либо только символ _ или ^, либо только фигурные скобки. В остальных случаях одиночные фигурные скобки экранирования не требуют.
• Знак доллара ($) требует экранирования перед фигурной скобкой (${).
• Одинарные квадратные скобки ([, ]) используются либо для задания внутри абзаца ссылок, совместимых с mediawiki (в этом случае содержимое скобок должно начинатсья с ftp:, http:, https:, mailto:), либо для задания картинок вне абзаца. В остальных случаях экранирование фигурных скобок не требуется.
• Двойные квадратные скобки ([[, ]]) требуют экранирования всегда.
• Тильда (~) требует экранирования всегда.
• Экранирование символов #, *, : требуется только при использовании их в начале строки, когда они могут быть расценены как определение элемента списка.
• Экранирование символа % требуется только при использовании его в начале строки, когда он может быть расценен как номер абзаца или заголовка.
• Одинарные апострофы (') экранирования не требуют, двойные и более требуют.
• Кавычка (") не требуют экранирования.

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

Режим NAKED

При указании опции --naked mwiki не формирует заголовки и хвост файла. Полученный в результате файл можно включать внутрь другого HTML-файла внутрь секции <html> (в режиме HTML) или внутрь другого LaTeX файла (в режиме LATEX).

Шаблоны

Шаблоны используются при помощи конструкции

${<имя_шаблона><разделитель><аргумент1><разделитель><аргумент2>}

Фотографии

Координаты

html

latex

Нумерованные заголовки и абзацы

plain