From: Marc Ihm <marc@ihm.name>
To: emacs-orgmode@gnu.org
Subject: [PATCH] ox-confluence.el: Handle checkboxes and inactive timestamps correctly
Date: Tue, 28 Feb 2017 20:08:07 +0100 [thread overview]
Message-ID: <8660ju2kx4.fsf@ihm.name> (raw)
[-- Attachment #1: Type: text/plain, Size: 503 bytes --]
Hello,
attached please find a patch for contrib/ox-confluence.el (authored by
Sébastien Delafond); the patch simply translates and fixes some selected
enhancements from ox-confluence-en.el (authored by Correl Roush).
As a result ox-confluence.el encodes square brackets in checkboxes or
inactive timestamps, so that they no longer collide with the native
link-syntax of atlassian confluence.
It would be great, if someone could review and apply this patch if
appropriate.
Best regards,
Marc Ihm
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: fix handling of square brackets --]
[-- Type: text/x-patch, Size: 3773 bytes --]
--- a/contrib/lisp/ox-confluence.el 2017-02-28 19:52:25.707036600 +0100
+++ b/contrib/lisp/ox-confluence.el 2017-02-28 19:52:42.225721900 +0100
@@ -38,6 +38,7 @@
;; Define the backend itself
(org-export-define-derived-backend 'confluence 'ascii
+ :filters-alist '((:filter-final-output . org-confluence-fix-timestamps))
:translate-alist '((bold . org-confluence-bold)
(code . org-confluence-code)
(example-block . org-confluence-example-block)
@@ -84,14 +85,23 @@
(defun org-confluence-item (item contents info)
(let* ((plain-list (org-export-get-parent item))
(type (org-element-property :type plain-list))
- (bullet (if (eq type 'ordered) ?\# ?\-)))
- (concat (make-string (1+ (org-confluence--li-depth item)) bullet)
- " "
- (if (eq type 'descriptive)
- (concat "*"
- (org-export-data (org-element-property :tag item) info)
- "* - "))
- (org-trim contents))))
+ (depth (1+ (org-confluence--li-depth item)))
+ (checkbox-possibly (cl-case (org-element-property :checkbox item)
+ (on "*{{(X)}}* ")
+ (off "*{{( )}}* ")
+ (trans "*{{(-)}}* "))))
+ (cl-case plain-list
+ (descriptive
+ (concat (make-string depth ?-) " " checkbox-possibly
+ (org-export-data (org-element-property :tag item) info) ": "
+ (org-trim contents)))
+ (ordered
+ (concat (make-string depth ?#) " " checkbox-possibly
+ (org-trim contents)))
+ (t
+ (concat (make-string depth ?-)
+ " " checkbox-possibly
+ (org-trim contents))))))
(defun org-confluence-fixed-width (fixed-width contents info)
(org-confluence--block
@@ -106,12 +116,18 @@
(format "\{\{%s\}\}" (org-element-property :value code)))
(defun org-confluence-headline (headline contents info)
- (let ((low-level-rank (org-export-low-level-p headline info))
- (text (org-export-data (org-element-property :title headline)
- info))
- (level (org-export-get-relative-level headline info)))
- ;; Else: Standard headline.
- (format "h%s. %s\n%s" level text
+ (let* ((low-level-rank (org-export-low-level-p headline info))
+ (text (org-export-data (org-element-property :title headline)
+ info))
+ (todo (org-export-data (org-element-property :todo-keyword headline)
+ info))
+ (level (org-export-get-relative-level headline info))
+ (todo-text (if (or (not org-export-with-todo-keywords)
+ (string= todo ""))
+ ""
+ (format "*{{%s}}* " todo))))
+
+ (format "h%s. %s%s\n%s" level todo-text text
(if (org-string-nw-p contents) contents
""))))
@@ -167,7 +183,7 @@
(concat
(when (org-export-table-row-starts-header-p table-row info)
"|")
- contents "|")))
+ " " contents " |")))
(defun org-confluence-template (contents info)
(let ((depth (plist-get info :with-toc)))
@@ -199,6 +215,23 @@
(setq item (org-export-get-parent item)))
depth))
+;; Define output filter
+(defun org-confluence-fix-timestamps (text back-end info)
+ "Mask brackets of timestamps in final output, so that
+ confluence does not misinterpret them as links."
+ (with-temp-buffer
+ (insert text)
+ (goto-char (point-min))
+ (while (search-forward-regexp org-ts-regexp-both nil t))
+ (goto-char (match-beginning 0))
+ (when (string= (char-to-string (following-char)) "[")
+ (delete-char 1)
+ (insert "(")
+ (goto-char (match-end 0))
+ (delete-char -1)
+ (insert ")"))
+ (buffer-substring (point-min) (point-max))))
+
;; main interactive entrypoint
(defun org-confluence-export-as-confluence
(&optional async subtreep visible-only body-only ext-plist)
next reply other threads:[~2017-02-28 19:08 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-28 19:08 Marc Ihm [this message]
2017-03-01 13:51 ` [PATCH] ox-confluence.el: Handle checkboxes and inactive timestamps correctly Nicolas Goaziou
2017-03-01 13:54 ` Nicolas Goaziou
2017-03-01 20:48 ` Marc Ihm
2017-03-02 19:33 ` Marc Ihm
2017-03-02 21:16 ` Nicolas Goaziou
2017-03-03 20:50 ` Marc Ihm
2017-03-05 17:41 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8660ju2kx4.fsf@ihm.name \
--to=marc@ihm.name \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.