如何最好地编写针对HTML和PDF的文档?

时间:2009-01-03 19:59:19

标签: html pdf documentation latex pdf-generation

我过去见过的Latex-to-html转换器非常糟糕。编辑原始HTML并不好玩,似乎不能很好地转换为打印页面。别人怎么解决这个问题?示例链接(pdf和html)都很棒。

补充:刚问了另一个类似的问题:

What formatting language should I use for project documentation

16 个答案:

答案 0 :(得分:12)

为了记录代码,我还推荐Sphinx。 ReStructured Text很好,因为它是可读的并且在明文中有点标记,并且可以很好地转换为html和pdf。对于某些事情,我仍然喜欢LaTeX。我的妻子和我用LaTeX写我们的圣诞信,我们通过蜗牛邮件寄出。 pdf版本非常华丽,有两列,页眉和页脚。 html版本更简单。我用plastex转换。这里的例子: http://fedibblety.com/annualReports

我不认为任何二进制格式对于您可能希望在10年后阅读的任何类型的文档都是一个不错的选择(Word)。这是LaTeX的好处之一。

答案 1 :(得分:5)

是的,LaTeX到HTML的转换器曾经很糟糕(你可能已经尝试过LaTeX2HTML),但是最近它们变得更好了。 Tex4ht具有高度可配置性,可生成出色的XHTML + CSS。另请参阅other converters

如果您愿意写下来,也可以使用Docbook。有从DocBook到HTML和LaTeX(或直接到PDF)的转换器;后者的一个例子是dblatex

请参阅此帖:LaTeX vs Docbook

答案 2 :(得分:5)

经过多年的痛苦和几次错误的开始,我即将重新审视这一点,我将尝试Sphinx。它可以从ReStructured Text生成HTML或LaTeX。

我希望它比完整的DocBook更加“轻松”,但具有许多优点。

答案 3 :(得分:4)

您可以退后一步,使用类似DocBook的内容,直接从DocBook文件通过LaTeX和HTML渲染为PDF。或者,Adobe技术通信套件(Framemaker)将允许您将文档单一来源为PDF和HTML。有关各种技术文档系统的详细信息,请参阅this posting

答案 4 :(得分:1)

PlasTeX看起来像一个很好的乳胶到HTML转换器,虽然我自己没有尝试过。

我的朋友Rob Felty撰写了一篇赞美其优点的博客文章:   http://blog.robfelty.com/2008/03/19/finally-a-better-latex-to-html-converter/

答案 5 :(得分:1)

AsciiDoc看起来很有趣。

答案 6 :(得分:1)

这是个人选择,但理论上乳胶是完美的,但在实践中它是痛苦的。我在需要时使用VS.NET HTML编辑器+原始HTML编辑。

所以我认为使用WSIWYG HTML编辑器是最佳选择。您始终可以使用简单的工具将其转换为PDF,并且您可以在需要高级内容时始终编辑HTML。此外,您可以在需要时更轻松地上线。

这就是我管理软件文档的方式,对我来说很好。

答案 7 :(得分:1)

了解EPUB格式。它的电子书格式。 http://en.wikipedia.org/wiki/EPUB

答案 8 :(得分:1)

由于提及Asciidoc的答案在示例上有点简短,以下是您正在寻找的一些内容:

  • 使用Asciidoc生成的pdf
  • A cheatsheet与Asciidoc标记和html结果并排。
  • 使用Asciidoc完成的list个出版物,包括O'Reilly书籍和git文档(用于查看用户规模的两端)。

答案 9 :(得分:0)

我不确定乳胶是否真的是最好的工具。你使用通常的乳胶到html转换器的问题表明了问题:html很简单,不像乳胶一样富有表现力。

如果你坚持使用html乳胶,请注意使用可以合理转换的有限子集。

答案 10 :(得分:0)

我过去曾使用TeXinfo,但它做得很好。这是一个例子:http://yootles.com/api。我宁愿坚持使用LaTeX,而不是使用其他语言。

答案 11 :(得分:0)

如果其他一切都失败了,您可以使用LaTeX to XML转换器并编写一个简单的XSLT样式表将其转换为HTML,或者创建一个CSS样式表并将其直接附加到XML文件。

答案 12 :(得分:0)

我们一直在使用WebWorks ePublisher(www.webworks.com),它提供多种单一来源格式(我们使用Word)并能够输出多种输出格式(我们输出到Adobe PDF和在线帮助( .CHM)。

答案 13 :(得分:0)

我们在涉及Eclipse软件的学术项目中遇到了这个问题,我们使用plastex将Latex转换为HTML和Eclipse帮助。让它工作非常困难,但最终结果看起来非常好。你可以在这里看到所有三个版本:

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

此外,由于这是一个开放项目,因此可以使用代码(构建脚本)。我们有一个连续构建系统(Jenkins),可以在签入新Latex时重建所有内容。这一点特别好,因为贡献者不需要在他们的系统上安装工具链。他们只是检查新的Latex并检查服务器是否正确生成了HTML。来源:

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

最好,迈克尔

答案 14 :(得分:0)

我没有足够的评论点,但为了支持plastex答案,这里是更新的plastex示例链接:

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

答案 15 :(得分:-16)

乳胶?真的吗?我不知道学术界以外的人还在使用它。我会使用HTML,您可以从Web浏览器另存为PDF。如果你真的必须有一些高级的印刷内容,那么请使用Word - 它有一种保存为HTML的方法(可能不像人们想的那样干净),你可以用免费的插件保存为PDF(可单独下载)

哦,我不打算使用像InDesign这样的东西 - 它们有点矫枉过正。此外,不要为Acrobat Professional付费 - 可用的解决方案很多。