doc/patchqueue/index.html_allowed.mdwn

   1 Instead of having files foo.html "in front of" foo/, I prefer to have foo/index.html. This patch allows that. Specifically, foo/index.type is translated to $links{'foo/'}, and bestlink looks for either "foo" or "foo/" when linking to pages. There are other miscellaneous changes that go with that:
   2
   3 1. change the `cgi_editpage` `@page_locs` code so that creating foo from a/b/c prefers a/b/foo and then a/b/c/foo, but if creating foo from a/b/c/, then prefer a/b/c/foo. I'm not really sure why the original was doing what it did (why trim terminal `/` if no pages end in `/`?), so this part might break something.
   4 2. backlinks from "foo/bar" to "foo/" trim common prefixes as long as there would be something left when the trimming is done (i.e. don't trim "foo/")
   5 3. parentlinks for "foo/" are the same as for "foo", except one directory higher
   6 4. rewrite parentlinks so that bestlink is called at each level
   7 5. basename("foo/") => basename("foo")
   8 6. links to "foo/" are translated to "foo/index.html" rather than "foo/.html". (Links to "foo/" might be preferred, but that causes an infinite loop in writefile, because apparently dirname("foo/") == "foo/" on my system for reasons that aren't clear to me.)
   9 7. pagetitle("foo/") => pagetitle("foo")
  10
  11 In case whitespace gets garbled, I'm also leaving a copy of the patch on [my site](http://ikidev.betacantrips.com/patches/index.patch). It should apply cleanly to a freshly unpacked ikiwiki-1.40. You can also see it in action [here](http://ikidev.betacantrips.com/one/). --Ethan
  12
  13     diff -urx .svn -x doc -x '*.po' -x '*.pot' ikiclean/IkiWiki/CGI.pm ikidev/IkiWiki/CGI.pm
  14     --- ikiclean/IkiWiki/CGI.pm 2007-01-17 22:11:41.794805000 -0800
  15     +++ ikidev/IkiWiki/CGI.pm   2007-01-17 21:43:33.750363000 -0800
  16     @@ -400,8 +400,8 @@
  17                                 @page_locs=$best_loc=$page;
  18                         }
  19                         else {
  20     -                           my $dir=$from."/";
  21     -                           $dir=~s![^/]+/+$!!;
  22     +                           my $dir=$from;
  23     +                           $dir=~s![^/]+$!!;
  24
  25                                 if ((defined $form->field('subpage') && length $form->field('subpage')) ||
  26                                     $page eq gettext('discussion')) {
  27     @@ -412,7 +412,9 @@
  28                                 }
  29
  30                                 push @page_locs, $dir.$page;
  31     -                           push @page_locs, "$from/$page";
  32     +                           if ($dir ne $from){ # i.e. $from not a directory
  33     +                                   push @page_locs, "$from/$page";
  34     +                           }
  35                                 while (length $dir) {
  36                                         $dir=~s![^/]+/+$!!;
  37                                         push @page_locs, $dir.$page;
  38     diff -urx .svn -x doc -x '*.po' -x '*.pot' ikiclean/IkiWiki/Render.pm ikidev/IkiWiki/Render.pm
  39     --- ikiclean/IkiWiki/Render.pm      2007-01-11 15:01:51.000000000 -0800
  40     +++ ikidev/IkiWiki/Render.pm        2007-01-17 22:25:13.526856000 -0800
  41     @@ -40,6 +40,7 @@
  42                 my $dir;
  43                 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
  44                         defined $dir &&
  45     +                   $p_trimmed=~m/^\Q$dir\E(?:.)/ &&
  46                         $p_trimmed=~s/^\Q$dir\E// &&
  47                         $page_trimmed=~s/^\Q$dir\E//;
  48
  49     @@ -57,10 +58,18 @@
  50         my $path="";
  51         my $skip=1;
  52         return if $page eq 'index'; # toplevel
  53     -   foreach my $dir (reverse split("/", $page)) {
  54     +   if ($page =~ m{/$}){
  55     +           $page =~ s{/$}{};
  56     +           $path="../";
  57     +   }
  58     +
  59     +   while ($page =~ m!([^/]+)$!) {
  60     +           my $last = $1;
  61     +           $page =~ s!/?[^/]+$!!;
  62                 if (! $skip) {
  63                         $path.="../";
  64     -                   unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
  65     +                   my $target = abs2rel(htmlpage(bestlink($page, $last)), $page);
  66     +                   unshift @ret, { url => $path.$target, page => pagetitle($last) };
  67                 }
  68                 else {
  69                         $skip=0;
  70     diff -urx .svn -x doc -x '*.po' -x '*.pot' ikiclean/IkiWiki.pm ikidev/IkiWiki.pm
  71     --- ikiclean/IkiWiki.pm     2007-01-12 12:47:09.000000000 -0800
  72     +++ ikidev/IkiWiki.pm       2007-01-15 16:56:58.973680000 -0800
  73     @@ -185,6 +185,7 @@
  74      sub basename ($) { #{{{
  75         my $file=shift;
  76
  77     +   $file=~s!/$!!;
  78         $file=~s!.*/+!!;
  79         return $file;
  80      } #}}}
  81     @@ -211,12 +212,14 @@
  82         my $type=pagetype($file);
  83         my $page=$file;
  84         $page=~s/\Q.$type\E*$// if defined $type;
  85     +   $page=~s#index$## if $page=~m{/index$};
  86         return $page;
  87      } #}}}
  88
  89      sub htmlpage ($) { #{{{
  90         my $page=shift;
  91
  92     +   return $page."index.html" if $page=~m{/$};
  93         return $page.".html";
  94      } #}}}
  95
  96     @@ -300,6 +303,7 @@
  97         my $page=shift;
  98         my $link=shift;
  99
 100     +   $page =~ s!/$!!;
 101         my $cwd=$page;
 102         if ($link=~s/^\/+//) {
 103                 # absolute links
 104     @@ -314,6 +318,9 @@
 105                 if (exists $links{$l}) {
 106                         return $l;
 107                 }
 108     +           if (exists $links{$l.'/'}){
 109     +                   return $l.'/';
 110     +           }
 111                 elsif (exists $pagecase{lc $l}) {
 112                         return $pagecase{lc $l};
 113                 }
 114     @@ -344,6 +351,7 @@
 115                 $page=~s/__(\d+)__/&#$1;/g;
 116         }
 117         $page=~y/_/ /;
 118     +   $page=~s!/$!!;
 119
 120         return $page;
 121      } #}}}
 122
 123 I independently implemented a similar, but smaller patch.
 124 (It's smaller because I only care about rendering; not CGI, for example.)
 125 The key to this patch is that "A/B/C" is treated as equivalent
 126 to "A/B/C/index".
 127 Here it is:  --Per Bothner
 128
 129     --- IkiWiki/Render.pm~  2007-01-11 15:01:51.000000000 -0800
 130     +++ IkiWiki/Render.pm   2007-02-02 22:24:12.000000000 -0800
 131     @@ -60,9 +60,9 @@
 132             foreach my $dir (reverse split("/", $page)) {
 133                     if (! $skip) {
 134                             $path.="../";
 135     -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
 136     +                       unshift @ret, { url => abs2rel(htmlpage(bestlink($page, $dir)), dirname($page)), page => pagetitle($dir) };
 137                     }
 138     -               else {
 139     +               elsif ($dir ne "index") {
 140                             $skip=0;
 141                     }
 142             }
 143
 144     --- IkiWiki.pm~ 2007-01-12 12:47:09.000000000 -0800
 145     +++ IkiWiki.pm  2007-02-02 18:02:16.000000000 -0800
 146     @@ -315,6 +315,12 @@
 147                     elsif (exists $pagecase{lc $l}) {
 148                             return $pagecase{lc $l};
 149                      }
 150     +               else {
 151     +                   my $lindex = $l . "/index";
 152     +                   if (exists $links{$lindex}) {
 153     +                       return $lindex;
 154     +               }
 155     +               }
 156              } while $cwd=~s!/?[^/]+$!!;
 157
 158             if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
 159
 160 Note I handle setting the url; slightly differently.
 161 Also note that an initial "index" is ignored.  I.e. a
 162 page "A/B/index.html" is treated as "A/B".
 163