From: David Maus <maus.david@gmail.com>
To: Org Mode <emacs-orgmode@gnu.org>
Subject: [patch] Correction for the manual (chapter 13.1.4)
Date: Sun, 28 Feb 2010 21:35:22 +0100 [thread overview]
Message-ID: <87ocj9umid.wl%maus.david@gmail.com> (raw)
[-- Attachment #1.1.1: Type: text/plain, Size: 932 bytes --]
While wrapping my head around a set of publishing functions to create
atom and rss feeds I noticed an incorrect description in the manual.
In chapter 13.1.4 in reads:
,----
| :publishing-function
|
| Function executing the publication of a file. This may also be a list
| of functions, which will all be called in turn.
|
| [...]
|
| The function must accept two arguments: a property list containing at
| least a :publishing-directory property, and the name of the file to be
| published. It should take the specified file, make the necessary
| transformation (if any) and place the result into the destination
| folder.
`----
But the publishing function must accept /three/ arguments: The third
one is the specific publishing directory for the source file.
Attached patch corrects the information in the manual.
Regards
-- David
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... maus.david@gmail.com
[-- Attachment #1.1.2: 0001-Fix-description-of-mandatory-parameters-of-publishin.patch --]
[-- Type: application/octet-stream, Size: 1388 bytes --]
From bd9444d3031a33e7f2041c7da0239aa2d3751f82 Mon Sep 17 00:00:00 2001
From: David Maus <maus.david@gmail.com>
Date: Sun, 28 Feb 2010 20:51:32 +0100
Subject: [PATCH] Fix description of mandatory parameters of publishing-function in
org-publish-project-alist.
---
doc/org.texi | 9 +++++----
1 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index ef17947..a5d8622 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -10156,10 +10156,11 @@ list of functions, which will all be called in turn.
@tab Non-nil means, publish htmlized source.
@end multitable
-The function must accept two arguments: a property list containing at least a
-@code{:publishing-directory} property, and the name of the file to be
-published. It should take the specified file, make the necessary
-transformation (if any) and place the result into the destination folder.
+The function must accept three arguments: a property list containing at least
+a @code{:publishing-directory} property, the name of the file to be
+published, and the path to the publishing directory of the output file. It
+should take the specified file, make the necessary transformation (if any)
+and place the result into the destination folder.
@node Publishing options, Publishing links, Publishing action, Configuration
@subsection Options for the HTML/La@TeX{} exporters
--
1.7.0
[-- 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
next reply other threads:[~2010-02-28 20:35 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-02-28 20:35 David Maus [this message]
2010-03-01 7:53 ` [patch] Correction for the manual (chapter 13.1.4) 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ocj9umid.wl%maus.david@gmail.com \
--to=maus.david@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.