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

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

Добавлено: Был задан еще один похожий вопрос:

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


person dreeves    schedule 03.01.2009    source источник


Ответы (16)


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

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

person Community    schedule 04.01.2009

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

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

См. Это сообщение: LaTeX против Docbook.

person ShreevatsaR    schedule 03.01.2009
comment
tex4ht тоже не пикник, и Hevea тоже. Как-то все они отстой. Отладка latex2html (0.96) была худшим опытом за всю мою карьеру программиста. Perl-скрипт tex4ht размером более 1 МБ иногда полностью закручивает ссылки, и есть некоторые недружелюбные новички (например, лигатуры) - person Marco van de Voort; 04.06.2009
comment
Все они сосут, но некоторые - меньше, чем другие. :-) (Вы пробовали plasTeX, BTW? plastex.sourceforge.net) - person ShreevatsaR; 04.06.2009
comment
Нет, я посмотрю, но то, что он написан на Python, меня не радует - person Marco van de Voort; 10.07.2009

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

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

person Brent.Longborough    schedule 03.01.2009
comment
Это как раз мой опыт. Наше руководство было написано в документальной книге, но его было громоздко редактировать, и поэтому мы никогда не работали над руководством (и в любом случае оно было довольно некрасивым). reST и Sphinx намного проще в использовании (и намного красивее). - person Paul Biggar; 29.07.2009

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

person ConcernedOfTunbridgeWells    schedule 03.01.2009
comment
+1 - вы также можете перейти прямо из docbook в pdf и html (и некоторые другие форматы, такие как файлы справки) без LaTeX между использованием docbook-xsl - person frankodwyer; 04.01.2009
comment
Бьюсь об заклад, верстка в PDF не так хороша, когда вы обойдете LaTeX, хотя :) Если не было больших изменений, о которых я не слышал ... - person Will Robertson; 03.03.2009

PlasTeX выглядит как хороший конвертер латекса в html, хотя я сам его не пробовал.

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

person dreeves    schedule 03.01.2009
comment
Ссылка неработающая :-( - у вас есть обновленная ссылка? - person jastram; 03.01.2014

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

person dreeves    schedule 03.01.2009

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

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

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

person dr. evil    schedule 03.01.2009

Прочтите о формате EPUB. Его формат электронной книги. http://en.wikipedia.org/wiki/EPUB

person Kamil    schedule 23.02.2012

Поскольку в ответе, в котором упоминается Asciidoc, немного примеров, вот некоторые из вещей, которые вы ищете за:

  • pdf, созданный с помощью Asciidoc.
  • cheatsheet с разметкой Asciidoc и результатом в формате html.
  • список публикаций, выполненных с помощью Asciidoc, включая книги О'Рейли и документацию git ( чтобы увидеть оба конца пользовательской шкалы).
person DavidG    schedule 06.03.2013

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

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

person dmckee --- ex-moderator kitten    schedule 03.01.2009

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

person dreeves    schedule 03.01.2009

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

person Jasper Bekkers    schedule 04.01.2009
comment
Интересный. Какой преобразователь латекса в xml вы имели в виду? - person Marco van de Voort; 04.06.2009

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

person Community    schedule 07.01.2009

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

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

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

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

С уважением, Майкл

person jastram    schedule 28.12.2013

У меня недостаточно моментов, чтобы прокомментировать, но чтобы подкрепить ответ пластекса, вот обновленная ссылка на пример пластекса:

http://robfelty.com/2008/03/19/finally-a-better-latex-to-html-converter

person David B    schedule 28.01.2014
comment
Обратите внимание, что ответы только по ссылкам не приветствуются, ответы SO должны быть конечной точкой поиска. для решения (по сравнению с очередной остановкой ссылок, которые со временем устаревают). Пожалуйста, подумайте о добавлении здесь отдельного синопсиса, сохранив ссылку в качестве справочной. - person kleopatra; 28.01.2014
comment
@kleopatra Это действительно полезная информация, и я надеюсь, что другие люди наткнутся на нее, прежде чем они собираются оставить комментарий. Вы объяснили, почему это плохой ответ, не бросая оскорблений. Хотел бы я дать вам еще +1. Извините, что наткнулся на 3 года. - person HowYaDoing; 26.06.2017

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

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

person Dmitri Nesteruk    schedule 03.01.2009
comment
Осмелюсь предположить, что фанаты LaTeX проголосовали против этого вопроса? - person Dmitri Nesteruk; 04.01.2009
comment
Это был не я, но предположение, что Word является адекватной заменой латекса, кажется мне очень сложным для защиты ... Обычно я предлагаю Word с таблицами стилей своим менее технически подкованным друзьям, но это не одно и то же. - person dmckee --- ex-moderator kitten; 04.01.2009
comment
Меня тоже не было, но вопрос гласит (в идеале в LaTeX), а html - это неинтересно и, похоже, плохо переносится на печатную страницу, и этот ответ рекомендует прямо противоположное тому, что требуется. Кроме того, да, я полагаю, что некоторые продвинутые типографские штучки, переход с Word, должно быть, звучало безумно :-) - person ShreevatsaR; 04.01.2009
comment
Многие хакеры работают в академических кругах, и на самом деле есть веские причины, по которым академики предпочитают это. Например, если вы много используете математику в своей документации, на мой взгляд, ничто другое не сравнится. Я думаю, что иметь противоположные мнения - это здорово. (Голос против может быть вызван просто недоверчивым тоном.) - person dreeves; 03.03.2009
comment
Что ж, если вы посмотрите, какой формат сейчас используют научные журналы и книжные издательства, то это Word, а не LaTeX. - person Dmitri Nesteruk; 04.03.2009
comment
Проголосовали против из-за того, что Word может печатать документы. - person Arafangion; 05.06.2009
comment
какой формат сейчас используют научные журналы и книжные издательства, это Word, а не LaTeX. false ... Как можно использовать Word для математических символов? - person Nadir SOUALEM; 28.10.2009
comment
Что ж, если вы посмотрите, какой формат сейчас используют научные журналы и книжные издательства, то это Word, а не LaTeX. Нет в моей сфере. Это 70% LateX - 30% слово в обработке сигналов. - person fulmicoton; 18.01.2010
comment
Для таких вещей есть причина: apeth.net/matt/iosbooktoolchain.html ... и просто потрогать LaTeX пальцем. (Я сам написал буквально тонны LaTeX, больше, чем средний академик.) - person sjas; 24.02.2013