X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=pelican-mode.el;h=bfd0ea6f78987c731276aebff2868b5c9764545b;hp=4c3428ab7879afc51ce9cc0a7b74707db8e9461d;hb=9bd1bc0c098b7f3e9d556e61a3d65e68e6ce48bd;hpb=b0fb69e2d54951212453dd290ca8ad8c6709a0f7 diff --git a/pelican-mode.el b/pelican-mode.el index 4c3428a..bfd0ea6 100644 --- a/pelican-mode.el +++ b/pelican-mode.el @@ -20,11 +20,32 @@ ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . + ;;; 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: @@ -33,7 +54,9 @@ (require 'subr-x) (defgroup pelican-mode nil - "Support for Pelican articles and pages." + "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 @@ -42,7 +65,7 @@ See the documentation for `pelican-mode-set-field' for more information about metadata fields and special values." - :group 'pelican + :group 'pelican-mode :type '(plist)) (defcustom pelican-mode-default-article-fields @@ -51,9 +74,21 @@ about metadata fields and special values." See the documentation for `pelican-mode-set-field' for more information about metadata fields and special values." - :group 'pelican + :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)) @@ -86,7 +121,7 @@ about metadata fields and special values." #'pelican-mode-insert-page-header #'pelican-mode-insert-draft-article-header))) -(defun pelican-mode-set-field/rst-mode (field value) +(defun pelican-mode-set-field-rst-mode (field value) "Set reStructuredText metadata FIELD to VALUE." (setq field (downcase field)) (if (equal field "title") @@ -96,23 +131,61 @@ about metadata fields and special values." (replace-match header) (insert header))) (let ((text (when value (format ":%s: %s\n" field value)))) - (when (re-search-forward "^#" nil t) - (forward-line 2)) + (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 - (re-search-forward "^$") - (replace-match text)))))) + (if (re-search-forward "^$" nil t) + (replace-match text) + (insert text))))))) -(defun pelican-mode-set-field/markdown-mode (field value) +(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 - (re-search-forward "^$") - (replace-match text))))) + (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. @@ -120,15 +193,19 @@ about metadata fields and special values." 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'. - `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)) @@ -137,13 +214,13 @@ the unquoted printed representation of it is used: (_ value))) (when (symbolp field) (setq field (string-remove-prefix ":" (symbol-name field)))) - (save-excursion - (goto-char 0) - (cond ((derived-mode-p 'markdown-mode) - (pelican-mode-set-field/markdown-mode field value)) - ((derived-mode-p 'rst-mode) - (pelican-mode-set-field/rst-mode field value)) - (t (error "Unsupported major mode %S" major-mode))))) + (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-mode-remove-field (field) "Remove FIELD." @@ -181,25 +258,12 @@ the unquoted printed representation of it is used: (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-mode-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)))) + (when-let (file-name (file-name-sans-extension buffer-file-name)) + (file-name-base file-name)))) (defun pelican-mode-find-root () "Return the root of the buffer's Pelican site, or nil." - (when-let (conf (pelican-mode-find-in-parents "pelicanconf.py")) - (file-name-directory conf))) + (locate-dominating-file default-directory "pelicanconf.py")) (defun pelican-make (target) "Execute TARGET in a Makefile at the root of the site." @@ -207,7 +271,7 @@ the unquoted printed representation of it is used: (if-let (default-directory (pelican-mode-find-root)) (compilation-start (format "make %s" target) nil (lambda (_) "*pelican*")) - (user-error "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." @@ -226,6 +290,10 @@ 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/. + When Pelican mode is enabled, additional commands are available for editing articles or pages: @@ -235,6 +303,7 @@ for editing articles or pages: (,(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 f") . pelican-set-field) (,(kbd "C-c P u") . pelican-make-rsync-upload))) ;;;###autoload @@ -244,6 +313,10 @@ 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. @@ -252,7 +325,7 @@ 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 + :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)))