web commit by http://ethan.betacantrips.com/: document the issue
[ikiwiki] / doc / plugins / rst / discussion.mdwn
1 The main problem with more sophisticated RST support is that ikiwiki turns 
2 preprocessor directives into raw HTML and reST hates inline HTML.
3 inline relies on Markdown's handling of raw HTML, specifically
4 that it doesn't wrap paragraph-level `<div>`s in `<p>` tags -- see 
5 [[todo/htmlvalidation]]. Other plugins might expect their output to be 
6 interpreted in certain ways too -- [[Joey]] mentions toggleable and fortune.
7
8 Is [prest][1] the perl version of the reST processor referred to in the text?
9 It seems to be reasonably well-maintained to me, and differences between it and
10 "standard" reST are pretty minor. A fairly exhaustive list, taken from the 
11 prest docs, follows:
12
13 [1]: http://search.cpan.org/~nodine/Text-Restructured-0.003024/
14
15 An exhaustive list of differences between prest and "standard" reST follows:
16
17 * fewer alternatives for bullet lists (only "+", "*" and "-")
18 * escaped colons are not allowed in field names
19 * RCS keyword processing is only activated on "recognized bibliographic 
20     field names"
21 * multiple consecutive blockquotes seperated by attributions may not be allowed 
22     (not sure; text could be interpreted either way)
23 * a warning about auto-symbol footnotes is missing (maybe it's not relevant?)
24 * colons are allowed within hyperlink reference names
25 * inline markup can be nested
26 * some directives are missing (epigraph, highlights, pull quote, date) and 
27     some have been added (MathML, code execution (disabled by default), enscript)
28 * container directive now uses "class" instead of "classes"
29 * csv directive doesn't require csv.py
30 * references directive doesn't allow options
31
32 There may be a few others; my eyes glazed over. --Ethan