aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.org26
-rw-r--r--ox-jira.el31
-rw-r--r--ox-jira.org37
3 files changed, 43 insertions, 51 deletions
diff --git a/README.org b/README.org
index 3d9477f..17c09ca 100644
--- a/README.org
+++ b/README.org
@@ -1,21 +1,21 @@
-* ox-jira - an Org export backend for JIRA
+#+TITLE: ox-jira.el --- JIRA Backend for Org Export Engine
+#+AUTHOR: Stig Brautaset
+* Introduction
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.
- 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
-** Maturity
+ Very immature. Positively juvenile. Please don't laugh.
- Very immature. Positively juvenile. Please don't laugh.
+* License
-** License
-
- Let's say MIT, shall we? Can I? I'm not even sure.
+ GPL.
diff --git a/ox-jira.el b/ox-jira.el
index 5cadffa..6c6bdc8 100644
--- a/ox-jira.el
+++ b/ox-jira.el
@@ -1,25 +1,20 @@
-;;; ox-jira.el --- an Org mode export backend for JIRA format
+;;; ox-jira.el --- JIRA Backend for Org Export Engine -*- lexical-binding: j; -*-
;;; Copyright (C) 2016 Stig Brautaset
-;; Permission is hereby granted, free of charge, to any person obtaining a
-;; copy of this software and associated documentation files (the "Software"),
-;; to deal in the Software without restriction, including without limitation
-;; the rights to use, copy, modify, merge, publish, distribute, sublicense,
-;; and/or sell copies of the Software, and to permit persons to whom the
-;; Software is furnished to do so, subject to the following conditions:
-
-;; The above copyright notice and this permission notice shall be included in
-;; all copies or substantial portions of the Software.
-
-;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-;; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-;; DEALINGS IN THE SOFTWARE.
+;; This program is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Author: Stig Brautaset <stig@brautaset.org>
diff --git a/ox-jira.org b/ox-jira.org
index 98b7f1d..fc28b4d 100644
--- a/ox-jira.org
+++ b/ox-jira.org
@@ -1,4 +1,4 @@
-#+TITLE: An Org mode export backend for JIRA
+#+TITLE: ox-jira.el --- JIRA Backend for Org Export Engine
#+AUTHOR: Stig Brautaset
#+PROPERTY: header-args:emacs-lisp :tangle yes :results silent
* Introduction
@@ -22,35 +22,32 @@
** Short description
#+BEGIN_SRC emacs-lisp
- ;;; ox-jira.el --- an Org mode export backend for JIRA format
+ ;;; ox-jira.el --- JIRA Backend for Org Export Engine -*- lexical-binding: j; -*-
#+END_SRC
** Copyright & License
I prefer the MIT license because it is short enough to read without toilet
or tea breaks, and I _think_ I can actually wrap my head around it. (And I
- feel it's important to understand the license of your choice.)
+ feel it's important to understand the license of your choice.) However,
+ given I've cribbed copiously from `ox-latex.el' I should probably stick
+ with the GPL for this work.
#+BEGIN_SRC emacs-lisp
;;; Copyright (C) 2016 Stig Brautaset
- ;; Permission is hereby granted, free of charge, to any person obtaining a
- ;; copy of this software and associated documentation files (the "Software"),
- ;; to deal in the Software without restriction, including without limitation
- ;; the rights to use, copy, modify, merge, publish, distribute, sublicense,
- ;; and/or sell copies of the Software, and to permit persons to whom the
- ;; Software is furnished to do so, subject to the following conditions:
-
- ;; The above copyright notice and this permission notice shall be included in
- ;; all copies or substantial portions of the Software.
-
- ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- ;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- ;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- ;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- ;; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- ;; DEALINGS IN THE SOFTWARE.
+ ;; This program is free software: you can redistribute it and/or modify
+ ;; it under the terms of the GNU General Public License as published by
+ ;; the Free Software Foundation, either version 3 of the License, or
+ ;; (at your option) any later version.
+
+ ;; This program is distributed in the hope that it will be useful,
+ ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+ ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ ;; GNU General Public License for more details.
+
+ ;; You should have received a copy of the GNU General Public License
+ ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
#+END_SRC
** Author