将 Confluence wiki 内容转换为硬拷贝/网络用户手册的工作流程?

发布于 2024-08-29 18:31:41 字数 1539 浏览 10 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

血之狂魔 2024-09-05 18:31:41

首先,我认为使用Confluence的优点是它是在线的并且可以由很多人同时更改。因此,通过打印出来,您会失去一些优点。

Confluence 提供了一些开箱即用的机制,您应该检查它们是否足以满足您的需要。

因此,请执行以下操作:

  1. 获取现有(小型)wiki 空间并将该 wiki 空间导出为 HTML 和 PDF。请参阅 Browse > 中的菜单项高级> HTML 导出和 PDF 导出
  2. 有一些选项可以选择包含哪些页面(按层次结构)或不包含哪些页面。
  3. 如果你想调整它,浏览>中有一些选项。空间管理> PDF 布局和 PDF 样式表(从未尝试过)。
  4. 对于 HTML,您当然可以首先调整 Confluence 导出的样式表。
  5. 如果这还不够,可能有一种方法可以使用 Browse > 为您自己构建导出。高级> XML Export 并使用其他一些技术以您想要的形式导出。

如果第一个实验足够了,那么工作流程就很简单,并且与上述四点类似。如果没有,使用 XML 格式构建自己的导出器可能需要做很多工作。

还有一点:所有这些的前提条件是您想要发布的内容恰好位于一个空间中。因此,您可能必须通过包含或排除页面来调整空间。

我过去有过以下经历......

  • 我发现无法调整导出(PDF)中页面的顺序。
  • PDF 的布局很奇怪(即使对于一个 wiki 页面也是如此),但同时这可能已经发生了变化。对于我的演讲(在 Confluence 中创建内容),我通过结合 CSS、Opera 中的打印预览并按正确的顺序收集 PDF 来打印它。
  • HTML 格式没问题,并且很容易隐藏我不想在 HTML 版本中显示的内容(例如. .hide { display: none; })。

First of all, I think the strong point in using Confluence is that it is online and changeable by a lot of people simultaneously. So by printing that out, you loose some of the strong points here.

Confluence provides some mechanism out-of-the-box, and you should check if they are sufficient for you.

So do the following:

  1. Take an existing (small) wiki space and export that wiki space into HTML and PDF. See the menu entries in Browse > Advanced > HTML Export and PDF Export
  2. There are options which pages to include (hierarchically) or not.
  3. If you want to tune it, there are some options in Browse > Space Admin > PDF Layout and PDF Stylesheet (never tried that).
  4. For HTML you may tune of course first the stylesheets exported by Confluence.
  5. If that is not sufficient, there may be a way to build an export for yourself by using Browse > Advanced > XML Export and use some other technology to export in the form you want to have it.

If this first experiment is sufficient, the workflow is straight forward and similar to the four points above. If not, the building of an own exporter in using the XML format may be a lot of work to do.

One more point: The per-requisit for all that is that the content that you want to publish lives in exactly one space. So you may have to tune your space by including or excluding pages

I had the following experience in the past ...

  • I found no way to tune the order of the pages in the export (PDF).
  • The layout of PDF was strange (even for one wiki page), but that may have changed in the meanwhile. For a lecture I give (creating the content in Confluence), I print it out by a combination of CSS, print preview in Opera and collecting the PDFs in the right order.
  • The HTML format was ok, and if was pretty easy to hide things that I did not want to show in the HTML version (eg. .hide { display: none; }.
贪了杯 2024-09-05 18:31:41

Confluence 用户指南是我发现的有关如何创建技术文档的最佳资源:

http://confluence.atlassian.com/display/DOC/Developing+Technical+Documentation+on+Confluence+Wiki

基本上概述了 Atlassian 如何使用自己的产品来创建其文档(非常自我参考的圈子)。

The Confluence User guide is the best resource that I've found regarding how to create technical documentation:

http://confluence.atlassian.com/display/DOC/Developing+Technical+Documentation+on+Confluence+Wiki

Basically an overview of how Atlassian dogfoods their own product to create its documentation (very self referential circle).

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文