5cf769b · typeable/pandoc

git.iko.soy/typeable/pandoc

Modified the HTML writer to add invisible anchors to each section

heading. The anchors are derived form the text of the section heading as described in README. This makes it easy to insert links that jump from one part of a document to another: for example, '[back to the Introduction](#Introduction)'. git-svn-id: https://pandoc.googlecode.com/svn/trunk@246 788f1e2b-df1e-0410-8736-df70ead52e1b

commit5cf769b1cd1d9e76ff5f543aba8b4a15a90b7d88 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateWed 20 Dec 2006, 00:25 (20 years ago) parentc1ebe94

8 files changed+108−6

compare with master

unifiedsplit

README+20 src/Text/Pandoc/Writers/HTML.hs+8−6 tests/s5.basic.html+8 tests/s5.fancy.html+8 tests/s5.fragment.html+3 tests/s5.inserts.html+3 tests/writer.html+29 tests/writer.smart.html+29

README+20

@@ -261,6 +261,26 @@ markdown test suite, type `make test-markdown`.)

261261

262262[standard markdown]: http://daringfireball.net/projects/markdown/syntax

263263

264+## Section Headings

265+

266+Pandoc creates an invisible anchor in front of every HTML section

267+heading. The ID of this anchor is derived from the section heading

268+itself: spaces are converted to underscores, and formatting, links,

269+and other markup are removed. Thus, for example, the source

270+

271+ ## Aristotle's *De Anima*

272+

273+gets converted to HTML as follows:

274+

275+ <a id="Aristotle's_De_Anima"></a>

276+ <h2>Aristotle's <em>De Anima</em></h2>

277+

278+This makes it easy to provide internal links that jump to a particular

279+place in a document. To provide a link to the heading above, for

280+example, just insert:

281+

282+ [Back to Aristotle](#Aristotle's_De_Anima)

283+

264284## Lists

265285

266286Pandoc behaves differently from standard markdown on some "edge

src/Text/Pandoc/Writers/HTML.hs+8−6

@@ -154,12 +154,14 @@ blockToHtml options (OrderedList lst) =

154154 let attribs = if (writerIncremental options) then " class=\"incremental\"" else "" in

155155 "<ol" ++ attribs ++ ">\n" ++ (concatMap (listItemToHtml options) lst) ++ "</ol>\n"

156156blockToHtml options HorizontalRule = "<hr />\n"

157−blockToHtml options (Header level lst) = if ((level > 0) && (level <= 6)) then

158− "<h" ++ (show level) ++ ">" ++

159− (inlineListToHtml options lst) ++

160− "</h" ++ (show level) ++ ">\n"

161− else

162− "<p>" ++ (inlineListToHtml options lst) ++ "</p>\n"

157+blockToHtml options (Header level lst) =

158+ let contents = inlineListToHtml options lst in

159+ let simplify = gsub "<[^>]*>" "" . gsub " " "_" in

160+ if ((level > 0) && (level <= 6))

161+ then "<a id=\"" ++ simplify contents ++ "\"></a>\n" ++

162+ "<h" ++ (show level) ++ ">" ++ contents ++

163+ "</h" ++ (show level) ++ ">\n"

164+ else "<p>" ++ contents ++ "</p>\n"

163165listItemToHtml options list = "<li>" ++ (concatMap (blockToHtml options) list) ++ "</li>\n"

164166

165167-- | Convert list of Pandoc inline elements to HTML.

tests/s5.basic.html+8

@@ -723,18 +723,24 @@ window.onresize = function(){setTimeout('fontScale()', 50);}</script>

723723<div id="currentSlide"></div>

724724<div id="header"></div>

725725<div id="footer">

726+<a id="July_15,_2006"></a>

726727<h1>July 15, 2006</h1>

728+<a id="My_S5_Document"></a>

727729<h2>My S5 Document</h2>

728730</div>

729731</div>

730732<div class="presentation">

731733

732734<div class="slide">

735+<a id="My_S5_Document"></a>

733736<h1>My S5 Document</h1>

737+<a id="Sam_Smith,_Jen_Jones"></a>

734738<h3>Sam Smith, Jen Jones</h3>

739+<a id="July_15,_2006"></a>

735740<h4>July 15, 2006</h4>

736741</div>

737742<div class="slide">

743+<a id="First_slide"></a>

738744<h1>First slide</h1>

739745<ul>

740746<li>first bullet</li>

@@ -742,6 +748,7 @@ window.onresize = function(){setTimeout('fontScale()', 50);}</script>

742748</ul>

743749</div>

744750<div class="slide">

751+<a id="Smarty"></a>

745752<h1>Smarty</h1>

746753<ul class="incremental">

747754<li>"Hello there"</li>

@@ -750,6 +757,7 @@ window.onresize = function(){setTimeout('fontScale()', 50);}</script>

750757</ul>

751758</div>

752759<div class="slide">

760+<a id="Math"></a>

753761<h1>Math</h1>

754762<ul>

755763<li>$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$</li>

tests/s5.fancy.html+8

@@ -1635,18 +1635,24 @@ else

16351635<div id="currentSlide"></div>

16361636<div id="header"></div>

16371637<div id="footer">

1638+<a id="July_15,_2006"></a>

16381639<h1>July 15, 2006</h1>

1640+<a id="My_S5_Document"></a>

16391641<h2>My S5 Document</h2>

16401642</div>

16411643</div>

16421644<div class="presentation">

16431645

16441646<div class="slide">

1647+<a id="My_S5_Document"></a>

16451648<h1>My S5 Document</h1>

1649+<a id="Sam_Smith,_Jen_Jones"></a>

16461650<h3>Sam Smith, Jen Jones</h3>

1651+<a id="July_15,_2006"></a>

16471652<h4>July 15, 2006</h4>

16481653</div>

16491654<div class="slide">

1655+<a id="First_slide"></a>

16501656<h1>First slide</h1>

16511657<ul class="incremental">

16521658<li>first bullet</li>

@@ -1654,6 +1660,7 @@ else

16541660</ul>

16551661</div>

16561662<div class="slide">

1663+<a id="Smarty"></a>

16571664<h1>Smarty</h1>

16581665<ul>

16591666<li>“Hello there”</li>

@@ -1662,6 +1669,7 @@ else

16621669</ul>

16631670</div>

16641671<div class="slide">

1672+<a id="Math"></a>

16651673<h1>Math</h1>

16661674<ul class="incremental">

16671675<li>$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$</li>

tests/s5.fragment.html+3

@@ -1,8 +1,10 @@

1+<a id="First_slide"></a>

12<h1>First slide</h1>

23<ul>

34<li>first bullet</li>

45<li>second bullet</li>

56</ul>

7+<a id="Smarty"></a>

68<h1>Smarty</h1>

79<blockquote>

810<ul>

@@ -11,6 +13,7 @@

1113<li>And 'ellipses'...</li>

1214</ul>

1315</blockquote>

16+<a id="Math"></a>

1417<h1>Math</h1>

1518<ul>

1619<li>$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$</li>

tests/s5.inserts.html+3

@@ -13,11 +13,13 @@ STUFF INSERTED

1313<body>

1414STUFF INSERTED

1515<h1 class="title">My S5 Document</h1>

16+<a id="First_slide"></a>

1617<h1>First slide</h1>

1718<ul>

1819<li>first bullet</li>

1920<li>second bullet</li>

2021</ul>

22+<a id="Smarty"></a>

2123<h1>Smarty</h1>

2224<blockquote>

2325<ul>

@@ -26,6 +28,7 @@ STUFF INSERTED

2628<li>And 'ellipses'...</li>

2729</ul>

2830</blockquote>

31+<a id="Math"></a>

2932<h1>Math</h1>

3033<ul>

3134<li>$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$</li>

tests/writer.html+29

@@ -12,18 +12,28 @@

1212<h1 class="title">Pandoc Test Suite</h1>

1313<p>This is a set of tests for pandoc. Most of them are adapted from John Gruber's markdown test suite.</p>

1414<hr />

15+<a id="Headers"></a>

1516<h1>Headers</h1>

17+<a id="Level_2_with_an_embedded_link"></a>

1618<h2>Level 2 with an <a href="/url">embedded link</a></h2>

19+<a id="Level_3_with_emphasis"></a>

1720<h3>Level 3 with <em>emphasis</em></h3>

21+<a id="Level_4"></a>

1822<h4>Level 4</h4>

23+<a id="Level_5"></a>

1924<h5>Level 5</h5>

25+<a id="Level_1"></a>

2026<h1>Level 1</h1>

27+<a id="Level_2_with_emphasis"></a>

2128<h2>Level 2 with <em>emphasis</em></h2>

29+<a id="Level_3"></a>

2230<h3>Level 3</h3>

2331<p>with no blank line</p>

32+<a id="Level_2"></a>

2433<h2>Level 2</h2>

2534<p>with no blank line</p>

2635<hr />

36+<a id="Paragraphs"></a>

2737<h1>Paragraphs</h1>

2838<p>Here's a regular paragraph.</p>

2939<p>In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. Because a hard-wrapped line in the middle of a paragraph looked like a list item.</p>

@@ -31,6 +41,7 @@

3141<p>There should be a hard line break<br />

3242here.</p>

3343<hr />

44+<a id="Block_Quotes"></a>

3445<h1>Block Quotes</h1>

3546<p>E-mail style:</p>

3647<blockquote>

@@ -79,6 +90,7 @@ here.</p>

7990</blockquote>

8091<p>And a following paragraph.</p>

8192<hr />

93+<a id="Code_Blocks"></a>

8294<h1>Code Blocks</h1>

8395<p>Code:</p>

8496<pre><code>---- (should be four hyphens)

@@ -95,7 +107,9 @@ this code block is indented by one tab

95107These should not be escaped: \$ \\ \> \[ \{

96108</code></pre>

97109<hr />

110+<a id="Lists"></a>

98111<h1>Lists</h1>

112+<a id="Unordered"></a>

99113<h2>Unordered</h2>

100114<p>Asterisks tight:</p>

101115<ul>

@@ -142,6 +156,7 @@ These should not be escaped: \$ \\ \> \[ \{

142156<li><p>Minus 3</p>

143157</li>

144158</ul>

159+<a id="Ordered"></a>

145160<h2>Ordered</h2>

146161<p>Tight:</p>

147162<ol>

@@ -183,6 +198,7 @@ These should not be escaped: \$ \\ \> \[ \{

183198<li><p>Item 3.</p>

184199</li>

185200</ol>

201+<a id="Nested"></a>

186202<h2>Nested</h2>

187203<ul>

188204<li>Tab<ul>

@@ -218,6 +234,7 @@ These should not be escaped: \$ \\ \> \[ \{

218234<li><p>Third</p>

219235</li>

220236</ol>

237+<a id="Tabs_and_spaces"></a>

221238<h2>Tabs and spaces</h2>

222239<ul>

223240<li><p>this is a list item indented with tabs</p>

@@ -232,6 +249,7 @@ These should not be escaped: \$ \\ \> \[ \{

232249</li>

233250</ul>

234251<hr />

252+<a id="HTML_Blocks"></a>

235253<h1>HTML Blocks</h1>

236254<p>Simple block on one line:</p>

237255<div>foo</div>

@@ -307,6 +325,7 @@ Blah

307325

308326<hr class="foo" id="bar">

309327<hr />

328+<a id="Inline_Markup"></a>

310329<h1>Inline Markup</h1>

311330<p>This is <em>emphasized</em>, and so <em>is this</em>.</p>

312331<p>This is <strong>strong</strong>, and so <strong>is this</strong>.</p>

@@ -317,6 +336,7 @@ Blah

317336<p>So is <strong><em>this</em></strong> word.</p>

318337<p>This is code: <code>></code>, <code>$</code>, <code>\</code>, <code>\$</code>, <code><html></code>.</p>

319338<hr />

339+<a id="Smart_quotes,_ellipses,_dashes"></a>

320340<h1>Smart quotes, ellipses, dashes</h1>

321341<p>"Hello," said the spider. "'Shelob' is my name."</p>

322342<p>'A', 'B', and 'C' are letters.</p>

@@ -327,6 +347,7 @@ Blah

327347<p>Dashes between numbers: 5-7, 255-66, 1987-1999.</p>

328348<p>Ellipses...and. . .and . . . .</p>

329349<hr />

350+<a id="LaTeX"></a>

330351<h1>LaTeX</h1>

331352<ul>

332353<li>\cite[22-23]{smith.1899}</li>

@@ -352,6 +373,7 @@ Dog & 2 \\

352373Cat & 1 \\ \hline

353374\end{tabular}</p>

354375<hr />

376+<a id="Special_Characters"></a>

355377<h1>Special Characters</h1>

356378<p>Here is some unicode:</p>

357379<ul>

@@ -383,7 +405,9 @@ Cat & 1 \\ \hline

383405<p>Plus: +</p>

384406<p>Minus: -</p>

385407<hr />

408+<a id="Links"></a>

386409<h1>Links</h1>

410+<a id="Explicit"></a>

387411<h2>Explicit</h2>

388412<p>Just a <a href="/url/">URL</a>.</p>

389413<p><a href="/url/" title="title">URL and title</a>.</p>

@@ -393,6 +417,7 @@ Cat & 1 \\ \hline

393417<p><a href="/url/" title="title with single quotes">URL and title</a></p>

394418<p><script type="text/javascript">h='nowhere.net';n='nobody';e=n+'@'+h;document.write('<a href="mailto:'+e+'">'+'Email link'+'<\/a>');</script><noscript>Email link (nobody [at] nowhere.net)</noscript></p>

395419<p><a href="">Empty</a>.</p>

420+<a id="Reference"></a>

396421<h2>Reference</h2>

397422<p>Foo <a href="/url/">bar</a>.</p>

398423<p>Foo <a href="/url/">bar</a>.</p>

@@ -407,11 +432,13 @@ Cat & 1 \\ \hline

407432</code></pre>

408433<p>Foo <a href="/url/" title="Title with "quotes" inside">bar</a>.</p>

409434<p>Foo <a href="/url/" title="Title with "quote" inside">biz</a>.</p>

435+<a id="With_ampersands"></a>

410436<h2>With ampersands</h2>

411437<p>Here's a <a href="http://example.com/?foo=1&bar=2">link with an ampersand in the URL</a>.</p>

412438<p>Here's a link with an amersand in the link text: <a href="http://att.com/" title="AT&T">AT&T</a>.</p>

413439<p>Here's an <a href="/script?foo=1&bar=2">inline link</a>.</p>

414440<p>Here's an <a href="/script?foo=1&bar=2">inline link in pointy braces</a>.</p>

441+<a id="Autolinks"></a>

415442<h2>Autolinks</h2>

416443<p>With an ampersand: <a href="http://example.com/?foo=1&bar=2">http://example.com/?foo=1&bar=2</a></p>

417444<ul>

@@ -427,11 +454,13 @@ Cat & 1 \\ \hline

427454<pre><code>or here: <http://example.com/>

428455</code></pre>

429456<hr />

457+<a id="Images"></a>

430458<h1>Images</h1>

431459<p>From "Voyage dans la Lune" by Georges Melies (1902):</p>

432460<p><img src="lalune.jpg" title="Voyage dans la Lune" alt="lalune"></p>

433461<p>Here is a movie <img src="movie.jpg" alt="movie"> icon.</p>

434462<hr />

463+<a id="Footnotes"></a>

435464<h1>Footnotes</h1>

436465<p>Here is a footnote reference,<sup class="footnoteRef" id="fnref1"><a href="#fn1">1</a></sup> and another.<sup class="footnoteRef" id="fnref2"><a href="#fn2">2</a></sup> This should <em>not</em> be a footnote reference, because it contains a space.[^my note] Here is an inline note.<sup class="footnoteRef" id="fnref3"><a href="#fn3">3</a></sup></p>

437466<p>This paragraph should not be part of the note, as it is not indented.</p>

tests/writer.smart.html+29

@@ -12,18 +12,28 @@

1212<h1 class="title">Pandoc Test Suite</h1>

1313<p>This is a set of tests for pandoc. Most of them are adapted from John Gruber’s markdown test suite.</p>

1414<hr />

15+<a id="Headers"></a>

1516<h1>Headers</h1>

17+<a id="Level_2_with_an_embedded_link"></a>

1618<h2>Level 2 with an <a href="/url">embedded link</a></h2>

19+<a id="Level_3_with_emphasis"></a>

1720<h3>Level 3 with <em>emphasis</em></h3>

21+<a id="Level_4"></a>

1822<h4>Level 4</h4>

23+<a id="Level_5"></a>

1924<h5>Level 5</h5>

25+<a id="Level_1"></a>

2026<h1>Level 1</h1>

27+<a id="Level_2_with_emphasis"></a>

2128<h2>Level 2 with <em>emphasis</em></h2>

29+<a id="Level_3"></a>

2230<h3>Level 3</h3>

2331<p>with no blank line</p>

32+<a id="Level_2"></a>

2433<h2>Level 2</h2>

2534<p>with no blank line</p>

2635<hr />

36+<a id="Paragraphs"></a>

2737<h1>Paragraphs</h1>

2838<p>Here’s a regular paragraph.</p>

2939<p>In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. Because a hard-wrapped line in the middle of a paragraph looked like a list item.</p>

@@ -31,6 +41,7 @@

3141<p>There should be a hard line break<br />

3242here.</p>

3343<hr />

44+<a id="Block_Quotes"></a>

3445<h1>Block Quotes</h1>

3546<p>E-mail style:</p>

3647<blockquote>

@@ -79,6 +90,7 @@ here.</p>

7990</blockquote>

8091<p>And a following paragraph.</p>

8192<hr />

93+<a id="Code_Blocks"></a>

8294<h1>Code Blocks</h1>

8395<p>Code:</p>

8496<pre><code>---- (should be four hyphens)

@@ -95,7 +107,9 @@ this code block is indented by one tab

95107These should not be escaped: \$ \\ \> \[ \{

96108</code></pre>

97109<hr />

110+<a id="Lists"></a>

98111<h1>Lists</h1>

112+<a id="Unordered"></a>

99113<h2>Unordered</h2>

100114<p>Asterisks tight:</p>

101115<ul>

@@ -142,6 +156,7 @@ These should not be escaped: \$ \\ \> \[ \{

142156<li><p>Minus 3</p>

143157</li>

144158</ul>

159+<a id="Ordered"></a>

145160<h2>Ordered</h2>

146161<p>Tight:</p>

147162<ol>

@@ -183,6 +198,7 @@ These should not be escaped: \$ \\ \> \[ \{

183198<li><p>Item 3.</p>

184199</li>

185200</ol>

201+<a id="Nested"></a>

186202<h2>Nested</h2>

187203<ul>

188204<li>Tab<ul>

@@ -218,6 +234,7 @@ These should not be escaped: \$ \\ \> \[ \{

218234<li><p>Third</p>

219235</li>

220236</ol>

237+<a id="Tabs_and_spaces"></a>

221238<h2>Tabs and spaces</h2>

222239<ul>

223240<li><p>this is a list item indented with tabs</p>

@@ -232,6 +249,7 @@ These should not be escaped: \$ \\ \> \[ \{

232249</li>

233250</ul>

234251<hr />

252+<a id="HTML_Blocks"></a>

235253<h1>HTML Blocks</h1>

236254<p>Simple block on one line:</p>

237255<div>foo</div>

@@ -307,6 +325,7 @@ Blah

307325

308326<hr class="foo" id="bar">

309327<hr />

328+<a id="Inline_Markup"></a>

310329<h1>Inline Markup</h1>

311330<p>This is <em>emphasized</em>, and so <em>is this</em>.</p>

312331<p>This is <strong>strong</strong>, and so <strong>is this</strong>.</p>

@@ -317,6 +336,7 @@ Blah

317336<p>So is <strong><em>this</em></strong> word.</p>

318337<p>This is code: <code>></code>, <code>$</code>, <code>\</code>, <code>\$</code>, <code><html></code>.</p>

319338<hr />

339+<a id="Smart_quotes,_ellipses,_dashes"></a>

320340<h1>Smart quotes, ellipses, dashes</h1>

321341<p>“Hello,” said the spider. “‘Shelob’ is my name.”</p>

322342<p>‘A’, ‘B’, and ‘C’ are letters.</p>

@@ -327,6 +347,7 @@ Blah

327347<p>Dashes between numbers: 5–7, 255–66, 1987–1999.</p>

328348<p>Ellipses…and…and … .</p>

329349<hr />

350+<a id="LaTeX"></a>

330351<h1>LaTeX</h1>

331352<ul>

332353<li>\cite[22-23]{smith.1899}</li>

@@ -352,6 +373,7 @@ Dog & 2 \\

352373Cat & 1 \\ \hline

353374\end{tabular}</p>

354375<hr />

376+<a id="Special_Characters"></a>

355377<h1>Special Characters</h1>

356378<p>Here is some unicode:</p>

357379<ul>

@@ -383,7 +405,9 @@ Cat & 1 \\ \hline

383405<p>Plus: +</p>

384406<p>Minus: -</p>

385407<hr />

408+<a id="Links"></a>

386409<h1>Links</h1>

410+<a id="Explicit"></a>

387411<h2>Explicit</h2>

388412<p>Just a <a href="/url/">URL</a>.</p>

389413<p><a href="/url/" title="title">URL and title</a>.</p>

@@ -393,6 +417,7 @@ Cat & 1 \\ \hline

393417<p><a href="/url/" title="title with single quotes">URL and title</a></p>

395419<p><a href="">Empty</a>.</p>

420+<a id="Reference"></a>

396421<h2>Reference</h2>

397422<p>Foo <a href="/url/">bar</a>.</p>

398423<p>Foo <a href="/url/">bar</a>.</p>

@@ -407,11 +432,13 @@ Cat & 1 \\ \hline

407432</code></pre>

408433<p>Foo <a href="/url/" title="Title with "quotes" inside">bar</a>.</p>

409434<p>Foo <a href="/url/" title="Title with "quote" inside">biz</a>.</p>

435+<a id="With_ampersands"></a>

410436<h2>With ampersands</h2>

411437<p>Here’s a <a href="http://example.com/?foo=1&bar=2">link with an ampersand in the URL</a>.</p>

412438<p>Here’s a link with an amersand in the link text: <a href="http://att.com/" title="AT&T">AT&T</a>.</p>

413439<p>Here’s an <a href="/script?foo=1&bar=2">inline link</a>.</p>

414440<p>Here’s an <a href="/script?foo=1&bar=2">inline link in pointy braces</a>.</p>

441+<a id="Autolinks"></a>

415442<h2>Autolinks</h2>

416443<p>With an ampersand: <a href="http://example.com/?foo=1&bar=2">http://example.com/?foo=1&bar=2</a></p>

417444<ul>

@@ -427,11 +454,13 @@ Cat & 1 \\ \hline

427454<pre><code>or here: <http://example.com/>

428455</code></pre>

429456<hr />

457+<a id="Images"></a>

430458<h1>Images</h1>

431459<p>From “Voyage dans la Lune” by Georges Melies (1902):</p>

432460<p><img src="lalune.jpg" title="Voyage dans la Lune" alt="lalune"></p>

433461<p>Here is a movie <img src="movie.jpg" alt="movie"> icon.</p>

434462<hr />

463+<a id="Footnotes"></a>

435464<h1>Footnotes</h1>

437466<p>This paragraph should not be part of the note, as it is not indented.</p>