raw escape with roles

[ikiwiki.git] / doc / bugs / rst_tweak.mdwn

diff --git a/doc/bugs/rst_tweak.mdwn b/doc/bugs/rst_tweak.mdwn
index 9d433e24e1a41b82a60c4b3bdae709dca66f5b25..8667a459bd7bfd9204e554f3ecf95ba0ecf6f857 100644 (file)
--- a/doc/bugs/rst_tweak.mdwn
+++ b/doc/bugs/rst_tweak.mdwn
@@ -41,3 +41,12 @@ what is supposed to happen? --Peter
 > 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]