reStructuredText
Расширение |
.rst |
---|---|
MIME-тип |
text/x-rst[1] |
Тип формата |
reStructuredText (сокращение: ReST, расширение файла: .rst) — облегчённый язык разметки. Хорошо применим для создания простых веб-страниц и других документов, а также в качестве вспомогательного языка при написании комментариев в программном коде. Используется в системе подготовки технической документации Docutils[2], написанной в основном Дэвидом Гуджером (David Goodger)[3]. reStructuredText можно считать потомком легковесных систем разметки StructuredText и Setext. Парсер reStructuredText поддерживает достаточное количество конечных форматов, в том числе PDF, HTML, ODT, LaTeX и формат презентаций S5.
Система документирования Sphinx[4], написанная для нужд документирования языка программирования Python на сайте docs.python.org и построенная на базе Docutils, применяется уже в нескольких десятках проектов[5]. ReST является одним из языков разметки, используемых на github[6], в частности, для README-файлов. Формат имеет статус экспериментального в проекте «Гутенберг»[7][8].
Пример синтаксиса
================== Название документа ================== Заголовок --------- Какой-нибудь простой текст, *текст курсивом*, **текст жирным шрифтом** и ссылка_: * элемент маркированного списка * элемент маркированного списка 1. Первый элемент нумерованного списка 2. Второй элемент нумерованного списка .. figure:: upload.wikimedia.org/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png Логотип русской Википедии .. _ссылка: ru.wikipedia.org
Разметка строк документации (внутри утроенных кавычек) в коде на Python[1]:
class Keeper(Storer):
"""
Keep data fresher longer.
Extend `Storer`. Class attribute `instances` keeps track
of the number of `Keeper` objects instantiated.
"""
instances = 0
"""How many `Keeper` objects are there?"""
def __init__(self):
"""
Extend `Storer.__init__()` to keep track of
instances. Keep count in `self.instances` and data
in `self.data`.
"""
Storer.__init__(self)
self.instances += 1
self.data = []
"""Store data in a list, most recent last."""
...
Поддержка текстовыми редакторами
Универсальные текстовые редакторы:
- Emacs (с помощью специального пакета rst-mode[9]),
- Vim (в базовой версии доступна подсветка синтаксиса),
- JED (доступен специальный режим[10]),
- ReText (специализированный редактор для языков разметки Markdown и ReST)[11],
- NoTex (редактор, работающий в браузере)[12],
- Geany,
- Sublime Text 2 / Sublime Text 3,
- gedit (доступен плагин)
Напишите отзыв о статье "ReStructuredText"
Примечания
- ↑ 1 2 [www.python.org/dev/peps/pep-0287/ PEP 287 — reStructuredText Docstring Format ]
- ↑ Mertz, David [www.ibm.com/developerworks/library/x-matters24/ XML Matters: reStructuredText]. IBM developerWorks (1 февраля 2003). Проверено 28 декабря 2011. [www.webcitation.org/6BhVT0UKT Архивировано из первоисточника 26 октября 2012].
- ↑ [www.ohloh.net/p/docutils docutils on Ohloh]
- ↑ [sphinx.pocoo.org/ Sphinx documentation generator]
- ↑ [sphinx.pocoo.org/examples.html Projects using Sphinx]
- ↑ [github.com/github/markup GitHub Markup]
- ↑ [www.gutenbergnews.org/20120307/pg-monthly-newsletter-2012-03-07/ PG Monthly Newsletter (2012-03-07)]
- ↑ [www.gutenberg.org/wiki/Gutenberg:RST RST]
- ↑ [docutils.sourceforge.net/docs/user/emacs.html Emacs Support for reStructuredText] (англ.)
- ↑ [jedmodes.sourceforge.net/mode/rst/ Mode for reStructuredText] (англ.)
- ↑ [www.linux-magazine.com/Online/Blogs/Productivity-Sauce/ReText-A-Text-Editor-with-Support-for-reStructuredText-and-Markdown Dmitri Popov, ReText: A Text Editor with Support for reStructuredText and Markdown]
- ↑ [notex.ch/ NoTex]
Ссылки
- [docutils.sf.net/rst.html Официальная страница] (англ.)
- Настройка Vim для удобного редактирования reStructuredText
Отрывок, характеризующий ReStructuredText
Через минуту толстая большая фигура старика, в полной парадной форме, со всеми регалиями, покрывавшими грудь, и подтянутым шарфом брюхом, перекачиваясь, вышла на крыльцо. Кутузов надел шляпу по фронту, взял в руки перчатки и бочком, с трудом переступая вниз ступеней, сошел с них и взял в руку приготовленный для подачи государю рапорт.Беготня, шепот, еще отчаянно пролетевшая тройка, и все глаза устремились на подскакивающие сани, в которых уже видны были фигуры государя и Волконского.
Все это по пятидесятилетней привычке физически тревожно подействовало на старого генерала; он озабоченно торопливо ощупал себя, поправил шляпу и враз, в ту минуту как государь, выйдя из саней, поднял к нему глаза, подбодрившись и вытянувшись, подал рапорт и стал говорить своим мерным, заискивающим голосом.
Государь быстрым взглядом окинул Кутузова с головы до ног, на мгновенье нахмурился, но тотчас же, преодолев себя, подошел и, расставив руки, обнял старого генерала. Опять по старому, привычному впечатлению и по отношению к задушевной мысли его, объятие это, как и обыкновенно, подействовало на Кутузова: он всхлипнул.
Государь поздоровался с офицерами, с Семеновским караулом и, пожав еще раз за руку старика, пошел с ним в замок.
Оставшись наедине с фельдмаршалом, государь высказал ему свое неудовольствие за медленность преследования, за ошибки в Красном и на Березине и сообщил свои соображения о будущем походе за границу. Кутузов не делал ни возражений, ни замечаний. То самое покорное и бессмысленное выражение, с которым он, семь лет тому назад, выслушивал приказания государя на Аустерлицком поле, установилось теперь на его лице.
Когда Кутузов вышел из кабинета и своей тяжелой, ныряющей походкой, опустив голову, пошел по зале, чей то голос остановил его.
– Ваша светлость, – сказал кто то.
Кутузов поднял голову и долго смотрел в глаза графу Толстому, который, с какой то маленькою вещицей на серебряном блюде, стоял перед ним. Кутузов, казалось, не понимал, чего от него хотели.
Вдруг он как будто вспомнил: чуть заметная улыбка мелькнула на его пухлом лице, и он, низко, почтительно наклонившись, взял предмет, лежавший на блюде. Это был Георгий 1 й степени.
На другой день были у фельдмаршала обед и бал, которые государь удостоил своим присутствием. Кутузову пожалован Георгий 1 й степени; государь оказывал ему высочайшие почести; но неудовольствие государя против фельдмаршала было известно каждому. Соблюдалось приличие, и государь показывал первый пример этого; но все знали, что старик виноват и никуда не годится. Когда на бале Кутузов, по старой екатерининской привычке, при входе государя в бальную залу велел к ногам его повергнуть взятые знамена, государь неприятно поморщился и проговорил слова, в которых некоторые слышали: «старый комедиант».
Неудовольствие государя против Кутузова усилилось в Вильне в особенности потому, что Кутузов, очевидно, не хотел или не мог понимать значение предстоящей кампании.
Когда на другой день утром государь сказал собравшимся у него офицерам: «Вы спасли не одну Россию; вы спасли Европу», – все уже тогда поняли, что война не кончена.
Один Кутузов не хотел понимать этого и открыто говорил свое мнение о том, что новая война не может улучшить положение и увеличить славу России, а только может ухудшить ее положение и уменьшить ту высшую степень славы, на которой, по его мнению, теперь стояла Россия. Он старался доказать государю невозможность набрания новых войск; говорил о тяжелом положении населений, о возможности неудач и т. п.