Mercurial > emacs
comparison lisp/org/org-publish.el @ 94773:817e282b0cc9
(org-publish-project-alist): Doc fixes.
(org-publish-use-timestamps-flag): Reflow docstring.
(org-publish-files-alist): Fix typos in docstring.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Thu, 08 May 2008 15:46:49 +0000 |
parents | ba3167bc4143 |
children | c1ef445563bb |
comparison
equal
deleted
inserted
replaced
94772:5910d449885a | 94773:817e282b0cc9 |
---|---|
160 :group 'org) | 160 :group 'org) |
161 | 161 |
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. |
164 Each element of the alist is a publishing 'project.' The CAR of | 164 Each element of the alist is a publishing 'project.' The CAR of |
165 each element is a string, uniquely identifying the project. The | 165 each element is a string, uniquely identifying the project. The |
166 CDR of each element is in one of the following forms: | 166 CDR of each element is in one of the following forms: |
167 | 167 |
168 (:property value :property value ... ) | 168 (:property value :property value ... ) |
169 | 169 |
170 OR, | 170 OR, |
172 (:components (\"project-1\" \"project-2\" ...)) | 172 (:components (\"project-1\" \"project-2\" ...)) |
173 | 173 |
174 When the CDR of an element of org-publish-project-alist is in | 174 When the CDR of an element of org-publish-project-alist is in |
175 this second form, the elements of the list after :components are | 175 this second form, the elements of the list after :components are |
176 taken to be components of the project, which group together files | 176 taken to be components of the project, which group together files |
177 requiring different publishing options. When you publish such a | 177 requiring different publishing options. When you publish such a |
178 project with M-x org-publish, the components all publish. | 178 project with \\[org-publish], the components all publish. |
179 | 179 |
180 When a property is given a value in org-publish-project-alist, its | 180 When a property is given a value in org-publish-project-alist, its |
181 setting overrides the value of the corresponding user variable | 181 setting 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 |
183 override everything. | 183 override everything. |
184 | 184 |
185 Most properties are optional, but some should always be set: | 185 Most properties are optional, but some should always be set: |
186 | 186 |
187 :base-directory Directory containing publishing source files | 187 :base-directory Directory containing publishing source files |
189 This can be a regular expression. | 189 This can be a regular expression. |
190 :publishing-directory Directory (possibly remote) where output | 190 :publishing-directory Directory (possibly remote) where output |
191 files will be published | 191 files will be published |
192 | 192 |
193 The :exclude property may be used to prevent certain files from | 193 The :exclude property may be used to prevent certain files from |
194 being published. Its value may be a string or regexp matching | 194 being published. Its value may be a string or regexp matching |
195 file names you don't want to be published. | 195 file names you don't want to be published. |
196 | 196 |
197 The :include property may be used to include extra files. Its | 197 The :include property may be used to include extra files. Its |
198 value may be a list of filenames to include. The filenames are | 198 value may be a list of filenames to include. The filenames are |
199 considered relative to the publishing directory. | 199 considered relative to the publishing directory. |
200 | 200 |
201 When both :include and :exclude properties are given values, the | 201 When both :include and :exclude properties are given values, the |
202 exclusion step happens first. | 202 exclusion step happens first. |
203 | 203 |
204 One special property controls which back-end function to use for | 204 One special property controls which back-end function to use for |
205 publishing files in the project. This can be used to extend the | 205 publishing files in the project. This can be used to extend the |
206 set of file types publishable by org-publish, as well as the set | 206 set of file types publishable by org-publish, as well as the set |
207 of output formats. | 207 of 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 |
216 Another property allows you to insert code that prepares a | 216 Another property allows you to insert code that prepares a |
217 project for publishing. For example, you could call GNU Make on a | 217 project for publishing. For example, you could call GNU Make on a |
218 certain makefile, to ensure published files are built up to date. | 218 certain 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 |
221 this project. | 221 this project. |
222 | 222 |
223 Some properties control details of the Org publishing process, | 223 Some properties control details of the Org publishing process, |
224 and are equivalent to the corresponding user variables listed in | 224 and are equivalent to the corresponding user variables listed in |
225 the right column. See the documentation for those variables to | 225 the right column. See the documentation for those variables to |
226 learn more about their use and default values. | 226 learn 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 |
251 The following properties may be used to control publishing of an | 251 The following properties may be used to control publishing of an |
252 index of files or summary page for a given project. | 252 index 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 |
264 :type 'alist) | 264 :type 'alist) |
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. |
268 When nil, do no timestamp checking and always publish all | 268 When nil, do no timestamp checking and always publish all files." |
269 files." | |
270 :group 'org-publish | 269 :group 'org-publish |
271 :type 'boolean) | 270 :type 'boolean) |
272 | 271 |
273 (defcustom org-publish-timestamp-directory "~/.org-timestamps/" | 272 (defcustom org-publish-timestamp-directory "~/.org-timestamps/" |
274 "Name of directory in which to store publishing timestamps." | 273 "Name of directory in which to store publishing timestamps." |
332 | 331 |
333 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | 332 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
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. |
338 Each element of this alist is of the form: | 337 Each element of this alist is of the form: |
339 | 338 |
340 (file-name . project-name)") | 339 (file-name . project-name)") |
341 | 340 |
342 (defvar org-publish-initial-buffer nil | 341 (defvar org-publish-initial-buffer nil |