web commit by http://jeremie.koenig.myopenid.com/: whoops
[ikiwiki.git] / doc / todo / format_escape.mdwn
1 Since some preprocessor directives insert raw HTML, it would be good to 
2 specify, per-format, how to pass HTML so that it goes through the format 
3 OK. With Markdown we cross our fingers; with reST we use the "raw" 
4 directive.
5
6 I added an extra named parameter to the htmlize hook, which feels sort of
7 wrong, since none of the other hooks take parameters. Let me know what 
8 you think. --Ethan
9
10 Seems fairly reasonable, actually. Shouldn't the `$type` come from `$page`
11 instead of `$destpage` though? Only other obvious change is to make the
12 escape parameter optional, and only call it if set. --[[Joey]]
13
14 > I couldn't figure out what to make it from, but thinking it through, 
15 > yeah, it should be $page. Revised patch follows. --Ethan
16
17 >> I've updated the patch some more, but I think it's incomplete. ikiwiki
18 >> emits raw html when expanding WikiLinks too, and it would need to escape
19 >> those. Assuming that escaping html embedded in the middle of a sentence
20 >> works.. --[[Joey]]
21
22 >>> Revised again. I get around this by making another hook, htmlescapelink,
23 >>> which is called to generate links in whatever language. In addition, it 
24 >>> doesn't (can't?) generate
25 >>> spans, and it doesn't handle inlineable image links. If these were 
26 >>> desired, the approach to take would probably be to use substitution
27 >>> definitions, which would require generating two bits of code for each
28 >>> link/html snippet, and putting one at the end of the paragraph (or maybe
29 >>> the document?).
30 >>> To specify that (for example) Discussion links are meant to be HTML and
31 >>> not rst or whatever, I added a "genhtml" parameter to htmllink. It seems
32 >>> to work -- see <http://ikidev.betacantrips.com/blah.html> for an example.
33 >>> --Ethan
34
35 ## Alternative solution
36
37 [Here](http://www.jk.fr.eu.org/ikiwiki/format-escapes-2.diff) is a patch
38 largely inspired from the one below, which is up to date and written with
39 [[todo/multiple_output_formats]] in mind. "htmlize" hooks are generalized
40 to "convert" ones, which can be registered for any pair of filename
41 extensions.
42
43 Preprocessor directives are allowed to return the content to be inserted
44 as a hash, in any format they want, provided they provide htmlize hooks for it.
45 Pseudo filename extensions (such as `"_link"`) can also be introduced,
46 which aren't used as real extensions but provide useful intermediate types.
47
48 --[[JeremieKoenig]]
49
50 > Wow, this is in many ways a beautiful patch. I did notice one problem,
51 > if a link is converted to rst and then from there to a hyperlink, the
52 > styling info usially added to such a link is lost. I wonder if it would
53 > be better to lose _link stuff and just create link html that is fed into
54 > the rst,html converter. Other advantage to doing that is that link
55 > creation has a rather complex interface, with selflink, attrs, url, and
56 > content parameters.
57
58 > --[[Joey]]
59
60 >> Thanks for the compliment. I must confess that I'm not too familiar with
61 >> rst. I am using this todo item somewhat as a pretext to get the conversion
62 >> stuff in, which I need to implement some other stuff. As a result I was
63 >> less careful with the rst plugin than with the rest of the patch.
64 >> I just updated the patch to fix some other problems which I found with
65 >> more testing, and document the current limitations.
66
67 >> Rst cannot embed raw html in the middle of a paragraph, which is why
68 >> "_link" was necessary. Rst links are themselves tricky and can't be made to
69 >> work inside of words without knowledge about the context.
70 >> Both problems could be fixed by inserting marks instead of the html/link,
71 >> which would be replaced at a later stage (htmlize, format), somewhat
72 >> similiar to the way the toc plugin works. When I get more time I will
73 >> try to fix the remaining glitches this way.
74
75 >> Also, I think it would be useful if ikiwiki had an option to export
76 >> the preprocessed source. This way you can use docutils to convert your
77 >> rst documents to other formats. Raw html would be loosed in such a
78 >> process (both with directives and marks), which is another
79 >> argument for `"_link"` and other intermediate forms. I think I can
80 >> come up with a way for rst's convert_link to be used only for export
81 >> purposes, though.
82
83 >> --[[JeremieKoenig]]
84
85 ## Original patch
86 [[tag patch]]
87
88 <pre>
89 Index: debian/changelog
90 ===================================================================
91 --- debian/changelog    (revision 3197)
92 +++ debian/changelog    (working copy)
93 @@ -24,6 +24,9 @@
94      than just a suggests, since OpenID is enabled by default.
95    * Fix a bug that caused link(foo) to succeed if page foo did not exist.
96    * Fix tags to page names that contain special characters.
97 +  * Based on a patch by Ethan, add a new htmlescape hook, that is called
98 +    when a preprocssor directive emits inline html. The rst plugin uses this
99 +    hook to support inlined raw html.
100  
101    [ Josh Triplett ]
102    * Use pngcrush and optipng on all PNG files.
103 Index: IkiWiki/Render.pm
104 ===================================================================
105 --- IkiWiki/Render.pm   (revision 3197)
106 +++ IkiWiki/Render.pm   (working copy)
107 @@ -96,7 +96,7 @@
108                 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
109                    (length $config{cgiurl} ||
110                     exists $links{$page."/".$discussionlink})) {
111 -                       $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), noimageinline => 1, forcesubpage => 1));
112 +                       $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), noimageinline => 1, forcesubpage => 1, genhtml => 1));
113                         $actions++;
114                 }
115         }
116 Index: IkiWiki/Plugin/rst.pm
117 ===================================================================
118 --- IkiWiki/Plugin/rst.pm       (revision 3197)
119 +++ IkiWiki/Plugin/rst.pm       (working copy)
120 @@ -30,15 +30,36 @@
121  html = publish_string(stdin.read(), writer_name='html', 
122         settings_overrides = { 'halt_level': 6, 
123                                'file_insertion_enabled': 0,
124 -                              'raw_enabled': 0 }
125 +                              'raw_enabled': 1 }
126  );
127  print html[html.find('<body>')+6:html.find('</body>')].strip();
128  ";
129  
130  sub import { #{{{
131         hook(type => "htmlize", id => "rst", call => \&htmlize);
132 +       hook(type => "htmlescape", id => "rst", call => \&htmlescape);
133 +       hook(type => "htmlescapelink", id => "rst", call => \&htmlescapelink);
134  } # }}}
135  
136 +sub htmlescapelink ($$;@) { #{{{
137 +       my $url = shift;
138 +       my $text = shift;
139 +       my %params = @_;
140 +
141 +       if ($params{broken}){
142 +               return "`? <$url>`_\ $text";
143 +       }
144 +       else {
145 +               return "`$text <$url>`_";
146 +       }
147 +} # }}}
148 +
149 +sub htmlescape ($) { #{{{
150 +       my $html=shift;
151 +       $html=~s/^/  /mg;
152 +       return ".. raw:: html\n\n".$html;
153 +} # }}}
154 +
155  sub htmlize (@) { #{{{
156         my %params=@_;
157         my $content=$params{content};
158 Index: doc/plugins/write.mdwn
159 ===================================================================
160 --- doc/plugins/write.mdwn      (revision 3197)
161 +++ doc/plugins/write.mdwn      (working copy)
162 @@ -121,6 +121,26 @@
163  The function is passed named parameters: "page" and "content" and should
164  return the htmlized content.
165  
166 +### htmlescape
167 +
168 +       hook(type => "htmlescape", id => "ext", call => \&htmlescape);
169 +
170 +Some markup languages do not allow raw html to be mixed in with the markup
171 +language, and need it to be escaped in some way. This hook is a companion
172 +to the htmlize hook, and is called when ikiwiki detects that a preprocessor
173 +directive is inserting raw html. It is passed the chunk of html in
174 +question, and should return the escaped chunk.
175 +
176 +### htmlescapelink
177 +
178 +       hook(type => "htmlescapelink", id => "ext", call => \&htmlescapelink);
179 +
180 +Some markup languages have special syntax to link to other pages. This hook
181 +is a companion to the htmlize and htmlescape hooks, and it is called when a
182 +link is inserted. It is passed the target of the link and the text of the 
183 +link, and an optional named parameter "broken" if a broken link is being
184 +generated. It should return the correctly-formatted link.
185 +
186  ### pagetemplate
187  
188         hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
189 @@ -355,6 +375,7 @@
190  * forcesubpage  - set to force a link to a subpage
191  * linktext - set to force the link text to something
192  * anchor - set to make the link include an anchor
193 +* genhtml - set to generate HTML and not escape for correct format
194  
195  #### `readfile($;$)`
196  
197 Index: doc/plugins/rst.mdwn
198 ===================================================================
199 --- doc/plugins/rst.mdwn        (revision 3197)
200 +++ doc/plugins/rst.mdwn        (working copy)
201 @@ -10,10 +10,8 @@
202  Note that this plugin does not interoperate very well with the rest of
203  ikiwiki. Limitations include:
204  
205 -* reStructuredText does not allow raw html to be inserted into
206 -  documents, but ikiwiki does so in many cases, including
207 -  [[WikiLinks|WikiLink]] and many
208 -  [[PreprocessorDirectives|PreprocessorDirective]].
209 +* Some bits of ikiwiki may still assume that markdown is used or embed html
210 +  in ways that break reStructuredText. (Report bugs if you find any.)
211  * It's slow; it forks a copy of python for each page. While there is a
212    perl version of the reStructuredText processor, it is not being kept in
213    sync with the standard version, so is not used.
214 Index: IkiWiki.pm
215 ===================================================================
216 --- IkiWiki.pm  (revision 3197)
217 +++ IkiWiki.pm  (working copy)
218 @@ -469,6 +469,10 @@
219         my $page=shift; # the page that will contain the link (different for inline)
220         my $link=shift;
221         my %opts=@_;
222 +       # we are processing $lpage and so we need to format things in accordance
223 +       # with the formatting language of $lpage. inline generates HTML so links
224 +       # will be escaped seperately.
225 +       my $type=pagetype($pagesources{$lpage});
226  
227         my $bestlink;
228         if (! $opts{forcesubpage}) {
229 @@ -494,12 +498,17 @@
230         }
231         if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
232                 return $linktext unless length $config{cgiurl};
233 -               return "<span><a href=\"".
234 -                       cgiurl(
235 -                               do => "create",
236 -                               page => pagetitle(lc($link), 1),
237 -                               from => $lpage
238 -                       ).
239 +               my $url = cgiurl(
240 +                                do => "create",
241 +                                page => pagetitle(lc($link), 1),
242 +                                from => $lpage
243 +                               );
244 +
245 +               if ($hooks{htmlescapelink}{$type} && ! $opts{genhtml}){
246 +                       return $hooks{htmlescapelink}{$type}{call}->($url, $linktext,
247 +                                                              broken => 1);
248 +               }
249 +               return "<span><a href=\"". $url.
250                         "\">?</a>$linktext</span>"
251         }
252         
253 @@ -514,6 +523,9 @@
254                 $bestlink.="#".$opts{anchor};
255         }
256  
257 +       if ($hooks{htmlescapelink}{$type} && !$opts{genhtml}) {
258 +         return $hooks{htmlescapelink}{$type}{call}->($bestlink, $linktext);
259 +       }
260         return "<a href=\"$bestlink\">$linktext</a>";
261  } #}}}
262  
263 @@ -628,6 +640,14 @@
264                                 preview => $preprocess_preview,
265                         );
266                         $preprocessing{$page}--;
267 +
268 +                       # Handle escaping html if the htmlizer needs it.
269 +                       if ($ret =~ /[<>]/ && $pagesources{$page}) {
270 +                               my $type=pagetype($pagesources{$page});
271 +                               if ($hooks{htmlescape}{$type}) {
272 +                                       return $hooks{htmlescape}{$type}{call}->($ret);
273 +                               }
274 +                       }
275                         return $ret;
276                 }
277                 else {
278 </pre>