2008-01-31 10:34:50 +00:00
|
|
|
;;; org-publish.el --- publish related org-mode files as a website
|
2010-04-07 14:26:10 +00:00
|
|
|
;; Copyright (C) 2006, 2007, 2008, 2009, 2010
|
|
|
|
;; Free Software Foundation, Inc.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
;; Author: David O'Toole <dto@gnu.org>
|
2009-03-10 07:18:30 +00:00
|
|
|
;; Maintainer: Carsten Dominik <carsten DOT dominik AT gmail DOT com>
|
2008-03-02 00:52:52 +00:00
|
|
|
;; Keywords: hypermedia, outlines, wp
|
2011-03-07 14:27:39 +00:00
|
|
|
;; Version: 7.5
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-01-31 10:38:46 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;;
|
2008-05-06 12:45:52 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2008-01-31 10:34:50 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2008-05-06 12:45:52 +00:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-01-31 10:38:46 +00:00
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2008-01-31 10:34:50 +00:00
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
2008-05-06 12:45:52 +00:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2008-03-02 00:52:52 +00:00
|
|
|
;; This program allow configurable publishing of related sets of
|
|
|
|
;; Org-mode files as a complete website.
|
2008-01-31 10:34:50 +00:00
|
|
|
;;
|
|
|
|
;; org-publish.el can do the following:
|
|
|
|
;;
|
2009-03-10 07:18:30 +00:00
|
|
|
;; + Publish all one's org-files to HTML or PDF
|
2008-03-02 00:52:52 +00:00
|
|
|
;; + Upload HTML, images, attachments and other files to a web server
|
2008-01-31 10:34:50 +00:00
|
|
|
;; + Exclude selected private pages from publishing
|
2010-02-25 06:31:29 +00:00
|
|
|
;; + Publish a clickable sitemap of pages
|
2008-03-02 00:52:52 +00:00
|
|
|
;; + Manage local timestamps for publishing only changed files
|
2008-01-31 10:34:50 +00:00
|
|
|
;; + Accept plugin functions to extend range of publishable content
|
|
|
|
;;
|
2009-03-10 07:18:30 +00:00
|
|
|
;; Documentation for publishing is in the manual.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
|
|
|
|
(defun org-publish-sanitize-plist (plist)
|
|
|
|
(mapcar (lambda (x)
|
2010-04-01 11:11:54 +00:00
|
|
|
(or (cdr (assq x '((:index-filename . :sitemap-filename)
|
|
|
|
(:index-title . :sitemap-title)
|
|
|
|
(:index-function . :sitemap-function)
|
|
|
|
(:index-style . :sitemap-style)
|
|
|
|
(:auto-index . :auto-sitemap))))
|
2010-03-28 08:01:07 +00:00
|
|
|
x))
|
|
|
|
plist))
|
2010-02-25 06:31:29 +00:00
|
|
|
|
2008-01-31 10:34:50 +00:00
|
|
|
(eval-when-compile
|
|
|
|
(require 'cl))
|
2008-06-15 06:50:10 +00:00
|
|
|
(require 'org)
|
|
|
|
(require 'org-exp)
|
2011-02-11 19:43:11 +00:00
|
|
|
(require 'format-spec)
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-14 10:41:54 +00:00
|
|
|
(eval-and-compile
|
|
|
|
(unless (fboundp 'declare-function)
|
|
|
|
(defmacro declare-function (fn file &optional arglist fileonly))))
|
|
|
|
|
2008-01-31 10:34:50 +00:00
|
|
|
(defgroup org-publish nil
|
2008-06-15 06:03:45 +00:00
|
|
|
"Options for publishing a set of Org-mode and related files."
|
|
|
|
:tag "Org Publishing"
|
|
|
|
:group 'org)
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
(defcustom org-publish-project-alist nil
|
|
|
|
"Association list to control publishing behavior.
|
|
|
|
Each element of the alist is a publishing 'project.' The CAR of
|
2008-06-17 15:05:23 +00:00
|
|
|
each element is a string, uniquely identifying the project. The
|
2008-01-31 10:34:50 +00:00
|
|
|
CDR of each element is in one of the following forms:
|
|
|
|
|
2010-10-14 12:12:37 +00:00
|
|
|
1. A well-formed property list with an even number of elements, alternating
|
|
|
|
keys and values, specifying parameters for the publishing process.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-10-14 12:12:37 +00:00
|
|
|
(:property value :property value ... )
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-10-14 12:12:37 +00:00
|
|
|
2. A meta-project definition, specifying of a list of sub-projects:
|
|
|
|
|
|
|
|
(:components (\"project-1\" \"project-2\" ...))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
When the CDR of an element of org-publish-project-alist is in
|
|
|
|
this second form, the elements of the list after :components are
|
|
|
|
taken to be components of the project, which group together files
|
2008-06-17 15:05:23 +00:00
|
|
|
requiring different publishing options. When you publish such a
|
2008-05-09 04:08:45 +00:00
|
|
|
project with \\[org-publish], the components all publish.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
When a property is given a value in org-publish-project-alist, its
|
|
|
|
setting overrides the value of the corresponding user variable
|
2008-05-09 04:08:45 +00:00
|
|
|
\(if any) during publishing. However, options set within a file
|
2008-01-31 10:34:50 +00:00
|
|
|
override everything.
|
|
|
|
|
|
|
|
Most properties are optional, but some should always be set:
|
|
|
|
|
2008-03-02 00:52:52 +00:00
|
|
|
:base-directory Directory containing publishing source files
|
|
|
|
:base-extension Extension (without the dot!) of source files.
|
2010-07-22 09:45:04 +00:00
|
|
|
This can be a regular expression. If not given,
|
|
|
|
\"org\" will be used as default extension.
|
2008-03-02 00:52:52 +00:00
|
|
|
:publishing-directory Directory (possibly remote) where output
|
|
|
|
files will be published
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
The :exclude property may be used to prevent certain files from
|
2008-06-17 15:05:23 +00:00
|
|
|
being published. Its value may be a string or regexp matching
|
2008-01-31 10:34:50 +00:00
|
|
|
file names you don't want to be published.
|
|
|
|
|
2008-06-17 15:05:23 +00:00
|
|
|
The :include property may be used to include extra files. Its
|
2008-01-31 10:34:50 +00:00
|
|
|
value may be a list of filenames to include. The filenames are
|
2008-05-24 19:54:37 +00:00
|
|
|
considered relative to the base directory.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
When both :include and :exclude properties are given values, the
|
|
|
|
exclusion step happens first.
|
|
|
|
|
|
|
|
One special property controls which back-end function to use for
|
2008-06-17 15:05:23 +00:00
|
|
|
publishing files in the project. This can be used to extend the
|
2008-01-31 10:34:50 +00:00
|
|
|
set of file types publishable by org-publish, as well as the set
|
|
|
|
of output formats.
|
|
|
|
|
2008-06-17 15:05:23 +00:00
|
|
|
:publishing-function Function to publish file. The default is
|
2008-05-09 04:08:45 +00:00
|
|
|
`org-publish-org-to-html', but other
|
2008-06-17 15:05:23 +00:00
|
|
|
values are possible. May also be a
|
2008-03-02 01:02:41 +00:00
|
|
|
list of functions, in which case
|
2008-03-02 00:52:52 +00:00
|
|
|
each function in the list is invoked
|
|
|
|
in turn.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
Another property allows you to insert code that prepares a
|
2008-06-17 15:05:23 +00:00
|
|
|
project for publishing. For example, you could call GNU Make on a
|
2008-03-02 01:02:41 +00:00
|
|
|
certain makefile, to ensure published files are built up to date.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-02 00:52:52 +00:00
|
|
|
:preparation-function Function to be called before publishing
|
2010-02-25 06:31:29 +00:00
|
|
|
this project. This may also be a list
|
|
|
|
of functions.
|
2008-06-15 06:03:45 +00:00
|
|
|
:completion-function Function to be called after publishing
|
2010-02-25 06:31:29 +00:00
|
|
|
this project. This may also be a list
|
|
|
|
of functions.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
Some properties control details of the Org publishing process,
|
|
|
|
and are equivalent to the corresponding user variables listed in
|
2008-06-17 15:05:23 +00:00
|
|
|
the right column. See the documentation for those variables to
|
2008-01-31 10:34:50 +00:00
|
|
|
learn more about their use and default values.
|
|
|
|
|
2008-05-09 04:08:45 +00:00
|
|
|
:language `org-export-default-language'
|
|
|
|
:headline-levels `org-export-headline-levels'
|
|
|
|
:section-numbers `org-export-with-section-numbers'
|
|
|
|
:table-of-contents `org-export-with-toc'
|
|
|
|
:emphasize `org-export-with-emphasize'
|
|
|
|
:sub-superscript `org-export-with-sub-superscripts'
|
|
|
|
:TeX-macros `org-export-with-TeX-macros'
|
|
|
|
:fixed-width `org-export-with-fixed-width'
|
|
|
|
:tables `org-export-with-tables'
|
|
|
|
:table-auto-headline `org-export-highlight-first-table-line'
|
|
|
|
:style `org-export-html-style'
|
|
|
|
:convert-org-links `org-export-html-link-org-files-as-html'
|
|
|
|
:inline-images `org-export-html-inline-images'
|
|
|
|
:expand-quoted-html `org-export-html-expand'
|
|
|
|
:timestamp `org-export-html-with-timestamp'
|
|
|
|
:publishing-directory `org-export-publishing-directory'
|
2011-02-10 12:19:37 +00:00
|
|
|
:html-preamble `org-export-html-preamble'
|
|
|
|
:html-postamble `org-export-html-postamble'
|
2008-05-09 04:08:45 +00:00
|
|
|
:author `user-full-name'
|
|
|
|
:email `user-mail-address'
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
The following properties may be used to control publishing of a
|
|
|
|
sitemap of files or summary page for a given project.
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
:auto-sitemap Whether to publish a sitemap during
|
2008-05-09 04:08:45 +00:00
|
|
|
`org-publish-current-project' or `org-publish-all'.
|
2010-02-25 06:31:29 +00:00
|
|
|
:sitemap-filename Filename for output of sitemap. Defaults
|
2009-03-10 07:18:30 +00:00
|
|
|
to 'sitemap.org' (which becomes 'sitemap.html').
|
2010-02-25 06:31:29 +00:00
|
|
|
:sitemap-title Title of sitemap page. Defaults to name of file.
|
|
|
|
:sitemap-function Plugin function to use for generation of sitemap.
|
|
|
|
Defaults to `org-publish-org-sitemap', which
|
2008-03-02 00:52:52 +00:00
|
|
|
generates a plain list of links to all files
|
2008-07-09 16:55:00 +00:00
|
|
|
in the project.
|
2010-02-25 06:31:29 +00:00
|
|
|
:sitemap-style Can be `list' (sitemap is just an itemized list
|
2008-12-04 14:33:43 +00:00
|
|
|
of the titles of the files involved) or
|
2008-07-09 16:55:00 +00:00
|
|
|
`tree' (the directory structure of the source
|
2010-02-25 06:31:29 +00:00
|
|
|
files is reflected in the sitemap). Defaults to
|
2010-04-22 07:10:14 +00:00
|
|
|
`tree'.
|
|
|
|
|
|
|
|
If you create a sitemap file, adjust the sorting like this:
|
|
|
|
|
|
|
|
:sitemap-sort-folders Where folders should appear in the sitemap.
|
|
|
|
Set this to `first' (default) or `last' to
|
|
|
|
display folders first or last, respectively.
|
|
|
|
Any other value will mix files and folders.
|
2010-12-01 15:06:16 +00:00
|
|
|
:sitemap-sort-files The site map is normally sorted alphabetically.
|
|
|
|
You can change this behaviour setting this to
|
|
|
|
`chronologically', `anti-chronologically' or nil.
|
2010-04-24 00:17:07 +00:00
|
|
|
:sitemap-ignore-case Should sorting be case-sensitive? Default nil.
|
2010-04-22 07:10:14 +00:00
|
|
|
|
|
|
|
The following properties control the creation of a concept index.
|
|
|
|
|
2010-08-19 15:31:58 +00:00
|
|
|
:makeindex Create a concept index.
|
|
|
|
|
|
|
|
Other properties affecting publication.
|
|
|
|
|
|
|
|
:body-only Set this to 't' to publish only the body of the
|
|
|
|
documents, excluding everything outside and
|
|
|
|
including the <body> tags in HTML, or
|
|
|
|
\begin{document}..\end{document} in LaTeX."
|
2008-01-31 10:34:50 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'alist)
|
|
|
|
|
|
|
|
(defcustom org-publish-use-timestamps-flag t
|
2010-07-16 21:23:01 +00:00
|
|
|
"Non-nil means use timestamp checking to publish only changed files.
|
2008-05-09 04:08:45 +00:00
|
|
|
When nil, do no timestamp checking and always publish all files."
|
2008-01-31 10:34:50 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'boolean)
|
|
|
|
|
2008-12-04 14:33:43 +00:00
|
|
|
(defcustom org-publish-timestamp-directory (convert-standard-filename
|
2008-10-19 18:55:36 +00:00
|
|
|
"~/.org-timestamps/")
|
2008-01-31 10:34:50 +00:00
|
|
|
"Name of directory in which to store publishing timestamps."
|
|
|
|
:group 'org-publish
|
2008-03-03 10:01:36 +00:00
|
|
|
:type 'directory)
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-07-08 08:09:05 +00:00
|
|
|
(defcustom org-publish-list-skipped-files t
|
2010-01-21 15:15:40 +00:00
|
|
|
"Non-nil means show message about files *not* published."
|
2009-07-08 08:09:05 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'boolean)
|
|
|
|
|
2008-03-10 09:34:06 +00:00
|
|
|
(defcustom org-publish-before-export-hook nil
|
|
|
|
"Hook run before export on the Org file.
|
2009-03-24 14:28:08 +00:00
|
|
|
The hook may modify the file in arbitrary ways before publishing happens.
|
2009-11-12 12:39:29 +00:00
|
|
|
The original version of the buffer will be restored after publishing."
|
2008-03-10 09:34:06 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'hook)
|
|
|
|
|
|
|
|
(defcustom org-publish-after-export-hook nil
|
|
|
|
"Hook run after export on the exported buffer.
|
2009-03-24 14:28:08 +00:00
|
|
|
Any changes made by this hook will be saved."
|
2008-03-10 09:34:06 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'hook)
|
|
|
|
|
2010-12-01 15:06:16 +00:00
|
|
|
(defcustom org-publish-sitemap-sort-files 'alphabetically
|
|
|
|
"How sitemaps files should be sorted by default?
|
|
|
|
Possible values are `alphabetically', `chronologically', `anti-chronologically' and nil.
|
|
|
|
If `alphabetically', files will be sorted alphabetically.
|
|
|
|
If `chronologically', files will be sorted with older modification time first.
|
|
|
|
If `anti-chronologically', files will be sorted with newer modification time first.
|
|
|
|
nil won't sort files.
|
2010-04-23 04:49:22 +00:00
|
|
|
|
|
|
|
You can overwrite this default per project in your
|
2010-12-01 15:06:16 +00:00
|
|
|
`org-publish-project-alist', using `:sitemap-sort-files'."
|
2010-04-23 04:49:22 +00:00
|
|
|
:group 'org-publish
|
2010-12-01 15:06:16 +00:00
|
|
|
:type 'symbol)
|
2010-04-23 04:49:22 +00:00
|
|
|
|
|
|
|
(defcustom org-publish-sitemap-sort-folders 'first
|
|
|
|
"A symbol, denoting if folders are sorted first in sitemaps.
|
|
|
|
Possible values are `first', `last', and nil.
|
|
|
|
If `first', folders will be sorted before files.
|
|
|
|
If `last', folders are sorted to the end after the files.
|
|
|
|
Any other value will not mix files and folders.
|
|
|
|
|
|
|
|
You can overwrite this default per project in your
|
|
|
|
`org-publish-project-alist', using `:sitemap-sort-folders'."
|
|
|
|
:group 'org-publish
|
|
|
|
:type 'symbol)
|
|
|
|
|
|
|
|
(defcustom org-publish-sitemap-sort-ignore-case nil
|
|
|
|
"Sort sitemaps case insensitively by default?
|
|
|
|
|
|
|
|
You can overwrite this default per project in your
|
|
|
|
`org-publish-project-alist', using `:sitemap-ignore-case'."
|
|
|
|
:group 'org-publish
|
|
|
|
:type 'boolean)
|
|
|
|
|
2011-02-09 17:23:54 +00:00
|
|
|
(defcustom org-publish-sitemap-date-format "%Y-%m-%d"
|
|
|
|
"Format for `format-time-string' which is used to print a date
|
|
|
|
in the sitemap."
|
|
|
|
:group 'org-publish
|
|
|
|
:type 'string)
|
|
|
|
|
2011-02-11 19:43:11 +00:00
|
|
|
(defcustom org-publish-sitemap-file-entry-format "%t"
|
2011-02-09 17:23:54 +00:00
|
|
|
"How a sitemap file entry is formated.
|
|
|
|
You could use brackets to delimit on what part the link will be.
|
|
|
|
|
2011-02-11 19:43:11 +00:00
|
|
|
%t is the title.
|
|
|
|
%a is the author.
|
|
|
|
%d is the date formated using `org-publish-sitemap-date-format'."
|
2011-02-09 17:23:54 +00:00
|
|
|
:group 'org-publish
|
|
|
|
:type 'string)
|
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2008-03-02 00:52:52 +00:00
|
|
|
;;; Timestamp-related functions
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-07-02 21:07:41 +00:00
|
|
|
(defun org-publish-timestamp-filename (filename &optional pub-dir pub-func)
|
2008-01-31 10:34:50 +00:00
|
|
|
"Return path to timestamp file for filename FILENAME."
|
2009-07-02 21:07:41 +00:00
|
|
|
(setq filename (concat filename "::" (or pub-dir "") "::"
|
|
|
|
(format "%s" (or pub-func ""))))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(concat "X" (if (fboundp 'sha1) (sha1 filename) (md5 filename))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-07-02 21:07:41 +00:00
|
|
|
(defun org-publish-needed-p (filename &optional pub-dir pub-func true-pub-dir)
|
2010-07-16 21:23:01 +00:00
|
|
|
"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
|
2009-07-02 21:07:41 +00:00
|
|
|
this - maybe it can eventually be used to check if the file is present at
|
2011-02-19 11:52:26 +00:00
|
|
|
the target location, and how old it is. Right now we cannot do this, because
|
2009-07-02 21:07:41 +00:00
|
|
|
we do not know under what file name the file will be stored - the publishing
|
|
|
|
function can still decide about that independently."
|
2008-07-05 15:27:29 +00:00
|
|
|
(let ((rtn
|
|
|
|
(if org-publish-use-timestamps-flag
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(org-publish-cache-file-needs-publishing
|
|
|
|
filename pub-dir pub-func)
|
2008-07-05 15:27:29 +00:00
|
|
|
;; don't use timestamps, always return t
|
|
|
|
t)))
|
|
|
|
(if rtn
|
2009-07-02 21:07:41 +00:00
|
|
|
(message "Publishing file %s using `%s'" filename pub-func)
|
2009-07-08 08:09:05 +00:00
|
|
|
(when org-publish-list-skipped-files
|
|
|
|
(message "Skipping unmodified file %s" filename)))
|
2008-07-05 15:27:29 +00:00
|
|
|
rtn))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-07-02 21:07:41 +00:00
|
|
|
(defun org-publish-update-timestamp (filename &optional pub-dir pub-func)
|
2008-03-03 10:01:36 +00:00
|
|
|
"Update publishing timestamp for file FILENAME.
|
|
|
|
If there is no timestamp, create one."
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(let ((key (org-publish-timestamp-filename filename pub-dir pub-func))
|
|
|
|
(stamp (org-publish-cache-ctime-of-src filename)))
|
|
|
|
(org-publish-cache-set key stamp)))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-07-07 13:04:15 +00:00
|
|
|
(defun org-publish-remove-all-timestamps ()
|
2010-07-16 21:23:01 +00:00
|
|
|
"Remove all files in the timestamp directory."
|
2009-07-07 13:04:15 +00:00
|
|
|
(let ((dir org-publish-timestamp-directory)
|
|
|
|
files)
|
|
|
|
(when (and (file-exists-p dir)
|
|
|
|
(file-directory-p dir))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(mapc 'delete-file (directory-files dir 'full "[^.]\\'"))
|
|
|
|
(org-publish-reset-cache))))
|
2009-07-07 13:04:15 +00:00
|
|
|
|
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;;;
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-11 11:48:17 +00:00
|
|
|
(defvar org-publish-initial-buffer nil
|
|
|
|
"The buffer `org-publish' has been called from.")
|
2008-03-14 12:39:24 +00:00
|
|
|
(defvar org-publish-temp-files nil
|
|
|
|
"Temporary list of files to be published.")
|
2008-03-11 11:48:17 +00:00
|
|
|
|
2010-04-22 07:10:14 +00:00
|
|
|
;; Here, so you find the variable right before it's used the first time:
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(defvar org-publish-cache nil
|
2010-07-16 21:23:01 +00:00
|
|
|
"This will cache timestamps and titles for files in publishing projects.
|
|
|
|
Blocks could hash sha1 values here.")
|
2010-04-22 07:10:14 +00:00
|
|
|
|
2008-11-02 15:20:40 +00:00
|
|
|
|
2008-03-03 23:55:39 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
;;; Compatibility aliases
|
|
|
|
|
|
|
|
;; Delete-dups is not in Emacs <22
|
|
|
|
(if (fboundp 'delete-dups)
|
2008-03-04 00:22:46 +00:00
|
|
|
(defalias 'org-publish-delete-dups 'delete-dups)
|
|
|
|
(defun org-publish-delete-dups (list)
|
2008-03-03 23:55:39 +00:00
|
|
|
"Destructively remove `equal' duplicates from LIST.
|
|
|
|
Store the result in LIST and return it. LIST must be a proper list.
|
|
|
|
Of several `equal' occurrences of an element in LIST, the first
|
|
|
|
one is kept.
|
|
|
|
|
|
|
|
This is a compatibility function for Emacsen without `delete-dups'."
|
|
|
|
;; Code from `subr.el' in Emacs 22:
|
|
|
|
(let ((tail list))
|
|
|
|
(while tail
|
|
|
|
(setcdr tail (delete (car tail) (cdr tail)))
|
|
|
|
(setq tail (cdr tail))))
|
|
|
|
list))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-14 10:41:54 +00:00
|
|
|
(declare-function org-publish-delete-dups "org-publish" (list))
|
2010-03-28 08:01:07 +00:00
|
|
|
(declare-function find-lisp-find-files "find-lisp" (directory regexp))
|
2008-03-14 10:41:54 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2008-03-02 00:52:52 +00:00
|
|
|
;;; Getting project information out of org-publish-project-alist
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-expand-projects (projects-alist)
|
2008-09-17 11:32:32 +00:00
|
|
|
"Expand projects in PROJECTS-ALIST.
|
|
|
|
This splices all the components into the list."
|
2008-09-17 11:55:59 +00:00
|
|
|
(let ((rest projects-alist) rtn p components)
|
2008-09-17 11:32:32 +00:00
|
|
|
(while (setq p (pop rest))
|
|
|
|
(if (setq components (plist-get (cdr p) :components))
|
|
|
|
(setq rest (append
|
|
|
|
(mapcar (lambda (x) (assoc x org-publish-project-alist))
|
|
|
|
components)
|
|
|
|
rest))
|
|
|
|
(push p rtn)))
|
|
|
|
(nreverse (org-publish-delete-dups (delq nil rtn)))))
|
2008-12-04 14:33:43 +00:00
|
|
|
|
2010-05-09 04:09:49 +00:00
|
|
|
|
2010-12-01 15:06:16 +00:00
|
|
|
(defvar sitemap-sort-files)
|
2010-05-09 04:09:49 +00:00
|
|
|
(defvar sitemap-sort-folders)
|
|
|
|
(defvar sitemap-ignore-case)
|
2010-05-15 12:15:08 +00:00
|
|
|
(defvar sitemap-requested)
|
2011-02-09 17:23:54 +00:00
|
|
|
(defvar sitemap-date-format)
|
|
|
|
(defvar sitemap-file-entry-format)
|
2010-04-22 07:10:14 +00:00
|
|
|
(defun org-publish-compare-directory-files (a b)
|
2010-12-01 15:06:16 +00:00
|
|
|
"Predicate for `sort', that sorts folders and files for sitemap."
|
2010-04-22 07:10:14 +00:00
|
|
|
(let ((retval t))
|
2010-12-01 15:06:16 +00:00
|
|
|
(when (or sitemap-sort-files sitemap-sort-folders)
|
|
|
|
;; First we sort files:
|
|
|
|
(when sitemap-sort-files
|
|
|
|
(cond ((equal sitemap-sort-files 'alphabetically)
|
|
|
|
(let* ((adir (file-directory-p a))
|
|
|
|
(aorg (and (string-match "\\.org$" a) (not adir)))
|
|
|
|
(bdir (file-directory-p b))
|
|
|
|
(borg (and (string-match "\\.org$" b) (not bdir)))
|
|
|
|
(A (if aorg
|
|
|
|
(concat (file-name-directory a)
|
|
|
|
(org-publish-find-title a)) a))
|
|
|
|
(B (if borg
|
|
|
|
(concat (file-name-directory b)
|
|
|
|
(org-publish-find-title b)) b)))
|
|
|
|
(setq retval (if sitemap-ignore-case
|
|
|
|
(not (string-lessp (upcase B) (upcase A)))
|
|
|
|
(not (string-lessp B A))))))
|
|
|
|
((or (equal sitemap-sort-files 'chronologically)
|
|
|
|
(equal sitemap-sort-files 'anti-chronologically))
|
2011-02-09 17:23:54 +00:00
|
|
|
(let* ((adate (org-publish-find-date a))
|
|
|
|
(bdate (org-publish-find-date b))
|
|
|
|
(A (+ (lsh (car adate) 16) (cadr adate)))
|
|
|
|
(B (+ (lsh (car bdate) 16) (cadr bdate))))
|
2010-12-01 15:06:16 +00:00
|
|
|
(setq retval (if (equal sitemap-sort-files 'chronologically)
|
|
|
|
(<= A B)
|
|
|
|
(>= A B)))))))
|
2010-04-22 07:10:14 +00:00
|
|
|
;; Directory-wise wins:
|
|
|
|
(when sitemap-sort-folders
|
|
|
|
;; a is directory, b not:
|
|
|
|
(cond
|
|
|
|
((and (file-directory-p a) (not (file-directory-p b)))
|
2010-04-22 16:04:13 +00:00
|
|
|
(setq retval (equal sitemap-sort-folders 'first)))
|
2010-04-22 07:10:14 +00:00
|
|
|
;; a is not a directory, but b is:
|
|
|
|
((and (not (file-directory-p a)) (file-directory-p b))
|
2010-04-22 16:04:13 +00:00
|
|
|
(setq retval (equal sitemap-sort-folders 'last))))))
|
|
|
|
retval))
|
2010-04-22 07:10:14 +00:00
|
|
|
|
2008-03-14 12:39:24 +00:00
|
|
|
(defun org-publish-get-base-files-1 (base-dir &optional recurse match skip-file skip-dir)
|
|
|
|
"Set `org-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
|
2008-12-16 16:33:19 +00:00
|
|
|
matching the regexp SKIP-DIR when recursing through BASE-DIR."
|
2008-04-24 08:29:47 +00:00
|
|
|
(mapc (lambda (f)
|
2008-10-27 06:44:12 +00:00
|
|
|
(let ((fd-p (file-directory-p f))
|
2008-03-14 12:39:24 +00:00
|
|
|
(fnd (file-name-nondirectory f)))
|
|
|
|
(if (and fd-p recurse
|
|
|
|
(not (string-match "^\\.+$" fnd))
|
2008-03-31 11:11:17 +00:00
|
|
|
(if skip-dir (not (string-match skip-dir fnd)) t))
|
|
|
|
(org-publish-get-base-files-1 f recurse match skip-file skip-dir)
|
2008-03-31 11:29:49 +00:00
|
|
|
(unless (or fd-p ;; this is a directory
|
|
|
|
(and skip-file (string-match skip-file fnd))
|
2008-10-27 06:44:12 +00:00
|
|
|
(not (file-exists-p (file-truename f)))
|
2008-03-31 11:29:49 +00:00
|
|
|
(not (string-match match fnd)))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
|
2008-03-14 12:39:24 +00:00
|
|
|
(pushnew f org-publish-temp-files)))))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(if sitemap-requested
|
|
|
|
(sort (directory-files base-dir t (unless recurse match))
|
|
|
|
'org-publish-compare-directory-files)
|
|
|
|
(directory-files base-dir t (unless recurse match)))))
|
2008-03-14 12:39:24 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-get-base-files (project &optional exclude-regexp)
|
|
|
|
"Return a list of all files in PROJECT.
|
|
|
|
If EXCLUDE-REGEXP is set, this will be used to filter out
|
|
|
|
matching filenames."
|
|
|
|
(let* ((project-plist (cdr project))
|
2008-03-04 00:54:40 +00:00
|
|
|
(base-dir (file-name-as-directory
|
2008-03-02 14:14:52 +00:00
|
|
|
(plist-get project-plist :base-directory)))
|
2008-12-16 16:27:21 +00:00
|
|
|
(include-list (plist-get project-plist :include))
|
|
|
|
(recurse (plist-get project-plist :recursive))
|
|
|
|
(extension (or (plist-get project-plist :base-extension) "org"))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;; sitemap-... variables are dynamically scoped for
|
|
|
|
;; org-publish-compare-directory-files:
|
|
|
|
(sitemap-requested
|
|
|
|
(plist-get project-plist :auto-sitemap))
|
2011-01-07 18:42:22 +00:00
|
|
|
(sitemap-filename
|
|
|
|
(or (plist-get project-plist :sitemap-filename)
|
|
|
|
"sitemap.org"))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(sitemap-sort-folders
|
|
|
|
(if (plist-member project-plist :sitemap-sort-folders)
|
|
|
|
(plist-get project-plist :sitemap-sort-folders)
|
|
|
|
org-publish-sitemap-sort-folders))
|
2010-12-01 15:06:16 +00:00
|
|
|
(sitemap-sort-files
|
|
|
|
(cond ((plist-member project-plist :sitemap-sort-files)
|
|
|
|
(plist-get project-plist :sitemap-sort-files))
|
|
|
|
;; For backward compatibility:
|
|
|
|
((plist-member project-plist :sitemap-alphabetically)
|
|
|
|
(if (plist-get project-plist :sitemap-alphabetically)
|
|
|
|
'alphabetically nil))
|
|
|
|
(t org-publish-sitemap-sort-files)))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(sitemap-ignore-case
|
|
|
|
(if (plist-member project-plist :sitemap-ignore-case)
|
|
|
|
(plist-get project-plist :sitemap-ignore-case)
|
|
|
|
org-publish-sitemap-sort-ignore-case))
|
2009-02-13 16:54:19 +00:00
|
|
|
(match (if (eq extension 'any)
|
|
|
|
"^[^\\.]"
|
|
|
|
(concat "^[^\\.].*\\.\\(" extension "\\)$"))))
|
2010-04-23 04:49:22 +00:00
|
|
|
;; Make sure sitemap-sort-folders' has an accepted value
|
|
|
|
(unless (memq sitemap-sort-folders '(first last))
|
|
|
|
(setq sitemap-sort-folders nil))
|
|
|
|
|
2008-03-14 12:39:24 +00:00
|
|
|
(setq org-publish-temp-files nil)
|
2011-01-07 18:42:22 +00:00
|
|
|
(if sitemap-requested
|
|
|
|
(pushnew (expand-file-name (concat base-dir sitemap-filename))
|
|
|
|
org-publish-temp-files))
|
2008-04-24 08:29:47 +00:00
|
|
|
(org-publish-get-base-files-1 base-dir recurse match
|
2008-03-31 11:11:17 +00:00
|
|
|
;; FIXME distinguish exclude regexp
|
|
|
|
;; for skip-file and skip-dir?
|
|
|
|
exclude-regexp exclude-regexp)
|
2008-06-15 06:03:45 +00:00
|
|
|
(mapc (lambda (f)
|
2008-12-04 14:33:43 +00:00
|
|
|
(pushnew
|
2008-06-15 06:03:45 +00:00
|
|
|
(expand-file-name (concat base-dir f))
|
|
|
|
org-publish-temp-files))
|
|
|
|
include-list)
|
2008-03-14 12:39:24 +00:00
|
|
|
org-publish-temp-files))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2009-02-26 21:18:16 +00:00
|
|
|
(defun org-publish-get-project-from-filename (filename &optional up)
|
2010-07-16 21:23:01 +00:00
|
|
|
"Return the project that FILENAME belongs to."
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(let* ((filename (expand-file-name filename))
|
|
|
|
project-name)
|
|
|
|
|
|
|
|
(catch 'p-found
|
|
|
|
(dolist (prj org-publish-project-alist)
|
|
|
|
(unless (plist-get (cdr prj) :components)
|
|
|
|
;; [[info:org:Selecting%20files]] shows how this is supposed to work:
|
|
|
|
(let* ((r (plist-get (cdr prj) :recursive))
|
2010-09-02 14:01:51 +00:00
|
|
|
(b (expand-file-name (file-name-as-directory
|
|
|
|
(plist-get (cdr prj) :base-directory))))
|
2010-07-05 13:14:59 +00:00
|
|
|
(x (or (plist-get (cdr prj) :base-extension) "org"))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(e (plist-get (cdr prj) :exclude))
|
|
|
|
(i (plist-get (cdr prj) :include))
|
|
|
|
(xm (concat "^" b (if r ".+" "[^/]+") "\\.\\(" x "\\)$")))
|
2010-12-01 15:06:16 +00:00
|
|
|
(when
|
|
|
|
(or
|
2010-08-16 15:27:25 +00:00
|
|
|
(and
|
2010-12-01 15:06:16 +00:00
|
|
|
i (member filename
|
2010-08-16 15:27:25 +00:00
|
|
|
(mapcar
|
|
|
|
(lambda (file) (expand-file-name file b))
|
|
|
|
i)))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(and
|
|
|
|
(not (and e (string-match e filename)))
|
|
|
|
(string-match xm filename)))
|
|
|
|
(setq project-name (car prj))
|
|
|
|
(throw 'p-found project-name))))))
|
2009-02-26 21:18:16 +00:00
|
|
|
(when up
|
|
|
|
(dolist (prj org-publish-project-alist)
|
|
|
|
(if (member project-name (plist-get (cdr prj) :components))
|
|
|
|
(setq project-name (car prj)))))
|
2008-03-02 14:14:52 +00:00
|
|
|
(assoc project-name org-publish-project-alist)))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
;;; Pluggable publishing back-end functions
|
2008-01-31 10:35:40 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-org-to (format plist filename pub-dir)
|
2008-01-31 10:35:40 +00:00
|
|
|
"Publish an org file to FORMAT.
|
|
|
|
PLIST is the property list for the given project.
|
2008-03-02 14:14:52 +00:00
|
|
|
FILENAME is the filename of the org file to be published.
|
|
|
|
PUB-DIR is the publishing directory."
|
2008-01-31 10:35:40 +00:00
|
|
|
(require 'org)
|
2008-03-02 14:14:52 +00:00
|
|
|
(unless (file-exists-p pub-dir)
|
|
|
|
(make-directory pub-dir t))
|
2008-10-21 16:21:52 +00:00
|
|
|
(let ((visiting (find-buffer-visiting filename)))
|
|
|
|
(save-excursion
|
2008-10-21 16:57:03 +00:00
|
|
|
(switch-to-buffer (or visiting (find-file filename)))
|
2008-10-21 16:21:52 +00:00
|
|
|
(let* ((plist (cons :buffer-will-be-killed (cons t plist)))
|
|
|
|
(init-buf (current-buffer))
|
|
|
|
(init-point (point))
|
|
|
|
(init-buf-string (buffer-string))
|
|
|
|
export-buf-or-file)
|
|
|
|
;; run hooks before exporting
|
|
|
|
(run-hooks 'org-publish-before-export-hook)
|
|
|
|
;; export the possibly modified buffer
|
|
|
|
(setq export-buf-or-file
|
|
|
|
(funcall (intern (concat "org-export-as-" format))
|
|
|
|
(plist-get plist :headline-levels)
|
2010-08-19 15:31:58 +00:00
|
|
|
nil plist nil
|
|
|
|
(plist-get plist :body-only)
|
|
|
|
pub-dir))
|
2008-10-21 16:21:52 +00:00
|
|
|
(when (and (bufferp export-buf-or-file)
|
|
|
|
(buffer-live-p export-buf-or-file))
|
|
|
|
(set-buffer export-buf-or-file)
|
|
|
|
;; run hooks after export and save export
|
2010-03-04 20:11:08 +00:00
|
|
|
(progn (run-hooks 'org-publish-after-export-hook)
|
|
|
|
(if (buffer-modified-p) (save-buffer)))
|
2008-10-21 16:21:52 +00:00
|
|
|
(kill-buffer export-buf-or-file))
|
|
|
|
;; maybe restore buffer's content
|
|
|
|
(set-buffer init-buf)
|
|
|
|
(when (buffer-modified-p init-buf)
|
|
|
|
(erase-buffer)
|
|
|
|
(insert init-buf-string)
|
|
|
|
(save-buffer)
|
2008-10-21 18:15:09 +00:00
|
|
|
(goto-char init-point))
|
|
|
|
(unless visiting
|
|
|
|
(kill-buffer init-buf))))))
|
2008-01-31 10:35:40 +00:00
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
(defmacro org-publish-with-aux-preprocess-maybe (&rest body)
|
|
|
|
"Execute BODY with a modified hook to preprocess for index."
|
|
|
|
`(let ((org-export-preprocess-after-headline-targets-hook
|
|
|
|
(if (plist-get project-plist :makeindex)
|
|
|
|
(cons 'org-publish-aux-preprocess
|
|
|
|
org-export-preprocess-after-headline-targets-hook)
|
|
|
|
org-export-preprocess-after-headline-targets-hook)))
|
|
|
|
,@body))
|
|
|
|
|
2010-03-28 08:01:07 +00:00
|
|
|
(defvar project-plist)
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-org-to-latex (plist filename pub-dir)
|
|
|
|
"Publish an org file to LaTeX.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
2010-02-25 06:31:29 +00:00
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "latex" plist filename pub-dir)))
|
2008-10-15 15:21:52 +00:00
|
|
|
|
|
|
|
(defun org-publish-org-to-pdf (plist filename pub-dir)
|
|
|
|
"Publish an org file to PDF (via LaTeX).
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
2010-02-25 06:31:29 +00:00
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "pdf" plist filename pub-dir)))
|
2008-03-02 14:14:52 +00:00
|
|
|
|
|
|
|
(defun org-publish-org-to-html (plist filename pub-dir)
|
|
|
|
"Publish an org file to HTML.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
2010-02-25 06:31:29 +00:00
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "html" plist filename pub-dir)))
|
2008-03-02 14:14:52 +00:00
|
|
|
|
2009-05-13 08:51:01 +00:00
|
|
|
(defun org-publish-org-to-org (plist filename pub-dir)
|
|
|
|
"Publish an org file to HTML.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
|
|
|
(org-publish-org-to "org" plist filename pub-dir))
|
|
|
|
|
2010-10-14 11:51:23 +00:00
|
|
|
(defun org-publish-org-to-ascii (plist filename pub-dir)
|
|
|
|
"Publish an org file to ASCII.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "ascii" plist filename pub-dir)))
|
|
|
|
|
|
|
|
(defun org-publish-org-to-latin1 (plist filename pub-dir)
|
|
|
|
"Publish an org file to Latin-1.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "latin1" plist filename pub-dir)))
|
|
|
|
|
|
|
|
(defun org-publish-org-to-utf8 (plist filename pub-dir)
|
|
|
|
"Publish an org file to UTF-8.
|
|
|
|
See `org-publish-org-to' to the list of arguments."
|
|
|
|
(org-publish-with-aux-preprocess-maybe
|
|
|
|
(org-publish-org-to "utf8" plist filename pub-dir)))
|
|
|
|
|
2008-03-10 21:46:41 +00:00
|
|
|
(defun org-publish-attachment (plist filename pub-dir)
|
2008-01-31 10:34:50 +00:00
|
|
|
"Publish a file with no transformation of any kind.
|
2008-03-10 21:46:41 +00:00
|
|
|
See `org-publish-org-to' to the list of arguments."
|
2008-01-31 10:34:50 +00:00
|
|
|
;; make sure eshell/cp code is loaded
|
Make org-publish-attachment honor directory structure
* lisp/org-publish.el (org-publish-attachment): Put the attachment
into the right directory.
Aidan Gauland <aidalgol@no8wireless.co.nz> writes:
> On Thu, Sep 16, 2010 at 12:40:34AM +0200, Sebastian Rose wrote:
>> Aidan Gauland <aidalgol@no8wireless.co.nz> writes:
>> > Sebastian Rose <sebastian_rose <at> gmx.de> writes:
>> >> It would be a bug.
>> >>
>> >> But I cannot reproduce it (current Org mode from git, emacs24).
>> >
>> > I just figured out why: I store all my images in ~/images/ and just
>> > have symbolic links to them in my Org website directory.
>> >
>> > Can you reproduce it now that you have this piece of information?
>>
>>
>> Ah, OK. That might be because of some call to
>>
>> (file-truename file...)
>>
>> or similar. `file-truename' removes symbolic links in filenames.
>>
>> Functions like this are called to make sure, the file is published only
>> if needed (i.e. the file has changed since last export).
>>
>> I'm not sure currently if it's clever to remove such calls (see
>> lisp/org-publish.el and search `file-truename').
>
> What if `file-truename' was used only to get the path of the actual
> file to copy, but the (relative) path of the link is used as the
> destination?
>
> --Aidan
Hi Aidan,
`org-publish-attachment' is wrong or called with wrong arguments.
This patch fixes it.
As always, there might be a better way to fix it,
but this way the function `org-publish-attachment' will work regardless
of parameters. Someone will always call this function with the wrong
`PUB-DIR' parameter...
Aidan, would like to apply the patch and verify it works for you?
Best wishes,
Sebastian
2010-09-16 17:23:37 +00:00
|
|
|
(unless (file-directory-p pub-dir)
|
|
|
|
(make-directory pub-dir t))
|
|
|
|
(or (equal (expand-file-name (file-name-directory filename))
|
|
|
|
(file-name-as-directory (expand-file-name pub-dir)))
|
2010-09-18 03:18:42 +00:00
|
|
|
(copy-file filename
|
|
|
|
(expand-file-name (file-name-nondirectory filename) pub-dir)
|
|
|
|
t)))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2008-03-02 00:52:52 +00:00
|
|
|
;;; Publishing files, sets of files, and indices
|
2008-01-31 10:34:50 +00:00
|
|
|
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(defun org-publish-file (filename &optional project no-cache)
|
|
|
|
"Publish file FILENAME from PROJECT.
|
|
|
|
If NO-CACHE is not nil, do not initialize org-publish-cache and
|
2010-07-16 21:23:01 +00:00
|
|
|
write it to disk. This is needed, since this function is used to
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
publish single files, when entire projects are published.
|
|
|
|
See `org-publish-projects'."
|
2009-07-02 21:07:41 +00:00
|
|
|
(let* ((project
|
|
|
|
(or project
|
|
|
|
(or (org-publish-get-project-from-filename filename)
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(error "File %s not part of any known project"
|
|
|
|
(abbreviate-file-name filename)))))
|
2009-07-02 21:07:41 +00:00
|
|
|
(project-plist (cdr project))
|
2010-09-18 03:18:42 +00:00
|
|
|
(ftname (expand-file-name filename))
|
2009-07-02 21:07:41 +00:00
|
|
|
(publishing-function
|
|
|
|
(or (plist-get project-plist :publishing-function)
|
|
|
|
'org-publish-org-to-html))
|
2010-07-22 09:45:04 +00:00
|
|
|
(base-dir
|
|
|
|
(file-name-as-directory
|
2010-09-18 03:18:42 +00:00
|
|
|
(expand-file-name
|
2010-07-22 09:45:04 +00:00
|
|
|
(or (plist-get project-plist :base-directory)
|
|
|
|
(error "Project %s does not have :base-directory defined"
|
|
|
|
(car project))))))
|
|
|
|
(pub-dir
|
|
|
|
(file-name-as-directory
|
|
|
|
(file-truename
|
|
|
|
(or (plist-get project-plist :publishing-directory)
|
|
|
|
(error "Project %s does not have :publishing-directory defined"
|
|
|
|
(car project))))))
|
2009-07-02 21:07:41 +00:00
|
|
|
tmp-pub-dir)
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
|
|
|
|
(unless no-cache
|
|
|
|
(org-publish-initialize-cache (car project)))
|
|
|
|
|
2009-07-02 21:07:41 +00:00
|
|
|
(setq tmp-pub-dir
|
|
|
|
(file-name-directory
|
|
|
|
(concat pub-dir
|
|
|
|
(and (string-match (regexp-quote base-dir) ftname)
|
|
|
|
(substring ftname (match-end 0))))))
|
|
|
|
(if (listp publishing-function)
|
|
|
|
;; allow chain of publishing functions
|
|
|
|
(mapc (lambda (f)
|
|
|
|
(when (org-publish-needed-p filename pub-dir f tmp-pub-dir)
|
|
|
|
(funcall f project-plist filename tmp-pub-dir)
|
|
|
|
(org-publish-update-timestamp filename pub-dir f)))
|
|
|
|
publishing-function)
|
|
|
|
(when (org-publish-needed-p filename pub-dir publishing-function
|
|
|
|
tmp-pub-dir)
|
|
|
|
(funcall publishing-function project-plist filename tmp-pub-dir)
|
|
|
|
(org-publish-update-timestamp
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
filename pub-dir publishing-function)))
|
|
|
|
(unless no-cache (org-publish-write-cache-file))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-projects (projects)
|
|
|
|
"Publish all files belonging to the PROJECTS alist.
|
2010-02-25 06:31:29 +00:00
|
|
|
If :auto-sitemap is set, publish the sitemap too.
|
|
|
|
If :makeindex is set, also produce a file theindex.org."
|
2008-03-04 00:54:40 +00:00
|
|
|
(mapc
|
2008-03-03 10:12:51 +00:00
|
|
|
(lambda (project)
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;; Each project uses it's own cache file:
|
|
|
|
(org-publish-initialize-cache (car project))
|
2008-06-15 06:03:45 +00:00
|
|
|
(let*
|
|
|
|
((project-plist (cdr project))
|
|
|
|
(exclude-regexp (plist-get project-plist :exclude))
|
2010-02-25 06:31:29 +00:00
|
|
|
(sitemap-p (plist-get project-plist :auto-sitemap))
|
|
|
|
(sitemap-filename (or (plist-get project-plist :sitemap-filename)
|
|
|
|
"sitemap.org"))
|
|
|
|
(sitemap-function (or (plist-get project-plist :sitemap-function)
|
|
|
|
'org-publish-org-sitemap))
|
2011-02-09 17:23:54 +00:00
|
|
|
(sitemap-date-format (or (plist-get project-plist :sitemap-date-format)
|
|
|
|
org-publish-sitemap-date-format))
|
|
|
|
(sitemap-file-entry-format (or (plist-get project-plist :sitemap-file-entry-format)
|
|
|
|
org-publish-sitemap-file-entry-format))
|
2008-06-15 06:03:45 +00:00
|
|
|
(preparation-function (plist-get project-plist :preparation-function))
|
|
|
|
(completion-function (plist-get project-plist :completion-function))
|
|
|
|
(files (org-publish-get-base-files project exclude-regexp)) file)
|
2010-02-25 06:31:29 +00:00
|
|
|
(when preparation-function (run-hooks 'preparation-function))
|
|
|
|
(if sitemap-p (funcall sitemap-function project sitemap-filename))
|
2008-03-02 14:14:52 +00:00
|
|
|
(while (setq file (pop files))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(org-publish-file file project t))
|
2010-02-25 06:31:29 +00:00
|
|
|
(when (plist-get project-plist :makeindex)
|
|
|
|
(org-publish-index-generate-theindex.inc
|
|
|
|
(plist-get project-plist :base-directory))
|
|
|
|
(org-publish-file (expand-file-name
|
|
|
|
"theindex.org"
|
|
|
|
(plist-get project-plist :base-directory))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
project t))
|
|
|
|
(when completion-function (run-hooks 'completion-function))
|
|
|
|
(org-publish-write-cache-file)))
|
2008-03-02 14:14:52 +00:00
|
|
|
(org-publish-expand-projects projects)))
|
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
(defun org-publish-org-sitemap (project &optional sitemap-filename)
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
"Create a sitemap of pages in set defined by PROJECT.
|
2010-02-25 06:31:29 +00:00
|
|
|
Optionally set the filename of the sitemap with SITEMAP-FILENAME.
|
|
|
|
Default for SITEMAP-FILENAME is 'sitemap.org'."
|
2008-03-03 10:12:51 +00:00
|
|
|
(let* ((project-plist (cdr project))
|
|
|
|
(dir (file-name-as-directory
|
|
|
|
(plist-get project-plist :base-directory)))
|
2008-06-16 15:23:03 +00:00
|
|
|
(localdir (file-name-directory dir))
|
|
|
|
(indent-str (make-string 2 ?\ ))
|
2008-03-02 14:14:52 +00:00
|
|
|
(exclude-regexp (plist-get project-plist :exclude))
|
2008-06-16 15:23:03 +00:00
|
|
|
(files (nreverse (org-publish-get-base-files project exclude-regexp)))
|
2010-02-25 06:31:29 +00:00
|
|
|
(sitemap-filename (concat dir (or sitemap-filename "sitemap.org")))
|
|
|
|
(sitemap-title (or (plist-get project-plist :sitemap-title)
|
|
|
|
(concat "Sitemap for project " (car project))))
|
|
|
|
(sitemap-style (or (plist-get project-plist :sitemap-style)
|
2008-07-09 16:55:00 +00:00
|
|
|
'tree))
|
2010-02-25 06:31:29 +00:00
|
|
|
(visiting (find-buffer-visiting sitemap-filename))
|
|
|
|
(ifn (file-name-nondirectory sitemap-filename))
|
|
|
|
file sitemap-buffer)
|
|
|
|
(with-current-buffer (setq sitemap-buffer
|
|
|
|
(or visiting (find-file sitemap-filename)))
|
2008-11-24 17:27:14 +00:00
|
|
|
(erase-buffer)
|
2010-02-25 06:31:29 +00:00
|
|
|
(insert (concat "#+TITLE: " sitemap-title "\n\n"))
|
2008-03-02 01:02:41 +00:00
|
|
|
(while (setq file (pop files))
|
2008-06-16 15:23:03 +00:00
|
|
|
(let ((fn (file-name-nondirectory file))
|
|
|
|
(link (file-relative-name file dir))
|
|
|
|
(oldlocal localdir))
|
2010-02-25 06:31:29 +00:00
|
|
|
;; sitemap shouldn't list itself
|
|
|
|
(unless (equal (file-truename sitemap-filename)
|
2008-11-25 06:18:36 +00:00
|
|
|
(file-truename file))
|
2010-02-25 06:31:29 +00:00
|
|
|
(if (eq sitemap-style 'list)
|
|
|
|
(message "Generating list-style sitemap for %s" sitemap-title)
|
|
|
|
(message "Generating tree-style sitemap for %s" sitemap-title)
|
2008-07-09 16:55:00 +00:00
|
|
|
(setq localdir (concat (file-name-as-directory dir)
|
|
|
|
(file-name-directory link)))
|
|
|
|
(unless (string= localdir oldlocal)
|
|
|
|
(if (string= localdir dir)
|
|
|
|
(setq indent-str (make-string 2 ?\ ))
|
|
|
|
(let ((subdirs
|
|
|
|
(split-string
|
|
|
|
(directory-file-name
|
|
|
|
(file-name-directory
|
|
|
|
(file-relative-name localdir dir))) "/"))
|
2008-10-26 06:45:13 +00:00
|
|
|
(subdir "")
|
|
|
|
(old-subdirs (split-string
|
|
|
|
(file-relative-name oldlocal dir) "/")))
|
2008-07-09 16:55:00 +00:00
|
|
|
(setq indent-str (make-string 2 ?\ ))
|
2008-10-26 06:45:13 +00:00
|
|
|
(while (string= (car old-subdirs) (car subdirs))
|
|
|
|
(setq indent-str (concat indent-str (make-string 2 ?\ )))
|
|
|
|
(pop old-subdirs)
|
|
|
|
(pop subdirs))
|
2008-07-09 16:55:00 +00:00
|
|
|
(dolist (d subdirs)
|
|
|
|
(setq subdir (concat subdir d "/"))
|
2008-11-02 07:08:32 +00:00
|
|
|
(insert (concat indent-str " + " d "\n"))
|
|
|
|
(setq indent-str (make-string
|
2008-07-09 16:55:00 +00:00
|
|
|
(+ (length indent-str) 2) ?\ )))))))
|
|
|
|
;; This is common to 'flat and 'tree
|
2011-02-09 17:23:54 +00:00
|
|
|
(let ((entry
|
|
|
|
(org-publish-format-file-entry sitemap-file-entry-format
|
|
|
|
file project-plist))
|
|
|
|
(regexp "\\(.*\\)\\[\\([^][]+\\)\\]\\(.*\\)"))
|
|
|
|
(cond ((string-match-p regexp entry)
|
|
|
|
(string-match regexp entry)
|
|
|
|
(insert (concat indent-str " + " (match-string 1 entry)
|
|
|
|
"[[file:" link "]["
|
|
|
|
(match-string 2 entry)
|
|
|
|
"]]" (match-string 3 entry) "\n")))
|
|
|
|
(t
|
|
|
|
(insert (concat indent-str " + [[file:" link "]["
|
|
|
|
entry
|
|
|
|
"]]\n"))))))))
|
2008-11-24 17:27:14 +00:00
|
|
|
(save-buffer))
|
2010-02-25 06:31:29 +00:00
|
|
|
(or visiting (kill-buffer sitemap-buffer))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2011-02-09 17:23:54 +00:00
|
|
|
(defun org-publish-format-file-entry (fmt file project-plist)
|
2011-02-11 19:43:11 +00:00
|
|
|
(format-spec fmt
|
2011-02-16 10:39:13 +00:00
|
|
|
`((?t . ,(org-publish-find-title file t))
|
2011-02-11 19:43:11 +00:00
|
|
|
(?d . ,(format-time-string sitemap-date-format
|
|
|
|
(org-publish-find-date file)))
|
|
|
|
(?a . ,(or (plist-get project-plist :author) user-full-name)))))
|
2011-02-09 17:23:54 +00:00
|
|
|
|
2011-02-16 10:39:13 +00:00
|
|
|
(defun org-publish-find-title (file &optional reset)
|
2010-07-16 21:23:01 +00:00
|
|
|
"Find the title of FILE in project."
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(or
|
2011-02-16 10:39:13 +00:00
|
|
|
(and (not reset) (org-publish-cache-get-file-property file :title nil t))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(let* ((visiting (find-buffer-visiting file))
|
2008-11-03 12:52:16 +00:00
|
|
|
(buffer (or visiting (find-file-noselect file)))
|
|
|
|
title)
|
2009-11-05 21:51:50 +00:00
|
|
|
(with-current-buffer buffer
|
Don't keep buffers visited during index publishing.
The index generation of org-publish does briefly visit all files in
order to extract the correct page title. Visiting is necessary,
because the title may be set by the first line in the buffer, by a
Before this patch, this would cause the generation of a large number
of buffers, one for each file mentioned in the index. This patch
arranges for these buffers to be removed again. However, buffers
which were already present will not be removed.
There is still one open problem: The files to be published are
visited twice, one for publishing them, a second time for creating the
index. Visiting causes some overhead, and we would like to limit this
overhead. For now, however, this is not done.
2008-11-02 16:13:25 +00:00
|
|
|
(let* ((opt-plist (org-combine-plists (org-default-export-plist)
|
|
|
|
(org-infile-export-plist))))
|
2008-11-03 12:52:16 +00:00
|
|
|
(setq title
|
|
|
|
(or (plist-get opt-plist :title)
|
|
|
|
(and (not
|
|
|
|
(plist-get opt-plist :skip-before-1st-heading))
|
|
|
|
(org-export-grab-title-from-buffer))
|
|
|
|
(file-name-nondirectory (file-name-sans-extension file))))))
|
Don't keep buffers visited during index publishing.
The index generation of org-publish does briefly visit all files in
order to extract the correct page title. Visiting is necessary,
because the title may be set by the first line in the buffer, by a
Before this patch, this would cause the generation of a large number
of buffers, one for each file mentioned in the index. This patch
arranges for these buffers to be removed again. However, buffers
which were already present will not be removed.
There is still one open problem: The files to be published are
visited twice, one for publishing them, a second time for creating the
index. Visiting causes some overhead, and we would like to limit this
overhead. For now, however, this is not done.
2008-11-02 16:13:25 +00:00
|
|
|
(unless visiting
|
2008-11-03 12:52:16 +00:00
|
|
|
(kill-buffer buffer))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(org-publish-cache-set-file-property file :title title)
|
2010-04-22 07:10:14 +00:00
|
|
|
title)))
|
2008-06-15 06:03:45 +00:00
|
|
|
|
2010-12-01 15:06:16 +00:00
|
|
|
(defun org-publish-find-date (file)
|
|
|
|
"Find the date of FILE in project.
|
|
|
|
If FILE provides a #+date keyword use it else use the file
|
2011-02-09 17:23:54 +00:00
|
|
|
system's modification time.
|
|
|
|
|
|
|
|
It returns time in `current-time' format."
|
2010-12-01 15:06:16 +00:00
|
|
|
(let ((visiting (find-buffer-visiting file)))
|
|
|
|
(save-excursion
|
|
|
|
(switch-to-buffer (or visiting (find-file file)))
|
|
|
|
(let* ((plist (org-infile-export-plist))
|
|
|
|
(date (plist-get plist :date)))
|
|
|
|
(unless visiting
|
|
|
|
(kill-buffer (current-buffer)))
|
|
|
|
(if date
|
2011-02-09 17:23:54 +00:00
|
|
|
(org-time-string-to-time date)
|
2010-12-01 15:06:16 +00:00
|
|
|
(when (file-exists-p file)
|
2011-02-09 17:23:54 +00:00
|
|
|
(nth 5 (file-attributes file))))))))
|
2010-12-01 15:06:16 +00:00
|
|
|
|
2008-03-02 14:14:52 +00:00
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2008-03-02 00:52:52 +00:00
|
|
|
;;; Interactive publishing functions
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2008-10-17 05:23:26 +00:00
|
|
|
;;;###autoload
|
2008-03-31 11:11:17 +00:00
|
|
|
(defalias 'org-publish-project 'org-publish)
|
2008-03-10 21:46:41 +00:00
|
|
|
|
2008-01-31 10:34:50 +00:00
|
|
|
;;;###autoload
|
2008-03-04 00:22:46 +00:00
|
|
|
(defun org-publish (project &optional force)
|
|
|
|
"Publish PROJECT."
|
2009-05-19 15:46:09 +00:00
|
|
|
(interactive
|
|
|
|
(list
|
2009-08-19 08:33:17 +00:00
|
|
|
(assoc (org-icompleting-read
|
2009-05-19 15:46:09 +00:00
|
|
|
"Publish project: "
|
|
|
|
org-publish-project-alist nil t)
|
|
|
|
org-publish-project-alist)
|
|
|
|
current-prefix-arg))
|
2008-03-11 11:48:17 +00:00
|
|
|
(setq org-publish-initial-buffer (current-buffer))
|
2008-01-31 10:34:50 +00:00
|
|
|
(save-window-excursion
|
2009-05-19 15:46:09 +00:00
|
|
|
(let* ((org-publish-use-timestamps-flag
|
2008-03-04 00:22:46 +00:00
|
|
|
(if force nil org-publish-use-timestamps-flag)))
|
2010-06-10 02:33:28 +00:00
|
|
|
(org-publish-projects
|
|
|
|
(if (stringp project)
|
|
|
|
;; If this function is called in batch mode,
|
|
|
|
;; project is still a string here.
|
|
|
|
(list (assoc project org-publish-project-alist))
|
|
|
|
(list project))))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
|
|
|
;;;###autoload
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-all (&optional force)
|
|
|
|
"Publish all projects.
|
2009-07-07 13:04:15 +00:00
|
|
|
With prefix argument, remove all files in the timestamp
|
|
|
|
directory and force publishing all files."
|
2008-01-31 10:34:50 +00:00
|
|
|
(interactive "P")
|
2009-07-07 13:04:15 +00:00
|
|
|
(when force
|
|
|
|
(org-publish-remove-all-timestamps))
|
2008-01-31 10:34:50 +00:00
|
|
|
(save-window-excursion
|
2008-03-02 14:14:52 +00:00
|
|
|
(let ((org-publish-use-timestamps-flag
|
2008-02-28 00:23:06 +00:00
|
|
|
(if force nil org-publish-use-timestamps-flag)))
|
2008-03-02 14:14:52 +00:00
|
|
|
(org-publish-projects org-publish-project-alist))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
|
2008-01-31 10:34:50 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defun org-publish-current-file (&optional force)
|
|
|
|
"Publish the current file.
|
|
|
|
With prefix argument, force publish the file."
|
|
|
|
(interactive "P")
|
|
|
|
(save-window-excursion
|
|
|
|
(let ((org-publish-use-timestamps-flag
|
2008-02-26 14:59:20 +00:00
|
|
|
(if force nil org-publish-use-timestamps-flag)))
|
2008-01-31 10:34:50 +00:00
|
|
|
(org-publish-file (buffer-file-name)))))
|
|
|
|
|
|
|
|
;;;###autoload
|
2008-03-02 14:14:52 +00:00
|
|
|
(defun org-publish-current-project (&optional force)
|
|
|
|
"Publish the project associated with the current file.
|
|
|
|
With a prefix argument, force publishing of all files in
|
|
|
|
the project."
|
2008-01-31 10:34:50 +00:00
|
|
|
(interactive "P")
|
|
|
|
(save-window-excursion
|
2009-02-26 21:18:16 +00:00
|
|
|
(let ((project (org-publish-get-project-from-filename (buffer-file-name) 'up))
|
2008-03-02 14:14:52 +00:00
|
|
|
(org-publish-use-timestamps-flag
|
|
|
|
(if force nil org-publish-use-timestamps-flag)))
|
|
|
|
(if (not project)
|
|
|
|
(error "File %s is not part of any known project" (buffer-file-name)))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;; FIXME: force is not used here?
|
2008-03-02 22:49:28 +00:00
|
|
|
(org-publish project))))
|
2008-01-31 10:34:50 +00:00
|
|
|
|
2010-02-25 06:31:29 +00:00
|
|
|
|
|
|
|
;;; Index generation
|
|
|
|
|
|
|
|
(defun org-publish-aux-preprocess ()
|
|
|
|
"Find index entries and write them to an .orgx file."
|
2010-04-04 20:45:26 +00:00
|
|
|
(let ((case-fold-search t)
|
|
|
|
entry index target)
|
2010-02-25 06:31:29 +00:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while
|
|
|
|
(and
|
|
|
|
(re-search-forward "^[ \t]*#\\+index:[ \t]*\\(.*?\\)[ \t]*$" nil t)
|
|
|
|
(> (match-end 1) (match-beginning 1)))
|
|
|
|
(setq entry (match-string 1))
|
2011-03-01 19:01:42 +00:00
|
|
|
(when (eq org-export-current-backend 'latex)
|
2010-02-25 06:31:29 +00:00
|
|
|
(replace-match (format "\\index{%s}" entry) t t))
|
|
|
|
(save-excursion
|
2010-04-22 07:23:56 +00:00
|
|
|
(ignore-errors (org-back-to-heading t))
|
2010-02-25 06:31:29 +00:00
|
|
|
(setq target (get-text-property (point) 'target))
|
|
|
|
(setq target (or (cdr (assoc target org-export-preferred-target-alist))
|
|
|
|
(cdr (assoc target org-export-id-target-alist))
|
2010-04-22 07:23:56 +00:00
|
|
|
target ""))
|
2010-02-25 06:31:29 +00:00
|
|
|
(push (cons entry target) index)))
|
2010-04-01 11:11:54 +00:00
|
|
|
(with-temp-file
|
2010-02-25 06:31:29 +00:00
|
|
|
(concat (file-name-sans-extension org-current-export-file) ".orgx")
|
|
|
|
(dolist (entry (nreverse index))
|
|
|
|
(insert (format "INDEX: (%s) %s\n" (cdr entry) (car entry)))))))
|
|
|
|
|
|
|
|
(defun org-publish-index-generate-theindex.inc (directory)
|
|
|
|
"Generate the index from all .orgx files in the current directory and below."
|
|
|
|
(require 'find-lisp)
|
|
|
|
(let* ((fulldir (file-name-as-directory
|
|
|
|
(expand-file-name directory)))
|
|
|
|
(full-files (find-lisp-find-files directory "\\.orgx\\'"))
|
|
|
|
(re (concat "\\`" fulldir))
|
|
|
|
(files (mapcar (lambda (f) (if (string-match re f)
|
|
|
|
(substring f (match-end 0))
|
|
|
|
f))
|
|
|
|
full-files))
|
|
|
|
(default-directory directory)
|
|
|
|
index origfile buf target entry ibuffer
|
2010-04-22 07:23:56 +00:00
|
|
|
main last-main letter last-letter file sub link tgext)
|
2010-02-25 06:31:29 +00:00
|
|
|
;; `files' contains the list of relative file names
|
|
|
|
(dolist (file files)
|
|
|
|
(setq origfile (substring file 0 -1))
|
|
|
|
(setq buf (find-file-noselect file))
|
|
|
|
(with-current-buffer buf
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "^INDEX: (\\(.*?\\)) \\(.*\\)" nil t)
|
|
|
|
(setq target (match-string 1)
|
|
|
|
entry (match-string 2))
|
|
|
|
(push (list entry origfile target) index)))
|
|
|
|
(kill-buffer buf))
|
|
|
|
(setq index (sort index (lambda (a b) (string< (downcase (car a))
|
|
|
|
(downcase (car b))))))
|
|
|
|
(setq ibuffer (find-file-noselect (expand-file-name "theindex.inc" directory)))
|
|
|
|
(with-current-buffer ibuffer
|
|
|
|
(erase-buffer)
|
|
|
|
(insert "* Index\n")
|
|
|
|
(setq last-letter nil)
|
|
|
|
(dolist (idx index)
|
|
|
|
(setq entry (car idx) file (nth 1 idx) target (nth 2 idx))
|
2010-04-22 07:23:56 +00:00
|
|
|
(if (and (stringp target) (string-match "\\S-" target))
|
|
|
|
(setq tgext (concat "::#" target))
|
|
|
|
(setq tgext ""))
|
2010-02-25 06:31:29 +00:00
|
|
|
(setq letter (upcase (substring entry 0 1)))
|
|
|
|
(when (not (equal letter last-letter))
|
|
|
|
(insert "** " letter "\n")
|
|
|
|
(setq last-letter letter))
|
|
|
|
(if (string-match "!" entry)
|
|
|
|
(setq main (substring entry 0 (match-beginning 0))
|
|
|
|
sub (substring entry (match-end 0)))
|
|
|
|
(setq main nil sub nil last-main nil))
|
|
|
|
(when (and main (not (equal main last-main)))
|
|
|
|
(insert " - " main "\n")
|
|
|
|
(setq last-main main))
|
2010-04-22 07:23:56 +00:00
|
|
|
(setq link (concat "[[file:" file tgext "]"
|
2010-02-25 06:31:29 +00:00
|
|
|
"[" (or sub entry) "]]"))
|
|
|
|
(if (and main sub)
|
|
|
|
(insert " - " link "\n")
|
|
|
|
(insert " - " link "\n")))
|
|
|
|
(save-buffer))
|
|
|
|
(kill-buffer ibuffer)
|
|
|
|
|
|
|
|
(let ((index-file (expand-file-name "theindex.org" directory)))
|
|
|
|
(unless (file-exists-p index-file)
|
|
|
|
(setq ibuffer (find-file-noselect index-file))
|
|
|
|
(with-current-buffer ibuffer
|
|
|
|
(erase-buffer)
|
|
|
|
(insert "\n\n#+include: \"theindex.inc\"\n\n")
|
|
|
|
(save-buffer))
|
|
|
|
(kill-buffer ibuffer)))))
|
|
|
|
|
2008-01-31 10:36:18 +00:00
|
|
|
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;; Caching functions:
|
|
|
|
|
|
|
|
(defun org-publish-write-cache-file (&optional free-cache)
|
|
|
|
"Write `org-publish-cache' to file.
|
|
|
|
If FREE-CACHE, empty the cache."
|
|
|
|
(unless org-publish-cache
|
|
|
|
(error "%s" "`org-publish-write-cache-file' called, but no cache present"))
|
|
|
|
|
|
|
|
(let ((cache-file (org-publish-cache-get ":cache-file:")))
|
|
|
|
(unless cache-file
|
2010-05-22 14:10:34 +00:00
|
|
|
(error
|
|
|
|
"%s" "Cannot find cache-file name in `org-publish-write-cache-file'"))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(with-temp-file cache-file
|
|
|
|
(let ((print-level nil)
|
2010-05-22 14:10:34 +00:00
|
|
|
(print-length nil))
|
|
|
|
(insert "(setq org-publish-cache (make-hash-table :test 'equal :weakness nil :size 100))\n")
|
|
|
|
(maphash (lambda (k v)
|
|
|
|
(insert
|
|
|
|
(format (concat "(puthash %S "
|
|
|
|
(if (or (listp v) (symbolp v))
|
|
|
|
"'" "")
|
|
|
|
"%S org-publish-cache)\n") k v)))
|
|
|
|
org-publish-cache)))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(when free-cache (org-publish-reset-cache))))
|
|
|
|
|
|
|
|
(defun org-publish-initialize-cache (project-name)
|
2010-07-16 21:23:01 +00:00
|
|
|
"Initialize the projects cache if not initialized yet and return it."
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
|
|
|
|
(unless project-name
|
|
|
|
(error "%s%s" "Cannot initialize `org-publish-cache' without projects name"
|
|
|
|
" in `org-publish-initialize-cache'"))
|
|
|
|
|
|
|
|
(unless (file-exists-p org-publish-timestamp-directory)
|
2010-07-01 09:31:14 +00:00
|
|
|
(make-directory org-publish-timestamp-directory t))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(if (not (file-directory-p org-publish-timestamp-directory))
|
|
|
|
(error "Org publish timestamp: %s is not a directory"
|
|
|
|
org-publish-timestamp-directory))
|
|
|
|
|
|
|
|
(unless (and org-publish-cache
|
|
|
|
(string= (org-publish-cache-get ":project:") project-name))
|
|
|
|
(let* ((cache-file (concat
|
|
|
|
(expand-file-name org-publish-timestamp-directory)
|
|
|
|
project-name
|
|
|
|
".cache"))
|
|
|
|
(cexists (file-exists-p cache-file)))
|
2010-05-22 14:10:34 +00:00
|
|
|
|
|
|
|
(when org-publish-cache
|
|
|
|
(org-publish-reset-cache))
|
|
|
|
|
|
|
|
(if cexists
|
|
|
|
(load-file cache-file)
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(setq org-publish-cache
|
2010-05-14 14:41:21 +00:00
|
|
|
(make-hash-table :test 'equal :weakness nil :size 100))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(org-publish-cache-set ":project:" project-name)
|
2010-05-14 14:46:25 +00:00
|
|
|
(org-publish-cache-set ":cache-file:" cache-file))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(unless cexists (org-publish-write-cache-file nil))))
|
|
|
|
org-publish-cache)
|
|
|
|
|
|
|
|
(defun org-publish-reset-cache ()
|
|
|
|
"Empty org-publish-cache and reset it nil."
|
|
|
|
(message "%s" "Resetting org-publish-cache")
|
|
|
|
(if (hash-table-p org-publish-cache)
|
|
|
|
(clrhash org-publish-cache))
|
|
|
|
(setq org-publish-cache nil))
|
|
|
|
|
|
|
|
(defun org-publish-cache-file-needs-publishing (filename &optional pub-dir pub-func)
|
|
|
|
"Check the timestamp of the last publishing of FILENAME.
|
|
|
|
Return `t', if the file needs publishing"
|
|
|
|
(unless org-publish-cache
|
|
|
|
(error "%s" "`org-publish-cache-file-needs-publishing' called, but no cache present"))
|
|
|
|
(let* ((key (org-publish-timestamp-filename filename pub-dir pub-func))
|
|
|
|
(pstamp (org-publish-cache-get key)))
|
|
|
|
(if (null pstamp)
|
|
|
|
t
|
|
|
|
(let ((ctime (org-publish-cache-ctime-of-src filename)))
|
|
|
|
(< pstamp ctime)))))
|
|
|
|
|
|
|
|
(defun org-publish-cache-set-file-property (filename property value &optional project-name)
|
2010-07-16 21:23:01 +00:00
|
|
|
"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."
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
;; Evtl. load the requested cache file:
|
|
|
|
(if project-name (org-publish-initialize-cache project-name))
|
|
|
|
(let ((pl (org-publish-cache-get filename)))
|
|
|
|
(if pl
|
|
|
|
(progn
|
|
|
|
(plist-put pl property value)
|
|
|
|
value)
|
|
|
|
(org-publish-cache-get-file-property
|
|
|
|
filename property value nil project-name))))
|
|
|
|
|
|
|
|
(defun org-publish-cache-get-file-property
|
|
|
|
(filename property &optional default no-create project-name)
|
2010-07-16 21:23:01 +00:00
|
|
|
"Return the value for a PROPERTY of file FILENAME in publishing cache.
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
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."
|
|
|
|
;; Evtl. load the requested cache file:
|
|
|
|
(if project-name (org-publish-initialize-cache project-name))
|
|
|
|
(let ((pl (org-publish-cache-get filename))
|
|
|
|
(retval nil))
|
|
|
|
(if pl
|
|
|
|
(if (plist-member pl property)
|
|
|
|
(setq retval (plist-get pl property))
|
|
|
|
(setq retval default))
|
|
|
|
;; no pl yet:
|
|
|
|
(unless no-create
|
|
|
|
(org-publish-cache-set filename (list property default)))
|
|
|
|
(setq retval default))
|
|
|
|
retval))
|
|
|
|
|
|
|
|
(defun org-publish-cache-get (key)
|
|
|
|
"Return the value stored in `org-publish-cache' for key KEY.
|
|
|
|
Returns nil, if no value or nil is found, or the cache does not
|
|
|
|
exist."
|
|
|
|
(unless org-publish-cache
|
|
|
|
(error "%s" "`org-publish-cache-get' called, but no cache present"))
|
|
|
|
(gethash key org-publish-cache))
|
|
|
|
|
|
|
|
(defun org-publish-cache-set (key value)
|
2010-07-16 21:23:01 +00:00
|
|
|
"Store KEY VALUE pair in `org-publish-cache'.
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
Returns value on success, else nil."
|
|
|
|
(unless org-publish-cache
|
|
|
|
(error "%s" "`org-publish-cache-set' called, but no cache present"))
|
|
|
|
(puthash key value org-publish-cache))
|
|
|
|
|
|
|
|
(defun org-publish-cache-ctime-of-src (filename)
|
2011-02-16 10:39:13 +00:00
|
|
|
"Get the FILENAME ctime as an integer."
|
2011-01-06 19:25:00 +00:00
|
|
|
(let ((src-attr (file-attributes (if (stringp (file-symlink-p filename))
|
|
|
|
(file-symlink-p filename)
|
|
|
|
filename))))
|
Publishing, cashing and timestamps
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Sebastian,
>
> sorry for being slow. Could you do me a favor and send me the cache patch one
> more time - if possible updated to the current master.
>
> I am just not sure I have the right patch in my hands.
Hi Carsten,
no problem. The patch is attached.
Here is a list of my ChangeLog entries, redated to today:
2010-05-13 Sebastian Rose <sebastian_rose@gmx.de>
* org-publish.el (org-publish-cache): Use one big hashmap for
each project defined in `org-publish-project-alist'. The
hashmap will hold pairs of our timestamp-filenames and
timestamps, as well as pairs of source-paths and associated
plists for arbitrary values. Currently only the files title is
stored there.
The caching feature writes the information gathered during
publishing to disk and re-loads it from there the next time we
publish the same project. All those informations will hence
survive a restart of emacs.
One cache file per publishing project is used. The contents of
that file is the elisp that fills the new variable
`org-publish-cache'. The cache file is named according to the
project with `.cache' added and lives in
`org-timestamp-directory'.
* org-publish.el (initialize-files-alist): This function and
the variable `org-publish-files-alist' are not used anymore in
favour of the reloadable cache and the functions for handling
it. Removed therefor.
* org-publish.el (org-publish-validate-link) was not used
anywhere. Removed.
* org-publish.el (org-publish-get-base-files): Added the
variable `sitemap-requested' to avoid sorting where possible.
See also end of `org-publish-get-base-files-1'.
* org-publish.el (org-publish-get-files): This function is
not called anymore. Removed.
* org-publish.el (org-publish-get-project-from-filename) does
not depend on a list of files anymore. Instead of laoding all
files of all, we walk `org-publish-project-alist' until we
find a project, where the properties :base-directory, :recursive,
:base-extension, :include and :exclude match.
* org-publish.el (org-publish-file) takes an additional
parameter to avoid superfloues loading and writing of the
cache file when used to publish a part of a project.
2010-05-13 11:43:53 +00:00
|
|
|
(+
|
|
|
|
(lsh (car (nth 5 src-attr)) 16)
|
|
|
|
(cadr (nth 5 src-attr)))))
|
|
|
|
|
|
|
|
(provide 'org-publish)
|
2008-03-03 10:12:51 +00:00
|
|
|
|
2008-01-31 10:36:18 +00:00
|
|
|
;; arch-tag: 72807f3c-8af0-4a6b-8dca-c3376eb25adb
|
2008-04-29 05:15:41 +00:00
|
|
|
|
2008-01-31 10:34:50 +00:00
|
|
|
;;; org-publish.el ends here
|