;; 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
;;
;; 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)
-(defun pelican-timestamp (&optional time)
- "Generate a Pelican-compatible timestamp for TIME."
+(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
+ '((markdown-mode . pelican-mode-set-field-markdown-mode)
+ (adoc-mode . pelican-mode-set-field-adoc-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-mode-timestamp (&optional time)
+ "Generate a pelican-mode-compatible timestamp for TIME."
(format-time-string "%Y-%m-%d %H:%M" time))
-(defun pelican-is-markdown ()
- "Check if the buffer is likely using Markdown."
- (derived-mode-p 'markdown-mode))
-
-(defun pelican-field (name value)
- "Format a line for a field NAME with a VALUE."
- (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-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)
- (concat title "\n" (make-string (string-width title) ?#) "\n"))
- (t (error "Unsupported major mode %S" major-mode))))
-
-(defun pelican-header (title date status category tags slug)
- "Create a Pelican header."
- ;; TODO: Use a property list (-> alist via seq-partition) instead.
- (when (eq date t)
- (setq date (pelican-timestamp)))
-
- (concat (pelican-title title)
- (pelican-field "date" date)
- (pelican-field "status" status)
- (pelican-field "tags" tags)
- (pelican-field "category" category)
- (pelican-field "slug" slug)
- "\n"))
-
-(defun pelican-insert-draft-post-header (title tags)
- "Insert a Pelican header for a draft post."
- (interactive "sPost title: \nsTags: ")
- (let ((slug (pelican-default-slug)))
- (save-excursion
- (goto-char 0)
- (insert (pelican-header title 't "draft" nil tags slug)))))
-
-(defun pelican-insert-page-header (title hidden)
- "Insert a Pelican header for a page."
- (interactive
- (list (read-string "Page title: ")
- (y-or-n-p "Hidden? ")))
- (let ((slug (pelican-default-slug))
- (hidden (if hidden "hidden" nil)))
+(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)))
+
+(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-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-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).
+
+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'.
+
+- `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.
+
+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))
+ ('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)
- (insert (pelican-header title nil hidden nil nil slug)))))
+ (funcall set-field field value))))
-(defun pelican-insert-header ()
- "Insert a Pelican header for a page or post."
- (interactive)
- (call-interactively (if (pelican-is-page)
- 'pelican-insert-page-header
- 'pelican-insert-draft-post-header)))
-
-(defun pelican-set-field (field value)
- "Set FIELD to VALUE."
- (save-excursion
- (goto-char 0)
- (if (re-search-forward (concat "^" (pelican-field field ".+*")) nil t)
- (replace-match (pelican-field field value))
- (re-search-forward "^$")
- (replace-match (pelican-field field value)))))
-
-(defun pelican-update-date ()
+(defun pelican-mode-remove-field (field)
+ "Remove FIELD."
+ (pelican-mode-set-field field nil))
+
+(defun pelican-mode-set-title (title)
+ "Set the title to TITLE."
+ (interactive "sTitle: ")
+ (pelican-mode-set-field :title title))
+
+(defun pelican-mode-update-date ()
"Update a Pelican date header."
(interactive)
- (pelican-set-field "date" (pelican-timestamp)))
+ (pelican-mode-set-field :date 'now))
-(defun pelican-publish-draft ()
- "Remove draft status from a Pelican post."
+(defun pelican-mode-publish-draft ()
+ "Remove draft status from a Pelican article."
(interactive)
- (pelican-set-field "status" nil)
- (pelican-update-date))
+ (pelican-mode-remove-field :status)
+ (pelican-mode-update-date))
-(defun pelican-is-page ()
- "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))
+(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-default-slug ()
- "Generate a Pelican post/page slug for the current buffer."
- (if-let ((pelican-base (pelican-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-base))
+ (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 "/"))
- (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-is-in-site ()
- "Check if this buffer is under a Pelican site."
- (not (null (pelican-find-root))))
+ (when-let (file-name (file-name-sans-extension buffer-file-name))
+ (file-name-base file-name))))
-(defun pelican-enable-if-site ()
- "Enable `pelican-mode' if this buffer is under a Pelican site."
- (when (pelican-is-in-site)
- (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"))
(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)))
- (let ((output (get-buffer-create "*Pelican Output*")))
- (display-buffer output)
- (pop-to-buffer output)
- (compilation-mode)
- (start-process "Pelican Makefile" output "make" target))
- (message "This doesn't look like a Pelican site.")))
+ (if-let (default-directory (pelican-mode-find-root))
+ (compilation-start (format "make %s" target)
+ nil (lambda (_) "*pelican*"))
+ (user-error "No Pelican site root could be found")))
(defun pelican-make-html ()
"Generate HTML via a Makefile at the root of the site."
(interactive)
(pelican-make "rsync_upload"))
-(defconst pelican-keymap (make-sparse-keymap)
- "The default keymap used in Pelican mode.")
-(define-key pelican-keymap (kbd "C-c P n")
- 'pelican-insert-header)
-(define-key pelican-keymap (kbd "C-c P p")
- 'pelican-publish-draft)
-(define-key pelican-keymap (kbd "C-c P t")
- 'pelican-update-date)
-(define-key pelican-keymap (kbd "C-c P h")
- 'pelican-make-html)
-(define-key pelican-keymap (kbd "C-c P u")
- '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.
-Interactively with no argument, this command toggles the mode.
-to show buffer size and position in mode-line."
- :init-value nil
- :lighter " Pelican"
- :keymap pelican-keymap
- :group 'pelican)
+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 mode is enabled, additional commands are available
+for editing articles or pages:
+
+\\{pelican-mode-map}"
+ :lighter " Pelican"
+ :keymap `((,(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 t") . pelican-mode-update-date)
+ (,(kbd "C-c P u") . pelican-make-rsync-upload)))
;;;###autoload
-(add-hook 'markdown-mode-hook 'pelican-enable-if-site)
+(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
-(add-hook 'rst-mode-hook 'pelican-enable-if-site)
+(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)))
(provide 'pelican-mode)
;;; pelican-mode.el ends here
+
+;; Local Variables:
+;; sentence-end-double-space: t
+;; End:
projects / pelican-mode.git / blobdiff