;;; planner-publish.el --- planner-specific publishing ;; Copyright (C) 2005, 2006 Peter K. Lee ;; Parts copyright (C) 2005 Chris McMahan ;; Parts copyright (C) 2005, 2006 Free Software Foundation, Inc. ;; Parts copyright (C) 2005 Dale P. Smith ;; Author: Peter K. Lee ;; Keywords: planner publish ;; Timestamp: 20 Jul 2005 10:05:29 ;; X-URL: http://www.corenova.com/... ;; This file is part of Planner. It is not part of GNU Emacs. ;; Planner is free software; you can redistribute it and/or modify it ;; under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 3, or (at your option) ;; any later version. ;; Planner is distributed in the hope that it will be useful, but ;; WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ;; General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with Planner; see the file COPYING. If not, write to the ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, ;; Boston, MA 02110-1301, USA. ;;; Commentary: ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Introduction ;; Muse Styles for Planner: planner-xml, planner-html, planner-xhtml, etc. ;; Handles publishing of planner files. Works with Muse to generate ;; flexible markup. ;;; History: ;; 2005-07-15 (0.1) : creation date ;; 2005-07-20 (0.2) : first public release ;; 2005-07-21 (0.3) : added planner-html-style-sheet customize option ;; 2005-08-09 : added to Planner, see ChangeLog for further changes ;;; TODO: ;; add support for various PLANNER specific sections such as Diary, ;; Accomplishments, Timeclock, etc. ;;; Contributors: ;; Chris McMahan (cmcmahan AT one.net) helped notes to publish correctly. ;; Jim Ottaway fixed several bugs. ;; David Smith fixed a few bugs. ;; Dale Smith implemented a new version of the "notes" tag and ;; provided several patches. ;; Andrew J. Korty enabled multiple links with the "categories" ;; attribute. (require 'planner) (require 'muse-mode) (require 'muse-publish) (require 'muse-html) ;;; allow derive style from "html" and "xhtml" (require 'muse-xml) ;;; allow derive style from "xml" (unless (featurep 'muse-nested-tags) (error (concat "Your version of Muse is too old. Please upgrade to" " at least Muse 3.03."))) (defgroup planner-publish nil "Options controlling the behavior of PLANNER publishing. See `planner-publish' for more information." :group 'planner) (defcustom planner-publish-markup-regexps '((1275 "^#\\([A-C]\\)\\([0-9]*\\)\\s-*\\([_oXDCP]\\)\\s-*\\(.+\\)" 0 task) (1280 "^\\.#[0-9]+\\s-*" 0 note) (3200 planner-date-regexp 0 link)) "List of markup rules for publishing PLANNER. For more on the structure of this list, see `muse-publish-markup-regexps'." :type '(repeat (choice (list :tag "Markup rule" integer (choice regexp symbol) integer (choice string function symbol)) function)) :group 'planner-publish) (defcustom planner-publish-markup-functions '((task . planner-publish-markup-task) (note . planner-publish-markup-note)) "An alist of style types to custom functions for that kind of text. For more on the structure of this list, see `muse-publish-markup-functions'." :type '(alist :key-type symbol :value-type function) :group 'planner-publish) (defcustom planner-publish-markup-tags '(("nested-section" t nil t planner-publish-nested-section-tag) ("title" t t nil planner-publish-title-tag) ("content" t nil nil planner-publish-content-tag) ("diary-section" t nil nil planner-publish-diary-section-tag) ("tasks-section" t nil nil planner-publish-tasks-section-tag) ("notes-section" t nil nil planner-publish-notes-section-tag) ("notes" nil nil nil planner-publish-notes-tag) ("past-notes" nil t nil planner-publish-past-notes-tag) ("task" t t nil planner-publish-task-tag) ("note" t t nil planner-publish-note-tag)) "A list of tag specifications, for specially marking up PLANNER. See `muse-publish-markup-tags' for more information." :type '(repeat (list (string :tag "Markup tag") (boolean :tag "Expect closing tag" :value t) (boolean :tag "Parse attributes" :value nil) (boolean :tag "Nestable" :value nil) function)) :group 'planner-publish) ;;;_ + XML specific customizations (defcustom planner-xml-markup-strings '((planner-begin-nested-section . "
") (planner-end-nested-section . "
") (planner-begin-title . "") (planner-end-title . "") (planner-begin-content . "") (planner-end-content . "") (planner-begin-body . "") (planner-end-body . "") (planner-begin-diary-section . "") (planner-end-diary-section . "") (planner-begin-task-section . "") (planner-end-task-section . "") (planner-begin-task-body . "") (planner-end-task-body . "") (planner-begin-note-section . "") (planner-end-note-section . "") (planner-begin-task . "") (planner-end-task . "") (planner-begin-note . "") (planner-end-note . "") (planner-begin-note-details . "
%s") (planner-end-note-details . "
") (planner-begin-note-link . "") (planner-end-note-link . "") (planner-begin-note-categories . "") (planner-end-note-categories . "")) "Strings used for marking up text as XML. These cover the most basic kinds of markup, the handling of which differs little between the various styles. If a markup rule is not found here, `muse-xml-markup-strings' is searched." :type '(alist :key-type symbol :value-type string) :group 'planner-publish) (defcustom planner-xml-header "(muse-xml-encoding)\"?> <lisp>(muse-publishing-directive \"title\")</lisp> (muse-publishing-directive \"author\") (muse-style-element :maintainer) (muse-publishing-directive \"date\") \n" "Header used for publishing PLANNER XML files. This may be text or a filename." :type 'string :group 'planner-publish) (defcustom planner-xml-footer " \n" "Footer used for publishing PLANNER XML files. This may be text or a filename." :type 'string :group 'planner-publish) ;;;_ + HTML specific customizations (defcustom planner-html-markup-strings '((planner-begin-nested-section . "
") (planner-end-nested-section . "
") (planner-begin-title . "") (planner-end-title . "") (planner-begin-content . "
") (planner-end-content . "
") (planner-begin-body . "
") (planner-end-body . "
") (planner-begin-diary-section . "
") (planner-end-diary-section . "
") (planner-begin-task-section . "
") (planner-end-task-section . "
") (planner-begin-task-body . "") (planner-begin-note-section . "
") (planner-end-note-section . "
") (planner-begin-task . "
  • %s") (planner-end-task . "
    • ") (planner-begin-note . "
    %s") (planner-end-note . "
    ") (planner-begin-note-details . "
    %s") (planner-end-note-details . "
    ") (planner-begin-note-link . " ") (planner-end-note-link . "") (planner-begin-note-categories . " ") (planner-end-note-categories . "")) "Strings used for marking up text as HTML. These cover the most basic kinds of markup, the handling of which differs little between the various styles. If a markup rule is not found here, `muse-html-markup-strings' is searched." :type '(alist :key-type symbol :value-type string) :group 'planner-publish) (defcustom planner-html-style-sheet "" "Store your stylesheet definitions here. The provided default is for reference only. You definitely want to customize this for your particular needs & wants. This is used in `planner-html-header' and `planner-xhtml-header'. Refer to `muse-html-style-sheet' for details on usage. You may simply override the above by specifying an explicit link to a CSS file." :type 'string :group 'planner-publish) (defcustom planner-html-header " <lisp> (concat (muse-publishing-directive \"title\") (let ((author (muse-publishing-directive \"author\"))) (if (not (string= author (user-full-name))) (concat \" (by \" author \")\"))))</lisp> muse-html-meta-http-equiv\" content=\"muse-html-meta-content-type\"> (let ((maintainer (muse-style-element :maintainer))) (when maintainer (concat \"\"))) planner-html-style-sheet

    (concat (muse-publishing-directive \"title\") (let ((author (muse-publishing-directive \"author\"))) (if (not (string= author (user-full-name))) (concat \" (by \" author \")\"))))

    planner-html-inner-header
    \n" "Header used for publishing PLANNER HTML files. This may be text or a filename." :type 'string :group 'planner-publish) (defcustom planner-html-footer "
    planner-html-inner-footer
    \n" "Footer used for publishing PLANNER HTML files. This may be text or a filename." :type 'string :group 'planner-publish) (defcustom planner-xhtml-header " (muse-html-encoding)\"?> <lisp> (concat (muse-publishing-directive \"title\") (let ((author (muse-publishing-directive \"author\"))) (if (not (string= author (user-full-name))) (concat \" (by \" author \")\"))))</lisp> muse-html-meta-http-equiv\" content=\"muse-html-meta-content-type\" /> (let ((maintainer (muse-style-element :maintainer))) (when maintainer (concat \"\"))) planner-html-style-sheet

    (concat (muse-publishing-directive \"title\") (let ((author (muse-publishing-directive \"author\"))) (if (not (string= author (user-full-name))) (concat \" (by \" author \")\"))))

    planner-html-inner-header
    \n" "Header used for publishing PLANNER XHTML files. This may be text or a filename." :type 'string :group 'planner-publish) (defcustom planner-xhtml-footer "
    planner-html-inner-footer
    \n" "Footer used for publishing PLANNER XHTML files. This may be text or a filename." :type 'string :group 'planner-publish) (defcustom planner-html-inner-header "" "Extra header section that can be embedded within `planner-html-header' and `planner-xhtml-header'." :type 'string :group 'planner-publish) (defcustom planner-html-inner-footer "" "Extra footer section that can be embedded within `planner-html-footer' and `planner-xhtml-footer'." :type 'string :group 'planner-publish) ;;;_ + Publishing hooks (defcustom planner-publish-prepare-regexps '((100 "^\\(\\*+\\)\\s-+" 0 planner-publish-section)) "List of markup rules to apply before publishing a page with Planner. See `muse-publish-markup-regexps' for details on the syntax used." :type '(repeat (choice (list :tag "Markup rule" integer (choice regexp symbol) integer (choice string function symbol)) function)) :group 'planner-publish) (defcustom planner-publish-finalize-regexps '() "List of markup rules to apply after publishing a page with Planner. See `muse-publish-markup-regexps' for details on the syntax used." :type '(repeat (choice (list :tag "Markup rule" integer (choice regexp symbol) integer (choice string function symbol)) function)) :group 'planner-publish) (defun planner-publish-prepare-buffer () (goto-char (point-min)) (muse-publish-markup "preparing Planner page" planner-publish-prepare-regexps) ;; indicate that we are to continue preparing the buffer nil) (defun planner-publish-finalize-buffer () (goto-char (point-min)) (muse-publish-markup "finalizing Planner page" planner-publish-finalize-regexps) ;; indicate that we are to continue finalizing the buffer nil) ;;;_ + Markup (defvar planner-publish-ignore-url-desc-specials nil "If non-nil, do not escape specials in URL descriptions.") (defun planner-publish-decide-specials (context) "Determine the specials to escape for Planner, depending on CONTEXT." (if (and (eq context 'url-desc) planner-publish-ignore-url-desc-specials) nil (muse-xml-decide-specials context))) (defun planner-publish-markup-task () "Replace tasks with XML representation of task data." (save-restriction (narrow-to-region (planner-line-beginning-position) (planner-line-end-position)) (let ((info (planner-current-task-info))) (delete-region (point-min) (point-max)) (forward-line 1) (insert (format (concat "") (or (planner-task-number info) "") (or (planner-task-priority info) "") (or (planner-publish-task-status-expand (planner-task-status info)) "") (or (planner-task-link-text info) "") (or (planner-task-plan info) "") (or (planner-task-date info) ""))) ;; mark this area read only for safety's sake (planner-insert-markup (planner-task-description info)) (insert "")))) (defun planner-publish-markup-note () "Replace note with XML representation of note data. Borrowed heavily from Sacha's personal configs." (save-restriction (narrow-to-region (save-excursion (beginning-of-line) (point)) (or (save-excursion (and (re-search-forward "^\\(\\.#\\|* \\|\\)" nil t) (match-beginning 0))) (point-max))) (let ((info (planner-current-note-info t))) (delete-region (point-min) (point-max)) (insert (format (concat "") (planner-note-anchor info) (or (planner-note-timestamp info) "") (or (planner-note-link info) "") (or (planner-note-link-text info) "")) "" (planner-note-title info) "\n" "\n") (planner-insert-markup (planner-note-body info)) (insert "\n\n\n\n")))) ;;;_ + Tags (defun planner-insert-markup (&rest args) (if (fboundp 'muse-insert-markup) (apply 'muse-insert-markup args) (let ((beg (point))) (apply 'insert args) (muse-publish-mark-read-only beg (point))))) (defun planner-publish-nested-section-tag (beg end) "Generated by `planner-publish-section', the nested section tag now takes in TITLE and LEVEL attributes. This is related to the Muse concept of sections, but done before marking up the buffer, and with special actions done on the title of each section." (save-excursion (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-nested-section)) (goto-char end) (planner-insert-markup (muse-markup-text 'planner-end-nested-section)))) (defun planner-publish-title-tag (beg end attrs) (let ((level (cdr (assoc "level" attrs)))) (save-excursion (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-title level)) (goto-char end) (planner-insert-markup (muse-markup-text 'planner-end-title level))))) (defun planner-publish-content-tag (beg end) (save-excursion (goto-char end) (planner-insert-markup (muse-markup-text 'planner-end-content)) (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-content)))) (defun planner-publish-diary-section-tag (beg end) (save-excursion (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-diary-section)) (forward-line 1) (muse-publish-verse-tag (point) end) (goto-char end) (insert "\n") (planner-insert-markup (muse-markup-text 'planner-end-diary-section)))) (defun planner-publish-tasks-section-tag (beg end) (save-excursion (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-task-section)) (forward-line 1) (planner-insert-markup (muse-markup-text 'planner-begin-task-body)) (goto-char end) (planner-insert-markup (muse-markup-text 'planner-end-task-body)) (planner-insert-markup (muse-markup-text 'planner-end-task-section)))) (defun planner-publish-task-tag (beg end attrs) (save-excursion (let ((number (cdr (assoc "id" attrs))) (status (cdr (assoc "status" attrs))) (priority (cdr (assoc "priority" attrs))) (link (cdr (assoc "link" attrs))) (plan (cdr (assoc "plan" attrs))) (date (cdr (assoc "date" attrs)))) (remove-text-properties beg end '(read-only nil rear-nonsticky nil)) (goto-char end) (when link (insert " (" (planner-make-link link) ")")) (planner-insert-markup (muse-markup-text 'planner-end-task)) (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-task status priority (if planner-use-task-numbers (concat priority number) (concat priority (number-to-string (random 134217727)))) (concat priority number " " (planner-publish-task-status-collapse status) " ")))))) (defun planner-publish-notes-section-tag (beg end) "Replace the region BEG to END with the notes for this page." (save-excursion (planner-insert-markup (muse-markup-text 'planner-begin-note-section)) (forward-line 1) (planner-insert-markup (muse-markup-text 'planner-begin-body)) (insert ?\n) (goto-char end) (planner-insert-markup (muse-markup-text 'planner-end-body)) (planner-insert-markup (muse-markup-text 'planner-end-note-section)))) (defun planner-publish-notes-tag (beg end) "Replace the region BEG to END with an index of the notes for this page." (delete-region beg end) (insert "\n") (mapcar (lambda (item) (insert (format " - [[%s%s][%s]]\n" (planner-page-name) (car item) (planner-remove-links (cdr item))))) (save-excursion (find-file muse-publishing-current-file) (planner-notes-get-headlines))) (insert "\n")) (defun planner-publish-past-notes-tag (beg end attrs) "Replace the region BEG to END with an index of past notes. If ATTRS is non-nil, it is an alist containing values for DIRECTORY and START." (let ((files (save-excursion (find-file muse-publishing-current-file) (planner-get-day-pages nil nil t))) (earliest (cdr (assoc "start" attrs)))) (while files (when (or (null earliest) (not (string-lessp (caar files) earliest))) (let ((title-lines (list t))) (with-temp-buffer (insert-file-contents (cdar files)) (while (re-search-forward "^\\.#\\([0-9]+\\)\\s-+\\(.+\\)" nil t) (nconc title-lines (list (cons (match-string 1) (match-string 2)))))) (setq title-lines (cdr title-lines)) (when title-lines (insert (planner-make-link (planner-page-name (caar files))) " ::\n") (planner-insert-markup "
    \n") (while title-lines (planner-insert-markup "
    ") (insert (format "[[%s#%s][%s]]" (planner-page-name (caar files)) (caar title-lines) (cdar title-lines))) (planner-insert-markup "
    \n") (setq title-lines (cdr title-lines))) (planner-insert-markup "
    \n\n")))) (setq files (cdr files))))) (defun planner-publish-note-tag (beg end attrs) (save-excursion (let ((anchor (or (cdr (assoc "anchor" attrs)) "")) (timestamp (or (cdr (assoc "timestamp" attrs)) "")) (link (or (cdr (assoc "link" attrs)) "")) (categories (or (cdr (assoc "categories" attrs)) ""))) (remove-text-properties beg end '(read-only nil rear-nonsticky nil)) (goto-char beg) (planner-insert-markup (muse-markup-text 'planner-begin-note anchor (concat "#" anchor))) (goto-char end) (planner-insert-markup (muse-markup-text 'planner-begin-note-details timestamp) (muse-markup-text 'planner-begin-note-link)) (insert link) (planner-insert-markup (muse-markup-text 'planner-end-note-link)) ;; remove link item from categories to avoid duplicates (unless (or (string= link "") (string= categories "")) (setq categories (planner-replace-regexp-in-string (regexp-quote link) "" categories t t))) (planner-insert-markup (muse-markup-text 'planner-begin-note-categories)) (insert categories) (planner-insert-markup (muse-markup-text 'planner-end-note-categories)) (insert ?\n) (planner-insert-markup (muse-markup-text 'planner-end-note-details)) (planner-insert-markup (muse-markup-text 'planner-end-note))))) ;;;_ + helper routine (defun planner-publish-task-status-expand (status) (cond ((string= status "_") "open") ((string= status "o") "in-progress") ((string= status "D") "delegated") ((string= status "P") "pending") ((string= status "X") "done") ((string= status "C") "cancelled") (t "unknown"))) (defun planner-publish-task-status-collapse (status) (cond ((string= status "open") "_") ((string= status "in-progress") "o") ((string= status "delegated") "D") ((string= status "pending") "P") ((string= status "done") "X") ((string= status "cancelled") "C") (t "?"))) (defun planner-publish-section-close (depth text) "Find where the closing tag of DEPTH should go, and insert TEXT." (let (not-end) (save-excursion (while (and (setq not-end (re-search-forward (concat "^\\*\\{1," (number-to-string depth) "\\}\\s-+") nil t)) (get-text-property (match-beginning 0) 'read-only))) (if not-end (forward-line 0) (goto-char (point-max))) (cond ((not (eq (char-before) ?\n)) (insert "\n\n")) ((not (eq (char-before (1- (point))) ?\n)) (insert "\n"))) (insert text) (insert "\n")))) (defvar planner-section-tagnames '(("Diary" . "diary-section") ("Tasks" . "tasks-section") ("Notes" . "notes-section")) "Alist of sections and their tag name.") (defun planner-publish-section-tagname (text) "A routine that checks `planner-section-tagnames' for tagname." (let ((tagname (cdr (assoc text planner-section-tagnames)))) (if tagname tagname "nested-section"))) (defun planner-publish-section () "Publish the current heading as a section." (let* ((depth (length (match-string 1))) (title (buffer-substring (match-end 0) (planner-line-end-position))) (tagname (planner-publish-section-tagname title))) (delete-region (match-beginning 0) (match-end 0)) (insert (format "<%s level=\"%s\">" tagname depth (1+ depth))) (end-of-line) (insert "") (planner-publish-section-close depth (format "" tagname)))) ;;;_ + Planner Style Definitions (muse-derive-style "planner-xml" "xml" :regexps 'planner-publish-markup-regexps :functions 'planner-publish-markup-functions :tags 'planner-publish-markup-tags :specials 'planner-publish-decide-specials :strings 'planner-xml-markup-strings :before 'planner-publish-prepare-buffer :after 'planner-publish-finalize-buffer :header 'planner-xml-header :footer 'planner-xml-footer) (muse-derive-style "planner-html" "html" :regexps 'planner-publish-markup-regexps :functions 'planner-publish-markup-functions :tags 'planner-publish-markup-tags :specials 'planner-publish-decide-specials :strings 'planner-html-markup-strings :before 'planner-publish-prepare-buffer :after 'planner-publish-finalize-buffer :header 'planner-html-header :footer 'planner-html-footer) (muse-derive-style "planner-xhtml" "xhtml" :regexps 'planner-publish-markup-regexps :functions 'planner-publish-markup-functions :tags 'planner-publish-markup-tags :specials 'planner-publish-decide-specials :strings 'planner-html-markup-strings :before 'planner-publish-prepare-buffer :after 'planner-publish-finalize-buffer :header 'planner-xhtml-header :footer 'planner-xhtml-footer) (provide 'planner-publish) ;;; planner-publish.el ends here