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

Для документирования кода я также рекомендую Сфинкса. Текст ReStructured хорош, потому что это читаемо и несколько повышенное в простом тексте и может сделать хорошее преобразование задания в HTML и в PDF. Мне все еще нравится ЛАТЕКС за определенные вещи. Моя жена и я используем ЛАТЕКС для записи нашей рождественской буквы, которую мы отправляем по почте через обычную почту. Версия PDF довольно необычна с двумя столбцами, и заголовки и нижние колонтитулы. Версия HTML более проста. Я преобразовываю с plastex. Примеры здесь: http://fedibblety.com/annualReports

я не думаю, что любой двоичный формат является хорошим выбором (Word) для любого вида документа, что Вы хотели бы читать 10 лет с этого времени. Это - одна из хороших вещей о ЛАТЕКСЕ.

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

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

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

Если все остальное перестало работать, Вы могли бы захватить ЛАТЕКС к преобразователю XML и записать простую таблицу стилей XSLT, чтобы преобразовать его в HTML, или создать таблицу стилей CSS и присоединить его к XML-файлу непосредственно.

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

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

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

AsciiDoc похож на интересную возможность.

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

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

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

PlasTeX похож на хороший преобразователь латекса к HTML, хотя я не попробовал его сам.

Мой друг Rob Felty записал сообщение в блоге, расхваливающее его достоинства: http://blog.robfelty.com/2008/03/19/finally-a-better-latex-to-html-converter/

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

После многих лет мучения и нескольких неудачных начал, я собираюсь пересмотреть это, и я собираюсь дать Сфинкс попытка. Это может генерировать HTML или ПРОПИТАТЬ ЛАТЕКСОМ от текст ReStructured .

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

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

можно также использовать DocBook , если можно перенести для записи в нем. Существуют преобразователи от DocBook и до HTML и до ЛАТЕКСА (или к PDF непосредственно); пример последнего dblatex.

См. это сообщение: ЛАТЕКС по сравнению с DocBook .