diff options
| author | Stig Brautaset <stig@brautaset.org> | 2016-03-02 00:17:53 +0100 |
|---|---|---|
| committer | Stig Brautaset <stig@brautaset.org> | 2016-03-02 00:22:48 +0100 |
| commit | 8fcfa3fa5a9be616ecbc5cf752a406d1bff173df (patch) | |
| tree | d969eec922422ecae834a8e4dde3a82d6f5c61fc | |
| parent | 15a41806e9efef9ede0283ae0f50878b50c555b8 (diff) | |
Reformat headers more idiomatically
Thanks to Steve Purcell, for https://github.com/stig/ox-jira.el/pull/1
| -rw-r--r-- | ox-jira.el | 22 | ||||
| -rw-r--r-- | ox-jira.org | 72 | ||||
| -rw-r--r-- | test/ox-jira-test.el | 6 | ||||
| -rw-r--r-- | test/ox-jira-test.org | 21 |
4 files changed, 38 insertions, 83 deletions
@@ -1,6 +1,14 @@ ;;; ox-jira.el --- JIRA Backend for Org Export Engine -;;; Copyright (C) 2016 Stig Brautaset +;; Copyright (C) 2016 Stig Brautaset + +;; Author: Stig Brautaset <stig@brautaset.org> +;; Version: 0.1-SNAPSHOT +;; Keywords: outlines, hypermedia, wp +;; Homepage: https://github.com/stig/ox-jira.el +;; Package-Requires: ((org "8.0")) + +;; This file is NOT part of GNU Emacs. ;; 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 @@ -15,18 +23,6 @@ ;; 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> - -;; Keywords: outlines, hypermedia, wp - -;; This file is NOT part of GNU Emacs. - -;;; Version: 0.1-SNAPSHOT - -;; Homepage: https://github.com/stig/ox-jira.el - -;; Package-Requires: ((org "8.0")) - ;;; Code: (eval-when-compile (require 'cl)) diff --git a/ox-jira.org b/ox-jira.org index 86c9f52..9b141a4 100644 --- a/ox-jira.org +++ b/ox-jira.org @@ -17,16 +17,34 @@ * 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 + requires them. Use =:padline no= to avoid starting the tangled file with a + blank line. #+BEGIN_SRC emacs-lisp :padline no ;;; ox-jira.el --- JIRA Backend for Org Export Engine + ;; Copyright (C) 2016 Stig Brautaset + + ;; Author: Stig Brautaset <stig@brautaset.org> + ;; Version: 0.1-SNAPSHOT #+END_SRC -** Copyright & License + Define the keywords that can be used to find this package with + =finder-by-keyword= (=C-h p=). + + #+BEGIN_SRC emacs-lisp :padline no + ;; Keywords: outlines, hypermedia, wp + ;; Homepage: https://github.com/stig/ox-jira.el + #+END_SRC + + We requires Org version 8 or above, as the export backend system we use + was introduced then. + + #+BEGIN_SRC emacs-lisp :padline no + ;; Package-Requires: ((org "8.0")) + + ;; This file is NOT part of GNU Emacs. + #+END_SRC 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 @@ -35,8 +53,6 @@ with the GPL for this work. #+BEGIN_SRC emacs-lisp - ;;; Copyright (C) 2016 Stig Brautaset - ;; 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 @@ -51,49 +67,7 @@ ;; along with this program. If not, see <http://www.gnu.org/licenses/>. #+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 -** Distribution - - #+BEGIN_SRC emacs-lisp - ;; This file is NOT part of GNU Emacs. - #+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 - - Lastly a special header to denote that we're done with the header section + Lastly a special marker to denote that we're done with the header section and starting the actual code now. #+BEGIN_SRC emacs-lisp diff --git a/test/ox-jira-test.el b/test/ox-jira-test.el index 455a605..b9a0dff 100644 --- a/test/ox-jira-test.el +++ b/test/ox-jira-test.el @@ -1,10 +1,10 @@ ;;; ox-jira-test.el --- tests for ox-jira.el -;;; Author: Stig Brautaset <stig@brautaset.org> +;; Copyright (C) 2016 Stig Brautaset -;; This file is NOT part of GNU Emacs. +;; Author: Stig Brautaset <stig@brautaset.org> -;;; Copyright (C) 2016 Stig Brautaset +;; This file is NOT part of GNU Emacs. ;; 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 diff --git a/test/ox-jira-test.org b/test/ox-jira-test.org index 47595e6..e1f461b 100644 --- a/test/ox-jira-test.org +++ b/test/ox-jira-test.org @@ -7,27 +7,16 @@ * Conventional headers -** Short description - #+BEGIN_SRC emacs-lisp :padline no ;;; ox-jira-test.el --- tests for ox-jira.el - #+END_SRC - -** Author - - #+BEGIN_SRC emacs-lisp - ;;; Author: Stig Brautaset <stig@brautaset.org> - #+END_SRC + ;; Copyright (C) 2016 Stig Brautaset -** Distribution + ;; Author: Stig Brautaset <stig@brautaset.org> - #+BEGIN_SRC emacs-lisp ;; This file is NOT part of GNU Emacs. #+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.) However, @@ -35,8 +24,6 @@ with the GPL for this work. #+BEGIN_SRC emacs-lisp - ;;; Copyright (C) 2016 Stig Brautaset - ;; 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 @@ -51,9 +38,7 @@ ;; along with this program. If not, see <http://www.gnu.org/licenses/>. #+END_SRC -** Code - - Lastly a special header to denote that we're done with the header section + Lastly a special marker to denote that we're done with the header section and starting the actual code now. #+BEGIN_SRC emacs-lisp |
