emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: David Maus <dmaus@ictsoc.de>
To: Carsten Dominik <carsten.dominik@gmail.com>
Cc: emacs org-mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: publishing, and :auto-index
Date: Thu, 18 Mar 2010 12:25:36 +0100	[thread overview]
Message-ID: <87zl25kh1r.wl%dmaus@ictsoc.de> (raw)
In-Reply-To: <10996750-3DF0-42AA-B0B0-45A75998067D@gmail.com>


[-- Attachment #1.1: Type: text/plain, Size: 1416 bytes --]

Hi Carsten,

Carsten Dominik wrote:
>Hi,

>I am wondering is anyone is using the :auto-index functionality with
>Org publishing.

I'm not using it on my publishing projects but intend to use it as the
place I can hook in to publish an atom feed for multiple input files
of a project.  For this "index" fits as good or bad as "sitemap" would
do.

>The fact that this is called "index" is driving me crazy, and I would
>like to rename this and all related properties to "sitemap.
>Thus :auto-sitemap, :sitemap-style, :sitemap-title etc etc

IMO the problem with the /function's/ name is that even "sitemap" is
to specific or, in other words, creating a sitemap for a project is a
special use case of a preparation function.

Compared with current functionality of :preparation-function,
:index-function is a better implementation of a preparation function
because the project is passed to it as an argument.

So a correct implementation could look like:

,----
| :sitemap-style 'tree
| :sitemap-title "Sitemap"
| :sitemap-filename "sitemap.org"
| :preparation-function 'org-publish-org-sitemap
`----

Reducing :index-function to a :preparation-function while keeping the
benefits of :index-function (i.e. project as argument) would introduce
a backward incompatible change.  But a least with a good argument, I
think.

 -- David
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #1.2: Type: application/pgp-signature, Size: 230 bytes --]

[-- Attachment #2: 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

  reply	other threads:[~2010-03-18 11:25 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-03-18  7:48 publishing, and :auto-index Carsten Dominik
2010-03-18 11:25 ` David Maus [this message]
2010-03-18 12:35 ` Sebastian Rose
2010-03-19 17:26   ` Carsten Dominik

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=87zl25kh1r.wl%dmaus@ictsoc.de \
    --to=dmaus@ictsoc.de \
    --cc=carsten.dominik@gmail.com \
    --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).