Parcourir la source

org-publish: sitemap doc

Hi,

Some documentation for new sitemap options.

>From 3a846a674a33a5f2a0a2404b88331942e2012779 Mon Sep 17 00:00:00 2001
From: Manuel Giraud <manuel.giraud@univ-nantes.fr>
Date: Mon, 14 Feb 2011 11:34:04 +0100
Subject: [PATCH] org.texi: documentation of sitemap's entry options
Manuel Giraud il y a 14 ans
Parent
commit
5f7654c6cf
1 fichiers modifiés avec 14 ajouts et 1 suppressions
  1. 14 1
      doc/org.texi

+ 14 - 1
doc/org.texi

@@ -10978,7 +10978,7 @@ of links to all files in the project.
 respectively.  Any other value will mix files and folders.
 
 @item @code{:sitemap-sort-files}
-@tab How the files are sorted in the site map.  Set this
+@tab How the files are sorted in the site map.  Set this to
 @code{alphabetically} (default), @code{chronologically} or
 @code{anti-chronologically}. @code{chronologically} sorts the files with
 older date first while @code{anti-chronologically} sorts the files with newer
@@ -10988,6 +10988,19 @@ a file is retrieved with @code{org-publish-find-date}.
 @item @code{:sitemap-ignore-case}
 @tab Should sorting be case-sensitive?  Default @code{nil}.
 
+@item @code{:sitemap-file-entry-format}
+@tab With this option one can tell how a sitemap's entry is formated in the
+sitemap. This is a format string with some escape sequences: @code{%t} stands
+for the title of the file, @code{%a} stands for the author of the file and
+@code{%d} stands for the date of the file. The date is retrieved with the
+@code{org-publish-find-date} function and formated with
+@code{org-publish-sitemap-date-format}. Default @code{%t}.
+
+@item @code{:sitemap-date-format}
+@tab Format string for the @code{format-time-string} function that tells how
+a sitemap entry's date is to be formated. This property bypasses
+@code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
+
 @end multitable
 
 @node Generating an index,  , Sitemap, Configuration