;;; org-e-html.el --- HTML Back-End For Org Export Engine ;; Copyright (C) 2011-2012 Free Software Foundation, Inc. ;; Author: Jambunathan K ;; Keywords: outlines, hypermedia, calendar, wp ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; This program is distributed in the hope that it will be useful, ;; 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 ;; along with this program. If not, see . ;;; Commentary: ;; This library implements a HTML back-end for Org generic exporter. ;; To test it, run ;; ;; M-: (org-export-to-buffer 'e-html "*Test e-HTML*") RET ;; ;; in an org-mode buffer then switch to the buffer to see the HTML ;; export. See contrib/lisp/org-export.el for more details on how ;; this exporter works. ;;; Code: ;;; org-e-html.el ;;; Dependencies (require 'org-export) (require 'format-spec) (eval-when-compile (require 'cl) (require 'table)) ;;; Function Declarations (declare-function org-id-find-id-file "org-id" (id)) (declare-function htmlize-region "ext:htmlize" (beg end)) (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label)) ;;; Define Back-End (defvar org-e-html-translate-alist '((babel-call . org-e-html-babel-call) (bold . org-e-html-bold) (center-block . org-e-html-center-block) (clock . org-e-html-clock) (code . org-e-html-code) (comment . org-e-html-comment) (comment-block . org-e-html-comment-block) (drawer . org-e-html-drawer) (dynamic-block . org-e-html-dynamic-block) (entity . org-e-html-entity) (example-block . org-e-html-example-block) (export-block . org-e-html-export-block) (export-snippet . org-e-html-export-snippet) (fixed-width . org-e-html-fixed-width) (footnote-definition . org-e-html-footnote-definition) (footnote-reference . org-e-html-footnote-reference) (headline . org-e-html-headline) (horizontal-rule . org-e-html-horizontal-rule) (inline-babel-call . org-e-html-inline-babel-call) (inline-src-block . org-e-html-inline-src-block) (inlinetask . org-e-html-inlinetask) (italic . org-e-html-italic) (item . org-e-html-item) (keyword . org-e-html-keyword) (latex-environment . org-e-html-latex-environment) (latex-fragment . org-e-html-latex-fragment) (line-break . org-e-html-line-break) (link . org-e-html-link) (macro . org-e-html-macro) (paragraph . org-e-html-paragraph) (plain-list . org-e-html-plain-list) (plain-text . org-e-html-plain-text) (planning . org-e-html-planning) (property-drawer . org-e-html-property-drawer) (quote-block . org-e-html-quote-block) (quote-section . org-e-html-quote-section) (radio-target . org-e-html-radio-target) (section . org-e-html-section) (special-block . org-e-html-special-block) (src-block . org-e-html-src-block) (statistics-cookie . org-e-html-statistics-cookie) (strike-through . org-e-html-strike-through) (subscript . org-e-html-subscript) (superscript . org-e-html-superscript) (table . org-e-html-table) (table-cell . org-e-html-table-cell) (table-row . org-e-html-table-row) (target . org-e-html-target) (template . org-e-html-template) (timestamp . org-e-html-timestamp) (underline . org-e-html-underline) (verbatim . org-e-html-verbatim) (verse-block . org-e-html-verse-block)) "Alist between element or object types and translators.") ;; FIXME (`org-e-html-options-alist'): Prefix KEYWORD and OPTION with ;; "HTML_". Prefix corresponding properties with `:html-". If such a ;; renaming is taken up, some changes will be required in ;; `org-jsinfo.el', I think. So defer renaming for now. (defconst org-e-html-options-alist '((:agenda-style nil nil org-agenda-export-html-style) (:creator "CREATOR" nil org-e-html-creator-string) (:convert-org-links nil nil org-e-html-link-org-files-as-html) ;; (:expand-quoted-html nil "@" org-e-html-expand) (:inline-images nil nil org-e-html-inline-images) (:link-home "LINK_HOME" nil org-e-html-link-home) (:link-up "LINK_UP" nil org-e-html-link-up) (:style nil nil org-e-html-style) (:style-extra "STYLE" nil org-e-html-style-extra newline) (:style-include-default nil nil org-e-html-style-include-default) (:style-include-scripts nil nil org-e-html-style-include-scripts) ;; (:timestamp nil nil org-e-html-with-timestamp) (:html-extension nil nil org-e-html-extension) (:html-postamble nil nil org-e-html-postamble) (:html-preamble nil nil org-e-html-preamble) (:html-table-tag nil nil org-e-html-table-tag) (:xml-declaration nil nil org-e-html-xml-declaration) (:LaTeX-fragments nil "LaTeX" org-export-with-LaTeX-fragments) (:mathjax "MATHJAX" nil "" space)) "Alist between HTML export properties and ways to set them. This variable is the HTML-specific counterpart of `org-export-options-alist'. The CAR of the alist is the property name, and the CDR is a list like (KEYWORD OPTION DEFAULT BEHAVIOUR) where: KEYWORD is a string representing a buffer keyword, or nil. OPTION is a string that could be found in an #+OPTIONS: line. DEFAULT is the default value for the property. BEHAVIOUR determine how Org should handle multiple keywords for the same property. It is a symbol among: nil Keep old value and discard the new one. t Replace old value with the new one. `space' Concatenate the values, separating them with a space. `newline' Concatenate the values, separating them with a newline. `split' Split values at white spaces, and cons them to the previous list. KEYWORD and OPTION have precedence over DEFAULT.") (defconst org-e-html-filters-alist '((:filter-final-output . org-e-html-final-function)) "Alist between filters keywords and back-end specific filters. See `org-export-filters-alist' for more information.") ;;; Internal Variables ;; FIXME: it already exists in org-e-html.el (defconst org-e-html-cvt-link-fn nil "Function to convert link URLs to exportable URLs. Takes two arguments, TYPE and PATH. Returns exportable url as (TYPE PATH), or nil to signal that it didn't handle this case. Intended to be locally bound around a call to `org-export-as-html'." ) (defvar org-e-html-format-table-no-css) (defvar htmlize-buffer-places) ; from htmlize.el (defvar body-only) ; dynamically scoped into this. ;;; User Configuration Variables (defgroup org-export-e-html nil "Options for exporting Org mode files to HTML." :tag "Org Export HTML" :group 'org-export) ;;;; Debugging (defcustom org-e-html-pretty-output nil "Enable this to generate pretty HTML." :group 'org-export-e-html :type 'boolean) ;;;; HTML-specific (defcustom org-e-html-allow-name-attribute-in-anchors t "When nil, do not set \"name\" attribute in anchors. By default, anchors are formatted with both \"id\" and \"name\" attributes, when appropriate." :group 'org-export-e-html :type 'boolean) ;;;; Document (defcustom org-e-html-extension "html" "The extension for exported HTML files." :group 'org-export-e-html :type 'string) (defcustom org-e-html-xml-declaration '(("html" . "") ("php" . "\"; ?>")) "The extension for exported HTML files. %s will be replaced with the charset of the exported file. This may be a string, or an alist with export extensions and corresponding declarations." :group 'org-export-e-html :type '(choice (string :tag "Single declaration") (repeat :tag "Dependent on extension" (cons (string :tag "Extension") (string :tag "Declaration"))))) (defcustom org-e-html-coding-system org-export-coding-system "Coding system for HTML export. Use `org-export-coding-system' as the default value." :group 'org-export-e-html :type 'coding-system) (defvar org-e-html-content-div "content" "The name of the container DIV that holds all the page contents. This variable is obsolete since Org version 7.7. Please set `org-e-html-divs' instead.") (defcustom org-e-html-divs '("preamble" "content" "postamble") "The name of the main divs for HTML export. This is a list of three strings, the first one for the preamble DIV, the second one for the content DIV and the third one for the postamble DIV." :group 'org-export-e-html :type '(list (string :tag " Div for the preamble:") (string :tag " Div for the content:") (string :tag "Div for the postamble:"))) ;;;; Document Header (Styles) (defconst org-e-html-style-default "" "The default style specification for exported HTML files. Please use the variables `org-e-html-style' and `org-e-html-style-extra' to add to this style. If you wish to not have the default style included, customize the variable `org-e-html-style-include-default'.") (defcustom org-e-html-style-include-default t "Non-nil means include the default style in exported HTML files. The actual style is defined in `org-e-html-style-default' and should not be modified. Use the variables `org-e-html-style' to add your own style information." :group 'org-export-e-html :type 'boolean) ;;;###autoload (put 'org-e-html-style-include-default 'safe-local-variable 'booleanp) (defcustom org-e-html-style "" "Org-wide style definitions for exported HTML files. This variable needs to contain the full HTML structure to provide a style, including the surrounding HTML tags. If you set the value of this variable, you should consider to include definitions for the following classes: title, todo, done, timestamp, timestamp-kwd, tag, target. For example, a valid value would be: If you'd like to refer to an external style file, use something like As the value of this option simply gets inserted into the HTML header, you can \"misuse\" it to add arbitrary text to the header. See also the variable `org-e-html-style-extra'." :group 'org-export-e-html :type 'string) ;;;###autoload (put 'org-e-html-style 'safe-local-variable 'stringp) (defcustom org-e-html-style-extra "" "Additional style information for HTML export. The value of this variable is inserted into the HTML buffer right after the value of `org-e-html-style'. Use this variable for per-file settings of style information, and do not forget to surround the style settings with tags." :group 'org-export-e-html :type 'string) ;;;###autoload (put 'org-e-html-style-extra 'safe-local-variable 'stringp) (defcustom org-e-html-mathjax-options '((path "http://orgmode.org/mathjax/MathJax.js") (scale "100") (align "center") (indent "2em") (mathml nil)) "Options for MathJax setup. path The path where to find MathJax scale Scaling for the HTML-CSS backend, usually between 100 and 133 align How to align display math: left, center, or right indent If align is not center, how far from the left/right side? mathml Should a MathML player be used if available? This is faster and reduces bandwidth use, but currently sometimes has lower spacing quality. Therefore, the default is nil. When browsers get better, this switch can be flipped. You can also customize this for each buffer, using something like #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\"" :group 'org-export-e-html :type '(list :greedy t (list :tag "path (the path from where to load MathJax.js)" (const :format " " path) (string)) (list :tag "scale (scaling for the displayed math)" (const :format " " scale) (string)) (list :tag "align (alignment of displayed equations)" (const :format " " align) (string)) (list :tag "indent (indentation with left or right alignment)" (const :format " " indent) (string)) (list :tag "mathml (should MathML display be used is possible)" (const :format " " mathml) (boolean)))) ;;;; Document Header (Scripts) (defcustom org-e-html-style-include-scripts t "Non-nil means include the JavaScript snippets in exported HTML files. The actual script is defined in `org-e-html-scripts' and should not be modified." :group 'org-export-e-html :type 'boolean) (defconst org-e-html-scripts "" "Basic JavaScript that is needed by HTML files produced by Org-mode.") ;;;; Document Header (Mathjax) (defcustom org-e-html-mathjax-template "" "The MathJax setup for XHTML files." :group 'org-export-e-html :type 'string) ;;;; Preamble (defcustom org-e-html-preamble t "Non-nil means insert a preamble in HTML export. When `t', insert a string as defined by one of the formatting strings in `org-e-html-preamble-format'. When set to a string, this string overrides `org-e-html-preamble-format'. When set to a function, apply this function and insert the returned string. The function takes the property list of export options as its only argument. Setting :html-preamble in publishing projects will take precedence over this variable." :group 'org-export-e-html :type '(choice (const :tag "No preamble" nil) (const :tag "Default preamble" t) (string :tag "Custom formatting string") (function :tag "Function (must return a string)"))) (defcustom org-e-html-preamble-format '(("en" "")) "The format for the HTML preamble. %t stands for the title. %a stands for the author's name. %e stands for the author's email. %d stands for the date. If you need to use a \"%\" character, you need to escape it like that: \"%%\"." :group 'org-export-e-html :type 'string) (defcustom org-e-html-link-up "" "Where should the \"UP\" link of exported HTML pages lead?" :group 'org-export-e-html :type '(string :tag "File or URL")) (defcustom org-e-html-link-home "" "Where should the \"HOME\" link of exported HTML pages lead?" :group 'org-export-e-html :type '(string :tag "File or URL")) (defcustom org-e-html-home/up-format "" "Snippet used to insert the HOME and UP links. This is a format string, the first %s will receive the UP link, the second the HOME link. If both `org-e-html-link-up' and `org-e-html-link-home' are empty, the entire snippet will be ignored." :group 'org-export-e-html :type 'string) ;;;; Postamble (defcustom org-e-html-postamble 'auto "Non-nil means insert a postamble in HTML export. When `t', insert a string as defined by the formatting string in `org-e-html-postamble-format'. When set to a string, this string overrides `org-e-html-postamble-format'. When set to 'auto, discard `org-e-html-postamble-format' and honor `org-export-author/email/creator-info' variables. When set to a function, apply this function and insert the returned string. The function takes the property list of export options as its only argument. Setting :html-postamble in publishing projects will take precedence over this variable." :group 'org-export-e-html :type '(choice (const :tag "No postamble" nil) (const :tag "Auto preamble" 'auto) (const :tag "Default formatting string" t) (string :tag "Custom formatting string") (function :tag "Function (must return a string)"))) (defcustom org-e-html-postamble-format '(("en" "

Author: %a (%e)

Date: %d

Generated by %c

%v

")) "The format for the HTML postamble. %a stands for the author's name. %e stands for the author's email. %d stands for the date. %c will be replaced by information about Org/Emacs versions. %v will be replaced by `org-e-html-validation-link'. If you need to use a \"%\" character, you need to escape it like that: \"%%\"." :group 'org-export-e-html :type 'string) (defcustom org-e-html-validation-link "Validate XHTML 1.0" "Link to HTML validation service." :group 'org-export-e-html :type 'string) ;; FIXME Obsolete since Org 7.7 ;; Use the :timestamp option or `org-export-time-stamp-file' instead ;;;; Emphasis (defcustom org-e-html-protect-char-alist '(("&" . "&") ("<" . "<") (">" . ">")) "Alist of characters to be converted by `org-e-html-protect'." :group 'org-export-e-html :type '(repeat (cons (string :tag "Character") (string :tag "HTML equivalent")))) (defconst org-e-html-special-string-regexps '(("\\\\-" . "­") ("---\\([^-]\\)" . "—\\1") ("--\\([^-]\\)" . "–\\1") ("\\.\\.\\." . "…")) "Regular expressions for special string conversion.") ;;;; Todos (defcustom org-e-html-todo-kwd-class-prefix "" "Prefix to class names for TODO keywords. Each TODO keyword gets a class given by the keyword itself, with this prefix. The default prefix is empty because it is nice to just use the keyword as a class name. But if you get into conflicts with other, existing CSS classes, then this prefix can be very useful." :group 'org-export-e-html :type 'string) ;;;; Tags (defcustom org-e-html-tag-class-prefix "" "Prefix to class names for TODO keywords. Each tag gets a class given by the tag itself, with this prefix. The default prefix is empty because it is nice to just use the keyword as a class name. But if you get into conflicts with other, existing CSS classes, then this prefix can be very useful." :group 'org-export-e-html :type 'string) ;;;; Timestamps ;;;; Statistics Cookie ;;;; Subscript ;;;; Superscript ;;;; Inline images (defcustom org-e-html-inline-images 'maybe "Non-nil means inline images into exported HTML pages. This is done using an tag. When nil, an anchor with href is used to link to the image. If this option is `maybe', then images in links with an empty description will be inlined, while images with a description will be linked only." :group 'org-export-e-html :type '(choice (const :tag "Never" nil) (const :tag "Always" t) (const :tag "When there is no description" maybe))) (defcustom org-e-html-inline-image-extensions '("png" "jpeg" "jpg" "gif" "svg") "Extensions of image files that can be inlined into HTML." :group 'org-export-e-html :type '(repeat (string :tag "Extension"))) ;;;; Block ;;;; Comment ;;;; Comment Block ;;;; Drawer ;;;; Dynamic Block ;;;; Emphasis ;;;; Entity ;;;; Example Block ;;;; Export Snippet ;;;; Export Block ;;;; Fixed Width ;;;; Footnotes (defcustom org-e-html-footnotes-section "

%s:

%s
" "Format for the footnotes section. Should contain a two instances of %s. The first will be replaced with the language-specific word for \"Footnotes\", the second one will be replaced by the footnotes themselves." :group 'org-export-e-html :type 'string) (defcustom org-e-html-footnote-format "%s" "The format for the footnote reference. %s will be replaced by the footnote reference itself." :group 'org-export-e-html :type 'string) (defcustom org-e-html-footnote-separator ", " "Text used to separate footnotes." :group 'org-export-e-html :type 'string) ;;;; Headline ;;;; Horizontal Rule ;;;; Inline Babel Call ;;;; Inline Src Block ;;;; Inlinetask ;;;; Item ;;;; Keyword ;;;; Latex Environment ;;;; Latex Fragment ;;;; Line Break ;;;; Link ;;;; Babel Call ;;;; Macro ;;;; Paragraph ;;;; Plain List ;;;; Plain Text ;;;; Property Drawer ;;;; Quote Block ;;;; Quote Section ;;;; Section ;;;; Radio Target ;;;; Special Block ;;;; Src Block (defgroup org-export-e-htmlize nil "Options for processing examples with htmlize.el." :tag "Org Export Htmlize" :group 'org-export-e-html) (defcustom org-export-e-htmlize-output-type 'inline-css "Output type to be used by htmlize when formatting code snippets. Choices are `css', to export the CSS selectors only, or `inline-css', to export the CSS attribute values inline in the HTML. We use as default `inline-css', in order to make the resulting HTML self-containing. However, this will fail when using Emacs in batch mode for export, because then no rich font definitions are in place. It will also not be good if people with different Emacs setup contribute HTML files to a website, because the fonts will represent the individual setups. In these cases, it is much better to let Org/Htmlize assign classes only, and to use a style file to define the look of these classes. To get a start for your css file, start Emacs session and make sure that all the faces you are interested in are defined, for example by loading files in all modes you want. Then, use the command \\[org-export-e-htmlize-generate-css] to extract class definitions." :group 'org-export-e-htmlize :type '(choice (const css) (const inline-css))) (defcustom org-export-e-htmlize-css-font-prefix "org-" "The prefix for CSS class names for htmlize font specifications." :group 'org-export-e-htmlize :type 'string) (defcustom org-export-e-htmlized-org-css-url nil "URL pointing to a CSS file defining text colors for htmlized Emacs buffers. Normally when creating an htmlized version of an Org buffer, htmlize will create CSS to define the font colors. However, this does not work when converting in batch mode, and it also can look bad if different people with different fontification setup work on the same website. When this variable is non-nil, creating an htmlized version of an Org buffer using `org-export-as-org' will remove the internal CSS section and replace it with a link to this URL." :group 'org-export-e-htmlize :type '(choice (const :tag "Keep internal css" nil) (string :tag "URL or local href"))) ;;;; Table (defcustom org-e-html-table-tag "" "The HTML tag that is used to start a table. This must be a
tag, but you may change the options like borders and spacing." :group 'org-export-e-html :type 'string) (defcustom org-e-html-table-header-tags '("") "The opening tag for table header fields. This is customizable so that alignment options can be specified. The first %s will be filled with the scope of the field, either row or col. The second %s will be replaced by a style entry to align the field. See also the variable `org-e-html-table-use-header-tags-for-first-column'. See also the variable `org-e-html-table-align-individual-fields'." :group 'org-export-tables ; FIXME: change group? :type '(cons (string :tag "Opening tag") (string :tag "Closing tag"))) (defcustom org-e-html-table-data-tags '("" . "") "The opening tag for table data fields. This is customizable so that alignment options can be specified. The first %s will be filled with the scope of the field, either row or col. The second %s will be replaced by a style entry to align the field. See also the variable `org-e-html-table-align-individual-fields'." :group 'org-export-tables :type '(cons (string :tag "Opening tag") (string :tag "Closing tag"))) (defcustom org-e-html-table-row-tags '("" . "") "The opening tag for table data fields. This is customizable so that alignment options can be specified. Instead of strings, these can be Lisp forms that will be evaluated for each row in order to construct the table row tags. During evaluation, the variable `head' will be true when this is a header line, nil when this is a body line. And the variable `nline' will contain the line number, starting from 1 in the first header line. For example (setq org-e-html-table-row-tags (cons '(if head \"\" (if (= (mod nline 2) 1) \"\" \"\")) \"\")) will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"." :group 'org-export-tables :type '(cons (choice :tag "Opening tag" (string :tag "Specify") (sexp)) (choice :tag "Closing tag" (string :tag "Specify") (sexp)))) (defcustom org-e-html-table-align-individual-fields t "Non-nil means attach style attributes for alignment to each table field. When nil, alignment will only be specified in the column tags, but this is ignored by some browsers (like Firefox, Safari). Opera does it right though." :group 'org-export-tables :type 'boolean) (defcustom org-e-html-table-use-header-tags-for-first-column nil "Non-nil means format column one in tables with header tags. When nil, also column one will use data tags." :group 'org-export-tables :type 'boolean) ;;;; Target ;;;; Timestamp ;;;; Verbatim ;;;; Verse Block ;;;; Headline (defcustom org-e-html-toplevel-hlevel 2 "The level for level 1 headings in HTML export. This is also important for the classes that will be wrapped around headlines and outline structure. If this variable is 1, the top-level headlines will be

, and the corresponding classes will be outline-1, section-number-1, and outline-text-1. If this is 2, all of these will get a 2 instead. The default for this variable is 2, because we use

for formatting the document title." :group 'org-export-e-html :type 'string) ;;;; Links ;;;; Drawers ;;;; Inlinetasks ;;;; Publishing (defcustom org-e-html-link-org-files-as-html t "Non-nil means make file links to `file.org' point to `file.html'. When org-mode is exporting an org-mode file to HTML, links to non-html files are directly put into a href tag in HTML. However, links to other Org-mode files (recognized by the extension `.org.) should become links to the corresponding html file, assuming that the linked org-mode file will also be converted to HTML. When nil, the links still point to the plain `.org' file." :group 'org-export-e-html :type 'boolean) ;;;; Compilation ;;; User Configurable Variables (MAYBE) ;;;; Preamble (defcustom org-e-html-date-format "\\today" "Format string for \\date{...}." :group 'org-export-e-html :type 'boolean) (defcustom org-e-html-creator-string (format "Generated by Org mode %s in Emacs %s." (if (fboundp 'org-version) (org-version) "(Unknown)") emacs-version) "String to insert at the end of the HTML document." :group 'org-export-e-html :type '(string :tag "Creator string")) ;;;; Headline (defcustom org-e-html-format-headline-function nil "Function to format headline text. This function will be called with 5 arguments: TODO the todo keyword (string or nil). TODO-TYPE the type of todo (symbol: `todo', `done', nil) PRIORITY the priority of the headline (integer or nil) TEXT the main headline text (string). TAGS the tags (string or nil). The function result will be used in the section format string. As an example, one could set the variable to the following, in order to reproduce the default set-up: \(defun org-e-html-format-headline \(todo todo-type priority text tags) \"Default format function for an headline.\" \(concat \(when todo \(format \"\\\\textbf{\\\\textsc{\\\\textsf{%s}}} \" todo)) \(when priority \(format \"\\\\framebox{\\\\#%c} \" priority)) text \(when tags (format \"\\\\hfill{}\\\\textsc{%s}\" tags))))" :group 'org-export-e-html :type 'function) ;;;; Text Markup (defcustom org-e-html-text-markup-alist '((bold . "%s") (code . "%s") (italic . "%s") (strike-through . "%s") (underline . "%s") (verbatim . "%s")) "Alist of HTML expressions to convert text markup The key must be a symbol among `bold', `code', `italic', `strike-through', `underline' and `verbatim'. The value is a formatting string to wrap fontified text with. If no association can be found for a given markup, text will be returned as-is." :group 'org-export-e-html :type '(alist :key-type (symbol :tag "Markup type") :value-type (string :tag "Format string")) :options '(bold code italic strike-through underline verbatim)) ;;;; Footnotes (defcustom org-e-html-footnote-separator ", " "Text used to separate footnotes." :group 'org-export-e-html :type 'string) ;;;; Timestamps (defcustom org-e-html-active-timestamp-format "\\textit{%s}" "A printf format string to be applied to active timestamps." :group 'org-export-e-html :type 'string) (defcustom org-e-html-inactive-timestamp-format "\\textit{%s}" "A printf format string to be applied to inactive timestamps." :group 'org-export-e-html :type 'string) (defcustom org-e-html-diary-timestamp-format "\\textit{%s}" "A printf format string to be applied to diary timestamps." :group 'org-export-e-html :type 'string) ;;;; Links (defcustom org-e-html-inline-image-rules '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'") ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'") ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")) "Rules characterizing image files that can be inlined into HTML. A rule consists in an association whose key is the type of link to consider, and value is a regexp that will be matched against link's path. Note that, by default, the image extension *actually* allowed depend on the way the HTML file is processed. When used with pdflatex, pdf, jpg and png images are OK. When processing through dvi to Postscript, only ps and eps are allowed. The default we use here encompasses both." :group 'org-export-e-html :type '(alist :key-type (string :tag "Type") :value-type (regexp :tag "Path"))) ;;;; Tables (defcustom org-e-html-table-caption-above t "When non-nil, place caption string at the beginning of the table. Otherwise, place it near the end." :group 'org-export-e-html :type 'boolean) ;;;; Drawers (defcustom org-e-html-format-drawer-function nil "Function called to format a drawer in HTML code. The function must accept two parameters: NAME the drawer name, like \"LOGBOOK\" CONTENTS the contents of the drawer. The function should return the string to be exported. For example, the variable could be set to the following function in order to mimic default behaviour: \(defun org-e-html-format-drawer-default \(name contents\) \"Format a drawer element for HTML export.\" contents\)" :group 'org-export-e-html :type 'function) ;;;; Inlinetasks (defcustom org-e-html-format-inlinetask-function nil "Function called to format an inlinetask in HTML code. The function must accept six parameters: TODO the todo keyword, as a string TODO-TYPE the todo type, a symbol among `todo', `done' and nil. PRIORITY the inlinetask priority, as a string NAME the inlinetask name, as a string. TAGS the inlinetask tags, as a list of strings. CONTENTS the contents of the inlinetask, as a string. The function should return the string to be exported. For example, the variable could be set to the following function in order to mimic default behaviour: \(defun org-e-html-format-inlinetask \(todo type priority name tags contents\) \"Format an inline task element for HTML export.\" \(let \(\(full-title \(concat \(when todo \(format \"\\\\textbf{\\\\textsf{\\\\textsc{%s}}} \" todo)) \(when priority (format \"\\\\framebox{\\\\#%c} \" priority)) title \(when tags (format \"\\\\hfill{}\\\\textsc{%s}\" tags))))) \(format (concat \"\\\\begin{center}\\n\" \"\\\\fbox{\\n\" \"\\\\begin{minipage}[c]{.6\\\\textwidth}\\n\" \"%s\\n\\n\" \"\\\\rule[.8em]{\\\\textwidth}{2pt}\\n\\n\" \"%s\" \"\\\\end{minipage}}\" \"\\\\end{center}\") full-title contents))" :group 'org-export-e-html :type 'function) ;; Src blocks ;;;; Plain text (defcustom org-e-html-quotes '(("fr" ("\\(\\s-\\|[[(]\\|^\\)\"" . "« ") ("\\(\\S-\\)\"" . " »") ("\\(\\s-\\|(\\|^\\)'" . "’")) ("en" ("\\(\\s-\\|[[(]\\|^\\)\"" . "“") ("\\(\\S-\\)\"" . "”") ("\\(\\s-\\|(\\|^\\)'" . "‘"))) "Alist for quotes to use when converting english double-quotes. The CAR of each item in this alist is the language code. The CDR of each item in this alist is a list of three CONS: - the first CONS defines the opening quote; - the second CONS defines the closing quote; - the last CONS defines single quotes. For each item in a CONS, the first string is a regexp for allowed characters before/after the quote, the second string defines the replacement string for this quote." :group 'org-export-e-html :type '(list (cons :tag "Opening quote" (string :tag "Regexp for char before") (string :tag "Replacement quote ")) (cons :tag "Closing quote" (string :tag "Regexp for char after ") (string :tag "Replacement quote ")) (cons :tag "Single quote" (string :tag "Regexp for char before") (string :tag "Replacement quote ")))) ;;;; Compilation ;;; Internal Functions (HTML) (defun org-e-html-format-inline-image (src &optional caption label attr standalone-p) (let* ((id (if (not label) "" (format " id=\"%s\"" (org-export-solidify-link-text label)))) (attr (concat attr (cond ((string-match "\\" src attr))) (format "\n%s%s\n" id (format "\n

%s

" img) (when caption (format "\n

%s

" caption))))) (t (format "" src (concat attr id)))))) ;;;; Bibliography (defun org-e-html-bibliography () "Find bibliography, cut it out and return it." (catch 'exit (let (beg end (cnt 1) bib) (save-excursion (goto-char (point-min)) (when (re-search-forward "^[ \t]*
" nil t) (setq cnt (+ cnt (if (string= (match-string 0) "") (forward-char 1)) (setq bib (buffer-substring beg (point))) (delete-region beg (point)) (throw 'exit bib)))) nil)))) ;;;; Table (defun org-e-html-splice-attributes (tag attributes) "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG." (if (not attributes) tag (let (oldatt newatt) (setq oldatt (org-extract-attributes-from-string tag) tag (pop oldatt) newatt (cdr (org-extract-attributes-from-string attributes))) (while newatt (setq oldatt (plist-put oldatt (pop newatt) (pop newatt)))) (if (string-match ">" tag) (setq tag (replace-match (concat (org-attributes-to-string oldatt) ">") t t tag))) tag))) (defun org-export-splice-style (style extra) "Splice EXTRA into STYLE, just before \"\"." (if (and (stringp extra) (string-match "\\S-" extra) (string-match "" style)) (concat (substring style 0 (match-beginning 0)) "\n" extra "\n" (substring style (match-beginning 0))) style)) (defun org-export-e-htmlize-region-for-paste (beg end) "Convert the region to HTML, using htmlize.el. This is much like `htmlize-region-for-paste', only that it uses the settings define in the org-... variables." (let* ((htmlize-output-type org-export-e-htmlize-output-type) (htmlize-css-name-prefix org-export-e-htmlize-css-font-prefix) (htmlbuf (htmlize-region beg end))) (unwind-protect (with-current-buffer htmlbuf (buffer-substring (plist-get htmlize-buffer-places 'content-start) (plist-get htmlize-buffer-places 'content-end))) (kill-buffer htmlbuf)))) ;;;###autoload (defun org-export-e-htmlize-generate-css () "Create the CSS for all font definitions in the current Emacs session. Use this to create face definitions in your CSS style file that can then be used by code snippets transformed by htmlize. This command just produces a buffer that contains class definitions for all faces used in the current Emacs session. You can copy and paste the ones you need into your CSS file. If you then set `org-export-e-htmlize-output-type' to `css', calls to the function `org-export-e-htmlize-region-for-paste' will produce code that uses these same face definitions." (interactive) (require 'htmlize) (and (get-buffer "*html*") (kill-buffer "*html*")) (with-temp-buffer (let ((fl (face-list)) (htmlize-css-name-prefix "org-") (htmlize-output-type 'css) f i) (while (setq f (pop fl) i (and f (face-attribute f :inherit))) (when (and (symbolp f) (or (not i) (not (listp i)))) (insert (org-add-props (copy-sequence "1") nil 'face f)))) (htmlize-region (point-min) (point-max)))) (org-pop-to-buffer-same-window "*html*") (goto-char (point-min)) (if (re-search-forward "" nil t) (delete-region (1+ (match-end 0)) (point-max))) (beginning-of-line 1) (if (looking-at " +") (replace-match "")) (goto-char (point-min))) (defun org-e-html-make-string (n string) (let (out) (dotimes (i n out) (setq out (concat string out))))) (defun org-e-html-toc-text (toc-entries) (let* ((prev-level (1- (nth 1 (car toc-entries)))) (start-level prev-level)) (concat (mapconcat (lambda (entry) (let ((headline (nth 0 entry)) (level (nth 1 entry))) (concat (let* ((cnt (- level prev-level)) (times (if (> cnt 0) (1- cnt) (- cnt))) rtn) (setq prev-level level) (concat (org-e-html-make-string times (cond ((> cnt 0) "\n
    \n
  • ") ((< cnt 0) "
  • \n
\n"))) (if (> cnt 0) "\n
    \n
  • " "
  • \n
  • "))) headline))) toc-entries "") (org-e-html-make-string (- prev-level start-level) "
  • \n
\n")))) (defun* org-e-html-format-toc-headline (todo todo-type priority text tags &key level section-number headline-label &allow-other-keys) (let ((headline (concat section-number (and section-number ". ") text (and tags "   ") (org-e-html--tags tags)))) (format "%s" (org-export-solidify-link-text headline-label) (if (not nil) headline (format "%s" todo-type headline))))) (defun org-e-html-toc (depth info) (assert (wholenump depth)) (let* ((headlines (org-export-collect-headlines info depth)) (toc-entries (loop for headline in headlines collect (list (org-e-html-format-headline--wrap headline info 'org-e-html-format-toc-headline) (org-export-get-relative-level headline info))))) (when toc-entries (concat "
\n" (format "%s\n" org-e-html-toplevel-hlevel (org-e-html--translate "Table of Contents" info) org-e-html-toplevel-hlevel) "
" (org-e-html-toc-text toc-entries) "
\n" "
\n")))) (defun org-e-html-fix-class-name (kwd) ; audit callers of this function "Turn todo keyword into a valid class name. Replaces invalid characters with \"_\"." (save-match-data (while (string-match "[^a-zA-Z0-9_]" kwd) (setq kwd (replace-match "_" t t kwd)))) kwd) (defun org-e-html-format-footnote-reference (n def refcnt) (let ((extra (if (= refcnt 1) "" (format ".%d" refcnt)))) (format org-e-html-footnote-format (let* ((id (format "fnr.%s%s" n extra)) (href (format " href=\"#fn.%s\"" n)) (attributes (concat " class=\"footref\"" href))) (org-e-html--anchor id n attributes))))) (defun org-e-html-format-footnotes-section (section-name definitions) (if (not definitions) "" (format org-e-html-footnotes-section section-name definitions))) (defun org-e-html-format-footnote-definition (fn) (let ((n (car fn)) (def (cdr fn))) (format "

\n\n\n\n" (format org-e-html-footnote-format (let* ((id (format "fn.%s" n)) (href (format " href=\"#fnr.%s\"" n)) (attributes (concat " class=\"footnum\"" href))) (org-e-html--anchor id n attributes))) def))) (defun org-e-html-footnote-section (info) (let* ((fn-alist (org-export-collect-footnote-definitions (plist-get info :parse-tree) info)) (fn-alist (loop for (n type raw) in fn-alist collect (cons n (if (eq (org-element-type raw) 'org-data) (org-trim (org-export-data raw info)) (format "

%s

" (org-trim (org-export-data raw info)))))))) (when fn-alist (org-e-html-format-footnotes-section (org-e-html--translate "Footnotes" info) (format "
" . "
%s%s
\n%s\n
\n" (mapconcat 'org-e-html-format-footnote-definition fn-alist "\n")))))) (defun org-e-html-format-date (info) (let ((date (org-export-data (plist-get info :date) info))) (cond ((and date (string-match "%" date)) (format-time-string date)) (date date) (t (format-time-string "%Y-%m-%d %T %Z"))))) ;;; Internal Functions (Ngz) (defun org-e-html--caption/label-string (caption label info) "Return caption and label HTML string for floats. CAPTION is a cons cell of secondary strings, the car being the standard caption and the cdr its short form. LABEL is a string representing the label. INFO is a plist holding contextual information. If there's no caption nor label, return the empty string. For non-floats, see `org-e-html--wrap-label'." (setq label nil) ;; FIXME (let ((label-str (if label (format "\\label{%s}" label) ""))) (cond ((and (not caption) (not label)) "") ((not caption) (format "\\label{%s}\n" label)) ;; Option caption format with short name. ((cdr caption) (format "\\caption[%s]{%s%s}\n" (org-export-data (cdr caption) info) label-str (org-export-data (car caption) info))) ;; Standard caption format. ;; (t (format "\\caption{%s%s}\n" ;; label-str ;; (org-export-data (car caption) info))) (t (org-export-data (car caption) info))))) (defun org-e-html--find-verb-separator (s) "Return a character not used in string S. This is used to choose a separator for constructs like \\verb." (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}")) (loop for c across ll when (not (string-match (regexp-quote (char-to-string c)) s)) return (char-to-string c)))) (defun org-e-html--quotation-marks (text info) "Export quotation marks depending on language conventions. TEXT is a string containing quotation marks to be replaced. INFO is a plist used as a communication channel." (mapc (lambda(l) (let ((start 0)) (while (setq start (string-match (car l) text start)) (let ((new-quote (concat (match-string 1 text) (cdr l)))) (setq text (replace-match new-quote t t text)))))) (cdr (or (assoc (plist-get info :language) org-e-html-quotes) ;; Falls back on English. (assoc "en" org-e-html-quotes)))) text) (defun org-e-html--wrap-label (element output) "Wrap label associated to ELEMENT around OUTPUT, if appropriate. This function shouldn't be used for floats. See `org-e-html--caption/label-string'." ;; (let ((label (org-element-property :name element))) ;; (if (or (not output) (not label) (string= output "") (string= label "")) ;; output ;; (concat (format "\\label{%s}\n" label) output))) output) ;;; Template (defun org-e-html-meta-info (info) (let* ((title (org-export-data (plist-get info :title) info)) (author (and (plist-get info :with-author) (let ((auth (plist-get info :author))) (and auth (org-export-data auth info))))) (description (plist-get info :description)) (keywords (plist-get info :keywords))) (concat (format "\n%s\n" title) (format "\n" (or (and org-e-html-coding-system (fboundp 'coding-system-get) (coding-system-get org-e-html-coding-system 'mime-charset)) "iso-8859-1")) (format "\n" title) (format "\n") (format "\n" (org-e-html-format-date info)) (format "\n" author) (format "\n" description) (format "\n" keywords)))) (defun org-e-html-style (info) (concat "\n" (when (plist-get info :style-include-default) org-e-html-style-default) (plist-get info :style) (plist-get info :style-extra) "\n" (when (plist-get info :style-include-scripts) org-e-html-scripts))) (defun org-e-html-mathjax-config (info) "Insert the user setup into the matchjax template." (when (member (plist-get info :LaTeX-fragments) '(mathjax t)) (let ((template org-e-html-mathjax-template) (options org-e-html-mathjax-options) (in-buffer (or (plist-get info :mathjax) "")) name val (yes " ") (no "// ") x) (mapc (lambda (e) (setq name (car e) val (nth 1 e)) (if (string-match (concat "\\<" (symbol-name name) ":") in-buffer) (setq val (car (read-from-string (substring in-buffer (match-end 0)))))) (if (not (stringp val)) (setq val (format "%s" val))) (if (string-match (concat "%" (upcase (symbol-name name))) template) (setq template (replace-match val t t template)))) options) (setq val (nth 1 (assq 'mathml options))) (if (string-match (concat "\\ " (nth 0 org-e-html-divs)) " " html-pre-real-contents " "))))) (defun org-e-html-postamble (info) (concat (when (and (not body-only) (plist-get info :html-postamble)) (let* ((html-post (plist-get info :html-postamble)) (date (org-e-html-format-date info)) (author (let ((author (plist-get info :author))) (and author (org-export-data author info)))) (email (mapconcat (lambda(e) (format "%s" e e)) (split-string (plist-get info :email) ",+ *") ", ")) (html-validation-link (or org-e-html-validation-link "")) (creator-info org-export-creator-string)) (concat ;; begin postamble "
" (cond ;; auto postamble ((eq (plist-get info :html-postamble) 'auto) (concat (when (plist-get info :time-stamp-file) (format "

%s: %s

" (org-e-html--translate "Date" info) date)) (when (and (plist-get info :with-author) author) (format "

%s : %s

" (org-e-html--translate "Author" info) author)) (when (and (plist-get info :with-email) email) (format "

%s

" email)) (when (plist-get info :with-creator) (format "

%s

" creator-info)) html-validation-link "\n")) ;; postamble from a string ((stringp (plist-get info :html-postamble)) (format-spec (plist-get info :html-postamble) `((?a . ,author) (?e . ,email) (?d . ,date) (?c . ,creator-info) (?v . ,html-validation-link)))) ;; postamble from a function ((functionp (plist-get info :html-postamble)) (with-temp-buffer (funcall (plist-get info :html-postamble)) (buffer-string))) ;; default postamble (t (format-spec (or (cadr (assoc (plist-get info :language) org-e-html-postamble-format)) (cadr (assoc "en" org-e-html-postamble-format))) `((?a . ,author) (?e . ,email) (?d . ,date) (?c . ,creator-info) (?v . ,html-validation-link))))) "
"))) ;; org-e-html-html-helper-timestamp )) (defun org-e-html-template (contents info) "Return complete document string after HTML conversion. CONTENTS is the transcoded contents string. RAW-DATA is the original parsed data. INFO is a plist holding export options." (concat (format (or (and (stringp org-e-html-xml-declaration) org-e-html-xml-declaration) (cdr (assoc (plist-get info :html-extension) org-e-html-xml-declaration)) (cdr (assoc "html" org-e-html-xml-declaration)) "") (or (and org-e-html-coding-system (fboundp 'coding-system-get) (coding-system-get org-e-html-coding-system 'mime-charset)) "iso-8859-1")) " " (format " " (plist-get info :language) (plist-get info :language)) " " (org-e-html-meta-info info) ; meta (org-e-html-style info) ; style (org-e-html-mathjax-config info) ; mathjax " " " " (let ((link-up (org-trim (plist-get info :link-up))) (link-home (org-trim (plist-get info :link-home)))) (unless (and (string= link-up "") (string= link-up "")) (format org-e-html-home/up-format (or link-up link-home) (or link-home link-up)))) ;; preamble (org-e-html-preamble info) ;; begin content (format "
" (or org-e-html-content-div (nth 1 org-e-html-divs))) ;; document title (format "

%s

\n" (org-export-data (plist-get info :title) info)) ;; table of contents (let ((depth (plist-get info :with-toc))) (when (wholenump depth) (org-e-html-toc depth info))) ;; document contents contents ;; footnotes section (org-e-html-footnote-section info) ;; bibliography (org-e-html-bibliography) ;; end content (unless body-only "
") ;; postamble (org-e-html-postamble info) (unless body-only " ") " ")) (defun org-e-html--translate (s info) "Transcode string S in to HTML. INFO is a plist used as a communication channel. Lookup utf-8 equivalent of S in `org-export-dictionary' and replace all non-ascii characters with its numeric reference." (let ((s (org-export-translate s :utf-8 info))) ;; Protect HTML metacharacters. (setq s (org-e-html-encode-plain-text s)) ;; Replace non-ascii characters with their numeric equivalents. (replace-regexp-in-string "[[:nonascii:]]" (lambda (m) (format "&#%d;" (encode-char (string-to-char m) 'ucs))) s t t))) ;;; Transcode Helpers ;;;; Anchor (defun org-e-html--anchor (&optional id desc attributes) (let* ((name (and org-e-html-allow-name-attribute-in-anchors id)) (attributes (concat (and id (format " id=\"%s\"" id)) (and name (format " name=\"%s\"" name)) attributes))) (format "%s" attributes (or desc "")))) ;;;; Todo (defun org-e-html--todo (todo) (when todo (format "%s" (if (member todo org-done-keywords) "done" "todo") org-e-html-todo-kwd-class-prefix (org-e-html-fix-class-name todo) todo))) ;;;; Tags (defun org-e-html--tags (tags) (when tags (format "%s" (mapconcat (lambda (tag) (format "%s" (concat org-e-html-tag-class-prefix (org-e-html-fix-class-name tag)) tag)) tags " ")))) ;;;; Headline (defun* org-e-html-format-headline (todo todo-type priority text tags &key level section-number headline-label &allow-other-keys) (let ((section-number (when section-number (format "%s " level section-number))) (todo (org-e-html--todo todo)) (tags (org-e-html--tags tags))) (concat section-number todo (and todo " ") text (and tags "   ") tags))) ;;;; Src Code (defun org-e-html-fontify-code (code lang) (when code (cond ;; Case 1: No lang. Possibly an example block. ((not lang) ;; Simple transcoding. (org-e-html-encode-plain-text code)) ;; Case 2: No htmlize or an inferior version of htmlize ((not (and (require 'htmlize nil t) (fboundp 'htmlize-region-for-paste))) ;; Emit a warning. (message "Cannot fontify src block (htmlize.el >= 1.34 required)") ;; Simple transcoding. (org-e-html-encode-plain-text code)) (t ;; Map language (setq lang (or (assoc-default lang org-src-lang-modes) lang)) (let* ((lang-mode (and lang (intern (format "%s-mode" lang))))) (cond ;; Case 1: Language is not associated with any Emacs mode ((not (functionp lang-mode)) ;; Simple transcoding. (org-e-html-encode-plain-text code)) ;; Case 2: Default. Fontify code. (t ;; htmlize (setq code (with-temp-buffer (insert code) ;; Switch to language-specific mode. (funcall lang-mode) ;; Fontify buffer. (font-lock-fontify-buffer) ;; Remove formatting on newline characters. (save-excursion (let ((beg (point-min)) (end (point-max))) (goto-char beg) (while (progn (end-of-line) (< (point) end)) (put-text-property (point) (1+ (point)) 'face nil) (forward-char 1)))) (org-src-mode) (set-buffer-modified-p nil) ;; Htmlize region. (org-export-e-htmlize-region-for-paste (point-min) (point-max)))) ;; Strip any encolosing
 tags.
	  (if (string-match "]*>\n*\\([^\000]*\\)" code)
	      (match-string 1 code)
	    code))))))))

(defun org-e-html-do-format-code
  (code &optional lang refs retain-labels num-start textarea-p)
  (when textarea-p
    (setq num-start nil refs nil lang nil))
  (let* ((code-lines (org-split-string code "\n"))
	 (code-length (length code-lines))
	 (num-fmt
	  (and num-start
	       (format "%%%ds: "
		       (length (number-to-string (+ code-length num-start))))))
	 (code (org-e-html-fontify-code code lang)))
    (assert (= code-length (length (org-split-string code "\n"))))
    (org-export-format-code
     code
     (lambda (loc line-num ref)
       (setq loc
	     (concat
	      ;; Add line number, if needed.
	      (when num-start
		(format "%s"
			(format num-fmt line-num)))
	      ;; Transcoded src line.
	      loc
	      ;; Add label, if needed.
	      (when (and ref retain-labels) (format " (%s)" ref))))
       ;; Mark transcoded line as an anchor, if needed.
       (if (not ref) loc
	 (format "%s"
		 ref loc)))
     num-start refs)))

(defun org-e-html-format-code (element info)
  (let* ((lang (org-element-property :language element))
	 ;; (switches (org-element-property :switches element))
	 (switches nil)			; FIXME
	 (textarea-p (and switches (string-match "-t\\>" switches)))
	 ;; Extract code and references.
	 (code-info (org-export-unravel-code element))
	 (code (car code-info))
	 (refs (cdr code-info))
	 ;; Does the src block contain labels?
	 (retain-labels (org-element-property :retain-labels element))
	 ;; Does it have line numbers?
	 (num-start (case (org-element-property :number-lines element)
		      (continued (org-export-get-loc element info))
		      (new 0))))
    (org-e-html-do-format-code
     code lang refs retain-labels num-start textarea-p)))



;;; Transcode Functions

;;;; Bold

(defun org-e-html-bold (bold contents info)
  "Transcode BOLD from Org to HTML.
CONTENTS is the text with bold markup.  INFO is a plist holding
contextual information."
  (format (or (cdr (assq 'bold org-e-html-text-markup-alist)) "%s")
	  contents))


;;;; Center Block

(defun org-e-html-center-block (center-block contents info)
  "Transcode a CENTER-BLOCK element from Org to HTML.
CONTENTS holds the contents of the block.  INFO is a plist
holding contextual information."
  (org-e-html--wrap-label
   center-block
   (format "
\n%s
" contents))) ;;;; Clock (defun org-e-html-clock (clock contents info) "Transcode a CLOCK element from Org to HTML. CONTENTS is nil. INFO is a plist used as a communication channel." (format "

%s %s%s

" org-clock-string (org-translate-time (org-element-property :value clock)) (let ((time (org-element-property :time clock))) (and time (format " (%s)" time))))) ;;;; Code (defun org-e-html-code (code contents info) "Transcode CODE from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (format (or (cdr (assq 'code org-e-html-text-markup-alist)) "%s") (org-element-property :value code))) ;;;; Comment ;; Comments are ignored. ;;;; Comment Block ;; Comment Blocks are ignored. ;;;; Drawer (defun org-e-html-drawer (drawer contents info) "Transcode a DRAWER element from Org to HTML. CONTENTS holds the contents of the block. INFO is a plist holding contextual information." (let* ((name (org-element-property :drawer-name drawer)) (output (if (functionp org-e-html-format-drawer-function) (funcall org-e-html-format-drawer-function name contents) ;; If there's no user defined function: simply ;; display contents of the drawer. contents))) (org-e-html--wrap-label drawer output))) ;;;; Dynamic Block (defun org-e-html-dynamic-block (dynamic-block contents info) "Transcode a DYNAMIC-BLOCK element from Org to HTML. CONTENTS holds the contents of the block. INFO is a plist holding contextual information. See `org-export-data'." (org-e-html--wrap-label dynamic-block contents)) ;;;; Entity (defun org-e-html-entity (entity contents info) "Transcode an ENTITY object from Org to HTML. CONTENTS are the definition itself. INFO is a plist holding contextual information." (org-element-property :html entity)) ;;;; Example Block (defun org-e-html-example-block (example-block contents info) "Transcode a EXAMPLE-BLOCK element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let* ((options (or (org-element-property :options example-block) "")) (lang (org-element-property :language example-block)) (caption (org-element-property :caption example-block)) (label (org-element-property :name example-block)) (caption-str (org-e-html--caption/label-string caption label info)) (attr (mapconcat #'identity (org-element-property :attr_html example-block) " ")) ;; (switches (org-element-property :switches example-block)) (switches nil) ; FIXME (textarea-p (and switches (string-match "-t\\>" switches))) (code (org-e-html-format-code example-block info))) (cond (textarea-p (let ((cols (if (not (string-match "-w[ \t]+\\([0-9]+\\)" switches)) 80 (string-to-number (match-string 1 switches)))) (rows (if (string-match "-h[ \t]+\\([0-9]+\\)" switches) (string-to-number (match-string 1 switches)) (org-count-lines code)))) (format "

\n\n

" cols rows code))) (t (format "
\n%s
" code))))) ;;;; Export Snippet (defun org-e-html-export-snippet (export-snippet contents info) "Transcode a EXPORT-SNIPPET object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (when (eq (org-export-snippet-backend export-snippet) 'e-html) (org-element-property :value export-snippet))) ;;;; Export Block (defun org-e-html-export-block (export-block contents info) "Transcode a EXPORT-BLOCK element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (when (string= (org-element-property :type export-block) "HTML") (org-remove-indentation (org-element-property :value export-block)))) ;;;; Fixed Width (defun org-e-html-fixed-width (fixed-width contents info) "Transcode a FIXED-WIDTH element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (org-e-html--wrap-label fixed-width (format "
\n%s
" (org-e-html-do-format-code (org-remove-indentation (org-element-property :value fixed-width)))))) ;;;; Footnote Definition ;; Footnote Definitions are ignored. ;;;; Footnote Reference (defun org-e-html-footnote-reference (footnote-reference contents info) "Transcode a FOOTNOTE-REFERENCE element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (concat ;; Insert separator between two footnotes in a row. (let ((prev (org-export-get-previous-element footnote-reference))) (when (eq (org-element-type prev) 'footnote-reference) org-e-html-footnote-separator)) (cond ((not (org-export-footnote-first-reference-p footnote-reference info)) (org-e-html-format-footnote-reference (org-export-get-footnote-number footnote-reference info) "IGNORED" 100)) ;; Inline definitions are secondary strings. ((eq (org-element-property :type footnote-reference) 'inline) (org-e-html-format-footnote-reference (org-export-get-footnote-number footnote-reference info) "IGNORED" 1)) ;; Non-inline footnotes definitions are full Org data. (t (org-e-html-format-footnote-reference (org-export-get-footnote-number footnote-reference info) "IGNORED" 1))))) ;;;; Headline (defun org-e-html-format-headline--wrap (headline info &optional format-function &rest extra-keys) "Transcode an HEADLINE element from Org to HTML. CONTENTS holds the contents of the headline. INFO is a plist holding contextual information." (let* ((level (+ (org-export-get-relative-level headline info) (1- org-e-html-toplevel-hlevel))) (headline-number (org-export-get-headline-number headline info)) (section-number (and (org-export-numbered-headline-p headline info) (mapconcat 'number-to-string headline-number "."))) (todo (and (plist-get info :with-todo-keywords) (let ((todo (org-element-property :todo-keyword headline))) (and todo (org-export-data todo info))))) (todo-type (and todo (org-element-property :todo-type headline))) (priority (and (plist-get info :with-priority) (org-element-property :priority headline))) (text (org-export-data (org-element-property :title headline) info)) (tags (and (plist-get info :with-tags) (org-export-get-tags headline info))) (headline-label (or (org-element-property :custom-id headline) (concat "sec-" (mapconcat 'number-to-string headline-number "-")))) (format-function (cond ((functionp format-function) format-function) ((functionp org-e-html-format-headline-function) (function* (lambda (todo todo-type priority text tags &allow-other-keys) (funcall org-e-html-format-headline-function todo todo-type priority text tags)))) (t 'org-e-html-format-headline)))) (apply format-function todo todo-type priority text tags :headline-label headline-label :level level :section-number section-number extra-keys))) (defun org-e-html-headline (headline contents info) "Transcode an HEADLINE element from Org to HTML. CONTENTS holds the contents of the headline. INFO is a plist holding contextual information." ;; Empty contents? (setq contents (or contents "")) (let* ((numberedp (org-export-numbered-headline-p headline info)) (level (org-export-get-relative-level headline info)) (text (org-export-data (org-element-property :title headline) info)) (todo (and (plist-get info :with-todo-keywords) (let ((todo (org-element-property :todo-keyword headline))) (and todo (org-export-data todo info))))) (todo-type (and todo (org-element-property :todo-type headline))) (tags (and (plist-get info :with-tags) (org-export-get-tags headline info))) (priority (and (plist-get info :with-priority) (org-element-property :priority headline))) (section-number (and (org-export-numbered-headline-p headline info) (mapconcat 'number-to-string (org-export-get-headline-number headline info) "."))) ;; Create the headline text. (full-text (org-e-html-format-headline--wrap headline info))) (cond ;; Case 1: This is a footnote section: ignore it. ((org-element-property :footnote-section-p headline) nil) ;; Case 2. This is a deep sub-tree: export it as a list item. ;; Also export as items headlines for which no section ;; format has been found. ((org-export-low-level-p headline info) ; FIXME (or (not section-fmt)) ;; Build the real contents of the sub-tree. (let* ((type (if numberedp 'unordered 'unordered)) ; FIXME (itemized-body (org-e-html-format-list-item contents type nil nil full-text))) (concat (and (org-export-first-sibling-p headline) (org-e-html-begin-plain-list type)) itemized-body (and (org-export-last-sibling-p headline) (org-e-html-end-plain-list type))))) ;; Case 3. Standard headline. Export it as a section. (t (let* ((section-number (mapconcat 'number-to-string (org-export-get-headline-number headline info) "-")) (ids (remove 'nil (list (org-element-property :custom-id headline) (concat "sec-" section-number) (org-element-property :id headline)))) (preferred-id (car ids)) (extra-ids (cdr ids)) (extra-class (org-element-property :html-container-class headline)) (level1 (+ level (1- org-e-html-toplevel-hlevel)))) (format "
%s%s
\n" (format "outline-container-%s" (or (org-element-property :custom-id headline) section-number)) (concat (format "outline-%d" level1) (and extra-class " ") extra-class) (format "\n%s%s\n" level1 preferred-id (mapconcat (lambda (x) (let ((id (org-export-solidify-link-text (if (org-uuidgen-p x) (concat "ID-" x) x)))) (org-e-html--anchor id))) extra-ids "") full-text level1) contents)))))) ;;;; Horizontal Rule (defun org-e-html-horizontal-rule (horizontal-rule contents info) "Transcode an HORIZONTAL-RULE object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((attr (mapconcat #'identity (org-element-property :attr_html horizontal-rule) " "))) (org-e-html--wrap-label horizontal-rule "
"))) ;;;; Inline Babel Call ;; Inline Babel Calls are ignored. ;;;; Inline Src Block (defun org-e-html-inline-src-block (inline-src-block contents info) "Transcode an INLINE-SRC-BLOCK element from Org to HTML. CONTENTS holds the contents of the item. INFO is a plist holding contextual information." (let* ((org-lang (org-element-property :language inline-src-block)) (code (org-element-property :value inline-src-block)) (separator (org-e-html--find-verb-separator code))) (error "FIXME"))) ;;;; Inlinetask (defun org-e-html-format-section (text class &optional id) (let ((extra (concat (when id (format " id=\"%s\"" id))))) (concat (format "
\n" class extra) text "
\n"))) (defun org-e-html-inlinetask (inlinetask contents info) "Transcode an INLINETASK element from Org to HTML. CONTENTS holds the contents of the block. INFO is a plist holding contextual information." (cond ;; If `org-e-html-format-inlinetask-function' is provided, call it ;; with appropriate arguments. ((functionp org-e-html-format-inlinetask-function) (let ((format-function (function* (lambda (todo todo-type priority text tags &key contents &allow-other-keys) (funcall org-e-html-format-inlinetask-function todo todo-type priority text tags contents))))) (org-e-html-format-headline--wrap inlinetask info format-function :contents contents))) ;; Otherwise, use a default template. (t (org-e-html--wrap-label inlinetask (format "
\n%s
\n%s
" (org-e-html-format-headline--wrap inlinetask info) contents))))) ;;;; Italic (defun org-e-html-italic (italic contents info) "Transcode ITALIC from Org to HTML. CONTENTS is the text with italic markup. INFO is a plist holding contextual information." (format (or (cdr (assq 'italic org-e-html-text-markup-alist)) "%s") contents)) ;;;; Item (defun org-e-html-checkbox (checkbox) (case checkbox (on "[X]") (off "[ ]") (trans "[-]") (t ""))) (defun org-e-html-format-list-item (contents type checkbox &optional term-counter-id headline) (let ((checkbox (concat (org-e-html-checkbox checkbox) (and checkbox " ")))) (concat (case type (ordered (let* ((counter term-counter-id) (extra (if counter (format " value=\"%s\"" counter) ""))) (format "" extra))) (unordered (let* ((id term-counter-id) (extra (if id (format " id=\"%s\"" id) ""))) (concat (format "" extra) (when headline (concat headline "
"))))) (descriptive (let* ((term term-counter-id)) (setq term (or term "(no term)")) ;; Check-boxes in descriptive lists are associated to tag. (concat (format "
%s
" (concat checkbox term)) "
")))) (unless (eq type 'descriptive) checkbox) contents (case type (ordered "") (unordered "") (descriptive "
"))))) (defun org-e-html-item (item contents info) "Transcode an ITEM element from Org to HTML. CONTENTS holds the contents of the item. INFO is a plist holding contextual information." (let* ((plain-list (org-export-get-parent item)) (type (org-element-property :type plain-list)) (counter (org-element-property :counter item)) (checkbox (org-element-property :checkbox item)) (tag (let ((tag (org-element-property :tag item))) (and tag (org-export-data tag info))))) (org-e-html-format-list-item contents type checkbox (or tag counter)))) ;;;; Keyword (defun org-e-html-keyword (keyword contents info) "Transcode a KEYWORD element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((key (org-element-property :key keyword)) (value (org-element-property :value keyword))) (cond ((string= key "LATEX") value) ((string= key "INDEX") (format "\\index{%s}" value)) ;; Invisible targets. ((string= key "TARGET") nil) ; FIXME ((string= key "TOC") (let ((value (downcase value))) (cond ((string-match "\\" value) (let ((depth (or (and (string-match "[0-9]+" value) (string-to-number (match-string 0 value))) (plist-get info :with-toc)))) (when (wholenump depth) (org-e-html-toc depth info)))) ((string= "tables" value) "\\listoftables") ((string= "figures" value) "\\listoffigures") ((string= "listings" value) (cond ;; At the moment, src blocks with a caption are wrapped ;; into a figure environment. (t "\\listoffigures"))))))))) ;;;; Latex Environment (defun org-e-html-format-latex (latex-frag processing-type) (let* ((cache-relpath (concat "ltxpng/" (file-name-sans-extension (file-name-nondirectory (buffer-file-name))))) (cache-dir (file-name-directory (buffer-file-name ))) (display-msg "Creating LaTeX Image...")) (with-temp-buffer (insert latex-frag) (org-format-latex cache-relpath cache-dir nil display-msg nil nil processing-type) (buffer-string)))) (defun org-e-html-latex-environment (latex-environment contents info) "Transcode a LATEX-ENVIRONMENT element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (org-e-html--wrap-label latex-environment (let ((processing-type (plist-get info :LaTeX-fragments)) (latex-frag (org-remove-indentation (org-element-property :value latex-environment))) (caption (org-e-html--caption/label-string (org-element-property :caption latex-environment) (org-element-property :name latex-environment) info)) (attr nil) ; FIXME (label (org-element-property :name latex-environment))) (cond ((memq processing-type '(t mathjax)) (org-e-html-format-latex latex-frag 'mathjax)) ((eq processing-type 'dvipng) (let* ((formula-link (org-e-html-format-latex latex-frag processing-type))) (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link)) (org-e-html-format-inline-image (match-string 1 formula-link) caption label attr t)))) (t latex-frag))))) ;;;; Latex Fragment (defun org-e-html-latex-fragment (latex-fragment contents info) "Transcode a LATEX-FRAGMENT object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((latex-frag (org-element-property :value latex-fragment)) (processing-type (plist-get info :LaTeX-fragments))) (case processing-type ((t mathjax) (org-e-html-format-latex latex-frag 'mathjax)) (dvipng (let* ((formula-link (org-e-html-format-latex latex-frag processing-type))) (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link)) (org-e-html-format-inline-image (match-string 1 formula-link))))) (t latex-frag)))) ;;;; Line Break (defun org-e-html-line-break (line-break contents info) "Transcode a LINE-BREAK object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." "
") ;;;; Link (defun org-e-html-link--inline-image (link desc info) "Return HTML code for an inline image. LINK is the link pointing to the inline image. INFO is a plist used as a communication channel." (let* ((type (org-element-property :type link)) (raw-path (org-element-property :path link)) (path (cond ((member type '("http" "https")) (concat type ":" raw-path)) ((file-name-absolute-p raw-path) (expand-file-name raw-path)) (t raw-path))) (parent (org-export-get-parent-element link)) (caption (org-e-html--caption/label-string (org-element-property :caption parent) (org-element-property :name parent) info)) (label (org-element-property :name parent)) ;; Retrieve latex attributes from the element around. (attr (let ((raw-attr (mapconcat #'identity (org-element-property :attr_html parent) " "))) (unless (string= raw-attr "") raw-attr)))) ;; Now clear ATTR from any special keyword and set a default ;; value if nothing is left. (setq attr (if (not attr) "" (org-trim attr))) ;; Return proper string, depending on DISPOSITION. (org-e-html-format-inline-image path caption label attr (org-e-html-standalone-image-p link info)))) (defvar org-e-html-standalone-image-predicate) (defun org-e-html-standalone-image-p (element info &optional predicate) "Test if ELEMENT is a standalone image for the purpose HTML export. INFO is a plist holding contextual information. Return non-nil, if ELEMENT is of type paragraph and it's sole content, save for whitespaces, is a link that qualifies as an inline image. Return non-nil, if ELEMENT is of type link and it's containing paragraph has no other content save for leading and trailing whitespaces. Return nil, otherwise. Bind `org-e-html-standalone-image-predicate' to constrain paragraph further. For example, to check for only captioned standalone images, do the following. \(setq org-e-html-standalone-image-predicate \(lambda \(paragraph\) \(org-element-property :caption paragraph\)\)\) " (let ((paragraph (case (org-element-type element) (paragraph element) (link (and (org-export-inline-image-p element org-e-html-inline-image-rules) (org-export-get-parent element))) (t nil)))) (when paragraph (assert (eq (org-element-type paragraph) 'paragraph)) (when (or (not (and (boundp 'org-e-html-standalone-image-predicate) (functionp org-e-html-standalone-image-predicate))) (funcall org-e-html-standalone-image-predicate paragraph)) (let ((contents (org-element-contents paragraph))) (loop for x in contents with inline-image-count = 0 always (cond ((eq (org-element-type x) 'plain-text) (not (org-string-nw-p x))) ((eq (org-element-type x) 'link) (when (org-export-inline-image-p x org-e-html-inline-image-rules) (= (incf inline-image-count) 1))) (t nil)))))))) (defun org-e-html-link (link desc info) "Transcode a LINK object from Org to HTML. DESC is the description part of the link, or the empty string. INFO is a plist holding contextual information. See `org-export-data'." (let* ((--link-org-files-as-html-maybe (function (lambda (raw-path info) "Treat links to `file.org' as links to `file.html', if needed. See `org-e-html-link-org-files-as-html'." (cond ((and org-e-html-link-org-files-as-html (string= ".org" (downcase (file-name-extension raw-path ".")))) (concat (file-name-sans-extension raw-path) "." (plist-get info :html-extension))) (t raw-path))))) (type (org-element-property :type link)) (raw-path (org-element-property :path link)) ;; Ensure DESC really exists, or set it to nil. (desc (and (not (string= desc "")) desc)) (path (cond ((member type '("http" "https" "ftp" "mailto")) (concat type ":" raw-path)) ((string= type "file") ;; Extract just the file path and strip all other ;; components. (when (string-match "\\(.+\\)::.+" raw-path) (setq raw-path (match-string 1 raw-path))) ;; Treat links to ".org" files as ".html", if needed. (setq raw-path (funcall --link-org-files-as-html-maybe raw-path info)) ;; If file path is absolute, prepend it with protocol ;; component - "file://". (if (not (file-name-absolute-p raw-path)) raw-path (concat "file://" (expand-file-name raw-path)))) (t raw-path))) ;; Extract attributes from parent's paragraph. (attributes (let ((attr (mapconcat 'identity (org-element-property :attr_html (org-export-get-parent-element link)) " "))) (if attr (concat " " attr) ""))) protocol) (cond ;; Image file. ((and (or (eq t org-e-html-inline-images) (and org-e-html-inline-images (not desc))) (org-export-inline-image-p link org-e-html-inline-image-rules)) (org-e-html-link--inline-image link desc info)) ;; Radio target: Transcode target's contents and use them as ;; link's description. ((string= type "radio") (let ((destination (org-export-resolve-radio-link link info))) (when destination (format "%s" (org-export-solidify-link-text path) attributes (org-export-data (org-element-contents destination) info))))) ;; Links pointing to an headline: Find destination and build ;; appropriate referencing command. ((member type '("custom-id" "fuzzy" "id")) (let ((destination (if (string= type "fuzzy") (org-export-resolve-fuzzy-link link info) (org-export-resolve-id-link link info)))) (case (org-element-type destination) ;; ID link points to an external file. (plain-text (assert (org-uuidgen-p path)) (let ((fragment (concat "ID-" path)) ;; Treat links to ".org" files as ".html", if needed. (path (funcall --link-org-files-as-html-maybe destination info))) (format "%s" path fragment attributes (or desc destination)))) ;; Fuzzy link points nowhere. ((nil) (format "%s" (or desc (org-export-data (org-element-property :raw-link link) info)))) ;; Fuzzy link points to an invisible target. (keyword nil) ;; Link points to an headline. (headline (let ((href ;; What href to use? (cond ;; Case 1: Headline is linked via it's CUSTOM_ID ;; property. Use CUSTOM_ID. ((string= type "custom-id") (org-element-property :custom-id destination)) ;; Case 2: Headline is linked via it's ID property ;; or through other means. Use the default href. ((member type '("id" "fuzzy")) (format "sec-%s" (mapconcat 'number-to-string (org-export-get-headline-number destination info) "-"))) (t (error "Shouldn't reach here")))) ;; What description to use? (desc ;; Case 1: Headline is numbered and LINK has no ;; description or LINK's description matches ;; headline's title. Display section number. (if (and (org-export-numbered-headline-p destination info) (or (not desc) (string= desc (org-element-property :raw-value destination)))) (mapconcat 'number-to-string (org-export-get-headline-number destination info) ".") ;; Case 2: Either the headline is un-numbered or ;; LINK has a custom description. Display LINK's ;; description or headline's title. (or desc (org-export-data (org-element-property :title destination) info))))) (format "%s" (org-export-solidify-link-text href) attributes desc))) ;; Fuzzy link points to a target. Do as above. (t (let ((path (org-export-solidify-link-text path)) number) (unless desc (setq number (cond ((org-e-html-standalone-image-p destination info) (org-export-get-ordinal (assoc 'link (org-element-contents destination)) info 'link 'org-e-html-standalone-image-p)) (t (org-export-get-ordinal destination info)))) (setq desc (when number (if (atom number) (number-to-string number) (mapconcat 'number-to-string number "."))))) (format "%s" path attributes (or desc "FIXME"))))))) ;; Coderef: replace link with the reference name or the ;; equivalent line number. ((string= type "coderef") (let ((fragment (concat "coderef-" path))) (format "%s" fragment (format (concat "class=\"coderef\"" " onmouseover=\"CodeHighlightOn(this, '%s');\"" " onmouseout=\"CodeHighlightOff(this, '%s');\"") fragment fragment) attributes (format (org-export-get-coderef-format path desc) (org-export-resolve-coderef path info))))) ;; Link type is handled by a special function. ((functionp (setq protocol (nth 2 (assoc type org-link-protocols)))) (funcall protocol (org-link-unescape path) desc 'html)) ;; External link with a description part. ((and path desc) (format "%s" path attributes desc)) ;; External link without a description part. (path (format "%s" path attributes path)) ;; No path, only description. Try to do something useful. (t (format "%s" desc))))) ;;;; Babel Call ;; Babel Calls are ignored. ;;;; Macro (defun org-e-html-macro (macro contents info) "Transcode a MACRO element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." ;; Use available tools. (org-export-expand-macro macro info)) ;;;; Paragraph (defun org-e-html-paragraph (paragraph contents info) "Transcode a PARAGRAPH element from Org to HTML. CONTENTS is the contents of the paragraph, as a string. INFO is the plist used as a communication channel." (let* ((style nil) ; FIXME (class (cdr (assoc style '((footnote . "footnote") (verse . nil))))) (extra (if class (format " class=\"%s\"" class) "")) (parent (org-export-get-parent paragraph))) (cond ((and (eq (org-element-type parent) 'item) (= (org-element-property :begin paragraph) (org-element-property :contents-begin parent))) ;; leading paragraph in a list item have no tags contents) ((org-e-html-standalone-image-p paragraph info) ;; standalone image contents) (t (format "\n%s

" extra contents))))) ;;;; Plain List (defun org-e-html-begin-plain-list (type &optional arg1) (case type (ordered (format "" (if arg1 ; FIXME (format " start=\"%d\"" arg1) ""))) (unordered "
    ") (descriptive "
    "))) (defun org-e-html-end-plain-list (type) (case type (ordered "") (unordered "
") (descriptive ""))) (defun org-e-html-plain-list (plain-list contents info) "Transcode a PLAIN-LIST element from Org to HTML. CONTENTS is the contents of the list. INFO is a plist holding contextual information." (let* (arg1 ;; FIXME (type (org-element-property :type plain-list)) (attr (mapconcat #'identity (org-element-property :attr_html plain-list) " "))) (org-e-html--wrap-label plain-list (format "%s\n%s%s" (org-e-html-begin-plain-list type) contents (org-e-html-end-plain-list type))))) ;;;; Plain Text (defun org-e-html-convert-special-strings (string) "Convert special characters in STRING to HTML." (let ((all org-e-html-special-string-regexps) e a re rpl start) (while (setq a (pop all)) (setq re (car a) rpl (cdr a) start 0) (while (string-match re string start) (setq string (replace-match rpl t nil string)))) string)) (defun org-e-html-encode-plain-text (text) "Convert plain text characters to HTML equivalent. Possible conversions are set in `org-export-html-protect-char-alist'." (mapc (lambda (pair) (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t))) org-e-html-protect-char-alist) text) (defun org-e-html-plain-text (text info) "Transcode a TEXT string from Org to HTML. TEXT is the string to transcode. INFO is a plist holding contextual information." ;; Protect following characters: <, >, &. (setq text (org-e-html-encode-plain-text text)) ;; Handle quotation marks. (setq text (org-e-html--quotation-marks text info)) ;; Handle special strings. (when (plist-get info :with-special-strings) (setq text (org-e-html-convert-special-strings text))) ;; Handle break preservation if required. (when (plist-get info :preserve-breaks) (setq text (replace-regexp-in-string "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" text))) ;; Return value. text) ;; Planning (defun org-e-html-planning (planning contents info) "Transcode a PLANNING element from Org to HTML. CONTENTS is nil. INFO is a plist used as a communication channel." (let ((span-fmt "%s %s")) (format "

%s

" (mapconcat 'identity (delq nil (list (let ((closed (org-element-property :closed planning))) (when closed (format span-fmt org-closed-string (org-translate-time closed)))) (let ((deadline (org-element-property :deadline planning))) (when deadline (format span-fmt org-deadline-string (org-translate-time deadline)))) (let ((scheduled (org-element-property :scheduled planning))) (when scheduled (format span-fmt org-scheduled-string (org-translate-time scheduled)))))) " ")))) ;;;; Property Drawer (defun org-e-html-property-drawer (property-drawer contents info) "Transcode a PROPERTY-DRAWER element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." ;; The property drawer isn't exported but we want separating blank ;; lines nonetheless. "") ;;;; Quote Block (defun org-e-html-quote-block (quote-block contents info) "Transcode a QUOTE-BLOCK element from Org to HTML. CONTENTS holds the contents of the block. INFO is a plist holding contextual information." (org-e-html--wrap-label quote-block (format "
\n%s
" contents))) ;;;; Quote Section (defun org-e-html-quote-section (quote-section contents info) "Transcode a QUOTE-SECTION element from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((value (org-remove-indentation (org-element-property :value quote-section)))) (when value (format "
\n%s
" value)))) ;;;; Section (defun org-e-html-section (section contents info) "Transcode a SECTION element from Org to HTML. CONTENTS holds the contents of the section. INFO is a plist holding contextual information." (let ((parent (org-export-get-parent-headline section))) ;; Before first headline: no container, just return CONTENTS. (if (not parent) contents ;; Get div's class and id references. (let* ((class-num (+ (org-export-get-relative-level parent info) (1- org-e-html-toplevel-hlevel))) (section-number (mapconcat 'number-to-string (org-export-get-headline-number parent info) "-"))) ;; Build return value. (format "
\n%s
" class-num (or (org-element-property :custom-id parent) section-number) contents))))) ;;;; Radio Target (defun org-e-html-radio-target (radio-target text info) "Transcode a RADIO-TARGET object from Org to HTML. TEXT is the text of the target. INFO is a plist holding contextual information." (let ((id (org-export-solidify-link-text (org-element-property :value radio-target)))) (org-e-html--anchor id text))) ;;;; Special Block (defun org-e-html-special-block (special-block contents info) "Transcode a SPECIAL-BLOCK element from Org to HTML. CONTENTS holds the contents of the block. INFO is a plist holding contextual information." (let ((type (downcase (org-element-property :type special-block)))) (org-e-html--wrap-label special-block (format "\\begin{%s}\n%s\\end{%s}" type contents type)))) ;;;; Src Block (defun org-e-html-src-block (src-block contents info) "Transcode a SRC-BLOCK element from Org to HTML. CONTENTS holds the contents of the item. INFO is a plist holding contextual information." (let* ((lang (org-element-property :language src-block)) (caption (org-element-property :caption src-block)) (label (org-element-property :name src-block)) (caption-str (org-e-html--caption/label-string caption label info)) (attr (mapconcat #'identity (org-element-property :attr_html src-block) " ")) ;; (switches (org-element-property :switches src-block)) (switches nil) ; FIXME (textarea-p (and switches (string-match "-t\\>" switches))) (code (org-e-html-format-code src-block info))) (cond (lang (format "
\n%s%s\n
" (if (not caption) "" (format "" caption-str)) (format "\n
%s
" lang code))) (textarea-p (let ((cols (if (not (string-match "-w[ \t]+\\([0-9]+\\)" switches)) 80 (string-to-number (match-string 1 switches)))) (rows (if (string-match "-h[ \t]+\\([0-9]+\\)" switches) (string-to-number (match-string 1 switches)) (org-count-lines code)))) (format "

\n\n

" cols rows code))) (t (format "
\n%s
" code))))) ;;;; Statistics Cookie (defun org-e-html-statistics-cookie (statistics-cookie contents info) "Transcode a STATISTICS-COOKIE object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((cookie-value (org-element-property :value statistics-cookie))) (format "%s" cookie-value))) ;;;; Strike-Through (defun org-e-html-strike-through (strike-through contents info) "Transcode STRIKE-THROUGH from Org to HTML. CONTENTS is the text with strike-through markup. INFO is a plist holding contextual information." (format (or (cdr (assq 'strike-through org-e-html-text-markup-alist)) "%s") contents)) ;;;; Subscript (defun org-e-html-subscript (subscript contents info) "Transcode a SUBSCRIPT object from Org to HTML. CONTENTS is the contents of the object. INFO is a plist holding contextual information." (format "%s" contents)) ;;;; Superscript (defun org-e-html-superscript (superscript contents info) "Transcode a SUPERSCRIPT object from Org to HTML. CONTENTS is the contents of the object. INFO is a plist holding contextual information." (format "%s" contents)) ;;;; Tabel Cell (defun org-e-html-table-cell (table-cell contents info) "Transcode a TABLE-CELL element from Org to HTML. CONTENTS is nil. INFO is a plist used as a communication channel." (let* ((table-row (org-export-get-parent table-cell)) (table (org-export-get-parent-table table-cell)) (cell-attrs (if (not org-e-html-table-align-individual-fields) "" (format (if (and (boundp 'org-e-html-format-table-no-css) org-e-html-format-table-no-css) " align=\"%s\"" " class=\"%s\"") (org-export-table-cell-alignment table-cell info))))) (when (or (not contents) (string= "" (org-trim contents))) (setq contents " ")) (cond ((and (org-export-table-has-header-p table info) (= 1 (org-export-table-row-group table-row info))) (concat "\n" (format (car org-e-html-table-header-tags) "col" cell-attrs) contents (cdr org-e-html-table-header-tags))) ((and org-e-html-table-use-header-tags-for-first-column (zerop (cdr (org-export-table-cell-address table-cell info)))) (concat "\n" (format (car org-e-html-table-header-tags) "row" cell-attrs) contents (cdr org-e-html-table-header-tags))) (t (concat "\n" (format (car org-e-html-table-data-tags) cell-attrs) contents (cdr org-e-html-table-data-tags)))))) ;;;; Table Row (defun org-e-html-table-row (table-row contents info) "Transcode a TABLE-ROW element from Org to HTML. CONTENTS is the contents of the row. INFO is a plist used as a communication channel." ;; Rules are ignored since table separators are deduced from ;; borders of the current row. (when (eq (org-element-property :type table-row) 'standard) (let* ((first-rowgroup-p (= 1 (org-export-table-row-group table-row info))) (rowgroup-tags (cond ;; Case 1: Row belongs to second or subsequent rowgroups. ((not (= 1 (org-export-table-row-group table-row info))) '("" . "\n")) ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups. ((org-export-table-has-header-p (org-export-get-parent-table table-row) info) '("" . "\n")) ;; Case 2: Row is from first and only row group. (t '("" . "\n"))))) (concat ;; Begin a rowgroup? (when (org-export-table-row-starts-rowgroup-p table-row info) (car rowgroup-tags)) ;; Actual table row (concat "\n" (eval (car org-e-html-table-row-tags)) contents "\n" (eval (cdr org-e-html-table-row-tags))) ;; End a rowgroup? (when (org-export-table-row-ends-rowgroup-p table-row info) (cdr rowgroup-tags)))))) ;;;; Table (defun org-e-html-table-first-row-data-cells (table info) (let ((table-row (org-element-map table 'table-row (lambda (row) (unless (eq (org-element-property :type row) 'rule) row)) info 'first-match)) (special-column-p (org-export-table-has-special-column-p table))) (if (not special-column-p) (org-element-contents table-row) (cdr (org-element-contents table-row))))) (defun org-e-html-table--table.el-table (table info) (when (eq (org-element-property :type table) 'table.el) (require 'table) (let ((outbuf (with-current-buffer (get-buffer-create "*org-export-table*") (erase-buffer) (current-buffer)))) (with-temp-buffer (insert (org-element-property :value table)) (goto-char 1) (re-search-forward "^[ \t]*|[^|]" nil t) (table-generate-source 'html outbuf)) (with-current-buffer outbuf (prog1 (org-trim (buffer-string)) (kill-buffer) ))))) (defun org-e-html-table (table contents info) "Transcode a TABLE element from Org to HTML. CONTENTS is the contents of the table. INFO is a plist holding contextual information." (case (org-element-property :type table) ;; Case 1: table.el table. Convert it using appropriate tools. (table.el (org-e-html-table--table.el-table table info)) ;; Case 2: Standard table. (t (let* ((label (org-element-property :name table)) (caption (org-e-html--caption/label-string (org-element-property :caption table) label info)) (attributes (mapconcat #'identity (org-element-property :attr_html table) " ")) (alignspec (if (and (boundp 'org-e-html-format-table-no-css) org-e-html-format-table-no-css) "align=\"%s\"" "class=\"%s\"")) (table-column-specs (function (lambda (table info) (mapconcat (lambda (table-cell) (let ((alignment (org-export-table-cell-alignment table-cell info))) (concat ;; Begin a colgroup? (when (org-export-table-cell-starts-colgroup-p table-cell info) "\n") ;; Add a column. Also specify it's alignment. (format "\n" (format alignspec alignment)) ;; End a colgroup? (when (org-export-table-cell-ends-colgroup-p table-cell info) "\n")))) (org-e-html-table-first-row-data-cells table info) "\n")))) (table-attributes (let ((table-tag (plist-get info :html-table-tag))) (concat (and (string-match "" table-tag) (match-string 1 table-tag)) (and label (format " id=\"%s\"" (org-export-solidify-link-text label))))))) ;; Remove last blank line. (setq contents (substring contents 0 -1)) ;; FIXME: splice (format "\n%s\n%s\n%s\n" table-attributes (or caption "") (funcall table-column-specs table info) contents))))) ;;;; Target (defun org-e-html-target (target contents info) "Transcode a TARGET object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((id (org-export-solidify-link-text (org-element-property :value target)))) (org-e-html--anchor id))) ;;;; Timestamp (defun org-e-html-timestamp (timestamp contents info) "Transcode a TIMESTAMP object from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (let ((value (org-translate-time (org-element-property :value timestamp)))) (format "%s" value))) ;;;; Underline (defun org-e-html-underline (underline contents info) "Transcode UNDERLINE from Org to HTML. CONTENTS is the text with underline markup. INFO is a plist holding contextual information." (format (or (cdr (assq 'underline org-e-html-text-markup-alist)) "%s") contents)) ;;;; Verbatim (defun org-e-html-verbatim (verbatim contents info) "Transcode VERBATIM from Org to HTML. CONTENTS is nil. INFO is a plist holding contextual information." (format (or (cdr (assq 'verbatim org-e-html-text-markup-alist)) "%s") (org-element-property :value verbatim))) ;;;; Verse Block (defun org-e-html-verse-block (verse-block contents info) "Transcode a VERSE-BLOCK element from Org to HTML. CONTENTS is verse block contents. INFO is a plist holding contextual information." ;; Replace each newline character with line break. Also replace ;; each blank line with a line break. (setq contents (replace-regexp-in-string "^ *\\\\\\\\$" "
\n" (replace-regexp-in-string "\\(\\\\\\\\\\)?[ \t]*\n" "
\n" contents))) ;; Replace each white space at beginning of a line with a ;; non-breaking space. (while (string-match "^[ \t]+" contents) (let* ((num-ws (length (match-string 0 contents))) (ws (let (out) (dotimes (i num-ws out) (setq out (concat out " ")))))) (setq contents (replace-match ws nil t contents)))) (org-e-html--wrap-label verse-block (format "

\n%s

" contents))) ;;; Filter Functions (defun org-e-html-final-function (contents backend info) (if (not org-e-html-pretty-output) contents (with-temp-buffer (nxml-mode) (insert contents) (indent-region (point-min) (point-max)) (buffer-substring-no-properties (point-min) (point-max))))) ;;; Interactive functions ;;;###autoload (defun org-e-html-export-to-html (&optional subtreep visible-only body-only ext-plist pub-dir) "Export current buffer to a HTML file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don't export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only write code between \"\\begin{document}\" and \"\\end{document}\". EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. When optional argument PUB-DIR is set, use it as the publishing directory. Return output file's name." (interactive) (setq debug-on-error t) ; FIXME (let* ((extension (concat "." org-e-html-extension)) (file (org-export-output-file-name extension subtreep pub-dir)) (org-export-coding-system org-e-html-coding-system)) (org-export-to-file 'e-html file subtreep visible-only body-only ext-plist))) ;;; FIXMES, TODOS, FOR REVIEW etc ;;;; org-format-table-html ;;;; org-format-org-table-html ;;;; org-format-table-table-html ;;;; org-table-number-fraction ;;;; org-table-number-regexp ;;;; org-e-html-table-caption-above ;;;; org-e-html-with-timestamp ;;;; org-e-html-html-helper-timestamp ;;;; org-export-as-html-and-open ;;;; org-export-as-html-batch ;;;; org-export-as-html-to-buffer ;;;; org-replace-region-by-html ;;;; org-export-region-as-html ;;;; org-export-as-html ;;;; (org-export-directory :html opt-plist) ;;;; (plist-get opt-plist :html-extension) ;;;; org-e-html-toplevel-hlevel ;;;; org-e-html-special-string-regexps ;;;; org-e-html-inline-images ;;;; org-e-html-inline-image-extensions ;;;; org-e-html-protect-char-alist ;;;; org-e-html-table-use-header-tags-for-first-column ;;;; org-e-html-todo-kwd-class-prefix ;;;; org-e-html-tag-class-prefix ;;;; org-e-html-footnote-separator ;;;; org-export-preferred-target-alist ;;;; org-export-solidify-link-text ;;;; class for anchors ;;;; org-export-with-section-numbers, body-only ;;;; org-export-mark-todo-in-toc ;;;; org-e-html-format-org-link ;;;; (caption (and caption (org-xml-encode-org-text caption))) ;;;; alt = (file-name-nondirectory path) (provide 'org-e-html) ;;; org-e-html.el ends here