Mercurial > emacs
comparison lisp/textmodes/org-publish.el @ 80467:1d830d9c60e0
* textmodes/org-export-latex.el: New file.
* textmodes/org-irc.el: New file.
* textmodes/org-mac-message.el: New file.
* textmodes/org-publish.el: New file.
* textmodes/org.el (org-agenda-collect-markers)
(org-create-marker-find-array)
(org-check-agenda-marker-table, org-extract-log-state-settings)
(org-nofm-to-completion, org-refile-goto-last-stored)
(org-export-html-convert-special-strings, org-first-list-item-p)
(org-imenu-new-marker, org-imenu-get-tree)
(org-speedbar-set-agenda-restriction)
(org-agenda-set-restriction-lock)
(org-agenda-remove-restriction-lock)
(org-agenda-maybe-redo, org-compute-latex-and-specials-regexp)
(org-do-latex-and-special-faces, org-read-date-display)
(org-select-remember-template, org-agenda-copy-local-variable)
(org-read-date-get-relative, org-columns-cleanup-item)
(org-find-entry-with-id)
(org-insert-columns-dblock, org-listtable-to-string)
(org-dblock-write:columnview, org-columns-capture-view)
(org-edit-headline, org-parse-local-options)
(org-in-clocktable-p, org-property-or-variable-value)
(org-get-tags-string, org-up-heading-safe)
(org-fast-todo-selection, org-get-wdays)
(org-switch-to-buffer-other-window, org-agenda-deadline-face)
(org-add-link-type, org-columns-content, org-columns-widen)
(org-columns-next-allowed-value, org-columns-edit-allowed)
(org-columns-store-format)
(org-columns-uncompile-format, org-columns-redo)
(org-columns-edit-attributes, org-delete-property)
(org-set-property, org-columns-update, org-columns-compute)
(org-columns-eval)
(org-columns-not-in-agenda, org-columns-compute-all)
(org-property-next-allowed-value)
(org-columns-compile-format, org-fill-paragraph-experimental)
(org-string-to-number, org-property-action, org-columns-move-left)
(org-columns-new)
(org-column-number-to-string, org-property-previous-allowed-value)
(org-at-property-p, org-columns-delete)
(org-columns-previous-allowed-value)
(org-columns-move-right, org-columns-narrow)
(org-property-get-allowed-values)
(org-verify-version, org-column-string-to-number)
(org-delete-property-globally)
(org-get-property-block, org-entry-properties, org-entry-get)
(org-entry-delete, org-entry-get-with-inheritance)
(org-entry-put, org-buffer-property-keys, org-new-column-overlay)
(org-overlay-columns)
(org-overlay-columns-title, org-remove-column-overlays)
(org-column-show-value, org-column-quit, org-column-edit)
(org-cached-entry-get, org-table-put-field-property)
(org-get-columns-autowidth-alist, turn-on-orgstruct)
(orgstruct-error, orgstruct-setup)
(orgstruct-make-binding, org-context-p, org-get-local-variables)
(org-run-like-in-org-mode)
(org-make-link-regexps, org-remove-keyword-keys)
(org-get-todo-face, org-export-get-title-from-subtree)
(org-assign-fast-keys, org-get-min-level)
(org-get-wdays, org-clock-find-position)
(org-clock-goto, org-fontify-priorities)
(org-get-date-from-calendar)
(org-entry-add-to-multivalued-property)
(org-entry-remove-from-multivalued-property)
(org-entry-member-in-multivalued-property)
(org-entry-is-todo-p, org-entry-is-done-p, org-get-todo-state)
(org-agenda-get-restriction-and-command)
(org-open-link-from-string, org-columns-open-link)
(org-go-to-remember-target, org-remember-insinuate)
(org-icalendar-cleanup-string, org-first-sibling-p)
(org-back-over-empty-lines, org-skip-whitespace)
(org-goto-local-auto-isearch)
(org-clocktable-steps, org-refile-get-location)
(org-kill-line, org-remove-timestamp-with-keyword)
(org-local-logging): New functions.
(org-agenda-marker-table, org-log-note-how)
(org-goto-local-auto-isearch-map)
(org-last-remember-storage-locations)
(org-imenu-markers, org-agenda-restriction-lock-overlay)
(org-speedbar-restriction-lock-overlay)
(org-massive-special-regexp)
(org-verbatim-re, org-read-date-display-live)
(org-agenda-file-regexp, org-complex-heading-regexp)
(org-completion-fallback-command, org-todo-log-states)
(org-goto-exit-command, org-goto-selected-point)
(org-todo-key-alist, org-todo-key-trigger, org-agenda-remove-date)
(org-agenda-after-show-hook, org-agenda-skip-unavailable-files)
(org-fast-tag-selection-can-set-todo-state, org-local-properties)
(org-store-link-functions, org-columns-top-level-marker)
(orgstruct-mode-map, org-entry-property-inherited-from)
(org-column-overlays, org-current-columns-fmt)
(org-current-columns-maxwidths, org-column-map)
(org-cached-props): New variables.
(org-special-ctrl-k, org-goto-auto-isearch)
(org-agenda-todo-keyword-format)
(org-remember-use-refile-when-interactive)
(org-imenu-depth, org-highlight-latex-fragments-and-specials)
(org-agenda-skip-scheduled-if-done, org-extend-today-until)
(org-agenda-window-frame-fractions, org-fontify-priorities)
(org-agenda-deadline-leaders, org-use-property-inheritance)
(org-clock-into-drawer, org-agenda-compact-blocks)
(org-use-fast-todo-selection, org-fast-tag-selection-include-todo)
(org-edit-timestamp-down-means-later, org-todo-keyword-faces)
(org-agenda-deadline-faces, org-remember-store-without-prompt)
(org-default-columns-format)
(org-agenda-default-appointment-duration)
(org-export-with-footnotes, org-clock-out-when-done)
(org-global-properties, org-todo-keyword-faces)
(org-archive-save-context-info)
(org-edit-timestamp-down-means-later)
(org-scheduled-past-days, org-export-with-drawers)
(org-read-date-prefer-future, org-hide-emphasis-markers)
(org-clock-heading-function, org-clock-in-switch-to-state)
(org-export-with-special-strings): New options.
(org-link-store, org-link-follow, org-latex)
(org-remember-templates, org-time-stamp-rounding-minutes)
(org-back-over-empty-lines, org-find-base-buffer-visiting)
(org-columns-new): Fix typos in docstrings.
(org-ctrl-c-star): Implement a missing branch in the decision
tree.
(org-select-remember-template): Clean the code.
(org-prepare-dblock): Add the extra :content parameter.
(org-write-agenda): New output type ".ics" files.
(org-write-agenda): Call `org-icalendar-verify-function', both for
time stamps and for TODO entries.
(org-export-as-html): Revert the change that killed the html
buffer. Side effects first need to be studied carefully.
(org-get-tags-at): Fix the structure of the condition-case
statement.
(org-ts-regexp0, org-repeat-re, org-display-custom-time)
(org-timestamp-change): Fix regulear expressions to swallow the
extra character for repeat-shift control.
(org-auto-repeat-maybe): Implement the new repeater mechanisms.
(org-get-legal-level): Alias to `org-get-valid-level'.
(org-dblock-write:clocktable): Add a :link parameter, linking
headlines to their location in the Org agenda files.
(org-get-tags-at): Bugfix: prevent `org-back-to-heading' from
throwing an error when getting tags before headlines.
(org-timestamp-change, org-modify-ts-extra)
(org-ts-regexp1): Fix timestamp editing.
(org-agenda-custom-commands-local-options): New constant.
(org-agenda-custom-commands): Use
`org-agenda-custom-commands-local-options' to improve customize
type. "htmlize": Removed hack to fix face problem with htmlize,
it no longer seem necessary.
(org-follow-link-hook): New hook.
(org-agenda-custom-commands): Add "Component" as a tag for each
item in a command serie.
(org-open-at-point): Run `org-follow-link-hook'.
(org-agenda-schedule): Bugfix: don't display marker type when it
is nil.
(org-store-link): org-irc required.
(org-set-regexps-and-options): Parse the new logging options.
(org-todo): Handle the new ways of recording state change stuff.
(org-columns-open-link): Fix bug with opening link in column view.
(org-todo): Make sure that LOGGING properties are honoured.
(org-todo-keywords): Improve docstring.
(org-startup-options): Cleanup startup options.
(org-set-regexps-and-options): Process the "!" markers.
(org-todo): Respect the new logging stuff.
(org-add-log-maybe): New parameter HOW that defines how logging
should be done and also overrides PURPOSE. Add a docstring.
(org-add-log-note): Check if we really need to ask for a note.
(org-get-current-options): Digest the new keyword.
(org-agenda-reset-markers): Rename from
`org-agenda-maybe-reset-markers'. Remove FORCE argument.
(org-diary, org-agenda-quit, org-prepare-agenda): Call the renamed
function, without force argument.
(org-buffer-property-keys): Bind local variables s and p.
(org-make-tags-matcher): Allow "" to match an empty or
non-existent property value.
(org-export-as-html): Join unsorted lists when they directly
follow each other. Such lists may be created by headlines that
are converted to lists.
(org-export-as-html): Use :html-extension instead of
org-export-html-extension.
(org-store-link): Support for links from `rmail-summary-mode'.
(org-columns-new, org-complete, org-set-property): Set the
`include-columns' argument in the call to
`org-buffer-property-keys'.
(org-buffer-property-keys): New argument `include-columns', to
include properties expected by any of the COLUMS formats in the
current buffer.
(org-cleaned-string-for-export): Get rid of drawers first, so that
they will be removed also in the text before the first headline.
(org-clock-report): Show the clocktable when found.
(org-refile): Fix positioning bug when `org-reverse-note-order' is
nil.
(org-version): With prefix argument, insert `org-version' at
point.
(org-agenda-goto): Recenter the window after finding the target
location, to make sure the correct position will be displayed.
(org-agenda-get-deadlines): Don't scale priority with the warning
period.
(org-insert-heading): Don't break line in the middle of the line.
(org-agenda-get-deadlines): Allow `org-deadline-warning-days' to
be 0.
(org-update-checkbox-count): Revamp to deal with hierarchical
beckboxes. This was a patch from Miguel A. Figueroa-Villanueva.
(org-schedule, org-deadline): Use
`org-remove-timestamp-with-keyword' to make sure all such time
stamps are removed.
(org-mode): Support for `align'.
(org-agenda-get-deadlines): Make sure priorities increase as the
due date approaches and is passed.
(org-remember-apply-template): Fix problem with tags that contain
"_" or "@".
(org-make-link-regexps): Improve the regular expression for plain
links.
(org-agenda-get-closed): List each clocking entry.
(org-set-tags): Only tabify before tags if indent-tabs-mode is t.
(org-archive-all-done): Fix incorrect number of stars in regexp.
(org-global-tags-completion-table): Add the value of org-tag-alist
in each buffer, to make sure that also unused tags will be
available for completion.
(org-columns-edit-value)
(org-columns-next-allowed-value): Only update if not in agenda.
(org-dblock-write:clocktable): Call `org-clocktable-steps'.
(org-archive-subtree): Add the outline tree context as a property.
(org-closest-date): New optional argument `prefer'.
(org-goto-map, org-get-location): Implement auto-isearch.
(org-goto-local-search-forward-headings)
(org-get-entries-from-diary): Require diary-lib.
(org-agenda-sunrise-sunset): Require solar.
(org-export-html-style): Doc fix.
(org-get-legal-level): New obsolete alias.
(org-get-valid-level): Rename from `org-get-legal-level'.
(org-promote, org-demote, org-archive-subtree)
(org-remember-handler, org-refile, org-put-clock-overlay): Use it.
(org-info): Use info rather than Info-goto-node.
(org-entry-properties): Let-bind `clocksum'.
(org-unmodified, org-cycle-emulate-tab)
(org-descriptive-links, org-link-file-path-type)
(org-remember-use-refile-when-interactive)
(org-agenda-skip-timestamp-if-done, org-agenda-scheduled-leaders)
(org-export-ascii-bullets, org-agenda-deadline-faces)
(turn-on-orgstruct++, orgtbl-to-texinfo, org-mhe-get-header)
(org-batch-agenda, org-batch-agenda-csv, org-fix-agenda-info)
(org-kill-note-or-show-branches): Fix typos in docstrings.
(org-html-do-expand): `org-export-html-convert-special-strings'
added to the list of conversion.
(org-infile-export-plist, org-get-current-options): Add support
for "-" in the #+OPTION line to let user switch on/off special
strings conversion.
(org-export-plist-vars): New :html-table-tag property.
(org-export-as-html, org-format-org-table-html)
(org-format-table-table-html) Use the :html-table-tag property
instead of the `org-export-html-table-tag' global value.
(org-additional-option-like-keywords): Add "TBLFM".
(org-entry-properties): Include the CLOCKSUM special property.
(org-columns-edit-value): Do not allow to edit the special
CLOCKSUM property.
(org-flag-drawer): Use the original value of `outline-regexp'.
(org-remember-handler): Add invisible-ok flag to call to
`org-end-of-subtree'.
(org-agenda-highlight-todo): Respect
`org-agenda-todo-keyword-format'.
(org-infile-export-plist): No restriction while searching for
options.
(org-remember-handler): Remove comments at the end of the buffer.
(org-table-sort-lines): Make sure sorting works on link
descritions only, and ignores the link.
(org-sort-entries-or-items): Make sure the end of the subtree is
included.
(org-refile-use-outline-path): New allowed values `file' and
`full-file-path'.
(org-get-refile-targets): Respect new values for
`org-refile-use-outline-path'.
(org-agenda-get-restriction-and-command): DEL goes back to initial
list.
(org-export-as-xoxo): Restore point when done.
(org-open-file): Allow multiple %s in command.
(org-get-refile-targets): Interpret the new maxlevel setting.
(org-refile-targets): New option `:maxlevel'.
(org-copy-subtree): Include empty lines before but not after
subtree.
(org-move-item-down, org-move-item-up): Include empty lines before
but not after item.
(org-remember-apply-template): Defaults, completions and history
for template prompts. Also, interpret new `%!' escape.
(org-context-choices): New constant.
(org-bound-and-true-p): New macro.
(org-agenda-restriction-lock): New face.
(org-open-at-point): Remove obsolete way to do redirection in
shell links.
(org-imenu-and-speedbar): New customization group.
(org-entry-properties): Return keyword-less time strings.
(org-clock-in): Use `org-clock-heading-function'.
(org-calendar-holiday): Try to use `calendar-check-holidays'
instead of the obsolete `check-calendar-holidays'.
(org-export-html-special-string-regexps): New constant.
(org-latex-and-export-specials): New face.
(org-link-escape-chars): Use characters instead of strings.
(org-link-escape-chars-browser, org-link-escape)
(org-link-unescape): Use characters instead of strings.
(org-export-html-convert-sub-super, org-html-do-expand): Check for
protected text.
(org-emphasis-alist): Additional `verbatim' flag.
(org-set-emph-re): Handle the verbatim flag and compute
`org-verbatim-re'.
(org-cleaned-string-for-export): Protect verbatim elements.
(org-additional-option-like-keywords): Add new keywords.
(org-get-entry): Rename from `org-get-cleaned-entry'.
(org-agenda-get-scheduled, org-agenda-get-blocks): Use
`org-agenda-skip-scheduled-if-done'.
(org-prepare-agenda-buffers): Allow buffers as arguments.
(org-entry-properties): Add CATEGORY as a special property.
(org-use-property-inheritance): Allow a list of properties as a
value.
(org-eval-in-calendar): No longer update the prompt.
(org-read-date-popup-calendar): Rename from
`org-popup-calendar-for-date-prompt'.
(org-remember-apply-template): Define `remember-finalize' if it is
not yet defined.
(org-read-date): Respect the setting of
`org-read-date-prefer-future'. Use `org-read-date-analyze'.
(org-set-font-lock-defaults): Use `org-archive-tag' instead of a
hardcoded string.
(org-remember-apply-template): Use `remember-finalize' instead of
`remember-buffer'.
(org-columns-compute, org-column-number-to-string)
(org-columns-uncompile-format, org-columns-compile-format)
(org-columns-compile-format): Handle printf format specifier.
(org-columns-new, org-column-number-to-string)
(org-columns-uncompile-format, org-columns-compile-format):
Support for new currency summary type.
(org-tree-to-indirect-buffer): Do not kill old buffer when
`org-indirect-buffer-display' is `new-frame'.
(org-indirect-buffer-display): Document that `new-frame' leads to
indiret buffer proliferation.
(org-agenda-list): Use `org-extend-today-until'.
(org-format-org-table-html): Use lower-case for <col> tag.
(org-agenda-execute): New command.
(org-agenda-mode-map): Keybindings of "g" "G", "e" modified.
(org-remember-apply-template): Use `org-select-remember-template'.
(org-region-active-p): Use `use-region-p'.
(org-cycle-hide-archived-subtrees)
(org-table-rotate-recalc-marks, org-mark-ring-push)
(org-follow-info-link, org-mhe-get-message-folder-from-index)
(org-auto-repeat-maybe, org-store-log-note, org-delete-property)
(org-evaluate-time-range, org-edit-agenda-file-list):
(org-paste-subtree):
(org-calendar-holiday): Use calendar-check-holidays instead of the
obsolete check-calendar-holidays.
(org-table-formula-substitute-names): Remove forgotten temporary
debugging code.
(org-agenda-get-restriction-and-command): Use `mapc' instead of
`mapcar'.
(org-agenda-list): Numeric prefix argument can specify the number
of days.
(remember-register, remember-buffer): Prevent byte compiler from
complaining.
(org-todo): Save and restore match data.
(org-no-warnings): New macro.
(org-columns-eval): Use `org-no-warnings'.
(org-version): Change to 5.13e.
(org-agenda-file-regexp): Fix typo in docstring.
(org-add-planning-info): Fix bug in parenthesis settings.
(org-scan-tags): Catch the case of indirect buffers with no
filename.
(org-fast-tag-selection, org-export-as-ascii, org-export-as-html):
Re-install switch to mapc, had been removed by accident.
(org-columns-map): New binding `C-c C-o'.
(org-columns-menu): Change menu text and added new entry.
(org-columns-eval): Document the use of `next-line'.
(org-columns-follow-link): Remove function.
(org-read-date-get-relative): Fix typo in docstring.
(org-read-date-get-relative): Leading +/- is not optional.
(org-agenda-get-restriction-and-command): Always resize window on
first loop cycle.
(org-agenda-open-link): Make sure the link abbreviations are
present in the agenda buffer.
(org-agenda-files): Allow directories in the variable.
(org-agenda): Use `org-agenda-get-restriction-and-command'.
(org-todo-blocker-hook, org-todo-trigger-hook): New hooks.
(org-remember-apply-template): Catch C-g and make sure window
configuration is restored.
(org-agenda-open-link): Make it work with several links in the
line.
(org-drawers, org-set-regexps-and-options)
(org-get-current-options): Add support for a DRAWERS in-buffer
option.
(org-fit-agenda-window): Use `org-agenda-window-frame-fractions'.
(org-agenda-to-appt): Require calendar.
(org-entry-get-with-inheritance): Widen for search.
(org-columns-display-here): Don't mark buffer as modified when
adding space characters to accomodate column overlays.
(org-export-as-html): Better formatting of tags in the toc.
(org-columns-display-here): Make the ITEM column as compact as
possible.
(org-remember-templates): Customization interface improved.
(org-export-with-property-drawer): Variable removed.
(org-sort-entries): Rewrite using `sort-subr'.
(org-set-property): More appropriate completion during interactive
use.
(org-sort-entries): Allow sorting by property.
(org-additional-option-like-keywords): Add more values.
(org-sort-entries-or-items): Rename from `org-sort-entries'.
(org-at-timestamp-p, org-timestamp-change)
(org-remember-templates): First element of each entry is now a
name for the template.
(org-store-log-note): Check for `org-note-abort'.
(org-kill-note-or-show-branches): New command.
(org-cut-subtree, org-copy-subtree): New argument N to act on N
sequential subtrees.
(org-paste-subtree): Fix the level at which a tree is pasted.
(org-fit-agenda-window): Limitations on window size removed.
(org-agenda-find-same-or-today-or-agenda): Rename from
`org-agenda-find-today-or-agenda'.
(org-agenda-scheduled-leaders)
(org-agenda-get-deadlines): Use `org-agenda-deadline-leaders'.
(org-agenda-get-scheduled): Use `org-agenda-scheduled-leaders'.
(org-export-with-tags, org-export-plist-vars)
(org-infile-export-plist): New "tags" option.
(org-cached-entry-get): Use `org-use-property-inheritance'.
(org-remember-apply-template): Fix typo.
(org-additional-option-like-keywords): New constant.
(org-complete): Use `org-additional-option-like-keywords'.
(org-clock-report): Only update the table at point, or insert a
new one.
(org-open-file): Use `start-process-shell-command' instead of
`shell-command' with an ampersand.
(org-deadline, org-schedule): New argument REMOVE to remove the
date from the entry.
(org-agenda-schedule, org-agenda-deadline): Pass the prefix
argument to `org-schedule' and `org-deadline'.
(org-trim): Use the correct expressions for beginning and end of
the string.
(org-get-cleaned-entry): Trim the string before returning it.
(org-agenda-tags-column): Rename from
`org-agenda-align-tags-to-column'.
(org-agenda-align-tags): Allow negative values for
`org-agenda-tags-column'.
(org-insert-labeled-timestamps-before-properties-drawer): Remove
var.
(org-agenda-to-appt): New optional argument FILTER.
(org-complete): Use `org-completion-fallback-command'.
(org-find-base-buffer-visiting): Catch the case that there is no
buffer visiting the file.
(org-todo): Use `org-property-or-variable-value'
(org-prepare-agenda, org-agenda-list): Use
`org-agenda-compact-blocks'.
(org-agenda-schedule, org-agenda-deadline): Call
`org-agenda-show-new-time'.
(org-agenda-show-new-time): New argument PREFIX.
(org-colgroup-info-to-vline-list): Fix but that cause a shift in
the vertical lines.
(org-buffer-property-keys): New argument INCLUDE-DEFAULTS.
(org-maybe-renumber-ordered-list, org-cycle-list-bullet)
(org-indent-item): No arg in call to `org-fix-bullet-type'.
(org-fix-bullet-type): Remove argument.
(org-read-date): Check for am/pm twice, to catch the end time.
(org-goto-map): Use `suppress-keymap'.
(org-remember-apply-template): Respect the dynamically scoped
selection character.
(org-kill-is-subtree-p): Use `org-outline-regexp'.
(org-outline-regexp): New constant.
(org-remember-handler): Throw error when the target file is not in
org-mode.
(org-cleaned-string-for-export): No longer call
`org-export-latex-cleaned-string' with an argument.
(org-get-tags): Returns now a list, not a string.
(org-archive-subtree): No need to split return of `org-get-tags'.
(org-set-tags, org-entry-properties): Call `org-get-tags-string'
instead of `org-get-tags'.
(org-agenda-format-date): Rename from `org-agenda-date-format'.
(org-time-from-absolute, org-agenda-format-date-aligned): New
funs.
(org-compatible-face): New argument INHERITS. Inherit from this
face if possible.
(org-level-1, org-level-2, org-level-3, org-level-4)
(org-level-5, org-level-6, org-level-7, org-level-8)
(org-special-keyword, org-drawer, org-column, org-warning)
(org-archived, org-todo, org-done, org-headline-done, org-table)
(org-formula, org-code, org-agenda-structure)
(org-scheduled-today, org-scheduled-previously)
(org-upcoming-deadline, org-time-grid): Call `org-compatible-face'
in the new way.
(org-get-heading): New argument NO-TAGS.
(org-fast-tag-selection-include-todo): Made defvar instead of
defcustom, feature is not deprecated.
(org-remember-store-without-prompt): New default value t.
(org-set-regexps-and-options): #+TODO is an alias for SEQ_TODO.
Compute the log states.
(org-goto-map): More commands copied from global map. Also bind
`org-occur'.
(org-goto): Made into a general lookup command.
(org-get-location): Complete rewrite.
(org-goto-ret, org-goto-left, org-goto-right, org-goto-quit): Set
the new variables.
(org-paste-subtree): Whitespace insertion strategy revised.
(org-remember-apply-template): Protect v-A from the possibility
that v-a might be nil.
(org-remember-handler): Insertion rules revised.
(org-todo): Respect org-todo-log-states.
(org-entry-get-with-inheritance): Use `org-up-heading-safe'.
(org-confirm-shell-link-function)
(org-confirm-elisp-link-function): Doc fixes.
(org-re): Also replace the :alpha: class.
(org-todo-tag-alist): Variable removed.
(org-log-done): Docstring fixed.
(org-deadline-warning-days): New default value 14.
(org-tag-alist): Docstring fixed.
(org-export-language-setup): New languages added.
(org-set-regexps-and-options): Compute the new variables.
(org-paste-subtree): Cleaning up.
(org-remember-apply-template): New escape %A.
(org-todo): Call fast TODO selection.
(org-add-log-note): Allow prefix for abort exit.
(org-at-property-p, org-entry-properties)
(org-columns-get-autowidth-alist): Use :alpha: class.
(org-agenda-get-deadlines): Use `org-get-wdays'.
(org-agenda-get-deadlines): Reverse ee before returning.
(org-format-agenda-item): New argument REMOVE-RE.
(org-agenda-convert-date): Baha'i calendar added.
(org-infile-export-plist): Also find DATE line.
(org-export-as-html, org-export-as-ascii): Use the date format.
(org-shiftup, org-shiftdown): Use.
`org-edit-timestamp-down-means-later'.
(org-columns-compile-format)
(org-columns-get-autowidth-alist, org-buffer-property-keys)
(org-entry-properties, org-at-property-p): Allow [:alnum:] in
property names.
(org-export-visible): Fix drawers before export.
(org-do-sort): Allow sorting by priority.
(org-agenda-files): Ignore non-existing files.
(org-ellipsis): All a face as value.
(org-mode): Interprete the face value of `org-ellipsis'.
(org-archive-subtree): Store context info in archived entry.
(org-fast-tag-selection): Allow setting TODO states through this
interface.
(org-cycle): Docstring updated.
(org-set-font-lock-defaults, org-agenda-highlight-todo): Use
`org-get-todo-face'.
(org-table-edit-field, org-table-show-reference)
(org-table-edit-formulas, org-add-log-note)
(org-fast-tag-selection, org-agenda, org-prepare-agenda)
(org-timeline): Use `org-switch-to-buffer-other-window' instead of
`switch-to-buffer-other-window' to make sure that the temporary
windows show up on the current frame.
(org-mhe-get-message-real-folder, org-batch-store-agenda-views)
(org-get-entries-from-diary, org-replace-region-by-html): Don't
allow pop-up frames.
(org-agenda-get-deadlines, org-agenda-get-scheduled): Fix problems
with time-of-day.
(org-agenda-get-scheduled, org-agenda-get-deadlines): Fix problems
with listing items that are DONE.
(org-change-tag-in-region): New command.
(org-agenda-skip-scheduled-if-done)
(org-agenda-skip-deadline-if-done): Docstring clarified.
(org-mode): Hide drawers on startup.
(org-set-regexps-and-options): Use `org-remove-keyword-keys'.
(org-agenda-skip): Allow a form for `org-agenda-skip-function'.
(org-agenda-redo): Re-use local settings.
(org-agenda): Store local settings.
(org-agenda-get-deadlines, org-agenda-get-scheduled): Also handle
entries on their due date.
(org-agenda-get-timestamps): No longer handle the due dates of
schedules and deadline items.
(org-insert-link-global, org-open-at-point-global): New commands.
(org-export-as-ascii): Call `org-cleaned-string-for-export' with a
:for-ascii parameter.
(org-skip-comments): Function removed.
(org-cleaned-string-for-export): Handle special table lines.
(org-entry-get-with-inheritance): Check global properties.
(org-set-regexps-and-options): Find the #+PROPERTY line.
(org-link-types): Change type into variable (was constant).
(org-link-re-with-space, org-link-re-with-space2)
(org-angle-link-re, org-plain-link-re, org-bracket-link-regexp)
(org-bracket-link-analytic-regexp, org-any-link-re): Creation of
these regular expressions happens now in the function
`org-make-link-regexps'.
(org-store-link): Call the functions in
`org-store-link-functions'.
(org-activate-tags): Force matches to be in headlines.
(org-batch-store-agenda-views): Fix bug with killing agenda
buffer.
(org-columns-display-here): Make sure this works in a narrowed
buffer by checking for point-min.
(org-columns-display-here): Make the rest of the line intangible,
so that point never can be there.
(org-cleaned-string-for-export): Use `with-current-buffer'.
(org-replace-region-by-html): Use `with-current-buffer'.
(org-unfontify-region, org-do-occur, org-columns-display-here)
(org-columns-remove-overlays, org-columns-quit)
(org-columns-edit-value, org-columns-next-allowed-value)
(org-eval-in-calendar, org-agenda-undo, org-no-read-only)
(org-finalize-agenda, org-remove-subtree-entries-from-agenda)
(org-agenda-todo, org-agenda-change-all-lines)
(org-agenda-align-tags, org-agenda-priority)
(org-agenda-set-tags, org-agenda-toggle-archive-tag)
(org-agenda-show-new-time, org-cleaned-string-for-export)
(org-export-grab-title-from-buffer)
(org-export-as-ascii, org-export-as-html): Use `inhibit-read-only'
instead of `buffer-read-only'.
(org-export-as-html): Set `coding-system-for-write'.
(org-archive-subtree): Fixed bug with modifying TODO keyword.
(org-beginning-of-line): Also treat C-a special in items.
(org-table-convert-refs-to-rc): Fixed problem with column
reference after "..".
(org-columns-compute): Don't mark buffer modified because of text
properties.
(org-batch-store-agenda-views): Use the variable
`default-directory', not the function.
(org-clock-out-if-current): Respect `org-clock-out-when-done'.
(org-html-entities): Added HTML entities for smileys.
(org-end-of-line): Move to end of line if in headline without
tags.
(org-agenda-day-view, org-agenda-week-view): Remember span as
default.
(org-columns-edit-value): Rename from `org-column-edit'.
(org-columns-display-here-title): Rename from
`org-overlay-columns-title'.
(org-columns-remove-overlays): Rename from
org-remove-column-overlays.
(org-columns-get-autowidth-alist): Rename from
`org-get-columns-autowidth-alist'.
(org-columns-display-here): Rename from `org-overlay-columns'.
(org-columns-new-overlay): Rename from `org-new-column-overlay'.
(org-columns-quit): Rename from `org-column-quit'.
(org-columns-show-value): Rename from `org-column-show-value'.
(org-columns-current-fmt): Rename from `org-current-columns-fmt'.
(org-columns-overlays): Rename from `org-column-overlays'.
(org-columns-map): Rename from `org-column-map'.
(org-columns-current-maxwidths): Rename from
`org-current-columns-maxwidths'.
(org-columns-begin-marker, org-columns-current-fmt-compiled)
(org-previous-header-line-format)
(org-columns-inhibit-recalculation)
(org-columns-default-format): Rename from
`org-default-columns-format'.
(org-property-re): New constant.
(orgstruct-mode): New minor mode.
(org-cycle-list-bullet): New command.
(org-special-properties, org-property-start-re)
(org-property-end-re): New constants.
(org-with-point-at): New macro.
(org-insert-property-drawer): New command.
(org-column): New face.
(org-column-menu): New menu.
(org-columns, org-agenda-columns): New commands.
(org-properties): New customize group.
(org-priority): Realign tags after changing priority.
(org-preserve-lc): New macro.
(org-update-checkbox-count): Catch case when there is no headline.
(org-agenda-quit): Remove any column overlays.
(org-beginning-of-item-list): Fixed bug when non-item line is
indented too deep.
(org-make-tags-matcher): Handle property matches.
(org-table-recalculate): Swap evaluation order: Field formula
first, then column formulas, but don't allow them to overwrite the
field formulas.
(org-table-eval-formula): New argument untouchable.
(org-export-as-html): Fix replacement bug for XEmacs.
| author | Carsten Dominik <dominik@science.uva.nl> |
|---|---|
| date | Tue, 08 Apr 2008 07:44:50 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 80466:a2033c4f12af | 80467:1d830d9c60e0 |
|---|---|
| 1 ;;; org-publish.el --- publish related org-mode files as a website | |
| 2 | |
| 3 ;; Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc. | |
| 4 | |
| 5 ;; Author: David O'Toole <dto@gnu.org> | |
| 6 ;; Maintainer: Bastien Guerry <bzg AT altern DOT org> | |
| 7 ;; Keywords: hypermedia, outlines, wp | |
| 8 ;; Version: 5.23a | |
| 9 | |
| 10 ;; This file is part of GNU Emacs. | |
| 11 ;; | |
| 12 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
| 13 ;; it under the terms of the GNU General Public License as published by | |
| 14 ;; the Free Software Foundation; either version 3, or (at your option) | |
| 15 ;; any later version. | |
| 16 | |
| 17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
| 18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 20 ;; GNU General Public License for more details. | |
| 21 | |
| 22 ;; You should have received a copy of the GNU General Public License | |
| 23 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
| 24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
| 25 ;; Boston, MA 02110-1301, USA. | |
| 26 | |
| 27 ;;; Commentary: | |
| 28 | |
| 29 ;; Requires at least version 4.27 of org.el | |
| 30 | |
| 31 ;; This program allow configurable publishing of related sets of | |
| 32 ;; Org-mode files as a complete website. | |
| 33 ;; | |
| 34 ;; org-publish.el can do the following: | |
| 35 ;; | |
| 36 ;; + Publish all one's org-files to HTML or LaTeX | |
| 37 ;; + Upload HTML, images, attachments and other files to a web server | |
| 38 ;; + Exclude selected private pages from publishing | |
| 39 ;; + Publish a clickable index of pages | |
| 40 ;; + Manage local timestamps for publishing only changed files | |
| 41 ;; + Accept plugin functions to extend range of publishable content | |
| 42 ;; | |
| 43 ;; Special thanks to the org-mode maintainer Carsten Dominik for his | |
| 44 ;; ideas, enthusiasm, and cooperation. | |
| 45 | |
| 46 ;;; Installation: | |
| 47 | |
| 48 ;; Put org-publish.el in your load path, byte-compile it, and then add | |
| 49 ;; the following lines to your emacs initialization file: | |
| 50 | |
| 51 ;; (autoload 'org-publish "org-publish" nil t) | |
| 52 ;; (autoload 'org-publish "org-publish-all" nil t) | |
| 53 ;; (autoload 'org-publish "org-publish-current-file" nil t) | |
| 54 ;; (autoload 'org-publish "org-publish-current-project" nil t) | |
| 55 | |
| 56 ;; NOTE: When org-publish.el is included with org.el, those forms are | |
| 57 ;; already in the file org-install.el, and hence don't need to be put | |
| 58 ;; in your emacs initialization file in this case. | |
| 59 | |
| 60 ;;; Usage: | |
| 61 ;; | |
| 62 ;; The program's main configuration variable is | |
| 63 ;; `org-publish-project-alist'. See below for example configurations | |
| 64 ;; with commentary. | |
| 65 | |
| 66 ;; The main interactive functions are: | |
| 67 ;; | |
| 68 ;; M-x org-publish | |
| 69 ;; M-x org-publish-all | |
| 70 ;; M-x org-publish-current-file | |
| 71 ;; M-x org-publish-current-project | |
| 72 | |
| 73 ;;;; Simple example configuration: | |
| 74 | |
| 75 ;; (setq org-publish-project-alist | |
| 76 ;; (list | |
| 77 ;; '("org" . (:base-directory "~/org/" | |
| 78 ;; :base-extension "org" | |
| 79 ;; :publishing-directory "~/public_html" | |
| 80 ;; :with-section-numbers nil | |
| 81 ;; :table-of-contents nil | |
| 82 ;; :recursive t | |
| 83 ;; :style "<link rel=stylesheet href=\"../other/mystyle.css\" type=\"text/css\">"))) | |
| 84 | |
| 85 ;;;; More complex example configuration: | |
| 86 | |
| 87 ;; Imagine your *.org files are kept in ~/org, your images in | |
| 88 ;; ~/images, and stylesheets in ~/other. Now imagine you want to | |
| 89 ;; publish the files through an ssh connection to a remote host, via | |
| 90 ;; Tramp-mode. To maintain relative links from *.org files to /images | |
| 91 ;; and /other, we should replicate the same directory structure in | |
| 92 ;; your web server account's designated html root (in this case, | |
| 93 ;; assumed to be ~/html) | |
| 94 | |
| 95 ;; Once you've done created the proper directories, you can adapt the | |
| 96 ;; following example configuration to your specific paths, run M-x | |
| 97 ;; org-publish-all, and it should publish the files to the correct | |
| 98 ;; directories on the web server, transforming the *.org files into | |
| 99 ;; HTML, and leaving other files alone. | |
| 100 | |
| 101 ;; (setq org-publish-project-alist | |
| 102 ;; (list | |
| 103 ;; '("orgfiles" :base-directory "~/org/" | |
| 104 ;; :base-extension "org" | |
| 105 ;; :publishing-directory "/ssh:user@host:~/html/notebook/" | |
| 106 ;; :publishing-function org-publish-org-to-html | |
| 107 ;; :exclude "PrivatePage.org" ;; regexp | |
| 108 ;; :headline-levels 3 | |
| 109 ;; :with-section-numbers nil | |
| 110 ;; :table-of-contents nil | |
| 111 ;; :style "<link rel=stylesheet href=\"../other/mystyle.css\" type=\"text/css\">" | |
| 112 ;; :auto-preamble t | |
| 113 ;; :auto-postamble nil) | |
| 114 ;; ("images" :base-directory "~/images/" | |
| 115 ;; :base-extension "jpg\\|gif\\|png" | |
| 116 ;; :publishing-directory "/ssh:user@host:~/html/images/" | |
| 117 ;; :publishing-function org-publish-attachment) | |
| 118 ;; ("other" :base-directory "~/other/" | |
| 119 ;; :base-extension "css" | |
| 120 ;; :publishing-directory "/ssh:user@host:~/html/other/" | |
| 121 ;; :publishing-function org-publish-attachment) | |
| 122 ;; ("website" :components ("orgfiles" "images" "other")))) | |
| 123 | |
| 124 ;; For more information, see the documentation for the variable | |
| 125 ;; `org-publish-project-alist'. | |
| 126 | |
| 127 ;; Of course, you don't have to publish to remote directories from | |
| 128 ;; within emacs. You can always just publish to local folders, and | |
| 129 ;; then use the synchronization/upload tool of your choice. | |
| 130 | |
| 131 ;;; List of user-visible changes since version 1.27 | |
| 132 | |
| 133 ;; 1.78: Allow list-valued :publishing-function | |
| 134 ;; 1.77: Added :preparation-function, this allows you to use GNU Make etc. | |
| 135 ;; 1.65: Remove old "composite projects". They're redundant. | |
| 136 ;; 1.64: Allow meta-projects with :components | |
| 137 ;; 1.57: Timestamps flag is now called "org-publish-use-timestamps-flag" | |
| 138 ;; 1.52: Properly set default for :index-filename | |
| 139 ;; 1.48: Composite projects allowed. | |
| 140 ;; :include keyword allowed. | |
| 141 ;; 1.43: Index no longer includes itself in the index. | |
| 142 ;; 1.42: Fix "function definition is void" error | |
| 143 ;; when :publishing-function not set in org-publish-current-file. | |
| 144 ;; 1.41: Fixed bug where index isn't published on first try. | |
| 145 ;; 1.37: Added interactive function "org-publish". Prompts for particular | |
| 146 ;; project name to publish. | |
| 147 ;; 1.34: Added force-publish option to all interactive functions. | |
| 148 ;; 1.32: Fixed "index.org has changed on disk" error during index publishing. | |
| 149 ;; 1.30: Fixed startup error caused by (require 'em-unix) | |
| 150 | |
| 151 ;;; Code: | |
| 152 | |
| 153 (eval-when-compile | |
| 154 (require 'cl)) | |
| 155 | |
| 156 (require 'dired-aux) | |
| 157 | |
| 158 (defgroup org-publish nil | |
| 159 "Options for publishing a set of Org-mode and related files." | |
| 160 :tag "Org Publishing" | |
| 161 :group 'org) | |
| 162 | |
| 163 (defcustom org-publish-project-alist nil | |
| 164 "Association list to control publishing behavior. | |
| 165 Each element of the alist is a publishing 'project.' The CAR of | |
| 166 each element is a string, uniquely identifying the project. The | |
| 167 CDR of each element is in one of the following forms: | |
| 168 | |
| 169 (:property value :property value ... ) | |
| 170 | |
| 171 OR, | |
| 172 | |
| 173 (:components (\"project-1\" \"project-2\" ...)) | |
| 174 | |
| 175 When the CDR of an element of org-publish-project-alist is in | |
| 176 this second form, the elements of the list after :components are | |
| 177 taken to be components of the project, which group together files | |
| 178 requiring different publishing options. When you publish such a | |
| 179 project with M-x org-publish, the components all publish. | |
| 180 | |
| 181 When a property is given a value in org-publish-project-alist, its | |
| 182 setting overrides the value of the corresponding user variable | |
| 183 (if any) during publishing. However, options set within a file | |
| 184 override everything. | |
| 185 | |
| 186 Most properties are optional, but some should always be set: | |
| 187 | |
| 188 :base-directory Directory containing publishing source files | |
| 189 :base-extension Extension (without the dot!) of source files. | |
| 190 This can be a regular expression. | |
| 191 :publishing-directory Directory (possibly remote) where output | |
| 192 files will be published | |
| 193 | |
| 194 The :exclude property may be used to prevent certain files from | |
| 195 being published. Its value may be a string or regexp matching | |
| 196 file names you don't want to be published. | |
| 197 | |
| 198 The :include property may be used to include extra files. Its | |
| 199 value may be a list of filenames to include. The filenames are | |
| 200 considered relative to the publishing directory. | |
| 201 | |
| 202 When both :include and :exclude properties are given values, the | |
| 203 exclusion step happens first. | |
| 204 | |
| 205 One special property controls which back-end function to use for | |
| 206 publishing files in the project. This can be used to extend the | |
| 207 set of file types publishable by org-publish, as well as the set | |
| 208 of output formats. | |
| 209 | |
| 210 :publishing-function Function to publish file. The default is | |
| 211 org-publish-org-to-html, but other | |
| 212 values are possible. May also be a | |
| 213 list of functions, in which case | |
| 214 each function in the list is invoked | |
| 215 in turn. | |
| 216 | |
| 217 Another property allows you to insert code that prepares a | |
| 218 project for publishing. For example, you could call GNU Make on a | |
| 219 certain makefile, to ensure published files are built up to date. | |
| 220 | |
| 221 :preparation-function Function to be called before publishing | |
| 222 this project. | |
| 223 | |
| 224 Some properties control details of the Org publishing process, | |
| 225 and are equivalent to the corresponding user variables listed in | |
| 226 the right column. See the documentation for those variables to | |
| 227 learn more about their use and default values. | |
| 228 | |
| 229 :language org-export-default-language | |
| 230 :headline-levels org-export-headline-levels | |
| 231 :section-numbers org-export-with-section-numbers | |
| 232 :table-of-contents org-export-with-toc | |
| 233 :emphasize org-export-with-emphasize | |
| 234 :sub-superscript org-export-with-sub-superscripts | |
| 235 :TeX-macros org-export-with-TeX-macros | |
| 236 :fixed-width org-export-with-fixed-width | |
| 237 :tables org-export-with-tables | |
| 238 :table-auto-headline org-export-highlight-first-table-line | |
| 239 :style org-export-html-style | |
| 240 :convert-org-links org-export-html-link-org-files-as-html | |
| 241 :inline-images org-export-html-inline-images | |
| 242 :expand-quoted-html org-export-html-expand | |
| 243 :timestamp org-export-html-with-timestamp | |
| 244 :publishing-directory org-export-publishing-directory | |
| 245 :preamble org-export-html-preamble | |
| 246 :postamble org-export-html-postamble | |
| 247 :auto-preamble org-export-html-auto-preamble | |
| 248 :auto-postamble org-export-html-auto-postamble | |
| 249 :author user-full-name | |
| 250 :email user-mail-address | |
| 251 | |
| 252 The following properties may be used to control publishing of an | |
| 253 index of files or summary page for a given project. | |
| 254 | |
| 255 :auto-index Whether to publish an index during | |
| 256 org-publish-current-project or org-publish-all. | |
| 257 :index-filename Filename for output of index. Defaults | |
| 258 to 'index.org' (which becomes 'index.html') | |
| 259 :index-title Title of index page. Defaults to name of file. | |
| 260 :index-function Plugin function to use for generation of index. | |
| 261 Defaults to 'org-publish-org-index', which | |
| 262 generates a plain list of links to all files | |
| 263 in the project." | |
| 264 :group 'org-publish | |
| 265 :type 'alist) | |
| 266 | |
| 267 (defcustom org-publish-use-timestamps-flag t | |
| 268 "When non-nil, use timestamp checking to publish only changed files. | |
| 269 When nil, do no timestamp checking and always publish all | |
| 270 files." | |
| 271 :group 'org-publish | |
| 272 :type 'boolean) | |
| 273 | |
| 274 (defcustom org-publish-timestamp-directory "~/.org-timestamps/" | |
| 275 "Name of directory in which to store publishing timestamps." | |
| 276 :group 'org-publish | |
| 277 :type 'directory) | |
| 278 | |
| 279 (defcustom org-publish-before-export-hook nil | |
| 280 "Hook run before export on the Org file. | |
| 281 If the functions in this hook modify the original Org buffer, the | |
| 282 modified buffer will be used for export, but the buffer will be | |
| 283 restored and saved back to its initial state after export." | |
| 284 :group 'org-publish | |
| 285 :type 'hook) | |
| 286 | |
| 287 (defcustom org-publish-after-export-hook nil | |
| 288 "Hook run after export on the exported buffer. | |
| 289 If functions in this hook modify the buffer, it will be saved." | |
| 290 :group 'org-publish | |
| 291 :type 'hook) | |
| 292 | |
| 293 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 294 ;;; Timestamp-related functions | |
| 295 | |
| 296 (defun org-publish-timestamp-filename (filename) | |
| 297 "Return path to timestamp file for filename FILENAME." | |
| 298 (while (string-match | |
| 299 (if (eq system-type 'windows-nt) "~\\|/\\|:" "~\\|/") filename) | |
| 300 (setq filename (replace-match "_" nil t filename))) | |
| 301 (concat org-publish-timestamp-directory filename ".timestamp")) | |
| 302 | |
| 303 (defun org-publish-needed-p (filename) | |
| 304 "Return `t' if FILENAME should be published." | |
| 305 (if org-publish-use-timestamps-flag | |
| 306 (if (file-exists-p org-publish-timestamp-directory) | |
| 307 ;; first handle possible wrong timestamp directory | |
| 308 (if (not (file-directory-p org-publish-timestamp-directory)) | |
| 309 (error "Org publish timestamp: %s is not a directory" | |
| 310 org-publish-timestamp-directory) | |
| 311 ;; there is a timestamp, check if FILENAME is newer | |
| 312 (file-newer-than-file-p | |
| 313 filename (org-publish-timestamp-filename filename)))) | |
| 314 ;; don't use timestamps, always return t | |
| 315 t)) | |
| 316 | |
| 317 (defun org-publish-update-timestamp (filename) | |
| 318 "Update publishing timestamp for file FILENAME. | |
| 319 If there is no timestamp, create one." | |
| 320 (let ((timestamp-file (org-publish-timestamp-filename filename)) | |
| 321 newly-created-timestamp) | |
| 322 (if (not (file-exists-p timestamp-file)) | |
| 323 ;; create timestamp file if needed | |
| 324 (with-temp-buffer | |
| 325 (make-directory (file-name-directory timestamp-file) t) | |
| 326 (write-file timestamp-file) | |
| 327 (setq newly-created-timestamp t))) | |
| 328 ;; Emacs 21 doesn't have `set-file-times' | |
| 329 (if (and (fboundp 'set-file-times) | |
| 330 (not newly-created-timestamp)) | |
| 331 (set-file-times timestamp-file) | |
| 332 (call-process "touch" nil 0 nil timestamp-file)))) | |
| 333 | |
| 334 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 335 ;;; Mapping files to project names | |
| 336 | |
| 337 (defvar org-publish-files-alist nil | |
| 338 "Alist of files and their parent project. | |
| 339 Each element of this alist is of the form: | |
| 340 | |
| 341 (file-name . project-name)") | |
| 342 | |
| 343 (defun org-publish-initialize-files-alist (&optional refresh) | |
| 344 "Set `org-publish-files-alist' if it is not set. | |
| 345 Also set it if the optional argument REFRESH is non-nil." | |
| 346 (interactive "P") | |
| 347 (when (or refresh (not org-publish-files-alist)) | |
| 348 (setq org-publish-files-alist | |
| 349 (org-publish-get-files org-publish-project-alist)))) | |
| 350 | |
| 351 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 352 ;;; Compatibility aliases | |
| 353 | |
| 354 ;; Delete-dups is not in Emacs <22 | |
| 355 (if (fboundp 'delete-dups) | |
| 356 (defalias 'org-publish-delete-dups 'delete-dups) | |
| 357 (defun org-publish-delete-dups (list) | |
| 358 "Destructively remove `equal' duplicates from LIST. | |
| 359 Store the result in LIST and return it. LIST must be a proper list. | |
| 360 Of several `equal' occurrences of an element in LIST, the first | |
| 361 one is kept. | |
| 362 | |
| 363 This is a compatibility function for Emacsen without `delete-dups'." | |
| 364 ;; Code from `subr.el' in Emacs 22: | |
| 365 (let ((tail list)) | |
| 366 (while tail | |
| 367 (setcdr tail (delete (car tail) (cdr tail))) | |
| 368 (setq tail (cdr tail)))) | |
| 369 list)) | |
| 370 | |
| 371 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 372 ;;; Getting project information out of org-publish-project-alist | |
| 373 | |
| 374 (defun org-publish-get-files (projects-alist &optional no-exclusion) | |
| 375 "Return the list of all publishable files for PROJECTS-ALIST. | |
| 376 If NO-EXCLUSION is non-nil, don't exclude files." | |
| 377 (let (all-files) | |
| 378 ;; add all projects | |
| 379 (mapc | |
| 380 (lambda(p) | |
| 381 (let* ((exclude (plist-get (cdr p) :exclude)) | |
| 382 (files (and p (org-publish-get-base-files p exclude)))) | |
| 383 ;; add all files from this project | |
| 384 (mapc (lambda(f) | |
| 385 (add-to-list 'all-files | |
| 386 (cons (expand-file-name f) (car p)))) | |
| 387 files))) | |
| 388 (org-publish-expand-projects projects-alist)) | |
| 389 all-files)) | |
| 390 | |
| 391 (defun org-publish-expand-projects (projects-alist) | |
| 392 "Expand projects contained in PROJECTS-ALIST." | |
| 393 (let (without-component with-component) | |
| 394 (mapc (lambda(p) | |
| 395 (add-to-list | |
| 396 (if (plist-get (cdr p) :components) | |
| 397 'with-component 'without-component) p)) | |
| 398 projects-alist) | |
| 399 (org-publish-delete-dups | |
| 400 (append without-component | |
| 401 (car (mapcar (lambda(p) (org-publish-expand-components p)) | |
| 402 with-component)))))) | |
| 403 | |
| 404 (defun org-publish-expand-components (project) | |
| 405 "Expand PROJECT into an alist of its components." | |
| 406 (let* ((components (plist-get (cdr project) :components))) | |
| 407 (org-publish-delete-dups | |
| 408 (delq nil (mapcar (lambda(c) (assoc c org-publish-project-alist)) | |
| 409 components))))) | |
| 410 | |
| 411 (defun org-publish-get-base-files (project &optional exclude-regexp) | |
| 412 "Return a list of all files in PROJECT. | |
| 413 If EXCLUDE-REGEXP is set, this will be used to filter out | |
| 414 matching filenames." | |
| 415 (let* ((project-plist (cdr project)) | |
| 416 (base-dir (file-name-as-directory | |
| 417 (plist-get project-plist :base-directory))) | |
| 418 (include-list (plist-get project-plist :include)) | |
| 419 (recursive-p (plist-get project-plist :recursive)) | |
| 420 (extension (or (plist-get project-plist :base-extension) "org")) | |
| 421 (regexp (concat "^[^\\.].*\\.\\(" extension "\\)$")) | |
| 422 alldirs allfiles files dir) | |
| 423 ;; Get all files and directories in base-directory | |
| 424 (setq files (dired-files-attributes base-dir)) | |
| 425 ;; Get all subdirectories if recursive-p | |
| 426 (setq alldirs | |
| 427 (if recursive-p | |
| 428 (delq nil (mapcar (lambda(f) (if (caaddr f) (cadr f))) files)) | |
| 429 (list base-dir))) | |
| 430 (while (setq dir (pop alldirs)) | |
| 431 (setq files (directory-files dir t regexp)) | |
| 432 ;; Exclude files | |
| 433 (setq files | |
| 434 (if (not exclude-regexp) | |
| 435 files | |
| 436 (delq nil | |
| 437 (mapcar (lambda (x) | |
| 438 (if (string-match exclude-regexp x) nil x)) | |
| 439 files)))) | |
| 440 ;; Include extra files | |
| 441 (let (inc) | |
| 442 (while (setq inc (pop include-list)) | |
| 443 (setq files (cons (expand-file-name inc dir) files)))) | |
| 444 (setq allfiles (append allfiles files))) | |
| 445 allfiles)) | |
| 446 | |
| 447 (defun org-publish-get-project-from-filename (filename) | |
| 448 "Return the project FILENAME belongs." | |
| 449 (let* ((project-name (cdr (assoc (expand-file-name filename) | |
| 450 org-publish-files-alist)))) | |
| 451 (assoc project-name org-publish-project-alist))) | |
| 452 | |
| 453 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 454 ;;; Pluggable publishing back-end functions | |
| 455 | |
| 456 (defun org-publish-org-to (format plist filename pub-dir) | |
| 457 "Publish an org file to FORMAT. | |
| 458 PLIST is the property list for the given project. | |
| 459 FILENAME is the filename of the org file to be published. | |
| 460 PUB-DIR is the publishing directory." | |
| 461 (require 'org) | |
| 462 (unless (file-exists-p pub-dir) | |
| 463 (make-directory pub-dir t)) | |
| 464 (find-file filename) | |
| 465 (let ((init-buf (current-buffer)) | |
| 466 (init-point (point)) | |
| 467 (init-buf-string (buffer-string)) export-buf) | |
| 468 ;; run hooks before exporting | |
| 469 (run-hooks 'org-publish-before-export-hook) | |
| 470 ;; export the possibly modified buffer | |
| 471 (setq export-buf | |
| 472 (funcall (intern (concat "org-export-as-" format)) | |
| 473 (plist-get plist :headline-levels) | |
| 474 nil plist nil nil pub-dir)) | |
| 475 (set-buffer export-buf) | |
| 476 ;; run hooks after export and save export | |
| 477 (and (run-hooks 'org-publish-after-export-hook) | |
| 478 (if (buffer-modified-p) (save-buffer))) | |
| 479 ;; maybe restore buffer's content | |
| 480 (set-buffer init-buf) | |
| 481 (when (buffer-modified-p init-buf) | |
| 482 (erase-buffer) | |
| 483 (insert init-buf-string) | |
| 484 (save-buffer) | |
| 485 (goto-char init-point)))) | |
| 486 | |
| 487 (defun org-publish-org-to-latex (plist filename pub-dir) | |
| 488 "Publish an org file to LaTeX. | |
| 489 See `org-publish-org-to' to the list of arguments." | |
| 490 (org-publish-org-to "latex" plist filename pub-dir)) | |
| 491 | |
| 492 (defun org-publish-org-to-html (plist filename pub-dir) | |
| 493 "Publish an org file to HTML. | |
| 494 See `org-publish-org-to' to the list of arguments." | |
| 495 (org-publish-org-to "html" plist filename pub-dir)) | |
| 496 | |
| 497 (defun org-publish-attachment (plist filename pub-dir) | |
| 498 "Publish a file with no transformation of any kind. | |
| 499 See `org-publish-org-to' to the list of arguments." | |
| 500 ;; make sure eshell/cp code is loaded | |
| 501 (eval-and-compile | |
| 502 (require 'eshell) | |
| 503 (require 'esh-maint) | |
| 504 (require 'em-unix)) | |
| 505 (eshell/cp filename pub-dir)) | |
| 506 | |
| 507 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 508 ;;; Publishing files, sets of files, and indices | |
| 509 | |
| 510 (defun org-publish-file (filename &optional project) | |
| 511 "Publish file FILENAME from PROJECT." | |
| 512 (when (org-publish-needed-p filename) | |
| 513 (let* ((project | |
| 514 (or project | |
| 515 (or (org-publish-get-project-from-filename filename) | |
| 516 (if (y-or-n-p | |
| 517 (format "%s is not in a project. Re-read the list of projects files? " | |
| 518 (abbreviate-file-name filename))) | |
| 519 ;; If requested, re-initialize the list of projects files | |
| 520 (progn (org-publish-initialize-files-alist t) | |
| 521 (or (org-publish-get-project-from-filename filename) | |
| 522 (error "File %s not part of any known project" | |
| 523 (abbreviate-file-name filename)))) | |
| 524 (error "Can't publish file outside of a project"))))) | |
| 525 (project-plist (cdr project)) | |
| 526 (publishing-function | |
| 527 (or (plist-get project-plist :publishing-function) | |
| 528 'org-publish-org-to-html)) | |
| 529 (base-dir (file-name-as-directory | |
| 530 (file-truename (plist-get project-plist :base-directory)))) | |
| 531 (pub-dir (file-name-as-directory | |
| 532 (file-truename (plist-get project-plist :publishing-directory)))) | |
| 533 tmp-pub-dir) | |
| 534 (setq tmp-pub-dir | |
| 535 (file-name-directory | |
| 536 (concat pub-dir | |
| 537 (and (string-match (regexp-quote base-dir) filename) | |
| 538 (substring filename (match-end 0)))))) | |
| 539 (if (listp publishing-function) | |
| 540 ;; allow chain of publishing functions | |
| 541 (mapc (lambda (f) | |
| 542 (funcall f project-plist filename tmp-pub-dir)) | |
| 543 publishing-function) | |
| 544 (funcall publishing-function project-plist filename tmp-pub-dir))) | |
| 545 (org-publish-update-timestamp filename))) | |
| 546 | |
| 547 (defun org-publish-projects (projects) | |
| 548 "Publish all files belonging to the PROJECTS alist. | |
| 549 If :auto-index is set, publish the index too." | |
| 550 (mapc | |
| 551 (lambda (project) | |
| 552 (let* ((project-plist (cdr project)) | |
| 553 (exclude-regexp (plist-get project-plist :exclude)) | |
| 554 (index-p (plist-get project-plist :auto-index)) | |
| 555 (index-filename (or (plist-get project-plist :index-filename) | |
| 556 "index.org")) | |
| 557 (index-function (or (plist-get project-plist :index-function) | |
| 558 'org-publish-org-index)) | |
| 559 (preparation-function (plist-get project-plist :preparation-function)) | |
| 560 (files (org-publish-get-base-files project exclude-regexp)) file) | |
| 561 (when preparation-function (funcall preparation-function)) | |
| 562 (if index-p (funcall index-function project index-filename)) | |
| 563 (while (setq file (pop files)) | |
| 564 (org-publish-file file project)))) | |
| 565 (org-publish-expand-projects projects))) | |
| 566 | |
| 567 (defun org-publish-org-index (project &optional index-filename) | |
| 568 "Create an index of pages in set defined by PROJECT. | |
| 569 Optionally set the filename of the index with INDEX-FILENAME. | |
| 570 Default for INDEX-FILENAME is 'index.org'." | |
| 571 (let* ((project-plist (cdr project)) | |
| 572 (dir (file-name-as-directory | |
| 573 (plist-get project-plist :base-directory))) | |
| 574 (exclude-regexp (plist-get project-plist :exclude)) | |
| 575 (files (org-publish-get-base-files project exclude-regexp)) | |
| 576 (index-filename (concat dir (or index-filename "index.org"))) | |
| 577 (index-buffer (find-buffer-visiting index-filename)) | |
| 578 (ifn (file-name-nondirectory index-filename)) | |
| 579 file) | |
| 580 ;; if buffer is already open, kill it to prevent error message | |
| 581 (if index-buffer | |
| 582 (kill-buffer index-buffer)) | |
| 583 (with-temp-buffer | |
| 584 (while (setq file (pop files)) | |
| 585 (let ((fn (file-name-nondirectory file))) | |
| 586 ;; index shouldn't index itself | |
| 587 (unless (string= fn ifn) | |
| 588 (insert (concat " + [[file:" fn "][" | |
| 589 (file-name-sans-extension fn) | |
| 590 "]]\n"))))) | |
| 591 (write-file index-filename) | |
| 592 (kill-buffer (current-buffer))))) | |
| 593 | |
| 594 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
| 595 ;;; Interactive publishing functions | |
| 596 | |
| 597 (defalias 'org-publish-project 'org-publish "Publish project.") | |
| 598 | |
| 599 ;;;###autoload | |
| 600 (defun org-publish (project &optional force) | |
| 601 "Publish PROJECT." | |
| 602 (interactive "P") | |
| 603 (save-window-excursion | |
| 604 (let* ((force current-prefix-arg) | |
| 605 (org-publish-use-timestamps-flag | |
| 606 (if force nil org-publish-use-timestamps-flag))) | |
| 607 (org-publish-projects | |
| 608 (list (or project | |
| 609 (assoc (completing-read | |
| 610 "Publish project: " | |
| 611 org-publish-project-alist nil t) | |
| 612 org-publish-project-alist))))))) | |
| 613 | |
| 614 ;;;###autoload | |
| 615 (defun org-publish-all (&optional force) | |
| 616 "Publish all projects. | |
| 617 With prefix argument, force publish all files." | |
| 618 (interactive "P") | |
| 619 (org-publish-initialize-files-alist) | |
| 620 (save-window-excursion | |
| 621 (let ((org-publish-use-timestamps-flag | |
| 622 (if force nil org-publish-use-timestamps-flag))) | |
| 623 (org-publish-projects org-publish-project-alist)))) | |
| 624 | |
| 625 ;;;###autoload | |
| 626 (defun org-publish-current-file (&optional force) | |
| 627 "Publish the current file. | |
| 628 With prefix argument, force publish the file." | |
| 629 (interactive "P") | |
| 630 (org-publish-initialize-files-alist) | |
| 631 (save-window-excursion | |
| 632 (let ((org-publish-use-timestamps-flag | |
| 633 (if force nil org-publish-use-timestamps-flag))) | |
| 634 (org-publish-file (buffer-file-name))))) | |
| 635 | |
| 636 ;;;###autoload | |
| 637 (defun org-publish-current-project (&optional force) | |
| 638 "Publish the project associated with the current file. | |
| 639 With a prefix argument, force publishing of all files in | |
| 640 the project." | |
| 641 (interactive "P") | |
| 642 (org-publish-initialize-files-alist) | |
| 643 (save-window-excursion | |
| 644 (let ((project (org-publish-get-project-from-filename (buffer-file-name))) | |
| 645 (org-publish-use-timestamps-flag | |
| 646 (if force nil org-publish-use-timestamps-flag))) | |
| 647 (if (not project) | |
| 648 (error "File %s is not part of any known project" (buffer-file-name))) | |
| 649 (org-publish project)))) | |
| 650 | |
| 651 (provide 'org-publish) | |
| 652 | |
| 653 | |
| 654 ;; arch-tag: 72807f3c-8af0-4a6b-8dca-c3376eb25adb | |
| 655 ;;; org-publish.el ends here |