Сфинкс для написания "параллельного текста" - PullRequest
4 голосов
/ 13 декабря 2010

Проблема: я пытаюсь написать «параллельный текст», используя reStructuredText .Под «параллельным текстом» я подразумеваю что-то вроде аннотированных художественных произведений, где текст находится в двух столбцах.В левом столбце содержится основной текст, а в правом столбце - комментарий.Я буду использовать sphinx для создания документации HTML и Latex из него.

У меня есть следующие требования:

  1. Как упоминалось выше, я должен быть в состояниивведите текст в два столбца, один для основного текста и один для аннотаций.
  2. Аннотации могут быть «уровнем предложения» и не всегда будут «уровнем абзаца».Т.е. я хочу иметь возможность комментировать разные предложения в абзаце или во всем абзаце.
  3. Было бы здорово иметь режим, в котором все аннотации отключены, поэтому выходные данные HTML и Latex содержат толькоосновной текст.В этом случае я хотел бы иметь возможность использовать всю «недвижимость» среды, а не только столбец.
  4. Было бы очень приятно иметь возможность «списка аннотаций», если это возможно.

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

Кто-нибудь делал что-то подобное раньше?

Спасибо!

1 Ответ

2 голосов
/ 21 декабря 2010

Это похоже на сноски? Я бы посоветовал взглянуть на http://ignorethecode.net/blog/2010/04/20/footnotes/

Если они соответствуют вашим целям, их интеграция не должна быть слишком сложной. Сфинкс выводит сноски специальным классом. Замена

$ ( "А [отн = 'Сноска']")

в коде, с выбранным вами селектором jquery css вы получите то, что вы хотите

...