Назад | Перейти на главную страницу

Система подготовки документов на основе текстовых файлов

Я ищу систему для подготовки внутренней технической документации, которая имеет следующие основные характеристики:

  1. исходные файлы должны быть удобочитаемыми текстовыми файлами, чтобы они хорошо работали с контролем версий
  2. поддерживает базовое форматирование (например, изображения, таблицы, жирный шрифт и т. д.)
  3. работает как с английскими, так и с китайскими иероглифами
  4. вывод в PDF

Я мог бы, например, пользователям писать HTML-страницы и распечатывать их в PDF, но это кажется сложным и подверженным ошибкам, а HTML едва ли «читается человеком». LaTeX также очень сложен и имеет множество зависимостей, которые могут затруднить обработку документов, которым несколько лет.

Есть ли у кого-нибудь лучшие предложения?

Сфинкс может помочь. http://sphinx.pocoo.org/

Вы используете какой-то серверный язык, например PHP?

если да, вы можете использовать библиотеку FPDF ... (http://html2fpdf.sourceforge.net/)

Вы в основном загружаете его BASIC html, и он выводит PDF ....

Как насчет этого расширения для markdown (пока markdown не добавит поддержку таблиц и т. Д.)

http://fletcherpenney.net/multimarkdown/features/

Я думаю, что лучший ответ здесь DocBook.
Он основан на XML, поэтому источник

а) небинарный,

б) читабельный, и

c) управление исходным кодом / удобство использования различий.

Вы можете использовать любые символы UTF-8, которые вам нравятся, если вы компилируете в PDF со шрифтом, который их поддерживает (если вы решили встроить openfont).

DocBook можно «скомпилировать» в несколько форматов, включая HTML, PDF и некоторые другие.

DocBook в PDF

Учебное пособие по DocBook

Я не использовал это лично, но слышал хорошие отзывы от других. Быстрый поиск показывает, что он поддерживает китайский язык и PDF. Очень простая разметка и, очевидно, ее легко изучить.

http://www.methods.co.nz/asciidoc/ Вы, очевидно, исследовали Latex / Tex. Вы думали об использовании редактора WYSIWYG, такого как Lyx? http://www.lyx.org/ Судя по тому, что существуют также проекты перевода LDP на китайский язык, поддержка китайского языка в LinuxDoc и Docbook тоже может быть хорошей. Набор инструментов для преобразования документов также, вероятно, будет более зрелым и свободным от ошибок.

Вот что я нашел при поиске уценки: Пандок. Он может конвертировать ряд форматов, включая Markdown и Textile, в PDF. Одного, кажется, не хватает, это контроля над версией механизмов разметки и форматирования, используемых при подготовке документов. Это делает вероятным, что исходные файлы необходимо будет постоянно обновлять, чтобы не отставать от последней версии Pandoc, что может стать серьезной проблемой в долгосрочной перспективе.

Одно из возможных решений: Docutils. Его формат «реструктурированного текста» более читабелен, чем другие варианты, и он имеет встроенную поддержку таблиц. Сопровождающие, похоже, хорошо документируют и поддерживают пакет, что должно сделать его относительно стабильным.