web commit by http://ethan.betacantrips.com/: ooh, activity
[ikiwiki.git] / 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 >>>>> Sorry, I'm dumb. I'm so used to doing -p1 that doing -p0 never occurred to me; I thought the patch format generated by svn diff was just "wrong". --Ethan
245
246 ----
247
248 First pass over Tumov's patch -- which doesn't cleanly apply anymore, so
249 I'll attach an updated and slightly modified version below.
250
251 * `urlto()` is O(N) to the number of pages in the wiki, which leads to
252   O(N^2) behavior, which could be a scalability problem. This happens because
253   of the lookup for `$to` in `%renderedfiles`, which shouldn't be necessary
254   most of the time. Couldn't it just be required that `$to` be a html page
255   name on input? Or require it be a non-html page name and always run
256   htmlpage on it.
257
258       > Perhaps it would be possible to require that, but it seems like a
259       > very artificial restriction.  The renderedfiles search is just a
260       > copy-paste from htmllink, and I'm no perl (or ikiwiki internals)
261       > expert... maybe there would be a faster way to do the check whether
262       > name translation is needed? No more than O(log n) steps should be
263       > needed for a simple search, after all, and maybe there would be shortcuts
264       > for even constant-time (in n) checks. --[[tuomov]]
265
266 * As we discussed in email, this will break handling of `foo/index.mdwn`
267   pages. Needs to be changed to generate `foo/index/index.html` for such
268   pages (though not for the toplevel `index`).
269
270   >> Can someone elaborate on this? What's broken about it? Will pages
271   >> foo/index/index.html include foo/index in their parentlinks? --Ethan
272
273 * This does make the resulting wikis much less browsable directly on the
274   filesystem, since `dir` to `dir/index.html` conversion is only handled by web
275   servers and so you end up browsing to a directory index all the time.
276   Wouldn't it be better to make the links themselves include the index.html?
277   (Although that would mean that [[bugs/broken_parentlinks]] would not be
278   fixed en passant by this patch..)
279
280      > Yes, the sites are not that browsable on the FS (I blame the browsers
281      > for being stupid!), but linking to the directory produces so much
282      > cleaner URLs for the Web, that I specifically want it. This is,
283      > after all, an optional arrangement. 
284
285 * Some of the generated links are missing the trailing / , which is
286   innefficient since it leads to a http redirect when clicking on that
287   link. Seems to be limited to ".." links, and possibly only to
288   parentlinks. (Already fixed it for "." links.)
289 * It calles abs2rel about 16% more often with the patch, which makes it
290   a bit slower, since abs2rel is not very efficient. (This omits abs2rel
291   calls that might be memoized away already.) This seems to be due to one
292   extra abs2rel for the toplevel wiki page due to the nicely cleaned up code
293   in `parentlinks` -- so I'm not really complaining.. Especially since the
294   patch adds a new nice memoizable `urlto`.
295 * The rss page name generation code seems unnecesarily roundabout, I'm sure
296   that can be cleaned up somehow, perhaps by making `htmlpage` more
297   generic.
298
299      > Something like `targetpage(basename, extension)`?
300
301 * `aggregate.pm` uses htmlpage in a way that breaks with its new behavior.
302   It will need to be changed as follows:
303
304 <pre>
305 Index: aggregate.pm
306 ===================================================================
307 --- aggregate.pm        (revision 2700)
308 +++ aggregate.pm        (working copy)
309 @@ -320,7 +320,7 @@
310                 # NB: This doesn't check for path length limits.
311                 eval q{use POSIX};
312                 my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
313 -               if (defined $max && length(htmlpage($page)) >= $max) {
314 +               if (defined $max && length(htmlfn($page)) >= $max) {
315                         $c="";
316                         $page=$feed->{dir}."/item";
317                         while (exists $IkiWiki::pagecase{lc $page.$c} ||
318 @@ -356,7 +356,7 @@
319         if (ref $feed->{tags}) {
320                 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
321         }
322 -       writefile(htmlpage($guid->{page}), $config{srcdir},
323 +       writefile(htmlfn($guid->{page}), $config{srcdir},
324                 $template->output);
325  
326         # Set the mtime, this lets the build process get the right creation
327 @@ -434,4 +434,8 @@
328         return "$config{srcdir}/".htmlpage($page);
329  } #}}}
330  
331 +sub htmlfn ($) { #{{{
332 +       return shift().".html";
333 +} #}}}
334 +
335  1
336 </pre>
337
338 * `linkmap.pm` uses `htmlpage` to construct a link and should probably be
339   changed like this (untested):
340
341 <pre>
342 Index: linkmap.pm
343 ===================================================================
344 --- linkmap.pm  (revision 2700)
345 +++ linkmap.pm  (working copy)
346 @@ -50,8 +50,7 @@
347         foreach my $item (keys %links) {
348                 if (pagespec_match($item, $params{pages}, $params{page})) {
349                         my $link=htmlpage($item);
350 -                       $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
351 -                       $mapitems{$item}=$link;
352 +                       $mapitems{$item}=urlto($link, $params{destpage});
353                 }
354         }
355 </pre>
356
357 * `inline.pm` uses htmlpage and `abs2rel` to generate a link, and probably
358   needs to be changed to either use `urlto` or to call `beautify_url` like
359   htmllink does. This might work:
360
361 <pre>
362 Index: inline.pm
363 ===================================================================
364 --- inline.pm   (revision 2700)
365 +++ inline.pm   (working copy)
366 @@ -150,10 +150,7 @@
367                         # Don't use htmllink because this way the
368                         # title is separate and can be overridden by
369                         # other plugins.
370 -                       my $link=bestlink($params{page}, $page);
371 -                       $link=htmlpage($link) if defined $type;
372 -                       $link=abs2rel($link, dirname($params{destpage}));
373 -                       $template->param(pageurl => $link);
374 +                       $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
375                         $template->param(title => pagetitle(basename($page)));
376                         $template->param(ctime => displaytime($pagectime{$page}));
377 </pre>
378
379 * `img.pm` makes some assumptions about name of the page that will be
380   linking to the image, which are probably broken.
381
382 * The changes to htmlpage's behavior probably call for the plugin
383   interface version number to be changed.
384
385 --[[Joey]]
386
387 Updated version of Tumov's patch follows:
388
389 <pre>
390 Index: IkiWiki/Render.pm
391 ===================================================================
392 --- IkiWiki/Render.pm   (revision 2700)
393 +++ IkiWiki/Render.pm   (working copy)
394 @@ -32,8 +32,8 @@
395         my @links;
396         return unless $backlinks{$page};
397         foreach my $p (keys %{$backlinks{$page}}) {
398 -               my $href=abs2rel(htmlpage($p), dirname($page));
399 -                       
400 +               my $href=urlto($p, $page);
401 +                
402                 # Trim common dir prefixes from both pages.
403                 my $p_trimmed=$p;
404                 my $page_trimmed=$page;
405 @@ -55,18 +55,14 @@
406         my @ret;
407         my $pagelink="";
408         my $path="";
409 -       my $skip=1;
410 +       my $title=$config{wikiname};
411 +       
412         return if $page eq 'index'; # toplevel
413 -       foreach my $dir (reverse split("/", $page)) {
414 -               if (! $skip) {
415 -                       $path.="../";
416 -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
417 -               }
418 -               else {
419 -                       $skip=0;
420 -               }
421 +       foreach my $dir (split("/", $page)) {
422 +               push @ret, { url => urlto($path, $page), page => $title };
423 +               $path.="/".$dir;
424 +               $title=pagetitle($dir);
425         }
426 -       unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
427         return @ret;
428  } #}}}
429  
430 Index: IkiWiki/Plugin/inline.pm
431 ===================================================================
432 --- IkiWiki/Plugin/inline.pm    (revision 2700)
433 +++ IkiWiki/Plugin/inline.pm    (working copy)
434 @@ -110,8 +110,8 @@
435  
436         add_depends($params{page}, $params{pages});
437  
438 -       my $rssurl=rsspage(basename($params{page}));
439 -       my $atomurl=atompage(basename($params{page}));
440 +       my $rssurl=basename(rsspage($params{page}));
441 +       my $atomurl=basename(atompage($params{page}));
442         my $ret="";
443  
444         if (exists $params{rootpage} && $config{cgiurl}) {
445 @@ -151,8 +151,7 @@
446                         # title is separate and can be overridden by
447                         # other plugins.
448                         my $link=bestlink($params{page}, $page);
449 -                       $link=htmlpage($link) if defined $type;
450 -                       $link=abs2rel($link, dirname($params{destpage}));
451 +                       $link=urlto($link, $params{destpage});
452                         $template->param(pageurl => $link);
453                         $template->param(title => pagetitle(basename($page)));
454                         $template->param(ctime => displaytime($pagectime{$page}));
455 @@ -205,15 +204,17 @@
456                 }
457         
458                 if ($rss) {
459 -                       will_render($params{page}, rsspage($params{page}));
460 -                       writefile(rsspage($params{page}), $config{destdir},
461 +                       my $rssp=rsspage($params{page});
462 +                       will_render($params{page}, $rssp);
463 +                       writefile($rssp, $config{destdir},
464                                 genfeed("rss", $rssurl, $desc, $params{page}, @list));
465                         $toping{$params{page}}=1 unless $config{rebuild};
466                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
467                 }
468                 if ($atom) {
469 -                       will_render($params{page}, atompage($params{page}));
470 -                       writefile(atompage($params{page}), $config{destdir},
471 +                       my $atomp=atompage($params{page});
472 +                       will_render($params{page}, $atomp);
473 +                       writefile($atomp, $config{destdir},
474                                 genfeed("atom", $atomurl, $desc, $params{page}, @list));
475                         $toping{$params{page}}=1 unless $config{rebuild};
476                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
477 @@ -288,16 +289,25 @@
478         return $content;
479  } #}}}
480  
481 +sub basepage ($) { #{{{
482 +       my $page=shift;
483 +       
484 +       $page=htmlpage($page);
485 +       $page =~ s/\.html$//;
486 +       
487 +       return $page;
488 +} #}}}
489 +
490  sub rsspage ($) { #{{{
491         my $page=shift;
492  
493 -       return $page.".rss";
494 +       return basepage($page).".rss";
495  } #}}}
496  
497  sub atompage ($) { #{{{
498         my $page=shift;
499  
500 -       return $page.".atom";
501 +       return basepage($page).".atom";
502  } #}}}
503  
504  sub genfeed ($$$$@) { #{{{
505 Index: ikiwiki.in
506 ===================================================================
507 --- ikiwiki.in  (revision 2700)
508 +++ ikiwiki.in  (working copy)
509 @@ -46,6 +46,7 @@
510                         "sslcookie!" => \$config{sslcookie},
511                         "httpauth!" => \$config{httpauth},
512                         "userdir=s" => \$config{userdir},
513 +                       "usedirs!" => \$config{usedirs},
514                         "exclude=s@" => sub {
515                                 push @{$config{wiki_file_prune_regexps}}, $_[1];
516                         },
517 Index: doc/usage.mdwn
518 ===================================================================
519 --- doc/usage.mdwn      (revision 2700)
520 +++ doc/usage.mdwn      (working copy)
521 @@ -244,6 +244,10 @@
522  
523    Log to syslog(3).
524  
525 +* --usedirs
526 +
527 +  Create output files named page/index.html instead of page.html.
528 +
529  * --w3mmode, --no-w3mmode
530  
531    Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
532 Index: doc/plugins/write.mdwn
533 ===================================================================
534 --- doc/plugins/write.mdwn      (revision 2700)
535 +++ doc/plugins/write.mdwn      (working copy)
536 @@ -412,6 +412,10 @@
537  
538  This is the standard gettext function, although slightly optimised.
539  
540 +#### `urlto($$)`
541 +
542 +Construct a relative url to the first parameter from the second.
543 +
544  ## RCS plugins
545  
546  ikiwiki's support for revision control systems also uses pluggable perl
547 Index: doc/ikiwiki.setup
548 ===================================================================
549 --- doc/ikiwiki.setup   (revision 2700)
550 +++ doc/ikiwiki.setup   (working copy)
551 @@ -94,6 +94,8 @@
552         syslog => 0,
553         # To link to user pages in a subdirectory of the wiki.
554         #userdir => "users",
555 +       # To enable alternate output filenames.
556 +       #usedirs => 1,
557  
558         # To add plugins, list them here.
559         #add_plugins => [qw{goodstuff openid search wikitext camelcase
560 Index: IkiWiki.pm
561 ===================================================================
562 --- IkiWiki.pm  (revision 2700)
563 +++ IkiWiki.pm  (working copy)
564 @@ -14,7 +14,7 @@
565  use Exporter q{import};
566  our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
567                   bestlink htmllink readfile writefile pagetype srcfile pagename
568 -                 displaytime will_render gettext
569 +                 displaytime will_render gettext urlto
570                   %config %links %renderedfiles %pagesources);
571  our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
572  our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
573 @@ -72,6 +72,7 @@
574         sslcookie => 0,
575         httpauth => 0,
576         userdir => "",
577 +       usedirs => 0
578  } #}}}
579     
580  sub checkconfig () { #{{{
581 @@ -226,7 +227,11 @@
582  sub htmlpage ($) { #{{{
583         my $page=shift;
584  
585 -       return $page.".html";
586 +       if (! $config{usedirs} || $page =~ /^index$/ || $page =~ /\/index$/) {
587 +               return $page.".html";
588 +       } else {
589 +               return $page."/index.html"; 
590 +       }
591  } #}}}
592  
593  sub srcfile ($) { #{{{
594 @@ -390,6 +395,7 @@
595  
596         return "$config{url}/" if ! defined $page;
597         
598 +       $page=htmlpage($page);
599         $page=~s/[^\/]+$//;
600         $page=~s/[^\/]+\//..\//g;
601         return $page;
602 @@ -419,6 +425,29 @@
603                         $config{timeformat}, localtime($time)));
604  } #}}}
605  
606 +sub beautify_url ($) { #{{{
607 +       my $url=shift;
608 +
609 +       $url =~ s!/index.html$!/!;
610 +       $url =~ s!^$!./!; # Browsers don't like empty links...
611 +
612 +       return $url;
613 +} #}}}
614 +
615 +sub urlto ($$) { #{{{
616 +       my $to=shift;
617 +       my $from=shift;
618 +
619 +       if (length $to &&
620 +           ! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
621 +               $to=htmlpage($to);
622 +       }
623 +
624 +       my $link = abs2rel($to, dirname(htmlpage($from)));
625 +
626 +       return beautify_url($link);
627 +} #}}}
628 +
629  sub htmllink ($$$;@) { #{{{
630         my $lpage=shift; # the page doing the linking
631         my $page=shift; # the page that will contain the link (different for inline)
632 @@ -454,7 +483,8 @@
633                         "\">?</a>$linktext</span>"
634         }
635         
636 -       $bestlink=abs2rel($bestlink, dirname($page));
637 +       $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
638 +       $bestlink=beautify_url($bestlink);
639         
640         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
641                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
642 </pre>