aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2008-05-08 15:46:49 +0000
committerJuanma Barranquero2008-05-08 15:46:49 +0000
commit50243adff2db2a9ef0b2d7138b2eeb7999f610d9 (patch)
tree468fe5db89d3ff1b01060f56e04786a25dd6d249
parent888b663c5ece6e9fa78a2534380b9e62584334c9 (diff)
downloademacs-50243adff2db2a9ef0b2d7138b2eeb7999f610d9.tar.gz
emacs-50243adff2db2a9ef0b2d7138b2eeb7999f610d9.zip
(org-publish-project-alist): Doc fixes.
(org-publish-use-timestamps-flag): Reflow docstring. (org-publish-files-alist): Fix typos in docstring.
-rw-r--r--lisp/org/org-publish.el85
1 files changed, 42 insertions, 43 deletions
diff --git a/lisp/org/org-publish.el b/lisp/org/org-publish.el
index 3dc5e744fe4..351b11e31a6 100644
--- a/lisp/org/org-publish.el
+++ b/lisp/org/org-publish.el
@@ -162,7 +162,7 @@
162(defcustom org-publish-project-alist nil 162(defcustom org-publish-project-alist nil
163 "Association list to control publishing behavior. 163 "Association list to control publishing behavior.
164Each element of the alist is a publishing 'project.' The CAR of 164Each element of the alist is a publishing 'project.' The CAR of
165each element is a string, uniquely identifying the project. The 165each element is a string, uniquely identifying the project. The
166CDR of each element is in one of the following forms: 166CDR of each element is in one of the following forms:
167 167
168 (:property value :property value ... ) 168 (:property value :property value ... )
@@ -174,12 +174,12 @@ OR,
174When the CDR of an element of org-publish-project-alist is in 174When the CDR of an element of org-publish-project-alist is in
175this second form, the elements of the list after :components are 175this second form, the elements of the list after :components are
176taken to be components of the project, which group together files 176taken to be components of the project, which group together files
177requiring different publishing options. When you publish such a 177requiring different publishing options. When you publish such a
178project with M-x org-publish, the components all publish. 178project with \\[org-publish], the components all publish.
179 179
180When a property is given a value in org-publish-project-alist, its 180When a property is given a value in org-publish-project-alist, its
181setting overrides the value of the corresponding user variable 181setting overrides the value of the corresponding user variable
182 (if any) during publishing. However, options set within a file 182\(if any) during publishing. However, options set within a file
183override everything. 183override everything.
184 184
185Most properties are optional, but some should always be set: 185Most properties are optional, but some should always be set:
@@ -191,30 +191,30 @@ Most properties are optional, but some should always be set:
191 files will be published 191 files will be published
192 192
193The :exclude property may be used to prevent certain files from 193The :exclude property may be used to prevent certain files from
194being published. Its value may be a string or regexp matching 194being published. Its value may be a string or regexp matching
195file names you don't want to be published. 195file names you don't want to be published.
196 196
197The :include property may be used to include extra files. Its 197The :include property may be used to include extra files. Its
198value may be a list of filenames to include. The filenames are 198value may be a list of filenames to include. The filenames are
199considered relative to the publishing directory. 199considered relative to the publishing directory.
200 200
201When both :include and :exclude properties are given values, the 201When both :include and :exclude properties are given values, the
202exclusion step happens first. 202exclusion step happens first.
203 203
204One special property controls which back-end function to use for 204One special property controls which back-end function to use for
205publishing files in the project. This can be used to extend the 205publishing files in the project. This can be used to extend the
206set of file types publishable by org-publish, as well as the set 206set of file types publishable by org-publish, as well as the set
207of output formats. 207of output formats.
208 208
209 :publishing-function Function to publish file. The default is 209 :publishing-function Function to publish file. The default is
210 org-publish-org-to-html, but other 210 `org-publish-org-to-html', but other
211 values are possible. May also be a 211 values are possible. May also be a
212 list of functions, in which case 212 list of functions, in which case
213 each function in the list is invoked 213 each function in the list is invoked
214 in turn. 214 in turn.
215 215
216Another property allows you to insert code that prepares a 216Another property allows you to insert code that prepares a
217project for publishing. For example, you could call GNU Make on a 217project for publishing. For example, you could call GNU Make on a
218certain makefile, to ensure published files are built up to date. 218certain makefile, to ensure published files are built up to date.
219 219
220 :preparation-function Function to be called before publishing 220 :preparation-function Function to be called before publishing
@@ -222,42 +222,42 @@ certain makefile, to ensure published files are built up to date.
222 222
223Some properties control details of the Org publishing process, 223Some properties control details of the Org publishing process,
224and are equivalent to the corresponding user variables listed in 224and are equivalent to the corresponding user variables listed in
225the right column. See the documentation for those variables to 225the right column. See the documentation for those variables to
226learn more about their use and default values. 226learn more about their use and default values.
227 227
228 :language org-export-default-language 228 :language `org-export-default-language'
229 :headline-levels org-export-headline-levels 229 :headline-levels `org-export-headline-levels'
230 :section-numbers org-export-with-section-numbers 230 :section-numbers `org-export-with-section-numbers'
231 :table-of-contents org-export-with-toc 231 :table-of-contents `org-export-with-toc'
232 :emphasize org-export-with-emphasize 232 :emphasize `org-export-with-emphasize'
233 :sub-superscript org-export-with-sub-superscripts 233 :sub-superscript `org-export-with-sub-superscripts'
234 :TeX-macros org-export-with-TeX-macros 234 :TeX-macros `org-export-with-TeX-macros'
235 :fixed-width org-export-with-fixed-width 235 :fixed-width `org-export-with-fixed-width'
236 :tables org-export-with-tables 236 :tables `org-export-with-tables'
237 :table-auto-headline org-export-highlight-first-table-line 237 :table-auto-headline `org-export-highlight-first-table-line'
238 :style org-export-html-style 238 :style `org-export-html-style'
239 :convert-org-links org-export-html-link-org-files-as-html 239 :convert-org-links `org-export-html-link-org-files-as-html'
240 :inline-images org-export-html-inline-images 240 :inline-images `org-export-html-inline-images'
241 :expand-quoted-html org-export-html-expand 241 :expand-quoted-html `org-export-html-expand'
242 :timestamp org-export-html-with-timestamp 242 :timestamp `org-export-html-with-timestamp'
243 :publishing-directory org-export-publishing-directory 243 :publishing-directory `org-export-publishing-directory'
244 :preamble org-export-html-preamble 244 :preamble `org-export-html-preamble'
245 :postamble org-export-html-postamble 245 :postamble `org-export-html-postamble'
246 :auto-preamble org-export-html-auto-preamble 246 :auto-preamble `org-export-html-auto-preamble'
247 :auto-postamble org-export-html-auto-postamble 247 :auto-postamble `org-export-html-auto-postamble'
248 :author user-full-name 248 :author `user-full-name'
249 :email user-mail-address 249 :email `user-mail-address'
250 250
251The following properties may be used to control publishing of an 251The following properties may be used to control publishing of an
252index of files or summary page for a given project. 252index of files or summary page for a given project.
253 253
254 :auto-index Whether to publish an index during 254 :auto-index Whether to publish an index during
255 org-publish-current-project or org-publish-all. 255 `org-publish-current-project' or `org-publish-all'.
256 :index-filename Filename for output of index. Defaults 256 :index-filename Filename for output of index. Defaults
257 to 'index.org' (which becomes 'index.html') 257 to 'index.org' (which becomes 'index.html').
258 :index-title Title of index page. Defaults to name of file. 258 :index-title Title of index page. Defaults to name of file.
259 :index-function Plugin function to use for generation of index. 259 :index-function Plugin function to use for generation of index.
260 Defaults to 'org-publish-org-index', which 260 Defaults to `org-publish-org-index', which
261 generates a plain list of links to all files 261 generates a plain list of links to all files
262 in the project." 262 in the project."
263 :group 'org-publish 263 :group 'org-publish
@@ -265,8 +265,7 @@ index of files or summary page for a given project.
265 265
266(defcustom org-publish-use-timestamps-flag t 266(defcustom org-publish-use-timestamps-flag t
267 "When non-nil, use timestamp checking to publish only changed files. 267 "When non-nil, use timestamp checking to publish only changed files.
268When nil, do no timestamp checking and always publish all 268When nil, do no timestamp checking and always publish all files."
269files."
270 :group 'org-publish 269 :group 'org-publish
271 :type 'boolean) 270 :type 'boolean)
272 271
@@ -334,7 +333,7 @@ If there is no timestamp, create one."
334;;; Mapping files to project names 333;;; Mapping files to project names
335 334
336(defvar org-publish-files-alist nil 335(defvar org-publish-files-alist nil
337 "Alist of files and their parent project. 336 "Alist of files and their parent projects.
338Each element of this alist is of the form: 337Each element of this alist is of the form:
339 338
340 (file-name . project-name)") 339 (file-name . project-name)")