github/ox-confluence-en
1
0
Fork 0
mirror of https://github.com/correl/ox-confluence-en.git synced 2024-11-23 11:09:54 +00:00
Code Issues Projects Releases Packages Wiki Activity
ox-confluence-en/README.org
Correl Roush e29814c366 Initial commit
2018-08-31 13:59:07 -04:00

1.7 KiB
Raw Blame History

ox-confluence-en

An enhanced Confluence wiki markup exporter for Org-mode.

This exporter is based on (and therefore requires) ox-confluence, which is included in org-contrib. It extends and improves upon it in several ways:

  • The exported wiki syntax is cleaned up, resolving various rendering quirks.
  • An entry is added to the exporter menu for ease of use.
  • Status badge macros are used when exporting todo keywords.
  • Support is added for exporting PlantUML graphs as a confluence macro.

Features

TODO keywords exported as status badges

If your document exports TODO keywords (todo:t in #+OPTIONS), they will be rendered using Confluence's status badge macro. TODO keywords will be colored red, and DONE keywords will be colored green.

PlantUML, Graphviz, and Ditaa graphs

if ox-confluence-en-use-plantuml-macro is set to t, PlantUML, Graphviz, and Ditaa source code blocks will be exported using the Confluence PlantUML macro, allowing them to be included in exported documents without having to upload the resulting images separately (instead including the PlantUML source in the document, to be rendered on the server). This requires the free Confluence PlantUML plugin to be installed on the server.

Lists as tables

Any list can be exported as a table, by setting :as-table to t using #+ATTR_CONFLUENCE:

  #+ATTR_CONFLUENCE: :as-table t
  - Thing one
  - Thing two

This is even more useful when using a description list, as the first column will be rendered as headings:

  #+ATTR_CONFLUENCE: :as-table t
  - Author :: John Doe
  - Published :: 2018-08-09