1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
;;; kexport.el --- Convert koutlines to other textual formats, including HTML -*- lexical-binding:t -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 26-Feb-98
;;
;; Copyright (C) 1998-2017 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;; Code:
;;; ************************************************************************
;;; Other required Elisp libraries
;;; ************************************************************************
(require 'hypb)
(require 'hpath)
(require 'hibtypes)
(require 'klink)
(declare-function kotl-mode:beginning-of-buffer "kotl-mode")
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defvar kexport:input-filename nil
"This is automatically set to the full pathname of the file presently being exported.")
(defvar kexport:output-filename nil
"This is automatically set to the full pathname of the file presently being exported.")
(defcustom kexport:html-body-attributes
"BGCOLOR=\"#FFFFFF\"" ;; white background
"*String of HTML attributes attached to the <BODY> tag of an HTML exported koutline file."
:type 'string
:group 'hyperbole-koutliner)
(defcustom kexport:html-description
"Created by Hyperbole's outliner.\nSee \"(hyperbole)Koutliner\" for more information."
"*String to insert as the HTML-exported document's description, or nil for none."
:type '(choice (const nil)
(string))
:group 'hyperbole-koutliner)
(defcustom kexport:html-keywords nil
"*String of comma separated keywords to include with an HTML-exported document, or nil for none."
:type '(choice (const nil)
(string))
:group 'hyperbole-koutliner)
(defcustom kexport:label-html-font-attributes
"COLOR=\"#C100C1\" SIZE=\"-1\""
"*String of HTML font attributes attached to kcell labels when exported."
:type 'string
:group 'hyperbole-koutliner)
(defvar kexport:kcell-reference-regexp
"[0-9a-zA-Z][.0-9a-zA-Z]*=\\([.0-9a-zA-Z]+\\)")
(defvar kexport:kcell-partial-reference-regexp
"\\([0-9a-zA-Z][.0-9a-zA-Z]*\\)")
(defvar kexport:html-replacement-alist
(list
;; make <> into literal markup
'("<" . "<")
'(">" . ">")
;;
;; italicize keybindings
'("{[^}]+}" . "<I>\\0</I>")
;;
;; make URLs into hyperlinks
(cons hpath:url-regexp 'kexport:html-url)
;; tightened version of hpath:url-regexp2
(cons
(concat
"<?\\(URL:\\|[^/@]\\|\\`\\|\"\\)\\(\\(\\)\\(\\)\\("
hpath:url-hostnames-regexp
"\\.[^/:@ \t\n\r\"`']+\\)\\(:[0-9]+\\)?\\([/~]\\([^\]\[@ \t\n\r\"`'(){}<>]+[^\]\[@ \t\n\r\"`'(){}<>.,?#!*]\\)*\\)?\\)>?")
'kexport:html-url)
;;
;; make mail addresses into hyperbuttons
(cons mail-address-regexp "<A HREF=\"mailto:\\1\"><I>\\1</I></A>\\2")
;;
;; make klinks into hyperlinks
(cons (concat "<\\s-*@\\s-*" kexport:kcell-reference-regexp
"[^&>]*>")
"<A HREF=\"#k\\1\">\\0</A>")
(cons (format "<\\s-*@\\s-*\\(%s\\)[^=&>]*>"
kexport:kcell-partial-reference-regexp)
"<A HREF=\"#k\\1\">\\0</A>")
(cons (format "<\\s-*\\([^ \t\n\r,<>]+\\)\\s-*,\\s-*%s[^=&>]*>"
kexport:kcell-reference-regexp)
'kexport:html-file-klink)
(cons (format "<\\s-*\\([^ \t\n\r,<>]+\\)\\s-*,\\s-*%s[^=&>]*>"
kexport:kcell-partial-reference-regexp)
'kexport:html-file-klink)
)
"*List of (regexp . replacement-pattern) elements applied in order to the
contents of each kcell from a koutline exported to HTML format. Replacement
pattern may be:
a string with references to regexp's grouping numbers, e.g. \\1, or
a function of one argument (it is passed the string being replaced in)
which returns the modified string. The function may use expressions such
as (match-beginning 1) since the regexp has just been matched against
the target string when it is called.")
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
;;;###autoload
(defun kexport:html (export-from output-to &optional soft-newlines-flag)
"Export a koutline buffer or file in EXPORT-FROM to html format in OUTPUT-TO.
By default, this retains newlines within cells as they are. With optional prefix arg, SOFT-NEWLINES-FLAG,
hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks.
STILL TODO:
Make delimited pathnames into file links (but not if within klinks).
Copy attributes stored in cell 0 and attributes from each cell."
(interactive "fKoutline buffer/file to export: \nFHTML buffer/file to save to: \nP")
;;
(defvar html-mode-hook)
(defvar hm--html-mode-hook)
(defvar psgml-mode-hook)
;; FIXME: These are presumably used to prevent syntax highlighting, but in
;; Emacs they don't exist, so I'm not sure if it means that we have a bug (we
;; need to prevent font-lock for Emacs as well), or rather that Emacs's
;; version of font-lock doesn't get in the way.
(defvar font-lock-auto-fontify)
(defvar font-lock-mode-disable-list)
(defvar font-lock-mode-enable-list)
(let* ((export-buf-name
(cond ((or (bufferp export-from)
(get-buffer export-from))
(buffer-name (get-buffer export-from)))
((get-file-buffer export-from)
(buffer-name (get-file-buffer export-from)))
((stringp export-from)
(buffer-name (find-file-noselect export-from)))
(t (error
"(kexport:html): `%s' is an invalid `export-from' argument" export-from))))
(font-lock-auto-fontify) ;; Prevent syntax highlighting
(font-lock-mode-disable-list '(html-mode))
(font-lock-mode-enable-list)
;; Avoid running user hooks in the destination file.
;; FIXME: There should be a better way to do that than to enumerate
;; the possible modes's hooks.
(html-mode-hook)
(hm--html-mode-hook)
(psgml-mode-hook)
(output-to-buf-name
(cond ((or (bufferp output-to)
(get-buffer output-to))
(buffer-name (get-buffer output-to)))
((get-file-buffer output-to)
(buffer-name (get-file-buffer output-to)))
((stringp output-to)
(buffer-name (find-file-noselect output-to)))
(t (error
"(kexport:html): `%s' is an invalid `output-to' argument" output-to))))
(standard-output (get-buffer output-to-buf-name))
title)
(set-buffer standard-output)
(setq buffer-read-only nil
kexport:output-filename buffer-file-name)
(erase-buffer)
(set-buffer export-buf-name)
(setq kexport:input-filename buffer-file-name)
;; Use the first line of the first cell as the default HTML document title.
(setq title (save-excursion
(kotl-mode:beginning-of-buffer)
(kcell-view:contents)))
(if (string-match "\n" title)
(setq title (substring title 0 (match-beginning 0))))
;; If called interactively, prompt user for the title to use.
(if (called-interactively-p 'interactive)
(setq title (read-string (format "Title for %s: " output-to-buf-name)
title)))
(princ "<HTML><HEAD>\n\n")
(princ "<A ID=\"top\"></A><A ID=\"k0\"></A>\n")
(princ (format "<TITLE>%s</TITLE>\n" title))
(if kexport:html-description
(princ (format "<META ID=\"description\" CONTENT=\"%s\">\n"
kexport:html-description)))
(if kexport:html-keywords
(princ (format "<META ID=\"keywords\" CONTENT=\"%s\">\n"
kexport:html-keywords)))
(princ "</HEAD>\n\n")
(princ (format "<BODY %s>\n\n" kexport:html-body-attributes))
(princ (format "<CENTER><H1>%s</H1></CENTER>\n\n" title))
(let* ((separator
(hypb:replace-match-string
">" (hypb:replace-match-string
"<" (kview:label-separator kview) "<")
">"))
i level label contents)
(kview:map-tree
(lambda (_kview)
(setq level (kcell-view:level)
i level)
(while (> i 1)
(princ "<UL>")
(setq i (1- i)))
(princ "<TABLE><TR>\n")
(setq label (kcell-view:label))
(princ (format "<A ID=\"k%s\"></A>" label))
(princ (format "<A ID=\"k%s\"></A>\n" (kcell-view:idstamp)))
(princ "<TD WIDTH=2% VALIGN=top><PRE>\n")
(princ (format
"<FONT %s>%s%s</FONT></PRE></TD>\n"
kexport:label-html-font-attributes
label separator))
(princ "<TD>")
(setq contents (kcell-view:contents))
(if (string-match "\\`\\([-_$%#@~^&*=+|/A-Za-z0-9 ]+\\):.*\\S-"
contents)
(princ (format "<A ID=\"%s\"></A>"
(substring contents 0 (match-end 1)))))
(setq contents (kexport:html-markup contents))
(if soft-newlines-flag
(princ contents)
(princ "<PRE>") (princ contents) (princ "</PRE>"))
(princ "</TD>\n")
(princ "</TR></TABLE>")
(setq i level)
(while (> i 1)
(princ "</UL>")
(setq i (1- i)))
(terpri) (terpri))
kview t t))
(princ "</BODY></HTML>\n")
(set-buffer standard-output)
(save-buffer)))
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
(defun kexport:html-file-klink (string)
"Convert STRING containing a klink with a file reference to Html format.
Works exclusively within a call to `hypb:replace-match-string'."
(let ((filename (substring string (match-beginning 1)
(match-end 1))))
(if (equal filename (file-name-nondirectory
kexport:input-filename))
"<A HREF=\"#k\\2\">\\0</A>"
(format "<A HREF=\"file://%s#k\\2\">\\0</A>"
(expand-file-name filename
(if kexport:input-filename
(file-name-directory
kexport:input-filename)))))))
(defun kexport:html-markup (string)
"Perform replacements on STRING specified by `kexport:html-replacement-alist'."
(mapc
(lambda (elt)
(setq string (hypb:replace-match-string (car elt) string (cdr elt))))
kexport:html-replacement-alist)
string)
(defun kexport:html-url (string)
"Convert STRING containing a Url to Html format.
Works exclusively within a call to `hypb:replace-match-string'."
(let* ((url (substring string (match-beginning hpath:url-grpn)
(match-end hpath:url-grpn)))
(last-str-char (length string))
(last-url-char (length url)))
(while (memq (aref url (1- last-url-char))
'(?. ?, ?? ?# ?! ?* ?\( ?\)))
(setq last-url-char (1- last-url-char)))
(while (memq (aref string (1- last-str-char))
'(?. ?, ?? ?# ?! ?* ?\( ?\)))
(setq last-str-char (1- last-str-char)))
(format "<A HREF=\"%s\">%s</A>%s"
(substring url 0 last-url-char)
(substring string (match-beginning 0) last-str-char)
(substring string last-str-char))))
(provide 'kexport)
;;; kexport.el ends here
|
