Skip to content

Commit 6a25d41

Browse files
progfolioprogfolio
committed
refactor parsing
mel-nodelist: always return a list of nodes as it may be spliced into other templates mel--dom-print, --insert-node: advise dom-print so special tagged specs (:raw, :comment) can be handled mel, mel-write-html: update to use above functions mel-read: rename to mel-load, refactor to delegate to parsers Implement mel-load parsers for txt, Org, md.
1 parent 7832a45 commit 6a25d41

File tree

5 files changed

+266
-181
lines changed

5 files changed

+266
-181
lines changed

‎index.htmel

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
;; -*- lexical-binding: t; -*-
2+
(cl-macrolet
3+
((example (&rest body)
4+
`'((.example
5+
(code ,(format "%S" (macroexp-progn body)))
6+
(p "Returns:")
7+
(pre ,(eval `(progn ,@body) t))))))
8+
`( html [:lang "en"]
9+
(head
10+
(meta[:charset UTF-8])
11+
(link [:rel "stylesheet" :href "https://cdn.simplecss.org/simple.min.css"])
12+
(style "pre { white-space: pre-line; } .center { margin: auto; }")
13+
(title "MEL: Elisp HTML Templating"))
14+
(body
15+
(h1 "MEL: Elisp HTML Templating")
16+
(p.center (img [ :src "./logo.png"
17+
:alt "A honeycomb with the word 'mel' written in honey in the center."]))
18+
(q.center "Short and sweet HTML.")
19+
(h2 "Usage")
20+
,(mel-md "The `mel` function accepts any number of nodes and returns an HTML string."
21+
"Each node is a list of the following form:")
22+
(pre "(TAG [attribute val...] CHILDREN...)")
23+
(h3 "Tags")
24+
,(mel-md "`TAG` must be a symbol staring with the name of an HTML tag.")
25+
,@(example (mel '(h1 "heading")))
26+
(h3 "Classes")
27+
,(mel-md "The `.` separator can be used in a tag symbol name to indicate a class.")
28+
,@(example (mel '(h1.class "heading")))
29+
(p "It may be used multiple times.")
30+
,@(example (mel '(h1.one.two "heading")))
31+
,(mel-md "As a special case, if a tag symbol begins with a `.`, a div tag is implied.")
32+
,@(example (mel '(.class "content")))
33+
(h3 "IDs")
34+
,(mel-md "A single `#` separator can be used to associate an ID with a tag."
35+
"Note that the separator must be escaped with a `\\` in elisp."
36+
"The `@` separator is an alias for `#` which does not need to be escaped.")
37+
,@(example (mel '(h1\#one "heading") '(h2@two "heading")))
38+
(h3 "Attributes")
39+
(p "An optional attribute vector may be added as the second element of a node list."
40+
"Each attribute must be a symbol (optionally a keyword) followed by its value."
41+
"The value will be coerced to its string representation.")
42+
,@(example (mel '(h1 [:one "true" :two false] "heading")))
43+
(h3 "Children")
44+
(p "Any elements of a node specified after the tag and optional attribute vector are the node's children."
45+
"They may be either strings or nodes.")
46+
,@(example (mel '(p "example " (span "text"))))
47+
(h2 "Tempalte Files")
48+
,(mel-md "An `htmel` file must contain an emacs-lisp program."
49+
"When evaluated, the value of the last expression must be a mel spec for an HTML document."
50+
"For example, the source for this page is stored in `[./index.htmel](./index.htmel)`.")
51+
,(mel-md "Content stored in other files can be included via the `mel-load` function.\n")
52+
(h2 "File Inclusion")
53+
,(mel-md "The `mel-load` function can be used to parse and load files into a template."))))

‎index.html

+73-67
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,92 @@
1-
<!DOCTYPE html><html lang="en">
1+
<!DOCTYPE html>
2+
<html lang="en">
23
<head>
34
<meta charset="UTF-8" />
45
<link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css" />
5-
<style>pre { white-space: pre-line; }</style>
6+
<style>pre { white-space: pre-line; } .center { margin: auto; }</style>
67
<title>MEL: Elisp HTML Templating</title>
78
</head>
89
<body>
910
<h1>MEL: Elisp HTML Templating</h1>
1011
<p class="center">
11-
<img src="./logo.png" alt="A honeycomb logo with the word 'mel' written in honey in the center." />
12+
<img src="./logo.png" alt="A honeycomb with the word 'mel' written in honey in the center." />
1213
</p>
13-
<blockquote class="center">&quot;Short and sweet HTML.&quot;</blockquote>
14+
<q class="center">Short and sweet HTML.</q>
1415
<h2>Usage</h2>
15-
<p>The
16-
<code>mel</code> function accepts any number of nodes and returns an HTML string.
17-
Each node is a list of the following form:
18-
</p>
16+
<p>The <code>mel</code> function accepts any number of nodes and returns
17+
an HTML string. Each node is a list of the following form:</p>
18+
1919
<pre>(TAG [attribute val...] CHILDREN...)</pre>
2020
<h3>Tags</h3>
21-
<p>
22-
<code>Tag</code> should be a symbol staring with the name of an HTML tag.
23-
</p>
24-
<code>(mel '(h1 &quot;heading&quot;))</code>
25-
<p>Returns:</p>
26-
<pre>&lt;h1&gt;heading&lt;/h1&gt;
27-
</pre>
21+
<p><code>TAG</code> must be a symbol staring with the name of an HTML
22+
tag.</p>
23+
24+
<div class="example">
25+
<code>(mel '(h1 &quot;heading&quot;))</code>
26+
<p>Returns:</p>
27+
<pre>&lt;h1&gt;heading&lt;/h1&gt;</pre>
28+
</div>
2829
<h3>Classes</h3>
29-
<p>The
30-
<code>.</code> separator can be used in a tag symbol name to indicate a class.
31-
</p>
32-
<code>(mel '(h1.class &quot;heading&quot;))</code>
33-
<p>Returns:</p>
34-
<pre>&lt;h1 class=&quot;class&quot;&gt;heading&lt;/h1&gt;
35-
</pre>
30+
<p>The <code>.</code> separator can be used in a tag symbol name to
31+
indicate a class.</p>
32+
33+
<div class="example">
34+
<code>(mel '(h1.class &quot;heading&quot;))</code>
35+
<p>Returns:</p>
36+
<pre>&lt;h1 class=&quot;class&quot;&gt;heading&lt;/h1&gt;</pre>
37+
</div>
3638
<p>It may be used multiple times.</p>
37-
<code>(mel '(h1.one.two &quot;heading&quot;))</code>
38-
<p>Returns:</p>
39-
<pre>&lt;h1 class=&quot;one two&quot;&gt;heading&lt;/h1&gt;
40-
</pre>
41-
<p>As a special case, if a tag symbol begins with a
42-
<code>.</code>, a div tag is implied.
43-
</p>
44-
<code>(mel '(\.class &quot;content&quot;))</code>
45-
<p>Returns:</p>
46-
<pre>&lt;div class=&quot;class&quot;&gt;content&lt;/div&gt;
47-
</pre>
39+
<div class="example">
40+
<code>(mel '(h1.one.two &quot;heading&quot;))</code>
41+
<p>Returns:</p>
42+
<pre>&lt;h1 class=&quot;one two&quot;&gt;heading&lt;/h1&gt;</pre>
43+
</div>
44+
<p>As a special case, if a tag symbol begins with a <code>.</code>, a
45+
div tag is implied.</p>
46+
47+
<div class="example">
48+
<code>(mel '(\.class &quot;content&quot;))</code>
49+
<p>Returns:</p>
50+
<pre>&lt;div class=&quot;class&quot;&gt;content&lt;/div&gt;</pre>
51+
</div>
4852
<h3>IDs</h3>
49-
<p>A single
50-
<code>#</code> separator can be used to associate an ID with a tag.
51-
Note that the separator must be escaped with a
52-
<code>\</code> in elisp.
53-
The
54-
<code>@</code> separator is an alias for
55-
<code>#</code> which does not need to be escaped.
56-
</p>
57-
<code>(mel '(h1\#one &quot;heading&quot;) '(h2@two &quot;heading&quot;))</code>
58-
<p>Returns:</p>
59-
<pre>&lt;h1 id=&quot;one&quot;&gt;heading&lt;/h1&gt;
60-
&lt;h2 id=&quot;two&quot;&gt;heading&lt;/h2&gt;
61-
</pre>
53+
<p>A single <code>#</code> separator can be used to associate an ID with
54+
a tag. Note that the separator must be escaped with a <code>\</code> in
55+
elisp. The <code>@</code> separator is an alias for <code>#</code> which
56+
does not need to be escaped.</p>
57+
58+
<div class="example">
59+
<code>(mel '(h1\#one &quot;heading&quot;) '(h2@two &quot;heading&quot;))</code>
60+
<p>Returns:</p>
61+
<pre>&lt;h1 id=&quot;one&quot;&gt;heading&lt;/h1&gt;&lt;h2 id=&quot;two&quot;&gt;heading&lt;/h2&gt;</pre>
62+
</div>
6263
<h3>Attributes</h3>
63-
<p>An optional attribute vector may be added as the second element of a node list.
64-
Each attribute must be a symbol (optionally a keyword) followed by its value.
65-
The value will be coerced to its string representation.</p>
66-
<code>(mel '(h1 [:one &quot;true&quot; :two false]))</code>
67-
<p>Returns:</p>
68-
<pre>&lt;h1 one=&quot;true&quot; two=&quot;false&quot; /&gt;
69-
</pre>
64+
<p>An optional attribute vector may be added as the second element of a node list.Each attribute must be a symbol (optionally a keyword) followed by its value.The value will be coerced to its string representation.</p>
65+
<div class="example">
66+
<code>(mel '(h1 [:one &quot;true&quot; :two false] &quot;heading&quot;))</code>
67+
<p>Returns:</p>
68+
<pre>&lt;h1 one=&quot;true&quot; two=&quot;false&quot;&gt;heading&lt;/h1&gt;</pre>
69+
</div>
7070
<h3>Children</h3>
71-
<p>Any elements of a node specified after the tag and optional attribute vector are the node's children. They may be either strings or nodes.</p>
72-
<code>(mel '(p &quot;example &quot; (span &quot;text&quot;)))</code>
73-
<p>Returns:</p>
74-
<pre>&lt;p&gt;example
75-
&lt;span&gt;text&lt;/span&gt;
76-
&lt;/p&gt;
77-
</pre>
78-
<h2>The MEL file format</h2>
79-
<p>A MEL file consists of a body which contains one or more nodes as top-level sexps.
80-
The forms are implicitly backquoted, so elisp may be used within each node via the
81-
<code>,</code> and
82-
<code>,@</code>
83-
<a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Backquote.html">backquote constructs</a>.
84-
</p>
71+
<p>Any elements of a node specified after the tag and optional attribute vector are the node's children.They may be either strings or nodes.</p>
72+
<div class="example">
73+
<code>(mel '(p &quot;example &quot; (span &quot;text&quot;)))</code>
74+
<p>Returns:</p>
75+
<pre>&lt;p&gt;example
76+
&lt;span&gt;text&lt;/span&gt;
77+
&lt;/p&gt;</pre>
78+
</div>
79+
<h2>Tempalte Files</h2>
80+
<p>An <code>htmel</code> file must contain an emacs-lisp program. When
81+
evaluated, the value of the last expression must be a mel spec for an
82+
HTML document. For example, the source for this page is stored in
83+
<code>[./index.htmel](./index.htmel)</code>.</p>
84+
85+
<p>Content stored in other files can be included via the
86+
<code>mel-load</code> function.</p>
87+
88+
<h2>File Inclusion</h2>
89+
<p>The <code>mel-load</code> function can be used to parse and load
90+
files into a template.</p>
8591
</body>
8692
</html>

‎index.mel

-51
This file was deleted.

‎mel-tests.el

+16-16
Original file line numberDiff line numberDiff line change
@@ -33,34 +33,34 @@
3333
(ert-deftest mel-node ()
3434
;;@MAYBE not?
3535
;;(should (equal (mel-node '(p nil)) '(p nil)))
36-
(should (mel-test-equal (mel-node '(p)) '(p nil)))
36+
(should (mel-test-equal (mel-node '(p)) '((p nil))))
3737

38-
(should (mel-test-equal (mel-node '(p.class)) '(p ((class . "class")))))
39-
(should (mel-test-equal (mel-node '(p.class.two)) '(p ((class . "class two")))))
38+
(should (mel-test-equal (mel-node '(p.class)) '((p ((class . "class"))))))
39+
(should (mel-test-equal (mel-node '(p.class.two)) '((p ((class . "class two"))))))
4040

41-
(should (mel-test-equal (mel-node '(p\#id)) '(p ((id . "id")))))
42-
(should (mel-test-equal (mel-node '(p\#id.class)) '(p ((id . "id") (class . "class")))))
41+
(should (mel-test-equal (mel-node '(p\#id)) '((p ((id . "id"))))))
42+
(should (mel-test-equal (mel-node '(p\#id.class)) '((p ((id . "id") (class . "class"))))))
4343
(should-error (mel-node '(p\#id\#again)))
4444

45-
(should (mel-test-equal (mel-node '(p.class\#id)) '(p ((class . "class") (id . "id")))))
46-
(should (mel-test-equal (mel-node '(p.class.two\#id)) '(p ((class . "class two") (id . "id")))))
45+
(should (mel-test-equal (mel-node '(p.class\#id)) '((p ((class . "class") (id . "id"))))))
46+
(should (mel-test-equal (mel-node '(p.class.two\#id)) '((p ((class . "class two") (id . "id"))))))
4747

48-
(should (mel-test-equal (mel-node '(p [attr])) '(p ((attr . "")))))
49-
(should (mel-test-equal (mel-node '(p.mixed [class class])) '(p ((class . "mixed class")))))
50-
(should (mel-test-equal (mel-node '(p.class [class])) '(p ((class . "class")))))
51-
(should (mel-test-equal (mel-node '(p.class [attr])) '(p ((class . "class") (attr . "")))))
52-
(should (mel-test-equal (mel-node '(p.class.two [attr])) '(p ((class . "class two") (attr . "")))))
53-
(should (mel-test-equal (mel-node '(p\#id [attr])) '(p ((id . "id") (attr . "")))))
48+
(should (mel-test-equal (mel-node '(p [attr])) '((p ((attr . ""))))))
49+
(should (mel-test-equal (mel-node '(p.mixed [class class])) '((p ((class . "mixed class"))))))
50+
(should (mel-test-equal (mel-node '(p.class [class])) '((p ((class . "class"))))))
51+
(should (mel-test-equal (mel-node '(p.class [attr])) '((p ((class . "class") (attr . ""))))))
52+
(should (mel-test-equal (mel-node '(p.class.two [attr])) '((p ((class . "class two") (attr . ""))))))
53+
(should (mel-test-equal (mel-node '(p\#id [attr])) '((p ((id . "id") (attr . ""))))))
5454
(should (mel-test-equal (mel-node '(p\#id.class [attr]))
55-
'(p ((id . "id") (class . "class") (attr . "")))))
55+
'((p ((id . "id") (class . "class") (attr . ""))))))
5656

57-
(should (mel-test-equal (mel-node '(p (p))) '(p nil (p nil)))))
57+
(should (mel-test-equal (mel-node '(p (p))) '((p nil (p nil))))))
5858

5959
(defun mel-test-output ()
6060
(interactive)
6161
(with-current-buffer (get-buffer-create "output.html")
6262
(erase-buffer)
63-
(let ((dom (mel-read "/tmp/test.mel" t)))
63+
(let ((dom (mel-load "/tmp/test.mel" t)))
6464
(insert (apply #'mel dom))
6565
(pop-to-buffer (current-buffer)))))
6666

0 commit comments

Comments
 (0)