[PATCH] org-publish: sitemap doc

[PATCH] org-publish: sitemap doc

[Manuel Giraud]

[-- Attachment #1: Type: text/plain, Size: 52 bytes --]


Hi, 

Some documentation for new sitemap options.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org.texi-documentation-of-sitemap-s-entry-options.patch --]
[-- Type: text/x-patch, Size: 1906 bytes --]

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

---
 doc/org.texi |   15 ++++++++++++++-
 1 files changed, 14 insertions(+), 1 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 0a5b065..c8e0597 100644
--- a/doc/org.texi
+++ b/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
-- 
1.7.1


[-- 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

[Accepted] org-publish: sitemap doc

[Bastien Guerry]

Patch 616 (http://patchwork.newartisans.com/patch/616/) is now "Accepted".

Maintainer comment: none

This relates to the following submission:

http://mid.gmane.org/%3C87hbc6n6wt.fsf%40univ-nantes.fr%3E

Here is the original message containing the patch:

> Content-Type: text/plain; charset="utf-8"
> MIME-Version: 1.0
> Content-Transfer-Encoding: 7bit
> Subject: [Orgmode] org-publish: sitemap doc
> Date: Mon, 14 Feb 2011 17:21:22 -0000
> From: Manuel Giraud <manuel.giraud@univ-nantes.fr>
> X-Patchwork-Id: 616
> Message-Id: <87hbc6n6wt.fsf@univ-nantes.fr>
> To: emacs-orgmode <emacs-orgmode@gnu.org>
> 
> 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
> 
> ---
>  doc/org.texi |   15 ++++++++++++++-
>  1 files changed, 14 insertions(+), 1 deletions(-)
> 
> diff --git a/doc/org.texi b/doc/org.texi
> index 0a5b065..c8e0597 100644
> --- a/doc/org.texi
> +++ b/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
> -- 
> 1.7.1
> 
> 

Re: [PATCH] org-publish: sitemap doc

[Bastien]

Manuel Giraud <manuel.giraud@univ-nantes.fr> writes:

> Some documentation for new sitemap options.

Applied, thanks Manuel.

-- 
 Bastien