improved fix for depends_simple_mixup

[git.ikiwiki.info.git] / doc / todo / format_escape.mdwn
diff --git a/doc/todo/format_escape.mdwn b/doc/todo/format_escape.mdwn

index fe16be37b2c805925e425fe12da267ef198bd20f..762f16646f5e195a63aa8c9b6376b45906e7b50c 100644 (file)
--- a/doc/todo/format_escape.mdwn
+++ b/doc/todo/format_escape.mdwn
@@ -76,14 +76,28 @@ which aren't used as real extensions but provide useful intermediate types.
  >> the preprocessed source. This way you can use docutils to convert your
  >> rst documents to other formats. Raw html would be loosed in such a
  >> process (both with directives and marks), which is another
  >> the preprocessed source. This way you can use docutils to convert your
  >> rst documents to other formats. Raw html would be loosed in such a
  >> process (both with directives and marks), which is another
->> argument for "_link" and other intermediate forms. I think I can
+>> argument for `"_link"` and other intermediate forms. I think I can
  >> come up with a way for rst's convert_link to be used only for export
  >> purposes, though.
  
  >> --[[JeremieKoenig]]
  
  >> come up with a way for rst's convert_link to be used only for export
  >> purposes, though.
  
  >> --[[JeremieKoenig]]
  
+> Another problem with this approach is when there is some html (say a
+> table), that contains a wikilink. If the link is left up to the markup
+> lamguage to handle, it will never convert it to a link, since the table
+> will be processed as a chunk of raw html.
+> --[[Joey]]
+
+### Updated patch
+
+I've created an updated [patch](http://www.idletheme.org/code/patches/ikiwiki-format-escapes-rlk-2007-09-24.diff) against the current revision.  No real functionality changes, except for a small test script, one minor bugfix (put a "join" around a scalar-context "map" in convert_link), and some wrangling to get it merged properly; I thought it might be helpful for anyone else who wants to work on the code.
+
+(With that out of the way, I think I'm going to take a stab at Jeremie's plan to use marks which would be replaced post-htmlization.  I've also got an eye towards [[todo/multiple_output_formats]].)
+
+--Ryan Koppenhaver
+
  ## Original patch
  ## Original patch
-[[tag patch]]
+[[!tag patch patch/core plugins/rst]]
  
  <pre>
  Index: debian/changelog
  
  <pre>
  Index: debian/changelog
@@ -127,13 +141,13 @@ Index: IkiWiki/Plugin/rst.pm
   print html[html.find('<body>')+6:html.find('</body>')].strip();
   ";
   
   print html[html.find('<body>')+6:html.find('</body>')].strip();
   ";
   
- sub import { #{{{
+ sub import {
         hook(type => "htmlize", id => "rst", call => \&htmlize);
  +      hook(type => "htmlescape", id => "rst", call => \&htmlescape);
  +      hook(type => "htmlescapelink", id => "rst", call => \&htmlescapelink);
         hook(type => "htmlize", id => "rst", call => \&htmlize);
  +      hook(type => "htmlescape", id => "rst", call => \&htmlescape);
  +      hook(type => "htmlescapelink", id => "rst", call => \&htmlescapelink);
- } # }}}
+ }
   
   
-+sub htmlescapelink ($$;@) { #{{{
++sub htmlescapelink ($$;@) {
  +      my $url = shift;
  +      my $text = shift;
  +      my %params = @_;
  +      my $url = shift;
  +      my $text = shift;
  +      my %params = @_;
@@ -144,15 +158,15 @@ Index: IkiWiki/Plugin/rst.pm
  +      else {
  +              return "`$text <$url>`_";
  +      }
  +      else {
  +              return "`$text <$url>`_";
  +      }
-+} # }}}
++}
  +
  +
-+sub htmlescape ($) { #{{{
++sub htmlescape ($) {
  +      my $html=shift;
  +      $html=~s/^/  /mg;
  +      return ".. raw:: html\n\n".$html;
  +      my $html=shift;
  +      $html=~s/^/  /mg;
  +      return ".. raw:: html\n\n".$html;
-+} # }}}
++}
  +
  +
- sub htmlize (@) { #{{{
+ sub htmlize (@) {
         my %params=@_;
         my $content=$params{content};
  Index: doc/plugins/write.mdwn
         my %params=@_;
         my $content=$params{content};
  Index: doc/plugins/write.mdwn
@@ -204,8 +218,8 @@ Index: doc/plugins/rst.mdwn
   
  -* reStructuredText does not allow raw html to be inserted into
  -  documents, but ikiwiki does so in many cases, including
   
  -* reStructuredText does not allow raw html to be inserted into
  -  documents, but ikiwiki does so in many cases, including
--  [[WikiLinks|WikiLink]] and many
--  [[PreprocessorDirectives|PreprocessorDirective]].
+-  [[WikiLinks|ikiwiki/WikiLink]] and many
+-  [[Directives|ikiwiki/Directive]].
  +* Some bits of ikiwiki may still assume that markdown is used or embed html
  +  in ways that break reStructuredText. (Report bugs if you find any.)
   * It's slow; it forks a copy of python for each page. While there is a
  +* Some bits of ikiwiki may still assume that markdown is used or embed html
  +  in ways that break reStructuredText. (Report bugs if you find any.)
   * It's slow; it forks a copy of python for each page. While there is a
@@ -258,7 +272,7 @@ Index: IkiWiki.pm
  +        return $hooks{htmlescapelink}{$type}{call}->($bestlink, $linktext);
  +      }
         return "<a href=\"$bestlink\">$linktext</a>";
  +        return $hooks{htmlescapelink}{$type}{call}->($bestlink, $linktext);
  +      }
         return "<a href=\"$bestlink\">$linktext</a>";
- } #}}}
+ }
   
  @@ -628,6 +640,14 @@
                                 preview => $preprocess_preview,
   
  @@ -628,6 +640,14 @@
                                 preview => $preprocess_preview,