1 ;;; org-jsinfo.el --- Support for org-info.js Javascript in Org HTML export
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
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 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; This file implements the support for Sebastian Rose's Javascript
29 ;; org-info.js to display an org-mode file exported to HTML in an
30 ;; Info-like way, or using folding similar to the outline structure
31 ;; org org-mode itself.
33 ;; Documentation for using this module is in the Org manual. The script
34 ;; itself is documented by Sebastian Rose in a file distributed with
35 ;; the script. FIXME: Accurate pointers!
37 ;; Org-mode loads this module by default - if this is not what you want,
38 ;; configure the variable `org-modules'.
44 (add-to-list 'org-export-inbuffer-options-extra
'("INFOJS_OPT" :infojs-opt
))
45 (add-hook 'org-export-options-filters
'org-infojs-handle-options
)
47 (defgroup org-infojs nil
48 "Options specific for using org-info.js in HTML export of Org-mode files."
49 :tag
"Org Export HTML INFOJS"
50 :group
'org-export-html
)
52 (defcustom org-export-html-use-infojs
'when-configured
53 "Should Sebasian Rose's Java Script org-info.js be linked into HTML files?
54 This option can be nil or t to never or always use the script. It can
55 also be the symbol `when-configured', meaning that the script will be
56 linked into the export file if and only if there is a \"#+INFOJS_OPT:\"
57 line in the buffer. See also the variable `org-infojs-options'."
58 :group
'org-export-html
61 (const :tag
"Never" nil
)
62 (const :tag
"When configured in buffer" when-configured
)
63 (const :tag
"Always" t
)))
65 (defconst org-infojs-opts-table
66 '((path PATH
"http://orgmode.org/org-info.js")
68 (toc TOC
:table-of-contents
)
69 (tdepth TOC_DEPTH
"max")
70 (sdepth SECTION_DEPTH
"max")
71 (mouse MOUSE_HINT
"underline")
72 (buttons VIEW_BUTTONS
"0")
75 (home LINK_HOME
:link-home
))
76 "JavaScript options, long form for script, default values.")
78 (defvar org-infojs-options
)
79 (when (and (boundp 'org-infojs-options
)
80 (assq 'runs org-infojs-options
))
81 (setq org-infojs-options
(delq (assq 'runs org-infojs-options
)
84 (defcustom org-infojs-options
85 (mapcar (lambda (x) (cons (car x
) (nth 2 x
)))
86 org-infojs-opts-table
)
87 "Options settings for the INFOJS Javascript.
88 Each of the options must have an entry in `org-export-html/infojs-opts-table'.
89 The value can either be a string that will be passed to the script, or
90 a property. This property is then assumed to be a property that is defined
91 by the Export/Publishing setup of Org.
92 The `sdepth' and `tdepth' parameters can also be set to \"max\", which
93 means to use the maximum value consistent with other options."
96 `(set :greedy t
:inline t
99 (list 'cons
(list 'const
(car x
))
101 (symbol :tag
"Publishing/Export property")
102 (string :tag
"Value"))))
103 org-infojs-opts-table
)))
105 (defcustom org-infojs-template
106 "<script type=\"text/javascript\" language=\"JavaScript\" src=\"%SCRIPT_PATH\"></script>
107 <script type=\"text/javascript\" language=\"JavaScript\">
110 org_html_manager.setup(); // activate after the parameterd are set
113 "The template for the export style additions when org-info.js is used.
114 Option settings will replace the %MANAGER-OPTIONS cookie."
118 (defun org-infojs-handle-options (exp-plist)
119 "Analyze JavaScript options in INFO-PLIST and modify EXP-PLIST accordingly."
120 (if (or (not org-export-html-use-infojs
)
121 (and (eq org-export-html-use-infojs
'when-configured
)
122 (or (not (plist-get exp-plist
:infojs-opt
))
123 (string-match "\\<view:nil\\>"
124 (plist-get exp-plist
:infojs-opt
)))))
125 ;; We do not want to use the script
127 ;; We do want to use the script, set it up
128 (let ((template org-infojs-template
)
129 (ptoc (plist-get exp-plist
:table-of-contents
))
130 (hlevels (plist-get exp-plist
:headline-levels
))
131 tdepth sdepth p1 s p v a1 tmp e opt var val table default
)
134 (if (integerp ptoc
) (setq tdepth
(min ptoc tdepth
)))
135 (setq v
(plist-get exp-plist
:infojs-opt
)
136 table org-infojs-opts-table
)
137 (while (setq e
(pop table
))
138 (setq opt
(car e
) var
(nth 1 e
)
139 default
(cdr (assoc opt org-infojs-options
)))
140 (and (symbolp default
) (not (memq default
'(t nil
)))
141 (setq default
(plist-get exp-plist default
)))
142 (if (string-match (format " %s:\\(\\S-+\\)" opt
) v
)
143 (setq val
(match-string 1 v
))
147 (and (string-match "%SCRIPT_PATH" template
)
148 (setq template
(replace-match val t t template
))))
150 (if (integerp (read val
))
151 (setq sdepth
(min (read val
) hlevels
))))
153 (if (integerp (read val
))
154 (setq tdepth
(min (read val
) hlevels
))))
158 ((or (eq val t
) (equal val
"t")) "1")
159 ((or (eq val nil
) (equal val
"nil")) "0")
161 (t (format "%s" val
))))
162 (push (cons var val
) s
))))
164 ;; Now we set the depth of the *generated* TOC to SDEPTH, because the
165 ;; toc will actually determine the splitting. How much of the toc will
166 ;; actually be displayed is governed by the TDEPTH option.
167 (setq exp-plist
(plist-put exp-plist
:table-of-contents sdepth
))
169 ;; The table of contents should ot show more sections then we generate
170 (setq tdepth
(min tdepth sdepth
))
171 (push (cons "TOC_DEPTH" tdepth
) s
)
174 (lambda (x) (format "org_html_manager.set(\"%s\", \"%s\");"
177 (when (and s
(> (length s
) 0))
178 (and (string-match "%MANAGER_OPTIONS" template
)
179 (setq s
(replace-match s t t template
))
183 (concat (or (plist-get exp-plist
:style
) "") "\n" s
)))))
184 ;; This script absolutely needs the table of contents, to we change that
186 (if (not (plist-get exp-plist
:table-of-contents
))
187 (setq exp-plist
(plist-put exp-plist
:table-of-contents t
)))
188 ;; Return the modified property list
191 (defun org-infojs-options-inbuffer-template ()
192 (format "#+INFOJS_OPT: view:%s toc:%s ltoc:%s mouse:%s buttons:%s path:%s"
193 (if (eq t org-export-html-use-infojs
) (cdr (assoc 'view org-infojs-options
)) nil
)
194 (let ((a (cdr (assoc 'toc org-infojs-options
))))
195 (cond ((memq a
'(nil t
)) a
)
196 (t (plist-get (org-infile-export-plist) :table-of-contents
))))
197 (if (equal (cdr (assoc 'ltoc org-infojs-options
)) "1") t nil
)
198 (cdr (assoc 'mouse org-infojs-options
))
199 (cdr (assoc 'buttons org-infojs-options
))
200 (cdr (assoc 'path org-infojs-options
))))
202 (provide 'org-infojs
)
204 ;; arch-tag: c71d1d85-3337-4817-a066-725e74ac9eac
205 ;;; org-jsinfo.el ends here