Подтвердить что ты не робот

Как лучше всего писать документацию, предназначенную как для HTML, так и для PDF?

Конвертеры Latex-to-html, которые я видел в прошлом, были довольно ужасны. Редактирование raw html не забавно и, похоже, не хорошо переводится на печатную страницу. Как другие решают эту проблему? Ссылки на примеры (как pdf, так и html) были бы замечательными.

Добавлено: Еще один подобный вопрос был просто задан:

Какой язык форматирования следует использовать для документации по проекту

4b9b3361

Ответ 1

Для документирования кода я также рекомендую Sphinx. ReStructured Text хорош, потому что он доступен для чтения и несколько отличается открытым текстом, а также может легко преобразовать его в html и pdf. Я все еще люблю LaTeX для определенных вещей. Моя жена и я используем LaTeX, чтобы написать наше рождественское письмо, которое мы отправляем по почте через уличную почту. Версия в формате pdf довольно интересна, с двумя колонками и верхними колонтитулами. Версия html проще. Я конвертирую с plastex. Примеры здесь: http://fedibblety.com/annualReports

Я не думаю, что какой-либо бинарный формат является хорошим выбором (Word) для любого документа, который вы хотели бы прочитать через 10 лет. Это одна из приятных вещей в LaTeX.

Ответ 2

Да, конвертеры LaTeX-to-HTML, используемые для сосания (вы, вероятно, пробовали LaTeX2HTML), но в последнее время они улучшились. Tex4ht очень настраивается и создает хороший XHTML + CSS. См. Также другие преобразователи.

Вы также можете использовать Docbook, если вы можете писать в нем. Существуют конвертеры из DocBook в HTML и LaTeX (или непосредственно в PDF); примером последнего является dblatex.

Смотрите это сообщение: LaTeX vs Docbook.

Ответ 3

После многих лет мучений и нескольких ложных запусков я собираюсь вернуться к этому, и я собираюсь дать Sphinx попробуйте. Он может генерировать HTML или LaTeX из ReStructured Text.

Я надеюсь, что это будет гораздо более легкий вариант, чем полный DocBook, но со многими преимуществами.

Ответ 4

Вы можете сделать шаг назад и использовать что-то вроде DocBook и визуализировать PDF через LaTeX и HTML прямо из файлов DocBook. В качестве альтернативы, Adobe Technical Communication Suite (Framemaker) предоставит вам документ с одним источником в PDF и HTML. См. эту публикацию для краткого изложения различных систем технической документации.

Ответ 6

AsciiDoc выглядит интересной возможностью.

Ответ 7

Это личный выбор, но Латекс в теории идеален, но на практике это боль в заднице. Я использую HTML-редактор VS.NET + необработанный HTML-код, когда мне это нужно.

Итак, я считаю, что лучший редактор для WSIWYG HTML-редактора. Вы всегда можете использовать простой инструмент для преобразования его в PDF, и вы всегда можете редактировать HTML, когда вам нужно что-то продвинутое. Также вам проще разместить онлайн, когда вам нужно.

То, как я управляю документацией по программному обеспечению и прекрасно работаю для меня.

Ответ 9

Так как ответ, упоминающий Asciidoc, был несколько коротким на примерах, вот некоторые из вещей, которые вы ищете:

  • A pdf, сгенерированный с помощью Asciidoc
  • A cheatsheet рядом с разметкой Asciidoc и результатом html.
  • A список публикаций, выполненных с использованием Asciidoc, включая книги O'Reilly и документацию git (чтобы увидеть оба конца пользовательской шкалы).

Ответ 10

Я не уверен, что латекс действительно лучший инструмент для этого. Проблема, с которой вы столкнулись с обычным латексным конвертером html, указывает на проблему: html прост не так выразителен, как латекс.

Если вы настаиваете на использовании латекса для html, позаботьтесь о том, чтобы использовать ограниченное подмножество, которое может конвертировать разумно.

Ответ 11

Я использовал TeXinfo в прошлом, и он отлично справляется. Вот пример: http://yootles.com/api. Я бы предпочел придерживаться LaTeX, но вместо того, чтобы использовать другой язык.

Ответ 12

Если все остальное не удается, вы можете захватить конвертер LaTeX в XML и написать простую таблицу стилей XSLT, чтобы преобразовать ее в HTML, или создать таблицу стилей CSS и напрямую прикрепить ее к XML файлу.

Ответ 13

Мы используем WebWorks ePublisher (www.webworks.com), который предлагает как множественные форматы с одним источником (мы используем Word), так и возможность вывода во многие форматы вывода (мы выводим в Adobe PDF и интерактивную справку (.CHM).

Ответ 14

Мы столкнулись с этой проблемой в академическом проекте, в котором используется программное обеспечение Eclipse, и мы использовали plastex для преобразования Latex в HTML и Eclipse Help. Работа на нем была довольно сложной, но конечный результат выглядел очень красиво. Здесь вы можете увидеть все три версии:

http://handbook.event-b.org/

Кроме того, поскольку это открытый проект, доступны сценарии (скрипты сборки). У нас есть система непрерывной сборки (Jenkins), которая восстанавливает все, когда проверяется новый латекс. Это особенно приятно, так как вкладчикам не нужно устанавливать инструментальную цепочку на своих системах. Они просто проверяют новый латекс и проверяют на сервере, был ли HTML создан правильно. Источники:

http://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/Handbook/org.rodinp.handbook.feature/

Лучший, Майкл

Ответ 16

LaTeX? Шутки в сторону? Я не знал, что кто-то за пределами академии все еще использовал его. Я бы пошел с HTML, который вы можете сохранить как PDF из веб-браузера. Если у вас действительно есть некоторые продвинутые типографские материалы, переходите к Word вместо этого - у него есть способ сохранить в HTML (возможно, не такой чистый, как хотелось бы), и вы можете сохранить его как PDF со свободным подключаемым модулем (можно загрузить отдельно).

О, и я не стал бы использовать такие вещи, как InDesign - они переполнены. Кроме того, не стоит платить за Acrobat Professional - есть доступные бесплатные решения.