diff options
| author | Stig Brautaset <stig@brautaset.org> | 2020-02-18 12:10:06 +0000 |
|---|---|---|
| committer | Stig Brautaset <stig@brautaset.org> | 2020-02-18 22:55:38 +0000 |
| commit | b027ba4886afa203b21928e3056b4ba9b89c7253 (patch) | |
| tree | 7928e5037ad222f96a1b17febc5ac2deb1a42096 | |
| parent | 2b35c0b4e016568b91b4ab349803a26ac834ccf7 (diff) | |
Regenerate ox-jira.el from ox-jira.org
| -rw-r--r-- | ox-jira.el | 119 |
1 files changed, 3 insertions, 116 deletions
@@ -35,14 +35,13 @@ ;;; Code: -;; This is Cargo-culted from `ox-latex.el'` (eval-when-compile (require 'cl)) (require 'ox) (require 'ox-publish) (require 'subr-x) - ;;; User Configurable Options + (defgroup ox-jira-export nil "Options specific to JIRA export back-end." :tag "Org Export JIRA" @@ -55,9 +54,8 @@ :group 'ox-export-jira :type '(integer)) - - ;;; Defining Backend + (org-export-define-backend 'jira '((babel-call . (lambda (&rest args) (ox-jira--not-implemented 'babel-call))) (body . (lambda (&rest args) (ox-jira--not-implemented 'body))) @@ -114,39 +112,22 @@ (verbatim . ox-jira-verbatim) (verse-block . (lambda (&rest args) (ox-jira--not-implemented 'verse-block)))) :filters-alist '((:filter-parse-tree . ox-jira-fix-multi-paragraph-items)) - :options-alist - '((:src-collapse-threshold nil nil ox-jira-src-collapse-threshold)) + :options-alist '((:src-collapse-threshold nil nil ox-jira-src-collapse-threshold)) :menu-entry '(?j "Export to JIRA" ((?j "As JIRA buffer" ox-jira-export-as-jira)))) ;;; Internal Helpers -;; Because I'm adding support for things as I find I need it rather than all -;; in one go, let's put a big fat red marker in for things we have not -;; implemented yet, to avoid missing it. -;; (defun ox-jira--not-implemented (element-type) "Replace anything we don't handle yet with a big red marker." (format "{color:red}Element of type '%s' not implemented!{color}" element-type)) -;; Super^script and sub_script I often want at the end of words, with no -;; whitespace immediately before it. Unfortunately JIRA doesn't support -;; that,so we have to fake it. This function makes simple text transforms -;; "embeddable" by preceding them with an empty anchor. This is admittedly a -;; bit of a hack, but I haven't found anything better. -;; (defun ox-jira--text-transform-embeddable (transform-char contents) (concat "{anchor}" transform-char contents transform-char)) ;;; Filters -;; Org support a single blank line between items in a list, but if we export -;; like that to JIRA format it will be interpreted as multiple consecutive -;; lists, which is never what I want. We can attempt to fix this by removing -;; the "post-blank" after a items (and paragraphs inside items) using a -;; filter. -;; (defun ox-jira-fix-multi-paragraph-items (tree backend info) "Remove extra blank line between paragraphs in plain-list items. @@ -166,10 +147,6 @@ Assume BACKEND is `jira'." ;;; Transcode functions -;; These functions do the actual translation to JIRA format. For this section -;; I've used Atlassian's Text Formatting Notation Help page as a reference: -;; https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all - (defun ox-jira-bold (bold contents info) "Transcode BOLD from Org to JIRA. CONTENTS is the text with bold markup. INFO is a plist holding @@ -198,8 +175,6 @@ information." (org-remove-indentation (org-element-property :value fixed-width)))) -;; Footnotes have two parts: the reference, and the definition. -;; (defun ox-jira--footnote-anchor (element) (let ((label (org-element-property :label element))) (replace-regexp-in-string ":" "" label))) @@ -225,15 +200,6 @@ information." (format "{anchor:fn%s}[^%s^|#fnr%s] %s" anchor ref anchor contents))) -;; Headlines are a little bit more complex. I'm not even attempting to support -;; TODO labels and meta-information, just the straight-up text. It would be -;; nice to support the six standard levels of headlines JIRA offers though. -;; -;; Since the headline level is _relative_ rather than absolute, if the -;; exporter sees a '** second level' heading before it's seen a '* first -;; level' then the '** second level' will think it's a top-level heading. -;; That's a bit weird, but there you go. -;; (defun ox-jira-headline (headline contents info) "Transcode a HEADLINE element from Org to JIRA. CONTENTS is the contents of the headline, as a string. INFO is @@ -270,22 +236,6 @@ CONTENTS is the text with italic markup. INFO is a plist holding contextual information." (format "_%s_" contents)) -;; A list item. The JIRA format for nested lists follows. (You can also mix -;; ordered and unordered lists.) -;; -;; * item -;; ** sub-item -;; ** sub-item 2 -;; * item 2 -;; -;; The item element itself does not know what type it is: that is an attribute -;; of its parent, a plain-list element. We need to walk the path of -;; alternating plain-list and item nodes until there are no more, and extract -;; their type. The type list is used to create a bullet string. -;; -;; JIRA doesn't really have support for definition lists, so we fake it with a -;; bullet list and some bold text for the term. -;; (defun ox-jira--list-type-path (item) (when (and item (eq 'item (org-element-type item))) (let* ((list (org-element-property :parent item)) @@ -320,10 +270,6 @@ contextual information." (format "*%s*: " tag)) contents))) -;; JIRA supports many types of links. I don't expect we support them all, but -;; we must make a token effort. A lot of this code is cribbed from -;; `ox-latex.el'. -;; (defun ox-jira-link (link desc info) "Transcode a LINK object from Org to JIRA. @@ -359,38 +305,18 @@ CONTENTS is nil. INFO is a plist used as a communication channel." (format "{{%s}}" (org-element-property :value verbatim))) -;; One of the most annoying things about JIRA markup is the way it doesn't -;; reflow text properly, so any linebreaks become hard linebreaks in the -;; rendered output. Let's fix that! -;; -;; What we need to do is replace any *internal* newlines (i.e. any not at the -;; end of the string) with a space. Regexes to the rescue! I used the -;; following reference to help me with this function: -;; https://www.gnu.org/software/emacs/manual/html_node/elisp/Regexp-Backslash.html#Regexp-Backslash - - (defun ox-jira-paragraph (paragraph contents info) "Transcode a PARAGRAPH element from Org to JIRA. CONTENTS is the contents of the paragraph, as a string. INFO is the plist used as a communication channel." (replace-regexp-in-string "\n\\([^\']\\)" " \\1" contents)) -;; I make a lot of lists. Let's make sure we handle them! This is very simple, -;; as in the JIRA format all the logic is actually _for each item_ in the -;; list. -;; (defun ox-jira-plain-list (plain-list contents info) "Transcode PLAIN-LIST from Org to JIRA. CONTENTS is the text with plain-list markup. INFO is a plist holding contextual information." contents) -;; This is text with no markup, but we have to escape certain characters to -;; avoid tripping up JIRA. In particular: -;; -;; - ={= :: Introduces macros -;; - =[= :: Introduces links -;; (defun ox-jira-plain-text (text info) "Transcode TEXT from Org to JIRA. TEXT is the string to transcode. INFO is a plist holding @@ -399,22 +325,12 @@ contextual information." '(lambda (p) (format "\\\\%s" p)) text)) -;; Paragraphs are grouped into sections. I've not found any mention in the Org -;; documentation, but it appears to be essential for any export to happen. -;; I've essentially cribbed this from `ox-latex.el`. -;; - (defun ox-jira-section (section contents info) "Transcode a SECTION element from Org to JIRA. CONTENTS is the contents of the section, as a string. INFO is the plist used as a communication channel." contents) -;; JIRA supports formatting for these languages: actionscript, html, -;; java, javascript, sql, xhtml, xml. If none of them fits, we can use 'none', -;; or leave out the language altogether, which I imagine will be a bit like -;; ={noformat}=. -;; (defun ox-jira-src-block (src-block contents info) "Transcode a SRC-BLOCK element from Org to Jira. CONTENTS holds the contents of the src-block. INFO is a plist holding @@ -444,34 +360,12 @@ CONTENTS is the text with superscript markup. INFO is a plist holding contextual information." (ox-jira--text-transform-embeddable "^" contents)) - -;; Org's table editor is one of the many reasons to use Org. It is excellent. -;; Org and JIRA's tables are quite similar. Where Org marks tables up like -;; this: -;; -;; | Name | Score | -;; |--------+-------| -;; | Ashley | 2 | -;; | Alex | 3 | -;; -;; Jira uses the following format: -;; -;; || Name || Score || -;; | Ashley | 2 | -;; | Alex | 3 | -;; -;; Tables are complex beasts. I only hope to support very simple ones. Looks -;; like most of the logic will live in the row and cell transcoding functions. -;; (defun ox-jira-table (table contents info) "Transcode a TABLE element from Org to JIRA. CONTENTS holds the contents of the table. INFO is a plist holding contextual information." contents) -;; We only want to output =standard= rows, not horizontal lines. I'm not sure -;; if detection of header rows belongs here or in the cells. -;; (defun ox-jira-table-row (table-row contents info) "Transcode a TABLE-ROW element from Org to JIRA. CONTENTS holds the contents of the table-row. INFO is a plist holding @@ -479,10 +373,6 @@ contextual information." (when (eq 'standard (org-element-property :type table-row)) (format "%s\n" contents))) -;; The cell itself does not know if it is a header cell or not, so we have to -;; ask its containing row if it is the first row, and the table if it has a -;; header row at all. If those things are true, make the cell a header cell. -;; (defun ox-jira-table-cell (table-cell contents info) "Transcode a TABLE-CELL element from Org to JIRA. CONTENTS holds the contents of the table-cell. INFO is a plist holding @@ -496,8 +386,6 @@ contextual information." (format "%s %s %s" sep (if contents contents "") (if (org-export-last-sibling-p table-cell info) sep "")))) -;; This is updated to show progress of subsequent list of check boxes. -;; (defun ox-jira-statistics-cookie (statistics-cookie _contents _info) "Transcode a STATISTICS-COOKIE object from Org to JIRA. CONTENTS is nil. INFO is a plist holding contextual information." @@ -515,7 +403,6 @@ CONTENTS holds the contents of the block. INFO is a plist holding contextual information." (format "{quote}\n%s{quote}" contents)) - (defun ox-jira-timestamp (timestamp _contents info) "Transcode a TIMESTAMP object from Org to JIRA. CONTENTS is nil. INFO is a plist holding contextual information." |
