doc/patchqueue/index.html_allowed.mdwn

   1 Instead of having files foo.html "in front of" foo/, I prefer to have
   2 foo/index.html. This patch allows that. Specifically, foo/index.type
   3 is translated to $links{'foo/'}, and bestlink looks for either "foo" or
   4 "foo/" when linking to pages. There are other miscellaneous changes that
   5 go with that:
   6
   7 1. change the `cgi_editpage` `@page_locs` code so that creating foo from
   8    a/b/c prefers a/b/foo and then a/b/c/foo, but if creating foo from a/b/c/,
   9    then prefer a/b/c/foo. I'm not really sure why the original was doing what
  10    it did (why trim terminal `/` if no pages end in `/`?), so this part might
  11    break something.
  12 2. tweak things so that index.rss and index.atom are generated if inlining
  13    from 'foo/'
  14 2. backlinks from "foo/bar" to "foo/" trim common prefixes as long as there
  15    would be something left when the trimming is done (i.e. don't trim "foo/")
  16 3. parentlinks for "foo/" are the same as for "foo", except one directory
  17    higher
  18 4. rewrite parentlinks so that bestlink is called at each level
  19 5. basename("foo/") => basename("foo")
  20 6. links to "foo/" are translated to "foo/index.html" rather than "foo/.html".
  21   (Links to "foo/" might be preferred, but that causes an infinite loop in
  22   writefile, because apparently dirname("foo/") == "foo/" on my system for
  23   reasons that aren't clear to me.)
  24 7. pagetitle("foo/") => pagetitle("foo")
  25 8. clip the final slash when matching a relative pagespec, even if there are
  26    no characters after it (otherwise inlining "./a" from "foo/" gets
  27    translated to "foo//a")
  28
  29 In case whitespace gets garbled, I'm also leaving a copy of the patch on
  30 [my site](http://ikidev.betacantrips.com/patches/index.patch). It should apply
  31 cleanly to a freshly unpacked ikiwiki-1.42. You can also see it in action
  32 [here](http://ikidev.betacantrips.com/one/). --Ethan
  33
  34     diff -urX ignorepats ikiclean/IkiWiki/CGI.pm ikidev/IkiWiki/CGI.pm
  35     --- ikiclean/IkiWiki/CGI.pm 2007-02-11 21:40:32.419641000 -0800
  36     +++ ikidev/IkiWiki/CGI.pm   2007-02-11 21:54:36.252357000 -0800
  37     @@ -408,8 +408,8 @@
  38                                 @page_locs=$best_loc=$page;
  39                         }
  40                         else {
  41     -                           my $dir=$from."/";
  42     -                           $dir=~s![^/]+/+$!!;
  43     +                           my $dir=$from;
  44     +                           $dir=~s![^/]+$!!;
  45
  46                                 if ((defined $form->field('subpage') && length $form->field('subpage')) ||
  47                                     $page eq gettext('discussion')) {
  48     @@ -420,7 +420,9 @@
  49                                 }
  50
  51                                 push @page_locs, $dir.$page;
  52     -                           push @page_locs, "$from/$page";
  53     +                           if ($dir ne $from){ # i.e. $from not a directory
  54     +                                   push @page_locs, "$from/$page";
  55     +                           }
  56                                 while (length $dir) {
  57                                         $dir=~s![^/]+/+$!!;
  58                                         push @page_locs, $dir.$page;
  59     diff -urX ignorepats ikiclean/IkiWiki/Plugin/inline.pm ikidev/IkiWiki/Plugin/inline.pm
  60     --- ikiclean/IkiWiki/Plugin/inline.pm       2007-02-11 21:40:31.996007000 -0800
  61     +++ ikidev/IkiWiki/Plugin/inline.pm 2007-02-11 21:54:36.008358000 -0800
  62     @@ -110,8 +110,8 @@
  63
  64         add_depends($params{page}, $params{pages});
  65
  66     -   my $rssurl=rsspage(basename($params{page}));
  67     -   my $atomurl=atompage(basename($params{page}));
  68     +   my $rssurl=basename(rsspage($params{page}));
  69     +   my $atomurl=basename(atompage($params{page}));
  70         my $ret="";
  71
  72         if (exists $params{rootpage} && $config{cgiurl}) {
  73     @@ -285,14 +285,18 @@
  74
  75      sub rsspage ($) { #{{{
  76         my $page=shift;
  77     +   $page = htmlpage($page);
  78     +   $page =~s/\.html$/.rss/;
  79
  80     -   return $page.".rss";
  81     +   return $page;
  82      } #}}}
  83
  84      sub atompage ($) { #{{{
  85         my $page=shift;
  86     +   $page = htmlpage($page);
  87     +   $page =~s/\.html$/.atom/;
  88
  89     -   return $page.".atom";
  90     +   return $page;
  91      } #}}}
  92
  93      sub genfeed ($$$$@) { #{{{
  94     diff -urX ignorepats ikiclean/IkiWiki/Render.pm ikidev/IkiWiki/Render.pm
  95     --- ikiclean/IkiWiki/Render.pm      2007-02-11 21:40:32.413641000 -0800
  96     +++ ikidev/IkiWiki/Render.pm        2007-02-11 21:54:36.246356000 -0800
  97     @@ -40,6 +40,7 @@
  98                 my $dir;
  99                 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
 100                         defined $dir &&
 101     +                   $p_trimmed=~m/^\Q$dir\E(?:.)/ &&
 102                         $p_trimmed=~s/^\Q$dir\E// &&
 103                         $page_trimmed=~s/^\Q$dir\E//;
 104
 105     @@ -57,10 +58,18 @@
 106         my $path="";
 107         my $skip=1;
 108         return if $page eq 'index'; # toplevel
 109     -   foreach my $dir (reverse split("/", $page)) {
 110     +   if ($page =~ m{/$}){
 111     +           $page =~ s{/$}{};
 112     +           $path="../";
 113     +   }
 114     +
 115     +   while ($page =~ m!([^/]+)$!) {
 116     +           my $last = $1;
 117     +           $page =~ s!/?[^/]+$!!;
 118                 if (! $skip) {
 119                         $path.="../";
 120     -                   unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
 121     +                   my $target = abs2rel(htmlpage(bestlink($page, $last)), $page);
 122     +                   unshift @ret, { url => $path.$target, page => pagetitle($last) };
 123                 }
 124                 else {
 125                         $skip=0;
 126     diff -urX ignorepats ikiclean/IkiWiki.pm ikidev/IkiWiki.pm
 127     --- ikiclean/IkiWiki.pm     2007-02-11 21:40:35.118406000 -0800
 128     +++ ikidev/IkiWiki.pm       2007-02-11 22:22:49.146071000 -0800
 129     @@ -188,6 +188,7 @@
 130      sub basename ($) { #{{{
 131         my $file=shift;
 132
 133     +   $file=~s!/$!!;
 134         $file=~s!.*/+!!;
 135         return $file;
 136      } #}}}
 137     @@ -214,12 +215,14 @@
 138         my $type=pagetype($file);
 139         my $page=$file;
 140         $page=~s/\Q.$type\E*$// if defined $type;
 141     +   $page=~s#index$## if $page=~m{/index$};
 142         return $page;
 143      } #}}}
 144
 145      sub htmlpage ($) { #{{{
 146         my $page=shift;
 147
 148     +   return $page."index.html" if $page=~m{/$};
 149         return $page.".html";
 150      } #}}}
 151
 152     @@ -307,6 +310,7 @@
 153         my $page=shift;
 154         my $link=shift;
 155
 156     +   $page =~ s!/$!!;
 157         my $cwd=$page;
 158         if ($link=~s/^\/+//) {
 159                 # absolute links
 160     @@ -321,6 +325,9 @@
 161                 if (exists $links{$l}) {
 162                         return $l;
 163                 }
 164     +           if (exists $links{$l.'/'}){
 165     +                   return $l.'/';
 166     +           }
 167                 elsif (exists $pagecase{lc $l}) {
 168                         return $pagecase{lc $l};
 169                 }
 170     @@ -351,6 +358,7 @@
 171                 $page=~s/__(\d+)__/&#$1;/g;
 172         }
 173         $page=~y/_/ /;
 174     +   $page=~s!/$!!;
 175
 176         return $page;
 177      } #}}}
 178     @@ -879,7 +887,7 @@
 179
 180         # relative matching
 181         if ($glob =~ m!^\./!) {
 182     -           $from=~s!/?[^/]+$!!;
 183     +           $from=~s!/?[^/]*$!!;
 184                 $glob=~s!^\./!!;
 185                 $glob="$from/$glob" if length $from;
 186         }
 187
 188 I independently implemented a similar, but smaller patch.
 189 (It's smaller because I only care about rendering; not CGI, for example.)
 190 The key to this patch is that "A/B/C" is treated as equivalent
 191 to "A/B/C/index".
 192 Here it is:  --Per Bothner
 193
 194     --- IkiWiki/Render.pm~  2007-01-11 15:01:51.000000000 -0800
 195     +++ IkiWiki/Render.pm   2007-02-02 22:24:12.000000000 -0800
 196     @@ -60,9 +60,9 @@
 197             foreach my $dir (reverse split("/", $page)) {
 198                     if (! $skip) {
 199                             $path.="../";
 200     -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
 201     +                       unshift @ret, { url => abs2rel(htmlpage(bestlink($page, $dir)), dirname($page)), page => pagetitle($dir) };
 202                     }
 203     -               else {
 204     +               elsif ($dir ne "index") {
 205                             $skip=0;
 206                     }
 207             }
 208
 209     --- IkiWiki.pm~ 2007-01-12 12:47:09.000000000 -0800
 210     +++ IkiWiki.pm  2007-02-02 18:02:16.000000000 -0800
 211     @@ -315,6 +315,12 @@
 212                     elsif (exists $pagecase{lc $l}) {
 213                             return $pagecase{lc $l};
 214                      }
 215     +               else {
 216     +                   my $lindex = $l . "/index";
 217     +                   if (exists $links{$lindex}) {
 218     +                       return $lindex;
 219     +               }
 220     +               }
 221              } while $cwd=~s!/?[^/]+$!!;
 222
 223             if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
 224
 225 Note I handle setting the url; slightly differently.
 226 Also note that an initial "index" is ignored.  I.e. a
 227 page "A/B/index.html" is treated as "A/B".
 228
 229 > This is actually a pretty cool hack. I'll have to think about
 230 > whether I like it better than my way though :) --Ethan
 231
 232 ---
 233
 234 How about doing the index stuff only on the output side? (Or does the latter patch do it? I haven't tried them.) That is, render every `foo.type` for the rendered types (mdwn etc.) as `foo/index.html`, generating links to `foo/` instead of `foo.html`, but not earlier than the point where the .html as presently appended to the page name. Then you just flip a build time option on an existing wiki without any changes to that, and the pages appear elsewhere. The `index.type` files might be left out of this scheme, though (and the top-level one, of course, has to). --[[tuomov]]
 235
 236 > Well, get around to wasting time on it after all, and [here's the patch](http://iki.fi/tuomov/use_dirs.diff). The `-use_dirs` option will cause everything to be rendered inside directories. There may still be some problems with it, that need looking into (it doesn't e.g. check for conflicts between foo/index.mdwn and foo.mdwn), but seems to work well enough for me... The patch also improves, I think, the parentlinks code a little, as it uses generic routines to actually find the target location now. The only places where the `use_dirs` option is used is `htmlpage`, in fact, although other specific kludges needed to be removed from other points in the code.
 237
 238 >> FWIW, [use_dirs.diff](http://iki.fi/tuomov/use_dirs.diff) applies cleanly, and works well for me. Given that it makes this behaviour optional, how about merging it? I have some follow-up patches which I'm sitting on for now. ;-) -- Ben
 239
 240 >>> How do you apply a patch created by svn diff? I've been curious about this for a long time. The use_dirs patch looks OK but I'd like to play with it. --Ethan
 241
 242 >>>> Just do `svn co svn://ikiwiki.kitenet.net/ikiwiki/trunk ikiwiki` then `cd ikiwiki && patch -p0 <use_dirs.diff`. :-) Same would work with a tarball as well.
 243
 244
 245 ----
 246
 247 First pass over Tumov's patch -- which doesn't cleanly apply anymore, so
 248 I'll attach an updated and slightly modified version below.
 249
 250 * `urlto()` is O(N) to the number of pages in the wiki, which leads to
 251   O(N^2) behavior, which could be a scalability problem. This happens because
 252   of the lookup for `$to` in `%renderedfiles`, which shouldn't be necessary
 253   most of the time. Couldn't it just be required that `$to` be a html page
 254   name on input? Or require it be a non-html page name and always run
 255   htmlpage on it.
 256
 257       > Perhaps it would be possible to require that, but it seems like a
 258       > very artificial restriction.  The renderedfiles search is just a
 259       > copy-paste from htmllink, and I'm no perl (or ikiwiki internals)
 260       > expert... maybe there would be a faster way to do the check whether
 261       > name translation is needed? No more than O(log n) steps should be
 262       > needed for a simple search, after all, and maybe there would be shortcuts
 263       > for even constant-time (in n) checks. --[[tuomov]]
 264
 265 * As we discussed in email, this will break handling of `foo/index.mdwn`
 266   pages. Needs to be changed to generate `foo/index/index.html` for such
 267   pages (though not for the toplevel `index`).
 268 * This does make the resulting wikis much less browsable directly on the
 269   filesystem, since `dir` to `dir/index.html` conversion is only handled by web
 270   servers and so you end up browsing to a directory index all the time.
 271   Wouldn't it be better to make the links themselves include the index.html?
 272   (Although that would mean that [[bugs/broken_parentlinks]] would not be
 273   fixed en passant by this patch..)
 274
 275      > Yes, the sites are not that browsable on the FS (I blame the browsers
 276      > for being stupid!), but linking to the directory produces so much
 277      > cleaner URLs for the Web, that I specifically want it. This is,
 278      > after all, an optional arrangement.
 279
 280 * Some of the generated links are missing the trailing / , which is
 281   innefficient since it leads to a http redirect when clicking on that
 282   link. Seems to be limited to ".." links, and possibly only to
 283   parentlinks. (Already fixed it for "." links.)
 284 * It calles abs2rel about 16% more often with the patch, which makes it
 285   a bit slower, since abs2rel is not very efficient. (This omits abs2rel
 286   calls that might be memoized away already.) This seems to be due to one
 287   extra abs2rel for the toplevel wiki page due to the nicely cleaned up code
 288   in `parentlinks` -- so I'm not really complaining.. Especially since the
 289   patch adds a new nice memoizable `urlto`.
 290 * The rss page name generation code seems unnecesarily roundabout, I'm sure
 291   that can be cleaned up somehow, perhaps by making `htmlpage` more
 292   generic.
 293
 294      > Something like `targetpage(basename, extension)`?
 295
 296 * `aggregate.pm` uses htmlpage in a way that breaks with its new behavior.
 297   It will need to be changed as follows:
 298
 299 <pre>
 300 Index: aggregate.pm
 301 ===================================================================
 302 --- aggregate.pm        (revision 2700)
 303 +++ aggregate.pm        (working copy)
 304 @@ -320,7 +320,7 @@
 305                 # NB: This doesn't check for path length limits.
 306                 eval q{use POSIX};
 307                 my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
 308 -               if (defined $max && length(htmlpage($page)) >= $max) {
 309 +               if (defined $max && length(htmlfn($page)) >= $max) {
 310                         $c="";
 311                         $page=$feed->{dir}."/item";
 312                         while (exists $IkiWiki::pagecase{lc $page.$c} ||
 313 @@ -356,7 +356,7 @@
 314         if (ref $feed->{tags}) {
 315                 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
 316         }
 317 -       writefile(htmlpage($guid->{page}), $config{srcdir},
 318 +       writefile(htmlfn($guid->{page}), $config{srcdir},
 319                 $template->output);
 320
 321         # Set the mtime, this lets the build process get the right creation
 322 @@ -434,4 +434,8 @@
 323         return "$config{srcdir}/".htmlpage($page);
 324  } #}}}
 325
 326 +sub htmlfn ($) { #{{{
 327 +       return shift().".html";
 328 +} #}}}
 329 +
 330  1
 331 </pre>
 332
 333 * `linkmap.pm` uses `htmlpage` to construct a link and should probably be
 334   changed like this (untested):
 335
 336 <pre>
 337 Index: linkmap.pm
 338 ===================================================================
 339 --- linkmap.pm  (revision 2700)
 340 +++ linkmap.pm  (working copy)
 341 @@ -50,8 +50,7 @@
 342         foreach my $item (keys %links) {
 343                 if (pagespec_match($item, $params{pages}, $params{page})) {
 344                         my $link=htmlpage($item);
 345 -                       $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
 346 -                       $mapitems{$item}=$link;
 347 +                       $mapitems{$item}=urlto($link, $params{destpage});
 348                 }
 349         }
 350 </pre>
 351
 352 * `inline.pm` uses htmlpage and `abs2rel` to generate a link, and probably
 353   needs to be changed to either use `urlto` or to call `beautify_url` like
 354   htmllink does. This might work:
 355
 356 <pre>
 357 Index: inline.pm
 358 ===================================================================
 359 --- inline.pm   (revision 2700)
 360 +++ inline.pm   (working copy)
 361 @@ -150,10 +150,7 @@
 362                         # Don't use htmllink because this way the
 363                         # title is separate and can be overridden by
 364                         # other plugins.
 365 -                       my $link=bestlink($params{page}, $page);
 366 -                       $link=htmlpage($link) if defined $type;
 367 -                       $link=abs2rel($link, dirname($params{destpage}));
 368 -                       $template->param(pageurl => $link);
 369 +                       $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
 370                         $template->param(title => pagetitle(basename($page)));
 371                         $template->param(ctime => displaytime($pagectime{$page}));
 372 </pre>
 373
 374 * `img.pm` makes some assumptions about name of the page that will be
 375   linking to the image, which are probably broken.
 376
 377 * The changes to htmlpage's behavior probably call for the plugin
 378   interface version number to be changed.
 379
 380 --[[Joey]]
 381
 382 Updated version of Tumov's patch follows:
 383
 384 <pre>
 385 Index: IkiWiki/Render.pm
 386 ===================================================================
 387 --- IkiWiki/Render.pm   (revision 2700)
 388 +++ IkiWiki/Render.pm   (working copy)
 389 @@ -32,8 +32,8 @@
 390         my @links;
 391         return unless $backlinks{$page};
 392         foreach my $p (keys %{$backlinks{$page}}) {
 393 -               my $href=abs2rel(htmlpage($p), dirname($page));
 394 -
 395 +               my $href=urlto($p, $page);
 396 +
 397                 # Trim common dir prefixes from both pages.
 398                 my $p_trimmed=$p;
 399                 my $page_trimmed=$page;
 400 @@ -55,18 +55,14 @@
 401         my @ret;
 402         my $pagelink="";
 403         my $path="";
 404 -       my $skip=1;
 405 +       my $title=$config{wikiname};
 406 +
 407         return if $page eq 'index'; # toplevel
 408 -       foreach my $dir (reverse split("/", $page)) {
 409 -               if (! $skip) {
 410 -                       $path.="../";
 411 -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
 412 -               }
 413 -               else {
 414 -                       $skip=0;
 415 -               }
 416 +       foreach my $dir (split("/", $page)) {
 417 +               push @ret, { url => urlto($path, $page), page => $title };
 418 +               $path.="/".$dir;
 419 +               $title=pagetitle($dir);
 420         }
 421 -       unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
 422         return @ret;
 423  } #}}}
 424
 425 Index: IkiWiki/Plugin/inline.pm
 426 ===================================================================
 427 --- IkiWiki/Plugin/inline.pm    (revision 2700)
 428 +++ IkiWiki/Plugin/inline.pm    (working copy)
 429 @@ -110,8 +110,8 @@
 430
 431         add_depends($params{page}, $params{pages});
 432
 433 -       my $rssurl=rsspage(basename($params{page}));
 434 -       my $atomurl=atompage(basename($params{page}));
 435 +       my $rssurl=basename(rsspage($params{page}));
 436 +       my $atomurl=basename(atompage($params{page}));
 437         my $ret="";
 438
 439         if (exists $params{rootpage} && $config{cgiurl}) {
 440 @@ -151,8 +151,7 @@
 441                         # title is separate and can be overridden by
 442                         # other plugins.
 443                         my $link=bestlink($params{page}, $page);
 444 -                       $link=htmlpage($link) if defined $type;
 445 -                       $link=abs2rel($link, dirname($params{destpage}));
 446 +                       $link=urlto($link, $params{destpage});
 447                         $template->param(pageurl => $link);
 448                         $template->param(title => pagetitle(basename($page)));
 449                         $template->param(ctime => displaytime($pagectime{$page}));
 450 @@ -205,15 +204,17 @@
 451                 }
 452
 453                 if ($rss) {
 454 -                       will_render($params{page}, rsspage($params{page}));
 455 -                       writefile(rsspage($params{page}), $config{destdir},
 456 +                       my $rssp=rsspage($params{page});
 457 +                       will_render($params{page}, $rssp);
 458 +                       writefile($rssp, $config{destdir},
 459                                 genfeed("rss", $rssurl, $desc, $params{page}, @list));
 460                         $toping{$params{page}}=1 unless $config{rebuild};
 461                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
 462                 }
 463                 if ($atom) {
 464 -                       will_render($params{page}, atompage($params{page}));
 465 -                       writefile(atompage($params{page}), $config{destdir},
 466 +                       my $atomp=atompage($params{page});
 467 +                       will_render($params{page}, $atomp);
 468 +                       writefile($atomp, $config{destdir},
 469                                 genfeed("atom", $atomurl, $desc, $params{page}, @list));
 470                         $toping{$params{page}}=1 unless $config{rebuild};
 471                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
 472 @@ -288,16 +289,25 @@
 473         return $content;
 474  } #}}}
 475
 476 +sub basepage ($) { #{{{
 477 +       my $page=shift;
 478 +
 479 +       $page=htmlpage($page);
 480 +       $page =~ s/\.html$//;
 481 +
 482 +       return $page;
 483 +} #}}}
 484 +
 485  sub rsspage ($) { #{{{
 486         my $page=shift;
 487
 488 -       return $page.".rss";
 489 +       return basepage($page).".rss";
 490  } #}}}
 491
 492  sub atompage ($) { #{{{
 493         my $page=shift;
 494
 495 -       return $page.".atom";
 496 +       return basepage($page).".atom";
 497  } #}}}
 498
 499  sub genfeed ($$$$@) { #{{{
 500 Index: ikiwiki.in
 501 ===================================================================
 502 --- ikiwiki.in  (revision 2700)
 503 +++ ikiwiki.in  (working copy)
 504 @@ -46,6 +46,7 @@
 505                         "sslcookie!" => \$config{sslcookie},
 506                         "httpauth!" => \$config{httpauth},
 507                         "userdir=s" => \$config{userdir},
 508 +                       "usedirs!" => \$config{usedirs},
 509                         "exclude=s@" => sub {
 510                                 push @{$config{wiki_file_prune_regexps}}, $_[1];
 511                         },
 512 Index: doc/usage.mdwn
 513 ===================================================================
 514 --- doc/usage.mdwn      (revision 2700)
 515 +++ doc/usage.mdwn      (working copy)
 516 @@ -244,6 +244,10 @@
 517
 518    Log to syslog(3).
 519
 520 +* --usedirs
 521 +
 522 +  Create output files named page/index.html instead of page.html.
 523 +
 524  * --w3mmode, --no-w3mmode
 525
 526    Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 527 Index: doc/plugins/write.mdwn
 528 ===================================================================
 529 --- doc/plugins/write.mdwn      (revision 2700)
 530 +++ doc/plugins/write.mdwn      (working copy)
 531 @@ -412,6 +412,10 @@
 532
 533  This is the standard gettext function, although slightly optimised.
 534
 535 +#### `urlto($$)`
 536 +
 537 +Construct a relative url to the first parameter from the second.
 538 +
 539  ## RCS plugins
 540
 541  ikiwiki's support for revision control systems also uses pluggable perl
 542 Index: doc/ikiwiki.setup
 543 ===================================================================
 544 --- doc/ikiwiki.setup   (revision 2700)
 545 +++ doc/ikiwiki.setup   (working copy)
 546 @@ -94,6 +94,8 @@
 547         syslog => 0,
 548         # To link to user pages in a subdirectory of the wiki.
 549         #userdir => "users",
 550 +       # To enable alternate output filenames.
 551 +       #usedirs => 1,
 552
 553         # To add plugins, list them here.
 554         #add_plugins => [qw{goodstuff openid search wikitext camelcase
 555 Index: IkiWiki.pm
 556 ===================================================================
 557 --- IkiWiki.pm  (revision 2700)
 558 +++ IkiWiki.pm  (working copy)
 559 @@ -14,7 +14,7 @@
 560  use Exporter q{import};
 561  our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
 562                   bestlink htmllink readfile writefile pagetype srcfile pagename
 563 -                 displaytime will_render gettext
 564 +                 displaytime will_render gettext urlto
 565                   %config %links %renderedfiles %pagesources);
 566  our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
 567  our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 568 @@ -72,6 +72,7 @@
 569         sslcookie => 0,
 570         httpauth => 0,
 571         userdir => "",
 572 +       usedirs => 0
 573  } #}}}
 574
 575  sub checkconfig () { #{{{
 576 @@ -226,7 +227,11 @@
 577  sub htmlpage ($) { #{{{
 578         my $page=shift;
 579
 580 -       return $page.".html";
 581 +       if (! $config{usedirs} || $page =~ /^index$/ || $page =~ /\/index$/) {
 582 +               return $page.".html";
 583 +       } else {
 584 +               return $page."/index.html";
 585 +       }
 586  } #}}}
 587
 588  sub srcfile ($) { #{{{
 589 @@ -390,6 +395,7 @@
 590
 591         return "$config{url}/" if ! defined $page;
 592
 593 +       $page=htmlpage($page);
 594         $page=~s/[^\/]+$//;
 595         $page=~s/[^\/]+\//..\//g;
 596         return $page;
 597 @@ -419,6 +425,29 @@
 598                         $config{timeformat}, localtime($time)));
 599  } #}}}
 600
 601 +sub beautify_url ($) { #{{{
 602 +       my $url=shift;
 603 +
 604 +       $url =~ s!/index.html$!/!;
 605 +       $url =~ s!^$!./!; # Browsers don't like empty links...
 606 +
 607 +       return $url;
 608 +} #}}}
 609 +
 610 +sub urlto ($$) { #{{{
 611 +       my $to=shift;
 612 +       my $from=shift;
 613 +
 614 +       if (length $to &&
 615 +           ! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
 616 +               $to=htmlpage($to);
 617 +       }
 618 +
 619 +       my $link = abs2rel($to, dirname(htmlpage($from)));
 620 +
 621 +       return beautify_url($link);
 622 +} #}}}
 623 +
 624  sub htmllink ($$$;@) { #{{{
 625         my $lpage=shift; # the page doing the linking
 626         my $page=shift; # the page that will contain the link (different for inline)
 627 @@ -454,7 +483,8 @@
 628                         "\">?</a>$linktext</span>"
 629         }
 630
 631 -       $bestlink=abs2rel($bestlink, dirname($page));
 632 +       $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
 633 +       $bestlink=beautify_url($bestlink);
 634
 635         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
 636                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
 637 </pre>