Browse Source

Docs: Correct the documentation for the publishing function.

Patch by David Maus
Carsten Dominik 15 years ago
parent
commit
cd708f15f8
2 changed files with 10 additions and 4 deletions
  1. 5 0
      doc/ChangeLog
  2. 5 4
      doc/org.texi

+ 5 - 0
doc/ChangeLog

@@ -1,3 +1,8 @@
+2010-03-01  Carsten Dominik  <carsten.dominik@gmail.com>
+
+	* org.texi (Publishing action): Correct the documentation for the
+	publishing function.
+
 2010-02-26  Carsten Dominik  <carsten.dominik@gmail.com>
 
 	* org.texi (The date/time prompt): Document that we accept dates

+ 5 - 4
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