<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article  PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN'  'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>ПомощьПоПарсерам/ReStructuredText</title></articleinfo><section><title>Парсер ReStructuredText</title><para>ReStructuredText — это легкий для чтения синтаксис разметки текста, парсер для которого включен в состав <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>. Он удобен для документирования программ непосредственно в исходном коде (как docstrings в Python), для быстрого создания простых веб-страниц и для автономных документов. ReStructuredText допускает расширяемость при применении в конкретных прикладных областях. ReStructuredText — это переработка и переосмысление легковесных систем разметки текста StructuredText и Setext. </para><para>Новички в Вики часто считают разметку ReStructuredText более естественной и простой для изучения, чем разметка, используемая в <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> по умолчанию. </para><section><title>Установка</title><para>Для того, чтобы получить возможность использовать эту разметку, необходимо установить пакет Python docutils, который используется в <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> для поддержки ReStructuredText.   </para><para>Необходимая версия пакета docutils зависит от версии <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>. </para><para>Если этот текст — часть Вашей инсталляции <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>, вероятно, у Вас установлен <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> версии 1.5 или более новой, для которой (по состоянию на январь 2006) требуется docutils версии 0.4.0 или более новой, или новейший вариант (snapshot) версии 0.3.10. Если <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> используется под Linux, пакет docutils, вероятно, уже доступен в составе Вашего дистрибутива Linux. Так, например, в Debian GNU/Linux достаточно просто набрать <code>apt-get install python-docutils</code>. В других дистрибутивах Linux могут использоваться иные варианты установки пакетов, см. документацию к Вашему дистрибутиву Linux. </para></section><section><title>Парсер в МойнМойн</title><para>Парсер поддерживает те же возможности, что и редактор docutils HTML writer. Однако, некоторые особенности были немного изменены для улучшения взаимодействия с <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>. Отличия перечислены ниже. </para></section><section><title>Использование ReST в МойнМойн</title><section><title>Пример</title>Rendering of reStructured text is not possible, please install Docutils.<!--RAW HTML: Rendering of reStructured text is not possible, please install Docutils.--><screen><![CDATA[Это *очень* простой пример. Если Вы видите две звездочки, окружающие слово "очень" в предыдущем предложении, это означает, что модуль docutils установлен неверно (или не установлен вообще). Если модуль docutils установлен, слово "очень" должно отображаться курсивом, а весь этот абзац — отображаться не в специальном формате, используемом для исходного кода программ, а как обычная часть страницы.]]></screen></section><section><title>Неопределенные ссылки</title><para>Неопределенные ссылки используются для создания вики-ссылок. В обычной ситуации, неопределенная ссылка приводит к ошибке в reStructuredText документе. Но, чтобы обеспечить поведение, аналогичное Вики, неопределенные ссылки создают ссылки на вики-страницы, используя имя такой ссылки в качестве имени этой вики-страницы. Например: </para><screen><![CDATA[{{{#!rst
Это ссылка на страницу МойнМойн с именем SecondPage_.
}}}]]></screen>Rendering of reStructured text is not possible, please install Docutils.<!--RAW HTML: Rendering of reStructured text is not possible, please install Docutils.--><screen><![CDATA[Это ссылка на страницу МойнМойн с именем SecondPage_.]]></screen><para>Вышеприведенный пример содержит reStructuredText ссылку на &quot;<ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/SecondPage#">SecondPage</ulink>&quot;.  В обычной ситуации такая ссылка вызвала бы  в парсере docutils ошибку &quot;ссылка на неизвестный объект&quot;, так как в документе нет части с именем &quot;<ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/SecondPage#">SecondPage</ulink>&quot;. Но в парсере <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> cсылка &quot;<ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/SecondPage#">SecondPage</ulink>_&quot; вместо генерации ошибки создает ссылку на страницу <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> с именем &quot;<ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/SecondPage#">SecondPage</ulink>&quot;. </para></section><section><title>Поддержка специфичных для МойнМойн схем ссылок</title><para>Спецефичные для <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> схемы ссылок поддерживаются, если они указываются в reStructuredText-гиперссылке явным образом. Например: </para><screen><![CDATA[{{{#!rst
Это ссылка на страницу attachment__.
]]><![CDATA[
__ attachment:Attachment.zip
}}}]]></screen>Rendering of reStructured text is not possible, please install Docutils.<!--RAW HTML: Rendering of reStructured text is not possible, please install Docutils.--><screen><![CDATA[Это ссылка на страницу attachment__.
]]><![CDATA[
__ attachment:Attachment.zip]]></screen><para>Вышеприведенный пример создает ссылку на вложение с названием Attachment.zip. Если на странице нет вложения, ссылка будет заменена на стандартный текст <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> с приглашением загрузить вложение. Поддерживаются следующие стандартные схемы ссылок <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>: </para><itemizedlist><listitem><para><code>wiki:</code> </para></listitem><listitem><para><code>attachment:</code> </para></listitem><listitem><para><code>inline:</code> </para></listitem><listitem><para><code>drawing:</code> </para></listitem></itemizedlist></section><section><title>Включённые изображения</title><para>Директивы изображений docutils, не являющиеся URL-ами, преобразуются в ссылки <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> <code>inline:</code>. Это обеспечивает желаемый результат — вставку изображения в документ. Если вложения с изображением не существует, будет отображено стандартное приглашение <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> для загрузки нового вложения. Например: </para><screen><![CDATA[{{{#!rst
Это фотография, которую я сделал вчера |image|
]]><![CDATA[
.. |image| image:: Yesterday.jpg
}}}]]></screen>Rendering of reStructured text is not possible, please install Docutils.<!--RAW HTML: Rendering of reStructured text is not possible, please install Docutils.--><screen><![CDATA[Это фотография, которую я сделал вчера |image|
]]><![CDATA[
.. |image| image:: Yesterday.jpg]]></screen><para>В вышеприведенном примере будет выполнена вставка изображения &quot;Yesterday.jpg&quot; вместо <code>|image|</code>. </para></section><section><title>Экспериментальные возможности</title><para>Директивы включения и макроса на данный момент имеют статус экспериментальных, так как не были тщательно протестированы. Предположительно, они работают задуманным образом, но пока широко не использовались. </para><section><title>Поддержка включения</title><para>Директива включения reStructuredText поддерживается с некоторыми ограничениями. Эта директива позволяет включать в страницу вики-страницы из той же вики(не считая вложений). Включаемые страницы должны быть оформлены с использованием разметки reStructuredText (страницы в вики-разметке приведут к получению неверно отформатированных документов). Например, нижеприведенный код вставит верхний и нижний колонтитулы, окружающие содержимое страницы. </para><screen><![CDATA[{{{#!rst
.. include:: header
]]><![CDATA[
Текст самого документа.
]]><![CDATA[
.. include:: footer
}}}]]></screen><para>Количество включаемых документов ограничено десятью. Это сделано для защиты от DoS атак, использующих рекурсивные директивы включения. </para></section><section><title>Поддержка Макро</title><para>Парсер reStructuredText в <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> добавляет новую, специфичную для <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> директиву макро. Эта директива позволяет получить доступ к макрокоммандам <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> из документа reStructuredText. Например: </para><screen><![CDATA[{{{#!rst
Использование макрокомманды поиска заголовков для вставки поля поиска по заголовкам страниц.
]]><![CDATA[
.. macro:: <<TitleSearch>>
}}}]]></screen>Rendering of reStructured text is not possible, please install Docutils.<!--RAW HTML: Rendering of reStructured text is not possible, please install Docutils.--><screen><![CDATA[Использование макро поиска заголовков для вставки поля поиска по заголовкам страниц.
]]><![CDATA[
.. macro:: <<TitleSearch>>]]></screen></section></section><section><title>Известные проблемы</title><itemizedlist><listitem><para>Docutils и <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink> используют разные наборы CSS-директив. Некоторые директивы совпадают, некоторые — нет. Например, директива заметки не отображается с любым особым форматированием. Эта проблема особенно актуальна при использовании темы с панелью справа вместе с директивой боковой панели docutils (sidebar). Боковая панель docutils заменяет боковую панель <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>. На данный момент рекомендуется не использовать директиву боковой панели в <ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9C%D0%BE%D0%B9%D0%BD%D0%9C%D0%BE%D0%B9%D0%BD#">МойнМойн</ulink>. </para></listitem><listitem><para>Возможности, связанные с получением внешних URL и файлов с локальных дисков не поддерживаются парсером в целях обеспечения локальной безопасности. Кроме того необработанные роли и другие возможности, которые могут дать пользователю возможность выводить необработанный HTML код, также запрещены. </para></listitem></itemizedlist></section><section><title>Ссылки</title><itemizedlist><listitem><para><ulink url="http://docutils.sourceforge.net/rst.html">reStructuredText</ulink> </para></listitem><listitem><para><ulink url="http://docutils.sourceforge.net/docs/user/rst/quickref.html">Quick Reference</ulink> </para></listitem><listitem><para><ulink url="http://docutils.sourceforge.net/">Docutils</ulink> </para></listitem><listitem><para><ulink url="http://research.math.uvt.ro/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/wiki/%D0%9F%D0%BE%D0%BC%D0%BE%D1%89%D1%8C%D0%9F%D0%BE%D0%9F%D0%B0%D1%80%D1%81%D0%B5%D1%80%D0%B0%D0%BC/ReStructuredText/RstPrimer#">A ReStructuredText Primer</ulink> </para></listitem></itemizedlist></section></section></section></article>