Table of Contents

Confluence layer

Table of ContentsClose


1. Description

This layer adds support for Atlassian Confluence.

1.1. Features:

  • Creating/editing of Confluence pages
  • Exporting of org buffers to Confluence wiki format

2. Install

2.1. Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add confluence to the existing dotspacemacs-configuration-layers list in this file.

3. Configuration

Define the variable confluence-url to point on your Confluence server xmlrpc endpoint.

(setq confluence-url "https://<host>/confluence/rpc/xmlrpc")

To be able to convert from xml format to the wiki format you need to install the tool xsltproc.

4. About xml and wiki formats

In confluence version 4.0, Atlassian decided to change the wiki format. They did away with the wiki format and changed the internal document format to xml.

By default the new xml format is used to edit the files. You can convert a Confluence page buffer to wiki format with SPC m TAB, it will be automatically converted back to xml before sending it to the server.

Note that xml to wiki conversion is not 100% accurate.

Although it is not recommended you can set the variable confluence-xml-convert-to-wiki-on-load to t in order to automatically convert xml content to wiki content on page load.

5. Key bindings

5.1. Confluence page

Key binding Description
SPC m TAB toggle the content type to wiki format or xml format
SPC m s save the buffer on the confluence server as a minor edit
SPC m S save the buffer on the confluence server as a major edit

5.2. Org

Key binding Description
SPC m e c in a org buffer, export the buffer to Confluence wiki format

Author: root

Created: 2024-05-17 Fri 04:17