Xpoint
   [напомнить пароль]

Синтаксис форматирования статей

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

Базовые примитивы форматирования можно посмотреть на странице описания синтаксиса форматирования.

Элемент форматирования Что пишем Что получаем Пояснения
Структурирование
= Первый заголовок
== Подзаголовок
==! Без оглавления
---+ Альтернативный формат
---++ Подзаголовок
{{ToC}}

Первый заголовок

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

Без оглавления

Альтернативный формат

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

Оглавление

Ссылки на части документа
[[#PervyiyZagolovok Ссылка]]
[[#ПервыйЗаголовок Ссылка]]
[[#Первый_заголовок Ссылка]]
Ссылка
Ссылка
Ссылка
Ссылки на другие документы (все ссылки относительно документа /XpW/FormattingSandbox)
Внутри кластера: ПростоСсылка
или: [[ПростоСсылка Ссылка]]
или: [[ПростоСсылка?comments]]
или: НеДокумент
но: ~НеСсылка

На уровень выше: [[../Katalog]]
Поддокумент: [[!/Свалка]]
Абсолютная ссылка: [[/Bugs]]

Внутри кластера: Просто ссылка
или: Ссылка
или: Просто ссылка
или: НеДокумент?
но: НеСсылка

На уровень выше: Алфавитный указатель
Поддокумент: Свалка
Абсолютная ссылка: Система отслеживания ошибок

Форматирование
!!Комментарий!!
??Вопрос??
-Зачеркивание-
Комментарий
Вопрос
Зачеркивание
Код с подсветкой синтаксиса
<<<(perl)
my $x = 5;
if ($x == 5)
{
  print "$x = 5";
}
>>>
my $x = 5;
if ($x == 5)
{
  print "$x = 5";
}
Можно указывать следующие идентификаторы языков: Perl, PHP, PHP-body (чистый PHP-код, не вставленный в HTML), Java, HTML, CSS, JavaScript (или короче: JS), SQL (это стандартный SQL или PL/SQL), MySQL. Регистр букв не важен. Поддерживается также ряд других форматов, но они, возможно, не будут отображаться корректно без дополнительных CSS-стилей.
Макросы
::x::
::+::

::@::


2017-02-23 03:24:24

2017-02-23 03:24:24

В отличие от других команд форматирования, макросы преобразуются при сохранении документа. При последующем редактировании в документе уже будет Ваше имя и дата Вашего изменения, а не текст команды.
Картинки
{{img logo}}
{{image logo}}
logo
logo
Можно использовать только картинки, прикрепленные к статье. В качестве идентификатора используется имя файла без расширения.
Вставки
(((
{{img logo}}
Рисунок 1.1
)))

А это ссылка на [[#Рисунок11]]
logo
Рисунок 1.1
А это ссылка на Рисунок 1.1
Последняя строка вставки является ее заголовком и определяет наименование якоря.
Блок произвольного класса
[[[(warning)
Осторожно!
Злой модератор!
]]]
Осторожно!
Злой модератор!
Форматирование произвольным классом
%%(comment)Это комментарий%%.
%%(question)Это вопрос%%.
Это комментарий.
Это вопрос.

Плагины и бирки

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

Эти элементы форматирования имеют вид {{плагин param1=value1 param2="value2 value2" param3}}, распознаваемые параметры зависят от конкретного плагина или бирки. Если значение параметра содержит пробелы, его можно заключить в двойные или одинарные кавычки. Некоторые параметры достаточно назвать, не указывая для них значения. Регистр букв не играет роли в названии плагина, но важен в названиях параметров.

Существует один универсальный параметр, поддерживаемый всеми плагинами и бирками. Если задан параметр section="Заголовок", то плагин выведет заголовок первого уровня с указанным текстом, но только в том случае, если он вообще выведет какой-нибудь текст. Это полезно для создания заголовков списков, которые не должны показываться, если список пустой.

Элемент форматирования Что пишем Пояснения
Дерево, Каталог
{{Tree}}
{{PageIndex}}
Эти плагины выводят список документов, находящихся в иерархии ниже текущей страницы. {{Tree}} располагает их в виде дерева, соответственно иерархии. {{PageIndex}} группирует документы по меткам, которые они содержат. Параметры:
  • page=/XpW — заставляет плагин выводить документы внутри другого кластера (можно указывать относительные пути, к примеру ../Perl и !/Bug, или /, чтобы показать все документы).
  • type=bug — ограничивает плагин документами определенного типа. Тип документа определяют некоторые бирки, к примеру {{bug}} или {{article}}. Для плагина {{Tree}} можно задавать несколько типов через пробел, в этом случае будет выведено несколько списков.
  • nolinks — указывает, что ссылки этого плагина не должны учитываться в списке ссылающихся страниц. Эта опция включена автоматически при отображении всех документов, чтобы не портить список забытых страниц (см. ниже).
Пропущенные/забытые страницы
{{MissedPages}}
{{ForgottenPages}}
Эти плагины выводят списки пропущенных страниц (несуществующих документов, на которые есть ссылки) и забытых страниц (документов, на которые нет ссылок) внутри кластера текущей страницы. Параметры:
  • page=/XpW — заставляет плагин выводить документы внутри другого кластера (можно указывать относительные пути, к примеру ../Perl и !/Bug, или /, чтобы показать все документы).
Последние изменения, последние комментарии, новые документы
{{RecentChanges}}
{{RecentComments}}
{{NewPages}}
Эти плагины выводят списки недавно изменившихся, прокомментированных или созданных документов внутри кластера текущей страницы. Параметры:
  • page=/XpW — заставляет плагин выводить документы внутри другого кластера (можно указывать относительные пути, к примеру ../Perl и !/Bug, или /, чтобы показать все документы).
  • max=15 — ограничивает количество документов в списке (по умолчанию в списке будут все документы).
  • more=!/RecentChanges — указывает ссылку, по которой пользователь может посмотреть полный список (выводится только в том случае, если указан параметр max).
Привязка к темам форума
{{thread}}
Эта бирка указывает на то, что статья или ее часть основаны на информации определенной темы форума. Она вставляет в документ соответствующую пометку и показывает ссылку на этот документ над темой, с которой он связан. Параметры:
  • 12345 или id=12345 или thread=/forums/thread/12345.xhtml — тема, к которой надо привязать текущий документ
  • notext — если указан этот параметр, в документ не будет добавлена пометка со ссылкой на тему (полезно, если ссылку нужно вставить в другом формате)
Система отслеживания ошибок
{{enhancement}}
{{bug}}
{{critical}}
{{major}}
{{minor}}

{{fixed}}
Эти бирки предназначены для классификации багов в системе отслеживания ошибок. Они указывают на то, что текущий документ, это:
  • {{enhancement}} — предложенное улучшение
  • {{minor}} — несущественная ошибка
  • {{bug}} — ошибка
  • {{major}} — существенная ошибка
  • {{critical}} — критическая ошибка
  • {{fixed}} — исправленная ошибка (только для технических администраторов базы знаний)
Бирки устанавливают тип документа, в котором они находятся, соответственно их названию. С помощью этого можно заставить плагин {{Tree}} показывать только баги определенного типа. Помимо этого, эти бирки вставляют в документ таблицу, отображающую текущее состояние бага. По мере продвижения работы над багом администраторы базы знаний меняют его состояние, устанавливая параметры:
  • priority=2 — приоритет бага
  • state="Принято к рассмотрению" — статус бага
Статья
{{Article}}
Эта бирка предназначена для публикации авторских статей и действует только в соответствующем кластере. Она вставляется в документ, когда статья готова к появлению в списке статей, где ее увидят все. Кроме того статья появляется в досье ее авторов. Бирка устанавливает тип документа article, чтобы позволить фильтрацию списка, который выдают плагины {{Tree}} и {{PageIndex}}. Параметры:
  • author="xpointUser1 Андрей Новиков" или author1="Василий Пупкин" author2="Манька Пупкина" — авторы статьи. Перед именем опционально идет идентификатор пользователя.
  • forum=programming/java — форум, к которому относится данная статья (можно указать и полную ссылку, но важна только часть между forums/ и /forum.xhtml)
  • description="О том, о сем и ни о чем" — краткое описание статьи, которое будет выводиться в списке статей
Удаление документов
{{delete}}
Бирка помечает страницу для удаления. В результате на самой странице появляется предупреждение, чтобы предотвратить ее бесполезное редактирование. Кроме того, такая страница показывается в списке запросов на удаление (см. ниже). Параметры:
  • reason="просто мусор":
Запросы на удаление
{{DoomedPages}}
Этот плагин выводит список страниц, помеченных к удалению биркой {{delete}}. Такой список нужен, как правило, администраторам базы знаний. По умолчанию выводятся только документы, находящиеся в кластере текущей страницы. Параметры:
  • page=/XpW — заставляет плагин выводить документы внутри другого кластера (можно указывать относительные пути, к примеру ../Perl и !/Bug, или /, чтобы показать все документы).
Powered by POEM™ Engine Copyright © 2002-2005