diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Cask | 10 | ||||
| -rw-r--r-- | README.org | 21 | ||||
| -rw-r--r-- | ox-jira.el | 16 | ||||
| -rw-r--r-- | ox-jira.org | 74 |
5 files changed, 122 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..849ddff --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +dist/ @@ -0,0 +1,10 @@ +(source gnu) +(source melpa) + +(package-file "ox-jira.el") + +(development + (depends-on "f") + (depends-on "ecukes") + (depends-on "ert-runner") + (depends-on "el-mock")) diff --git a/README.org b/README.org new file mode 100644 index 0000000..3d9477f --- /dev/null +++ b/README.org @@ -0,0 +1,21 @@ +* ox-jira - an Org export backend for JIRA + + Export Org mode files to JIRA markup for pasting into JIRA tickets & + comments. + +** Motivation + + My last three jobs I've had to use JIRA, and had to deal with its (to me) + incredibly unintuitive markup format. Having discovered---and fallen in + love with---Org mode I now find myself writing everything in Org and + exporting to various other formats (html, markdown, plain text) but I + haven't been able to find a way to export to JIRA. So I am attempting to + write one, and learn about Emacs package development at the same time. + +** Maturity + + Very immature. Positively juvenile. Please don't laugh. + +** License + + Let's say MIT, shall we? Can I? I'm not even sure. diff --git a/ox-jira.el b/ox-jira.el new file mode 100644 index 0000000..a2192fb --- /dev/null +++ b/ox-jira.el @@ -0,0 +1,16 @@ + +;;; ox-jira.el --- an Org mode export backend for JIRA format + +;;; Copyright (C) 2016 Stig Brautaset + +;;; Author: Stig Brautaset <stig@brautaset.org> + +;;; Version: 0.1-SNAPSHOT + +;; Homepage: https://github.com/stig/ox-jira.el + +;; Package-Requires: ((org "8.0")) + +;;; Code: + +;;; ox-jira.el ends here diff --git a/ox-jira.org b/ox-jira.org new file mode 100644 index 0000000..46c3563 --- /dev/null +++ b/ox-jira.org @@ -0,0 +1,74 @@ +#+TITLE: ox-jira +#+AUTHOR: Stig Brautaset +#+PROPERTY: header-args:emacs-lisp :tangle yes +* ox-jira - a JIRA export backend for Org mode + +** Header + + First come some [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Library-Headers.html][conventional headers]] that libraries tend to include. Cask + _requires_ them, so I assume they are a good idea. + +*** Short description + + #+BEGIN_SRC emacs-lisp + ;;; ox-jira.el --- an Org mode export backend for JIRA format + #+END_SRC + +*** Copyright + + #+BEGIN_SRC emacs-lisp + ;;; Copyright (C) 2016 Stig Brautaset + #+END_SRC + +*** Author + + #+BEGIN_SRC emacs-lisp + ;;; Author: Stig Brautaset <stig@brautaset.org> + #+END_SRC + +*** Keywords + + Define the keywords that can be used to find this package with + =finder-by-keyword= (=C-h p=). + + #+BEGIN_SRC emacs-lisp + ;; Keywords: outlines, hypermedia, wp + #+END_SRC +*** Version + + #+BEGIN_SRC emacs-lisp + ;;; Version: 0.1-SNAPSHOT + #+END_SRC + +*** Homepage + + #+BEGIN_SRC emacs-lisp + ;; Homepage: https://github.com/stig/ox-jira.el + #+END_SRC + +*** Package Requires + + We requires Org version 8 or above, as the export backend system we use + was introduced then. + + #+BEGIN_SRC emacs-lisp + ;; Package-Requires: ((org "8.0")) + #+END_SRC + +** Code + + First a special header to denote that we're done with the header section + and starting the actual code now. + + #+BEGIN_SRC emacs-lisp + ;;; Code: + #+END_SRC + +** Footer + + Now we need to put and end to this malarky. There's a magic comment for + that too. It looks like this: + + #+BEGIN_SRC emacs-lisp + ;;; ox-jira.el ends here + #+END_SRC |
