Org API

Publish project.

Publish all projects. With prefix argument, remove all files in the timestamp directory and force publishing all files.

Publish a file with no transformation of any kind.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Get the filename ctime as an integer.

Check the timestamp of the last publishing of filename. Return t, if the file needs publishing. The function also checks if any included files have been more recently published, so that the file including them will be republished as well.

Return the value stored in org-e-publish-cache for key key. Returns nil, if no value or nil is found, or the cache does not exist.

Return the value for a property of file filename in publishing cache. Use cache file of project-name. Return the value of that property or default, if the value does not yet exist. If the entry will be created, unless no-create is not nil.

Store key value pair in org-e-publish-cache. Returns value on success, else nil.

Set the value for a property of file filename in publishing cache to value. Use cache file of project-name. If the entry does not exist, it will be created. Return value.

Update index for a file with tree in cache.

backend is the back-end being used for transcoding. info is a plist containing publishing options.

The index relative to current file is stored as an alist. An association has the following shape: (TERM FILE-NAME PARENT), where TERM is the indexed term, as a string, FILE-NAME is the original full path of the file where the term in encountered, and PARENT is the headline element containing the original index keyword.

Predicate for sort, that sorts folders and files for sitemap.

Publish the current file. With prefix argument, force publish the file.

Publish the project associated with the current file. With a prefix argument, force publishing of all files in the project.

Expand projects in projects-alist. This splices all the components into the list.

Publish file filename from project. If no-cache is not nil, do not initialize org-e-publish-cache and write it to disk. This is needed, since this function is used to publish single files, when entire projects are published. See org-e-publish-projects.

Find the date of file in project. If file provides a #+date keyword use it else use the file system's modification time.

It returns time in current-time format.

Find the title of file in project.

Return a list of all files in project. If exclude-regexp is set, this will be used to filter out matching filenames.

Set org-e-publish-temp-files with files from base-dir directory. If recurse is non-nil, check base-dir recursively. If match is non-nil, restrict this list to the files matching the regexp match. If skip-file is non-nil, skip file matching the regexp skip-file. If skip-dir is non-nil, don't check directories matching the regexp skip-dir when recursing through base-dir.

Return the project that filename belongs to.

Retrieve full index from cache and build "theindex.org". project is the project the index relates to. directory is the publishing directory.

Initialize the projects cache if not initialized yet and return it.

Return t if filename should be published in pub-dir using pub-func. true-pub-dir is where the file will truly end up. Currently we are not using this - maybe it can eventually be used to check if the file is present at the target location, and how old it is. Right now we cannot do this, because we do not know under what file name the file will be stored - the publishing function can still decide about that independently.

Create a sitemap of pages in set defined by project. Optionally set the filename of the sitemap with sitemap-filename. Default for sitemap-filename is 'sitemap.org'.

Publish an Org file to a specified back-end.

backend is a symbol representing the back-end used for transcoding. filename is the filename of the Org file to be published. extension is the extension used for the output string, with the leading dot. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an Org file to ASCII.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an org file to HTML.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an Org file to LaTeX.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an Org file to Latin-1.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an Org file to PDF (via LaTeX).

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish an org file to UTF-8.

filename is the filename of the Org file to be published. plist is the property list for the given project. pub-dir is the publishing directory.

Return output file name.

Publish project.

Publish all files belonging to the projects alist. If :auto-sitemap is set, publish the sitemap too. If :makeindex is set, also produce a file theindex.org.

Remove all files in the timestamp directory.

Empty org-e-publish-cache and reset it nil.

Return path to timestamp file for filename filename.

Update publishing timestamp for file filename. If there is no timestamp, create one.

Write org-e-publish-cache to file. If free-cache, empty the cache.