X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=pelican-mode.el;h=0bb885bbea3adae084932b854fb888e4b60392d1;hp=85d2be924aeb5f1660a6cf80b031e172bf894657;hb=c3ab3ec067de3597e77a972f20f5961356247d6f;hpb=2442f07f94c4b90bceae26d04fa593d3a9eba3ff

diff --git a/pelican-mode.el b/pelican-mode.el
index 85d2be9..0bb885b 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: 20170808
 ;; 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
@@ -24,14 +25,16 @@
 
 ;;; 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.
@@ -55,69 +58,6 @@
 (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
@@ -126,6 +66,11 @@ in an ancestor directory."
 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.
@@ -158,6 +103,69 @@ arguments, field and value strings."
 
 
 
+;; 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.")
+
+;;;###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}"
+  :group 'pelican-mode
+  :require 'pelican-mode
+  :keymap pelican-mode-map
+  :lighter " Pelican")
+
+;;;###autoload
+(define-globalized-minor-mode pelican-global-mode pelican-mode
+  (lambda ()
+    (when (derived-mode-p #'text-mode)
+      (pelican-mode-enable-if-site)))
+  :group 'pelican-mode
+  :require 'pelican-mode)
+
+;;;###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)
@@ -170,7 +178,7 @@ 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'.
@@ -181,7 +189,7 @@ 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)))
@@ -213,19 +221,22 @@ 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 :date))
 
-(defun pelican-mode-insert-draft-article-header (title tags)
-  "Insert a Pelican header for a draft with a TITLE and TAGS."
+(defun pelican-mode-insert-article-header (title tags)
+  "Insert a Pelican header for an article with a TITLE and TAGS."
   (interactive "sArticle title: \nsTags: ")
-  (apply #'pelican-mode-set-fields
-         `(:title ,title
-           ,@pelican-mode-default-article-fields
-           :tags ,tags)))
+  (save-excursion
+    (goto-char 0)
+    (insert "\n")
+    (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.
@@ -233,10 +244,13 @@ than the modification date."
 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)))
+  (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."
@@ -244,7 +258,7 @@ has no status."
   (call-interactively
    (if (pelican-mode-page-p)
        #'pelican-mode-insert-page-header
-     #'pelican-mode-insert-draft-article-header)))
+     #'pelican-mode-insert-article-header)))
 
 (defun pelican-make (target)
   "Execute TARGET in a Makefile at the root of the site."
@@ -266,10 +280,6 @@ has no status."
 
 
 
-(defun pelican-mode-timestamp (&optional time)
-  "Generate a pelican-mode-compatible timestamp for TIME."
-  (format-time-string "%Y-%m-%d %H:%M" time))
-
 (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)
@@ -343,22 +353,20 @@ has no status."
 
 (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)))))
+  (string-match-p
+   "^[^/]+/pages/"
+   (file-relative-name
+    (abbreviate-file-name (or (buffer-file-name) (buffer-name)))
+    (pelican-mode-find-root))))
 
 (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))))
+  "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)))))
 
 (defun pelican-mode-find-root ()
   "Return the root of the buffer's Pelican site, or nil."