X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=pelican-mode.el;h=804f288e00cb25b5d2327f09bc4670bf7831e7c9;hp=5fbd12965d455488767e38c02145add04da892fe;hb=4dfce47d66561680157026878202ec60f81b4cee;hpb=6961723664a6a705c7ee05e6f0e508610ae0a108

diff --git a/pelican-mode.el b/pelican-mode.el
index 5fbd129..804f288 100644
--- a/pelican-mode.el
+++ b/pelican-mode.el
@@ -3,7 +3,7 @@
 ;; Copyright 2013-2017 Joe Wreschnig
 ;;
 ;; Author: Joe Wreschnig <joe.wreschnig@gmail.com>
-;; Package-Version: 20170618
+;; Package-Version: 20170730
 ;; Package-Requires: ((emacs "25"))
 ;; Keywords: convenience, editing
 ;;
@@ -20,194 +20,239 @@
 ;; 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:
 ;;
-;; Probably, this doesn't handle a lot of error cases.  I also never
-;; tested it on networked drives and the lookup for pelicanconf.py
-;; might slow it down considerably.
+;; pelican-mode is an Emacs minor mode for editing pages and posts 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:
+;;
+;;  * The existence of ``pelicanconf.py'' and ``Makefile'' in some
+;;    ancestor directory.
+;;  * The first component of the path (e.g. ``content'') after that
+;;    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)
 
+;; Mode Definition
+
+;;;###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/.
+
+Rather than manually enabling this mode, you may wish to use
+`pelican-global-mode' or `pelican-mode-enable-if-site'.
+
+When Pelican mode is enabled, additional commands are available
+for editing articles or pages:
+
+\\{pelican-mode-map}"
+  :lighter " Pelican"
+  :keymap `((,(kbd "C-c P d") . pelican-mode-update-date)
+            (,(kbd "C-c P f") . pelican-set-field)
+            (,(kbd "C-c P h") . pelican-make-html)
+            (,(kbd "C-c P n") . pelican-mode-insert-header)
+            (,(kbd "C-c P p") . pelican-mode-publish-draft)
+            (,(kbd "C-c P u") . pelican-make-rsync-upload)))
+
+;;;###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)))
+
+
+
+;; 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-default-page-fields
+  '(:slug slug)
+  "Fields to include when creating a new page.
+
+See the documentation for `pelican-mode-set-field' for more information
+about metadata fields and special values."
+  :group 'pelican-mode
+  :type '(plist))
+
+(defcustom pelican-mode-default-article-fields
+  '(:date now :status "draft" :slug slug)
+  "Fields to include when creating a new article.
+
+See the documentation for `pelican-mode-set-field' for more information
+about metadata fields and special values."
+  :group 'pelican-mode
+  :type '(plist))
+
+(defcustom pelican-mode-formats
+  '((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.
+
+This association list maps modes to functions that take two
+arguments, field and value strings."
+  :group 'pelican-mode
+  :type '(alist :key-type function :value-type function))
 
-(defun pelican-timestamp (&optional time)
-  "Generate a Pelican-compatible timestamp for TIME."
-  (format-time-string "%Y-%m-%d %H:%M" time))
+
 
-(defun pelican-field (name value)
-  "Format a line for a field NAME with a VALUE.
+;; User Commands
 
-NAME may be a string or a symbol; if it is a symbol, the
+(defun pelican-mode-set-field (field value)
+  "Set FIELD to VALUE.
+
+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-timestamp'.
+- `now' means the current time.
 
 - `slug' means the file's path relative to the document root sans
-  extension; see `pelican-default-slug'.
+  extension; see `pelican-mode-default-slug'.
 
-- nil means return an empty string, without any name or value."
-  (setq value (pcase value
-                ('now (pelican-timestamp))
-                ('slug (pelican-default-slug))
-                (_ value)))
-  (when (symbolp name)
-    (setq name (string-remove-prefix ":" (symbol-name name))))
-  (if value
-      (cond ((derived-mode-p 'markdown-mode)
-             (format "%s: %s\n" (capitalize name) value))
-            ((derived-mode-p 'rst-mode)
-             (format ":%s: %s\n" (downcase name) value))
-            (t (error "Unsupported major mode %S" major-mode)))
-    ""))
-
-(defun pelican-rst-title (title)
-  "Create a ReSt version of TITLE."
-  (concat title "\n" (make-string (string-width title) ?#) "\n\n"))
-
-(defun pelican-title (title)
-  "Format a TITLE for the current document, according to major mode."
-  (cond ((derived-mode-p 'markdown-mode)
-         (pelican-field "title" title))
-        ((derived-mode-p 'rst-mode)
-         (pelican-rst-title title))
-        (t (error "Unsupported major mode %S" major-mode))))
-
-(defun pelican-header (title &rest fields)
-  "Generate a Pelican header for a post with a TITLE and metadata FIELDS."
-  (concat (pelican-title title)
-          (mapconcat (apply-partially #'apply #'pelican-field)
-                     (seq-partition fields 2) "")
-          "\n"))
-
-(defun pelican-insert-header (title &rest fields)
-  "Insert a Pelican header for a post with a TITLE and metadata FIELDS."
-  (save-excursion
-    (goto-char 0)
-    (insert (apply #'pelican-header (cons title fields)))))
-
-(defun pelican-insert-draft-post-header (title tags)
-  "Insert a Pelican header for a draft with a TITLE and TAGS."
-  (interactive "sPost title: \nsTags: ")
-  (save-excursion
-    (goto-char 0)
-    (insert (pelican-header title
-                            :date 'now
-                            :status "draft"
-                            :tags tags
-                            :slug 'slug))))
-
-(defun pelican-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? ")))
-  (save-excursion
-    (goto-char 0)
-    (insert (pelican-header title
-                            :status (when hidden "hidden")
-                            :slug 'slug))))
-
-(defun pelican-insert-auto-header ()
-  "Insert a Pelican header for a page or post."
-  (interactive)
-  (call-interactively (if (pelican-page-p)
-                          'pelican-insert-page-header
-                        'pelican-insert-draft-post-header)))
+- nil or an empty string removes the field.
 
-(defun pelican-set-field (field value)
-  "Set FIELD to VALUE."
+The buffer must be in a format listed in `pelican-mode-formats'
+for this function to work correctly."
   (interactive "sField: \nsValue: ")
-  (save-excursion
-    (goto-char 0)
-    (when (and (derived-mode-p 'rst-mode)
-               (re-search-forward "^#" nil t))
-      (forward-line 2))
-    (if (re-search-forward (concat "^" (pelican-field field ".+*")) nil t)
-        (replace-match (pelican-field field value))
-      (when value
-        (re-search-forward "^$")
-        (replace-match (pelican-field field value))))))
+  (setq value (pcase value
+                ('now (format-time-string "%Y-%m-%d %H:%M"))
+                ('slug (pelican-mode-default-slug))
+                ('"" nil)
+                (_ value)))
+  (when (symbolp field)
+    (setq field (string-remove-prefix ":" (symbol-name field))))
+  (let ((set-field
+         (assoc-default nil pelican-mode-formats #'derived-mode-p)))
+    (unless set-field
+      (error "Unsupported major mode %S" major-mode))
+    (save-excursion
+      (goto-char 0)
+      (funcall set-field field value))))
 
-(defun pelican-remove-field (field)
+(defun pelican-mode-remove-field (field)
   "Remove FIELD."
-  (pelican-set-field field nil))
+  (interactive "sField: ")
+  (pelican-mode-set-field field nil))
 
-(defun pelican-set-title (title)
+(defun pelican-mode-set-title (title)
   "Set the title to TITLE."
   (interactive "sTitle: ")
-  (if (derived-mode-p 'markdown-mode)
-      (pelican-set-field "title" title)
-    (save-excursion
-      (goto-char 0)
-      (let ((header (pelican-rst-title title)))
-        (if (looking-at ".*\n#+\n+")
-            (replace-match header)
-          (insert header))))))
+  (pelican-mode-set-field :title title))
 
-(defun pelican-update-date ()
-  "Update a Pelican date header."
-  (interactive)
-  (pelican-set-field :date 'now))
+(defun pelican-mode-update-date (&optional original)
+  "Update the document's modification date.
 
-(defun pelican-publish-draft ()
-  "Remove draft status from a Pelican post."
-  (interactive)
-  (pelican-remove-field :status)
-  (pelican-update-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-page-p ()
-  "Guess the current buffer is a Pelican page (vs. a post or neither)."
-  (when-let (pelican-base (pelican-find-root))
-    (let* ((relative (file-relative-name buffer-file-name pelican-base))
-           (components (split-string relative "/")))
-      (equal "pages" (cadr components)))))
-
-(defun pelican-default-slug ()
-  "Generate a Pelican post/page slug for the current buffer."
-  (if-let ((pelican-base (pelican-find-root))
-           (file-name (file-name-sans-extension buffer-file-name)))
-      (let* ((relative (file-relative-name file-name pelican-base))
-             (components (cdr (split-string relative "/")))
-             (components (if (string= "pages" (car components))
-                             (cdr components) components)))
-        (mapconcat 'identity components "/"))
-    (format "%s/%s"
-            (file-name-nondirectory
-             (directory-file-name
-              (file-name-directory file-name)))
-            (file-name-base file-name))))
-
-(defun pelican-find-in-parents (file-name)
-  "Find FILE-NAME in the default directory or one of its parents, or nil."
-  (let* ((parent (expand-file-name default-directory)))
-    (while (and (not (file-readable-p (concat parent file-name)))
-                (not (string= parent (directory-file-name parent))))
-      (setq parent (file-name-directory (directory-file-name parent))))
-    (let ((found (concat parent file-name)))
-      (if (file-readable-p found) found nil))))
-
-(defun pelican-find-root ()
-  "Return the root of the buffer's Pelican site, or nil."
-  (when-let (conf (pelican-find-in-parents "pelicanconf.py"))
-    (file-name-directory conf)))
+(defun pelican-mode-publish-draft ()
+  "Remove draft status from a Pelican article."
+  (interactive)
+  (pelican-mode-remove-field :status)
+  (pelican-mode-update-date :date))
 
-(defun pelican-site-p ()
-  "Check if this buffer is under a Pelican site."
-  (not (null (pelican-find-root))))
+(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-set-fields
+         `(:title ,title
+           ,@pelican-mode-default-article-fields
+           :tags ,tags)))
+
+(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")
+  (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-draft-article-header)))
 
 (defun pelican-make (target)
   "Execute TARGET in a Makefile at the root of the site."
   (interactive "sMake Pelican target: ")
-  (if-let (default-directory (pelican-find-root))
+  (if-let (default-directory (pelican-mode-find-root))
       (compilation-start (format "make %s" target)
                          nil (lambda (_) "*pelican*"))
-    (message "This doesn't look like a Pelican site.")))
+    (user-error "No Pelican site root could be found")))
 
 (defun pelican-make-html ()
   "Generate HTML via a Makefile at the root of the site."
@@ -219,31 +264,107 @@ the unquoted printed representation of it is used:
   (interactive)
   (pelican-make "rsync_upload"))
 
-;;;###autoload
-(define-minor-mode pelican-mode
-  "Toggle Pelican mode.
+
 
-Interactively with no argument, this command toggles the mode.
-for editing Pelican site files."
-  :lighter " Pelican"
-  :group 'pelican
-  :keymap `((,(kbd "C-c P n") . pelican-insert-auto-header)
-            (,(kbd "C-c P p") . pelican-publish-draft)
-            (,(kbd "C-c P t") . pelican-update-date)
-            (,(kbd "C-c P h") . pelican-make-html)
-            (,(kbd "C-c P u") . pelican-make-rsync-upload)))
+(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)))
 
-;;;###autoload
-(defun pelican-enable-if-site ()
-  "Enable `pelican-mode' if this buffer is under a Pelican site."
-  (when (pelican-site-p)
-    (pelican-mode 1)))
+(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)))))))
+
+(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))))))
+
+(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)))))))
+
+(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))))))
+
+(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)))))
 
-;;;###autoload
-(add-hook 'markdown-mode-hook 'pelican-enable-if-site)
+(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))))
 
-;;;###autoload
-(add-hook 'rst-mode-hook 'pelican-enable-if-site)
+(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: