X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=pelican-mode.el;h=893fc2901245d7ef45b36e8ab619f917849ea330;hp=8a53c2703f1f5e65ca3dc8dc764b667b128eedf8;hb=0eeee74fd9a459dd8c04c264c183d80f2d2b98b2;hpb=34a86b496ee99c25368df2dd930fc9cb915a1e77

diff --git a/pelican-mode.el b/pelican-mode.el
index 8a53c27..893fc29 100644
--- a/pelican-mode.el
+++ b/pelican-mode.el
@@ -3,8 +3,9 @@
 ;; Copyright 2013-2017 Joe Wreschnig
 ;;
 ;; Author: Joe Wreschnig <joe.wreschnig@gmail.com>
-;; Package-Version: 20170730
+;; Package-Version: 20170807
 ;; Package-Requires: ((emacs "25"))
+;; URL: https://git.korewanetadesu.com/pelican-mode.git
 ;; Keywords: convenience, editing
 ;;
 ;; This program is free software; you can redistribute it and/or modify
@@ -20,17 +21,20 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+
 
 ;;; Commentary:
 ;;
-;; pelican-mode is an Emacs minor mode for editing pages and posts in
-;; Pelican sites.  Pelican is a static site generator which can
+;; pelican-mode is an Emacs minor mode for editing articles and pages
+;; in Pelican sites.  Pelican is a static site generator which can
 ;; process a variety of text file formats.  For more information, see
 ;; URL https://blog.getpelican.com/.
 ;;
-;; It's intended to be used alongside `markdown-mode' or `rst-mode'.
-;; It also assumes you've set up Pelican with ``pelican-quickstart''
-;; or something like it.  In particular it assumes:
+;; It's intended to be used alongside a major mode for the Pelican
+;; document.  Currently supported formats are Markdown,
+;; reStructuredText, AsciiDoc, and Org.  It also assumes you've set up
+;; Pelican with ``pelican-quickstart'' or something like it.  In
+;; particular it expects:
 ;;
 ;;  * The existence of ``pelicanconf.py'' and ``Makefile'' in some
 ;;    ancestor directory.
@@ -38,19 +42,35 @@
 ;;    ancestor is irrelevant.
 ;;  * If the next component is ``pages'', that indicates a page
 ;;    rather than an article.
+;;
+;; To enable by default on all text files in a Pelican site:
+;;
+;;     (require 'pelican-mode)
+;;     (pelican-global-mode)
+;;
+;; Or, register `pelican-mode' or `pelican-mode-enable-if-site'
+;; as hook functions for more direct control.
 
+
 
 ;;; Code:
 
 (require 'seq)
 (require 'subr-x)
 
+;; Customizations
+
 (defgroup pelican-mode nil
   "Support for Pelican articles and pages.
 
 For more information about Pelican see URL https://blog.getpelican.com/."
   :group 'convenience)
 
+(defcustom pelican-mode-keymap-prefix (kbd "C-c P")
+  "Pelican mode keymap prefix."
+  :group 'pelican-mode
+  :type 'string)
+
 (defcustom pelican-mode-default-page-fields
   '(:slug slug)
   "Fields to include when creating a new page.
@@ -70,8 +90,9 @@ about metadata fields and special values."
   :type '(plist))
 
 (defcustom pelican-mode-formats
-  '((markdown-mode . pelican-mode-set-field-markdown-mode)
-    (adoc-mode . pelican-mode-set-field-adoc-mode)
+  '((adoc-mode . pelican-mode-set-field-adoc-mode)
+    (markdown-mode . pelican-mode-set-field-markdown-mode)
+    (org-mode . pelican-mode-set-field-org-mode)
     (rst-mode . pelican-mode-set-field-rst-mode))
   "Functions to handle setting metadata, based on major mode.
 
@@ -80,85 +101,86 @@ arguments, field and value strings."
   :group 'pelican-mode
   :type '(alist :key-type function :value-type function))
 
-(defun pelican-mode-timestamp (&optional time)
-  "Generate a pelican-mode-compatible timestamp for TIME."
-  (format-time-string "%Y-%m-%d %H:%M" time))
+
+
+;; Mode Definition
+
+(defvar pelican-mode-command-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map (kbd "d") #'pelican-mode-update-date)
+    (define-key map (kbd "f") #'pelican-mode-set-field)
+    (define-key map (kbd "h") #'pelican-make-html)
+    (define-key map (kbd "n") #'pelican-mode-insert-header)
+    (define-key map (kbd "p") #'pelican-mode-publish)
+    (define-key map (kbd "u") #'pelican-make-rsync-upload)
+    map)
+  "Keymap for Pelican commands after `pelican-mode-keymap-prefix'.")
+(fset 'pelican-mode-command-map pelican-mode-command-map)
+
+(defvar pelican-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map pelican-mode-keymap-prefix
+      'pelican-mode-command-map)
+    map)
+  "Keymap for Pelican mode.")
 
-(defun pelican-mode-insert-header (&rest fields)
-  "Insert a Pelican header for an article with metadata FIELDS."
-  (mapc (apply-partially #'apply #'pelican-mode-set-field)
-        (seq-partition fields 2)))
+;;;###autoload
+(define-minor-mode pelican-mode
+  "Toggle Pelican mode.
+With a prefix argument ARG, enable Pelican mode if ARG is
+positive, and disable it otherwise.  If called from Lisp, enable
+the mode if ARG is omitted or nil.
 
-(defun pelican-mode-insert-draft-article-header (title tags)
-  "Insert a Pelican header for a draft with a TITLE and TAGS."
-  (interactive "sArticle title: \nsTags: ")
-  (apply #'pelican-mode-insert-header
-         `(:title ,title ,@pelican-mode-default-article-fields :tags ,tags)))
+Pelican is a static site generator which can process a variety of
+text file formats.  For more information, see URL
+https://blog.getpelican.com/.
 
-(defun pelican-mode-insert-page-header (title &optional hidden)
-  "Insert a Pelican header for a page with a TITLE, potentially HIDDEN."
-  (interactive
-   (list (read-string "Page title: ")
-         (y-or-n-p "Hidden? ")))
-  (apply #'pelican-mode-insert-header
-         `(:title ,title ,@pelican-mode-default-page-fields
-                  :hidden ,(when hidden "hidden"))))
-
-(defun pelican-mode-insert-auto-header ()
-  "Insert a Pelican header for a page or article."
-  (interactive)
-  (call-interactively
-   (if (pelican-mode-page-p)
-       #'pelican-mode-insert-page-header
-     #'pelican-mode-insert-draft-article-header)))
+Rather than manually enabling this mode, you may wish to use
+`pelican-global-mode' or `pelican-mode-enable-if-site'.
 
-(defun pelican-mode-set-field-rst-mode (field value)
-  "Set reStructuredText metadata FIELD to VALUE."
-  (setq field (downcase field))
-  (if (equal field "title")
-      (let ((header (format "%s\n%s\n\n"
-                            value (make-string (string-width value) ?#))))
-        (if (looking-at ".*\n#+\n+")
-            (replace-match header)
-          (insert header)))
-    (let ((text (when value (format ":%s: %s\n" field value))))
-      (when (looking-at "^.*\n#")
-        (forward-line 3))
-      (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
-          (replace-match (or text ""))
-        (when text
-          (if (re-search-forward "^$" nil t)
-              (replace-match text)
-            (insert text)))))))
+When Pelican mode is enabled, additional commands are available
+for editing articles or pages:
 
-(defun pelican-mode-set-field-markdown-mode (field value)
-  "Set Markdown metadata FIELD to VALUE."
-  (setq field (capitalize field))
-  (let ((text (when value (format "%s: %s\n" field value))))
-    (if (re-search-forward (format "^%s:.*\n" (regexp-quote field)) nil t)
-        (replace-match text)
-      (when value
-        (if (re-search-forward "^$" nil t)
-            (replace-match text)
-          (insert text))))))
+\\{pelican-mode-map}"
+  :keymap pelican-mode-map
+  :lighter " Pelican")
 
-(defun pelican-mode-set-field-adoc-mode (field value)
-  "Set AsciiDoc metadata FIELD to VALUE."
-  (setq field (downcase field))
-  (if (equal field "title")
-      (let ((header (format "= %s\n\n" value)))
-        (if (looking-at "= .*\n\n+")
-            (replace-match header)
-          (insert header)))
-    (let ((text (when value (format ":%s: %s\n" field value))))
-      (when (looking-at "^=")
-        (forward-line 2))
-      (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
-          (replace-match (or text ""))
-        (when text
-          (if (re-search-forward "^$" nil t)
-              (replace-match text)
-            (insert text)))))))
+;;;###autoload
+(define-minor-mode pelican-global-mode
+  "Toggle Pelican global mode.
+With a prefix argument ARG, enable Pelican global mode if ARG is
+positive, and disable it otherwise.  If called from Lisp, enable
+the mode if ARG is omitted or nil.
+
+Pelican is a static site generator which can process a variety of
+text file formats.  For more information, see URL
+https://blog.getpelican.com/.
+
+When Pelican global mode is enabled, text files which seem to
+be part of a Pelican site will have `pelican-mode' automatically
+enabled.
+
+If you disable this, you may still enable `pelican-mode' manually
+or add `pelican-mode-enable-if-site' to more specific mode
+hooks."
+  :global t
+  :group 'pelican-mode
+  (if pelican-global-mode
+      (add-hook 'text-mode-hook #'pelican-mode-enable-if-site)
+    (remove-hook 'text-mode-hook #'pelican-mode-enable-if-site)))
+
+;;;###autoload
+(defun pelican-mode-enable-if-site ()
+  "Enable `pelican-mode' if this buffer is part of a Pelican site.
+
+Pelican sites are detected by looking for a file named `pelicanconf.py'
+in an ancestor directory."
+  (when (pelican-mode-find-root)
+    (pelican-mode)))
+
+
+
+;; User Commands
 
 (defun pelican-mode-set-field (field value)
   "Set FIELD to VALUE.
@@ -166,18 +188,22 @@ arguments, field and value strings."
 FIELD may be a string or a symbol; if it is a symbol, the
 symbol name is used (removing a leading ':' if present).
 
-VALUE may be any value; except for the following special values,
-the unquoted printed representation of it is used:
+When called from Lisp, VALUE may be any value; except for the
+following special values, the unquoted printed representation of
+it is used:
 
-- `now' means the current time; see `pelican-mode-timestamp'.
+- `now' means the current time.
 
 - `slug' means the file's path relative to the document root sans
   extension; see `pelican-mode-default-slug'.
 
-- nil or an empty string removes the field."
+- nil or an empty string removes the field.
+
+The buffer must be in a format listed in `pelican-mode-formats'
+for this function to work correctly."
   (interactive "sField: \nsValue: ")
   (setq value (pcase value
-                ('now (pelican-mode-timestamp))
+                ('now (format-time-string "%Y-%m-%d %H:%M"))
                 ('slug (pelican-mode-default-slug))
                 ('"" nil)
                 (_ value)))
@@ -193,6 +219,7 @@ the unquoted printed representation of it is used:
 
 (defun pelican-mode-remove-field (field)
   "Remove FIELD."
+  (interactive "sField: ")
   (pelican-mode-set-field field nil))
 
 (defun pelican-mode-set-title (title)
@@ -200,39 +227,52 @@ the unquoted printed representation of it is used:
   (interactive "sTitle: ")
   (pelican-mode-set-field :title title))
 
-(defun pelican-mode-update-date ()
-  "Update a Pelican date header."
-  (interactive)
-  (pelican-mode-set-field :date 'now))
+(defun pelican-mode-update-date (&optional original)
+  "Update the document's modification date.
+
+If ORIGINAL is non-nil, the publication date is updated rather
+than the modification date."
+  (interactive "P")
+  (pelican-mode-set-field (if original :date :modified) 'now))
 
-(defun pelican-mode-publish-draft ()
-  "Remove draft status from a Pelican article."
+(defun pelican-mode-publish ()
+  "Remove draft or hidden status from a Pelican article."
   (interactive)
   (pelican-mode-remove-field :status)
-  (pelican-mode-update-date))
+  (pelican-mode-update-date :date))
 
-(defun pelican-mode-page-p ()
-  "Return non-nil the current buffer is a Pelican page."
-  (when-let (pelican-mode-base (pelican-mode-find-root))
-    (let* ((relative (file-relative-name buffer-file-name pelican-mode-base))
-           (components (split-string relative "/")))
-      (equal "pages" (cadr components)))))
-
-(defun pelican-mode-default-slug ()
-  "Generate a Pelican article/page slug for the current buffer."
-  (if-let ((pelican-mode-base (pelican-mode-find-root))
-           (file-name (file-name-sans-extension buffer-file-name)))
-      (let* ((relative (file-relative-name file-name pelican-mode-base))
-             (components (cdr (split-string relative "/")))
-             (components (if (string= "pages" (car components))
-                             (cdr components) components)))
-        (mapconcat 'identity components "/"))
-    (when-let (file-name (file-name-sans-extension buffer-file-name))
-      (file-name-base file-name))))
+(defun pelican-mode-insert-article-header (title tags)
+  "Insert a Pelican header for an article with a TITLE and TAGS."
+  (interactive "sArticle title: \nsTags: ")
+  (save-excursion
+    (goto-char 0)
+    (insert "\n")
+    (apply #'pelican-mode-set-fields
+           `(:title ,title
+             ,@pelican-mode-default-article-fields
+             :tags ,tags))))
 
-(defun pelican-mode-find-root ()
-  "Return the root of the buffer's Pelican site, or nil."
-  (locate-dominating-file default-directory "pelicanconf.py"))
+(defun pelican-mode-insert-page-header (title &optional hidden)
+  "Insert a Pelican header for a page with a TITLE.
+
+If HIDDEN is non-nil, the page is marked hidden; otherwise it
+has no status."
+  (interactive "sPage title: \nP")
+  (save-excursion
+    (goto-char 0)
+    (insert "\n")
+    (apply #'pelican-mode-set-fields
+           (append
+            (list :title title :status (when hidden "hidden"))
+            pelican-mode-default-page-fields))))
+
+(defun pelican-mode-insert-header ()
+  "Insert a Pelican header for a page or article."
+  (interactive)
+  (call-interactively
+   (if (pelican-mode-page-p)
+       #'pelican-mode-insert-page-header
+     #'pelican-mode-insert-article-header)))
 
 (defun pelican-make (target)
   "Execute TARGET in a Makefile at the root of the site."
@@ -252,61 +292,105 @@ the unquoted printed representation of it is used:
   (interactive)
   (pelican-make "rsync_upload"))
 
-;;;###autoload
-(define-minor-mode pelican-mode
-  "Toggle Pelican mode.
-With a prefix argument ARG, enable Pelican mode if ARG is
-positive, and disable it otherwise.  If called from Lisp, enable
-the mode if ARG is omitted or nil.
+
 
-Pelican is a static site generator which can process a variety of
-text file formats.  For more information, see URL
-https://blog.getpelican.com/.
+(defun pelican-mode-set-fields (&rest fields)
+  "Insert a Pelican header for an article with metadata FIELDS."
+  (mapc (apply-partially #'apply #'pelican-mode-set-field)
+        (seq-partition fields 2)))
 
-When Pelican mode is enabled, additional commands are available
-for editing articles or pages:
+(defun pelican-mode-set-field-rst-mode (field value)
+  "Set reStructuredText metadata FIELD to VALUE."
+  (setq field (downcase field))
+  (if (equal field "title")
+      (let ((header (format "%s\n%s\n\n"
+                            value (make-string (string-width value) ?#))))
+        (if (looking-at ".*\n#+\n+")
+            (replace-match header)
+          (insert header)))
+    (let ((text (when value (format ":%s: %s\n" field value))))
+      (when (looking-at "^.*\n#")
+        (forward-line 3))
+      (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
+          (replace-match (or text ""))
+        (when text
+          (if (re-search-forward "^$" nil t)
+              (replace-match text)
+            (insert text)))))))
 
-\\{pelican-mode-map}"
-  :lighter " Pelican"
-  :keymap `((,(kbd "C-c P n") . pelican-mode-insert-auto-header)
-            (,(kbd "C-c P p") . pelican-mode-publish-draft)
-            (,(kbd "C-c P t") . pelican-mode-update-date)
-            (,(kbd "C-c P h") . pelican-make-html)
-            (,(kbd "C-c P u") . pelican-make-rsync-upload)))
+(defun pelican-mode-set-field-markdown-mode (field value)
+  "Set Markdown metadata FIELD to VALUE."
+  (setq field (capitalize field))
+  (let ((text (when value (format "%s: %s\n" field value))))
+    (if (re-search-forward (format "^%s:.*\n" (regexp-quote field)) nil t)
+        (replace-match text)
+      (when value
+        (if (re-search-forward "^$" nil t)
+            (replace-match text)
+          (insert text))))))
 
-;;;###autoload
-(define-minor-mode pelican-global-mode
-  "Toggle Pelican global mode.
-With a prefix argument ARG, enable Pelican global mode if ARG is
-positive, and disable it otherwise.  If called from Lisp, enable
-the mode if ARG is omitted or nil.
+(defun pelican-mode-set-field-adoc-mode (field value)
+  "Set AsciiDoc metadata FIELD to VALUE."
+  (setq field (downcase field))
+  (if (equal field "title")
+      (let ((header (format "= %s\n\n" value)))
+        (if (looking-at "= .*\n\n+")
+            (replace-match header)
+          (insert header)))
+    (let ((text (when value (format ":%s: %s\n" field value))))
+      (when (looking-at "^=")
+        (forward-line 2))
+      (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
+          (replace-match (or text ""))
+        (when text
+          (if (re-search-forward "^$" nil t)
+              (replace-match text)
+            (insert text)))))))
 
-Pelican is a static site generator which can process a variety of
-text file formats.  For more information, see URL
-https://blog.getpelican.com/.
+(defun pelican-mode-set-field-org-mode (field value)
+  "Set Org global metadata FIELD to VALUE."
+  ;; None of org-mode's functions I can find for setting properties
+  ;; operate on the global list, only a single property drawer.
+  (setq field (upcase field))
+  (setq field
+        (format (if (member field '("TITLE" "DATE" "CATEGORY" "AUTHOR"))
+                    "#+%s:"
+                  "#+PROPERTY: %s")
+                field))
+  (let ((text (when value (format "%s %s\n" field value))))
+    (if (re-search-forward (format "^%s .*\n" (regexp-quote field)) nil t)
+        (replace-match (or text ""))
+      (when text
+        (if (re-search-forward "^$" nil t)
+            (replace-match text)
+          (insert text))))))
 
-When Pelican global mode is enabled, text files which seem to
-be part of a Pelican site will have `pelican-mode' automatically
-enabled.
+(defun pelican-mode-page-p ()
+  "Return non-nil the current buffer is a Pelican page."
+  (string-match-p
+   "^[^/]+/pages/"
+   (file-relative-name
+    (abbreviate-file-name (or (buffer-file-name) (buffer-name)))
+    (pelican-mode-find-root))))
 
-If you disable this, you may still enable `pelican-mode' manually
-or add `pelican-mode-enable-if-site' to more specific mode
-hooks."
-  :global t
-  :group 'pelican-mode
-  (if pelican-global-mode
-      (add-hook 'text-mode-hook #'pelican-mode-enable-if-site)
-    (remove-hook 'text-mode-hook #'pelican-mode-enable-if-site)))
+(defun pelican-mode-default-slug ()
+  "Generate a Pelican slug for the current buffer."
+  (file-name-sans-extension
+   (replace-regexp-in-string
+    "^[^/]+/\\(?:pages/\\)?" ""
+    (file-relative-name
+     (abbreviate-file-name (or (buffer-file-name) (buffer-name)))
+     (pelican-mode-find-root)))))
 
-;;;###autoload
-(defun pelican-mode-enable-if-site ()
-  "Enable `pelican-mode' if this buffer is part of a Pelican site."
-  (when (pelican-mode-find-root)
-    (pelican-mode 1)))
+(defun pelican-mode-find-root ()
+  "Return the root of the buffer's Pelican site, or nil."
+  (locate-dominating-file default-directory "pelicanconf.py"))
 
 (provide 'pelican-mode)
 ;;; pelican-mode.el ends here
 
+
+
 ;; Local Variables:
 ;; sentence-end-double-space: t
 ;; End: