From: Manuel Giraud <manuel.giraud@univ-nantes.fr>
To: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: [Patch 2/2] org-publish
Date: Wed, 01 Dec 2010 11:11:56 +0100 [thread overview]
Message-ID: <87ipzd7qfn.fsf@univ-nantes.fr> (raw)
[-- Attachment #1: Type: text/plain, Size: 254 bytes --]
This second patch (that should be applied after the first one) adds a
formating option to sitemap entries. One can now use a formated string
to generate a sitemap entry. This formated string currently understands
title (%T), author (%A) and date (%D).
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: formated-sitemap.patch --]
[-- Type: text/x-patch, Size: 4581 bytes --]
diff --git a/lisp/org-publish.el b/lisp/org-publish.el
index 296921f..ec58af0 100644
--- a/lisp/org-publish.el
+++ b/lisp/org-publish.el
@@ -267,6 +267,22 @@ You can overwrite this default per project in your
:group 'org-publish
:type 'boolean)
+(defcustom org-publish-sitemap-date-format "%Y-%m-%d"
+ "Format for `format-time-string' which is used to print a date
+in the sitemap."
+ :group 'org-publish
+ :type 'string)
+
+(defcustom org-publish-sitemap-file-entry-format "[%T]"
+ "How a sitemap file entry is formated.
+Watch out the text used for the link should between brackets.
+
+%T is the title.
+%A is the author.
+%D is the date formated using `org-publish-sitemap-date-format'."
+ :group 'org-publish
+ :type 'string)
+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Timestamp-related functions
@@ -370,6 +386,8 @@ This splices all the components into the list."
(defvar sitemap-sort-folders)
(defvar sitemap-ignore-case)
(defvar sitemap-requested)
+(defvar sitemap-date-format)
+(defvar sitemap-file-entry-format)
(defun org-publish-compare-directory-files (a b)
"Predicate for `sort', that sorts folders and files for sitemap."
(let ((retval t))
@@ -392,8 +410,10 @@ This splices all the components into the list."
(not (string-lessp B A))))))
((or (equal sitemap-sort-files 'chronologically)
(equal sitemap-sort-files 'anti-chronologically))
- (let ((A (org-publish-find-date a))
- (B (org-publish-find-date b)))
+ (let* ((adate (org-publish-find-date a))
+ (bdate (org-publish-find-date b))
+ (A (+ (lsh (car adate) 16) (cadr adate)))
+ (B (+ (lsh (car bdate) 16) (cadr bdate))))
(setq retval (if (equal sitemap-sort-files 'chronologically)
(<= A B)
(>= A B)))))))
@@ -695,6 +715,10 @@ If :makeindex is set, also produce a file theindex.org."
"sitemap.org"))
(sitemap-function (or (plist-get project-plist :sitemap-function)
'org-publish-org-sitemap))
+ (sitemap-date-format (or (plist-get project-plist :sitemap-date-format)
+ org-publish-sitemap-date-format))
+ (sitemap-file-entry-format (or (plist-get project-plist :sitemap-file-entry-format)
+ org-publish-sitemap-file-entry-format))
(preparation-function (plist-get project-plist :preparation-function))
(completion-function (plist-get project-plist :completion-function))
(files (org-publish-get-base-files project exclude-regexp)) file)
@@ -770,12 +794,27 @@ Default for SITEMAP-FILENAME is 'sitemap.org'."
(setq indent-str (make-string
(+ (length indent-str) 2) ?\ )))))))
;; This is common to 'flat and 'tree
- (insert (concat indent-str " + [[file:" link "]["
- (org-publish-find-title file)
- "]]\n")))))
+ (let ((entry
+ (org-publish-format-file-entry sitemap-file-entry-format
+ file project-plist))
+ (regexp "\\(.*\\)\\[\\([^][]+\\)\\]\\(.*\\)"))
+ (string-match regexp entry)
+ (insert (concat indent-str " + " (match-string 1 entry)
+ "[[file:" link "]["
+ (match-string 2 entry)
+ "]]" (match-string 3 entry) "\n"))))))
(save-buffer))
(or visiting (kill-buffer sitemap-buffer))))
+(defun org-publish-format-file-entry (fmt file project-plist)
+ (org-replace-escapes fmt
+ (list (cons "%T" (org-publish-find-title file))
+ (cons "%D" (format-time-string
+ sitemap-date-format
+ (org-publish-find-date file)))
+ (cons "%A" (or (plist-get project-plist :author)
+ user-full-name)))))
+
(defun org-publish-find-title (file)
"Find the title of FILE in project."
(or
@@ -800,7 +839,9 @@ Default for SITEMAP-FILENAME is 'sitemap.org'."
(defun org-publish-find-date (file)
"Find the date of FILE in project.
If FILE provides a #+date keyword use it else use the file
-system's modification time."
+system's modification time.
+
+It returns time in `current-time' format."
(let ((visiting (find-buffer-visiting file)))
(save-excursion
(switch-to-buffer (or visiting (find-file file)))
@@ -809,10 +850,9 @@ system's modification time."
(unless visiting
(kill-buffer (current-buffer)))
(if date
- (let ((dt (org-time-string-to-time date)))
- (+ (lsh (car dt) 16) (cadr dt)))
+ (org-time-string-to-time date)
(when (file-exists-p file)
- (org-publish-cache-ctime-of-src file)))))))
+ (nth 5 (file-attributes file))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Interactive publishing functions
[-- Attachment #3: Type: text/plain, Size: 19 bytes --]
--
Manuel Giraud
[-- Attachment #4: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
next reply other threads:[~2010-12-01 10:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-01 10:11 Manuel Giraud [this message]
2011-02-08 17:04 ` [Patch 2/2] org-publish Bastien
2011-02-09 12:23 ` Manuel Giraud
2011-02-09 16:13 ` [Accepted] [Orgmode,2/2] org-publish Bastien Guerry
2011-02-09 16:14 ` [Patch 2/2] org-publish Bastien
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ipzd7qfn.fsf@univ-nantes.fr \
--to=manuel.giraud@univ-nantes.fr \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).