Add AsciiDoc support.
[pelican-mode.git] / pelican-mode.el
index 47153f8..8a53c27 100644 (file)
@@ -24,7 +24,9 @@
 ;;; Commentary:
 ;;
 ;; pelican-mode is an Emacs minor mode for editing pages and posts in
-;; Pelican (URL http://getpelican.com/) sites.
+;; 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''
@@ -44,7 +46,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
@@ -53,7 +57,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
@@ -62,17 +66,18 @@ 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-set-field-alist
+(defcustom pelican-mode-formats
   '((markdown-mode . pelican-mode-set-field-markdown-mode)
+    (adoc-mode . pelican-mode-set-field-adoc-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
+  :group 'pelican-mode
   :type '(alist :key-type function :value-type function))
 
 (defun pelican-mode-timestamp (&optional time)
@@ -117,8 +122,8 @@ arguments, field and value strings."
             (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
@@ -137,6 +142,24 @@ arguments, field and value strings."
             (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 (field value)
   "Set FIELD to VALUE.
 
@@ -161,7 +184,7 @@ the unquoted printed representation of it is used:
   (when (symbolp field)
     (setq field (string-remove-prefix ":" (symbol-name field))))
   (let ((set-field
-         (assoc-default nil pelican-mode-set-field-alist #'derived-mode-p)))
+         (assoc-default nil pelican-mode-formats #'derived-mode-p)))
     (unless set-field
       (error "Unsupported major mode %S" major-mode))
     (save-excursion
@@ -236,6 +259,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:
 
@@ -254,6 +281,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.
@@ -262,7 +293,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)))