summaryrefslogtreecommitdiff
path: root/doc/bugs/rst_tweak.mdwn
blob: 8667a459bd7bfd9204e554f3ecf95ba0ecf6f857 (plain)

rst.pm disallows raw HTML input. (It's meant as a security feature.) IkiWiki generates HTML in rst files pretty much all the time. As such, we should enable raw HTML support. --Ethan

[[done]], although I did add a news item about it, since it could break the security of certian setups that don't use the htmlscrubber. --[[Joey]]


Does the Perl version of this plugin still exist? There appears to be no "rst.pm" in the current distribution; all there is is the python version. --Peter

No, only the python version exists. It does have raw_enabled set. --[[Joey]]

I am sorry, but I am confused. Does this mean that I can use Ikiwiki features that translate to HTML in rst files? For example, when I use a [[pagename]]-style link in a rst file, the page generated by Ikiwiki's rst plugin says <a href="./../pagename/">pagename</a> as text. The link is expanded correctly, but the result isn't interpreted as HTML. Is that what is supposed to happen? --Peter

raw_enabled allows you to use the raw directive, but this is not used by ikiwiki for wikilinks or anything else. That's why the [[plugin_page|plugins/rst]] has its note about issues with wikilinks and directives. You'd have to put those inside raw directives yourself to avoid rst escaping their result. --[[Joey]]

You can also create a raw "role" which is at least easier than raw directives.

.. role:: ikiwiki(raw)
   :format: html

:ikiwiki:`\[[WikiLink]]`

A role assigns meaning to interpreted text (for example :acronym:ABC) or :PEP:8. --ulrik [kaizer.se]