ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / Support__47__Switch_to_MultiMarkdown.mdwn
1 Supporting or switching to MultiMarkdown would take care of a few of the outstanding feature requests. Quoting from the MultiMarkdown site:
2
3 >MultiMarkdown is a modification of John Gruber's original Markdown.pl file. It uses the same basic syntax, with several additions:
4
5 >   1.  I have added a basic metadata feature, to allow the inclusion of
6 >       metadata within a document that can be used in different ways based
7 >       on the output format.
8
9 >   2.  I have allowed the automatic use of cross-references within a Markdown
10 >       document.  For instance, you can easily jump to
11 >       [the Introduction][Introduction].
12
13 >   3.  I have incorporated John's proposed syntax for footnotes. Since he
14 >       has not determined the output format, I created my own.  Mainly, I 
15 >       wanted to be able to add footnotes to the LaTeX output; I was less 
16 >       concerned with the XHTML formatting.
17
18 >   4.  Most importantly, however, I have changed the way that the processed 
19 >       output is created, so that it is quite simple to export Markdown syntax
20 >       to a variety of outputs.  By setting the `Format` metadata to `complete`,
21 >       you generate a well-formed XHTML page.  You can then use XSLT to convert
22 >       to virtually any format you like.
23
24 MultiMarkdown would solve the BibTex request and the multiple output formats would make the print_link request an easy fix. MultiMarkdown is actively developed and can be found at:
25
26 [MultiMarkdown Homepage](http://fletcher.freeshell.org/wiki/MultiMarkdown)
27
28 > I don't think MultiMarkdown solves [[the_BibTeX_request|todo/BibTeX]], but it might solve the request for LaTeX output. --[[JoshTriplett]]
29
30 > Unless there's a way to disable a zillion of the features, please **no**. Do _not_ switch to it. One thing that I like about markdown as opposed to most other ASCII markup languages, is that it has at least a bit of moderation on the syntax (although it could be even simpler). There's not a yet another reserved character lurking behind every corner. Not so in multimarkdown anymore. Footnotes, bibliography and internal references I could use, and they do not add any complex syntax: it's all inside the already reserved sequences of bracketed stuff. (If you can even say that ASCII markup languages have reserved sequences, as they randomly decide to interpret stuff, never actually failing on illegal input, like a proper language to write any serious documentation in, would do.) But tables, math, and so on, no thanks! Too much syntax! Syntax overload! Bzzzt! I don't want mischievous syntaxes lurking behind every corner, out to get me. --[[tuomov]]
31
32 > ikiwiki already supports MultiMarkdown, since it has the same API as MarkDown. So if you install it as Markdown.pm (or as /usr/bin/markdown), it should Just Work. It would also be easy to support some other extension such as mmdwn to use multimarkdown installed as MuliMarkdown.pm, if someone wanted to do that for some reason -- just copy the mdwn plugin and lightly modify. --[[Joey]]
33
34 > There's now a multimarkdown setup file option that uses
35 > Text::MultiMarkdown for .mdwn files. [[done]] --[[Joey]]