web commit by http://ethan.betacantrips.com/: oops, missed inline
[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.
3
4 I independently implemented a similar, but smaller patch.
5 (It's smaller because I only care about rendering; not CGI, for example.)
6 The key to this patch is that "A/B/C" is treated as equivalent
7 to "A/B/C/index".
8 Here it is:  --Per Bothner
9
10     --- IkiWiki/Render.pm~  2007-01-11 15:01:51.000000000 -0800
11     +++ IkiWiki/Render.pm   2007-02-02 22:24:12.000000000 -0800
12     @@ -60,9 +60,9 @@
13             foreach my $dir (reverse split("/", $page)) {
14                     if (! $skip) {
15                             $path.="../";
16     -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
17     +                       unshift @ret, { url => abs2rel(htmlpage(bestlink($page, $dir)), dirname($page)), page => pagetitle($dir) };
18                     }
19     -               else {
20     +               elsif ($dir ne "index") {
21                             $skip=0;
22                     }
23             }
24
25     --- IkiWiki.pm~ 2007-01-12 12:47:09.000000000 -0800
26     +++ IkiWiki.pm  2007-02-02 18:02:16.000000000 -0800
27     @@ -315,6 +315,12 @@
28                     elsif (exists $pagecase{lc $l}) {
29                             return $pagecase{lc $l};
30                      }
31     +               else {
32     +                   my $lindex = $l . "/index";
33     +                   if (exists $links{$lindex}) {
34     +                       return $lindex;
35     +               }
36     +               }
37              } while $cwd=~s!/?[^/]+$!!;
38      
39             if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
40
41 Note I handle setting the url; slightly differently.
42 Also note that an initial "index" is ignored.  I.e. a
43 page "A/B/index.html" is treated as "A/B".
44
45 > Actually, your patch is shorter because it's more elegant and better :)
46 > I'm withdrawing my old patch, because yours is much more in line with
47 > ikiwiki's design and architecture.
48 > I would like to make one suggestion to your patch, which is:
49
50     diff -urX ignorepats clean-ikidev/IkiWiki/Plugin/inline.pm ikidev/IkiWiki/Plugin/inline.pm
51     --- clean-ikidev/IkiWiki/Plugin/inline.pm   2007-02-25 12:26:54.099113000 -0800
52     +++ ikidev/IkiWiki/Plugin/inline.pm 2007-02-25 14:55:21.163340000 -0800
53     @@ -154,7 +154,7 @@
54                         $link=htmlpage($link) if defined $type;
55                         $link=abs2rel($link, dirname($params{destpage}));
56                         $template->param(pageurl => $link);
57     -                   $template->param(title => pagetitle(basename($page)));
58     +                   $template->param(title => titlename($page));
59                         $template->param(ctime => displaytime($pagectime{$page}));
60
61                         if ($actions) {
62     @@ -318,7 +318,7 @@
63                 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
64
65                 $itemtemplate->param(
66     -                   title => pagetitle(basename($p), 1),
67     +                   title => titlename($p, 1),
68                         url => $u,
69                         permalink => $u,
70                         date_822 => date_822($pagectime{$p}),
71     diff -urX ignorepats clean-ikidev/IkiWiki/Render.pm ikidev/IkiWiki/Render.pm
72     --- clean-ikidev/IkiWiki/Render.pm  2007-02-25 12:26:54.745833000 -0800
73     +++ ikidev/IkiWiki/Render.pm        2007-02-25 14:54:01.564715000 -0800
74     @@ -110,7 +110,7 @@
75         $template->param(
76                 title => $page eq 'index'
77                         ? $config{wikiname}
78     -                   : pagetitle(basename($page)),
79     +                   : titlename($page),
80                 wikiname => $config{wikiname},
81                 parentlinks => [parentlinks($page)],
82                 content => $content,
83     diff -urX ignorepats clean-ikidev/IkiWiki.pm ikidev/IkiWiki.pm
84     --- clean-ikidev/IkiWiki.pm 2007-02-25 12:26:58.812850000 -0800
85     +++ ikidev/IkiWiki.pm       2007-02-25 15:05:22.328852000 -0800
86     @@ -192,6 +192,12 @@
87         return $untainted;
88      } #}}}
89
90     +sub titlename($;@) { #{{{
91     +   my $page = shift;
92     +   $page =~ s!/index$!!;
93     +   return pagetitle(basename($page), @_);
94     +} #}}}
95     +
96      sub basename ($) { #{{{
97         my $file=shift;
98
99
100 > This way foo/index gets "foo" as its title, not "index". --Ethan
101
102 ---
103
104 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]]
105
106 > 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.
107
108 >> 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
109
110 >>> 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
111
112 >>>> 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.   
113
114 >>>>> 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
115
116 ----
117
118 First pass over Tumov's patch -- which doesn't cleanly apply anymore, so
119 I'll attach an updated and modified version below. --[[Joey]]
120
121 * As we discussed in email, this will break handling of `foo/index.mdwn`
122   pages. Needs to be changed to generate `foo/index/index.html` for such
123   pages (though not for the toplevel `index`).
124
125   >> Can someone elaborate on this? What's broken about it? Will pages
126   >> foo/index/index.html include foo/index in their parentlinks? --Ethan
127
128   >>> Presently the patch does not move `foo/index.type` as `foo/index/index.html`, but renders
129   >>> it as `foo/index.html`, not because I particularly want that (except for the top-level one, of
130   >>> course), but because it could be done :). This, however, conflicts with a `foo.mdwn`
131   >>> rendered as `foo/index.html`. The easiest and cleanest way to fix this, is to simply
132   >>> not handle `index` in such a special manner -- except for the top-level one. --[[tuomov]]
133
134   >>>> Oh, I see, this patch doesn't address wanting to use foo/index.mdwn as 
135   >>>> an input page. Hmm. --Ethan
136
137   >>>>> No, it doesn't. I originally also was after that, but after discussing the
138   >>>>> complexities of supporting that with Joey, came up with this simpler scheme
139   >>>>> without many of those issues. It is the output that I primarily care about, anyway,
140   >>>>> and I do, in fact, find the present input file organisation quite nice. The output
141   >>>>> locations just aren't very good for conversion of an existing site to ikiwiki, and do
142   >>>>> make for rather ugly URLs with the .html extensions. (I do often type some URLs
143   >>>>> out of memory, when they're gone from the browser's completion history, and the
144   >>>>> .html makes that more laboursome.)
145
146   >>>>>> I support your decision, but now this wiki page serves two different patches :).
147   >>>>>> Can we split them somehow?
148   >>>>>> What are the complexities involved?
149   >>>>>> I think I overcomplicated it a little with my patch, and Per Bothner's gets 
150   >>>>>> much closer to the heart of it. --Ethan
151
152 * This does make the resulting wikis much less browsable directly on the
153   filesystem, since `dir` to `dir/index.html` conversion is only handled by web
154   servers and so you end up browsing to a directory index all the time.
155   Wouldn't it be better to make the links themselves include the index.html?
156   (Although that would mean that [[bugs/broken_parentlinks]] would not be
157   fixed en passant by this patch..)
158
159      > Yes, the sites are not that browsable on the FS (I blame the browsers
160      > for being stupid!), but linking to the directory produces so much
161      > cleaner URLs for the Web, that I specifically want it. This is,
162      > after all, an optional arrangement. 
163
164      >> It's optional for *now* ... I suppose that I could make adding the
165      >> index.html yet another option. I'm not _that_ fond of optioons
166      >> however. --[[Joey]]
167
168      >>> It is worth noting, that with this patch, you _can_ render the local
169      >>> copy in the present manner, while rendering the Web copy under
170      >>> directories. So no extra options are really needed for local browsing, 
171      >>> unless you also want to serve the same copy over the Web, which I
172      >>> doubt. --[[tuomov]]
173
174 * Some of the generated links are missing the trailing / , which is
175   innefficient since it leads to a http redirect when clicking on that
176   link. Seems to be limited to ".." links, and possibly only to
177   parentlinks. (Already fixed it for "." links.)
178
179       > The solution seems to be to add to `urlto` the following snippet,
180       > which might also help with the next point. (Sorry, no updated patch
181       > yet. Should be on my way out in the cold anyway...)
182
183         if ( !length $to ) {
184                 return baseurl($from);
185         }
186  
187       >> Indeed, this brings the number of abs2rels closer to par, as well
188       >> as fixing the .. links. --[[Joey]]
189
190 * It calles abs2rel about 16% more often with the patch, which makes it
191   a bit slower, since abs2rel is not very efficient. (This omits abs2rel
192   calls that might be memoized away already.) This seems to be due to one
193   extra abs2rel for the toplevel wiki page due to the nicely cleaned up code
194   in `parentlinks` -- so I'm not really complaining.. Especially since the
195   patch adds a new nice memoizable `urlto`.
196 * The rss page name generation code seems unnecesarily roundabout, I'm sure
197   that can be cleaned up somehow, perhaps by making `htmlpage` more
198   generic.
199
200      > Something like `targetpage(basename, extension)`?
201
202      >> Yes exactly. It might also be possible to remove htmlpage from the
203      >> plugin interface entirely (in favour of urlto), which would be a
204      >> good time to make such a changes. Not required to accept this patch
205      >> though.
206
207      >>> [...] in fact, all uses of htmlpage in the plugins are used to
208      >>> construct an absolute address: the absolute url in most cases, so an `absurl`
209      >>> call could be added to be used instead of htmlpage
210      >>> --[[tuomov]]
211
212      >>>> Or it could use urlto("index", $page) instead. --[[Joey]]
213
214      >>>>> That is, however, a relative URL, and maybe an absolute one
215      >>>>> is wanted. Perhaps `urlto($targetpage)` should return the
216      >>>>> absolute version --[[tuomov]]
217
218 * > and something else in the
219   > aggregate plugin (above), that I also think isn't what's wanted:
220   > aren't `foo.html` pages also "rendered", so that they get moved as `foo/index.html`?
221   > --[[tuomov]]
222
223   >> Yes, the aggregate plugin will save the files as foo.html in the
224   >> sourcedir, and that will result in foo/index.html in the web site, same
225   >> as any other page. --[[Joey]]
226
227 * `img.pm` makes some assumptions about name of the page that will be
228   linking to the image, which are probably broken.
229
230 * The changes to htmlpage's behavior probably call for the plugin
231   interface version number to be changed.
232
233 Latest version of my patch... with most of the stuff that's been discussed, including `targetpage`.
234 Also available [here](http://iki.fi/tuomov/use_dirs-20070221.diff). (BTW, this posting, applying, and
235 updating of plain-old-diffs containing all the previous changes is starting to be painful. Reminds
236 me why I use darcs..) --[[tuomov]]
237
238 <pre>
239 Index: IkiWiki.pm
240 ===================================================================
241 --- IkiWiki.pm  (revision 2806)
242 +++ IkiWiki.pm  (working copy)
243 @@ -14,7 +14,7 @@
244  use Exporter q{import};
245  our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
246                   bestlink htmllink readfile writefile pagetype srcfile pagename
247 -                 displaytime will_render gettext
248 +                 displaytime will_render gettext urlto targetpage
249                   %config %links %renderedfiles %pagesources);
250  our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
251  our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
252 @@ -73,6 +73,7 @@
253         sslcookie => 0,
254         httpauth => 0,
255         userdir => "",
256 +       usedirs => 0
257  } #}}}
258     
259  sub checkconfig () { #{{{
260 @@ -224,10 +225,21 @@
261         return $page;
262  } #}}}
263  
264 +sub targetpage ($$) { #{{{
265 +       my $page=shift;
266 +       my $ext=shift;
267 +       
268 +       if (! $config{usedirs} || $page =~ /^index$/ ) {
269 +               return $page.".".$ext;
270 +       } else {
271 +               return $page."/index.".$ext;
272 +       }
273 +} #}}}
274 +
275  sub htmlpage ($) { #{{{
276         my $page=shift;
277 -
278 -       return $page.".html";
279 +       
280 +       return targetpage($page, "html");
281  } #}}}
282  
283  sub srcfile ($) { #{{{
284 @@ -393,6 +405,7 @@
285  
286         return "$config{url}/" if ! defined $page;
287         
288 +       $page=htmlpage($page);
289         $page=~s/[^\/]+$//;
290         $page=~s/[^\/]+\//..\//g;
291         return $page;
292 @@ -422,6 +435,32 @@
293                         $config{timeformat}, localtime($time)));
294  } #}}}
295  
296 +sub beautify_url ($) { #{{{
297 +       my $url=shift;
298 +
299 +       $url =~ s!/index.html$!/!;
300 +       $url =~ s!^$!./!; # Browsers don't like empty links...
301 +
302 +       return $url;
303 +} #}}}
304 +
305 +sub urlto ($$) { #{{{
306 +       my $to=shift;
307 +       my $from=shift;
308 +
309 +       if (! length $to) {
310 +               return beautify_url(baseurl($from));
311 +       }
312 +
313 +       if (! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
314 +               $to=htmlpage($to);
315 +       }
316 +
317 +       my $link = abs2rel($to, dirname(htmlpage($from)));
318 +
319 +       return beautify_url($link);
320 +} #}}}
321 +
322  sub htmllink ($$$;@) { #{{{
323         my $lpage=shift; # the page doing the linking
324         my $page=shift; # the page that will contain the link (different for inline)
325 @@ -457,7 +496,8 @@
326                         "\">?</a>$linktext</span>"
327         }
328         
329 -       $bestlink=abs2rel($bestlink, dirname($page));
330 +       $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
331 +       $bestlink=beautify_url($bestlink);
332         
333         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
334                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
335 Index: IkiWiki/Render.pm
336 ===================================================================
337 --- IkiWiki/Render.pm   (revision 2806)
338 +++ IkiWiki/Render.pm   (working copy)
339 @@ -32,8 +32,8 @@
340         my @links;
341         return unless $backlinks{$page};
342         foreach my $p (keys %{$backlinks{$page}}) {
343 -               my $href=abs2rel(htmlpage($p), dirname($page));
344 -                       
345 +               my $href=urlto($p, $page);
346 +                
347                 # Trim common dir prefixes from both pages.
348                 my $p_trimmed=$p;
349                 my $page_trimmed=$page;
350 @@ -55,18 +55,14 @@
351         my @ret;
352         my $pagelink="";
353         my $path="";
354 -       my $skip=1;
355 +       my $title=$config{wikiname};
356 +       
357         return if $page eq 'index'; # toplevel
358 -       foreach my $dir (reverse split("/", $page)) {
359 -               if (! $skip) {
360 -                       $path.="../";
361 -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
362 -               }
363 -               else {
364 -                       $skip=0;
365 -               }
366 +       foreach my $dir (split("/", $page)) {
367 +               push @ret, { url => urlto($path, $page), page => $title };
368 +               $path.="/".$dir;
369 +               $title=pagetitle($dir);
370         }
371 -       unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
372         return @ret;
373  } #}}}
374  
375 Index: IkiWiki/Plugin/inline.pm
376 ===================================================================
377 --- IkiWiki/Plugin/inline.pm    (revision 2806)
378 +++ IkiWiki/Plugin/inline.pm    (working copy)
379 @@ -110,8 +110,8 @@
380  
381         add_depends($params{page}, $params{pages});
382  
383 -       my $rssurl=rsspage(basename($params{page}));
384 -       my $atomurl=atompage(basename($params{page}));
385 +       my $rssurl=basename(rsspage($params{page}));
386 +       my $atomurl=basename(atompage($params{page}));
387         my $ret="";
388  
389         if (exists $params{rootpage} && $config{cgiurl}) {
390 @@ -150,10 +150,7 @@
391                         # Don't use htmllink because this way the
392                         # title is separate and can be overridden by
393                         # other plugins.
394 -                       my $link=bestlink($params{page}, $page);
395 -                       $link=htmlpage($link) if defined $type;
396 -                       $link=abs2rel($link, dirname($params{destpage}));
397 -                       $template->param(pageurl => $link);
398 +                       $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
399                         $template->param(title => pagetitle(basename($page)));
400                         $template->param(ctime => displaytime($pagectime{$page}));
401  
402 @@ -205,15 +202,17 @@
403                 }
404         
405                 if ($rss) {
406 -                       will_render($params{page}, rsspage($params{page}));
407 -                       writefile(rsspage($params{page}), $config{destdir},
408 +                       my $rssp=rsspage($params{page});
409 +                       will_render($params{page}, $rssp);
410 +                       writefile($rssp, $config{destdir},
411                                 genfeed("rss", $rssurl, $desc, $params{page}, @list));
412                         $toping{$params{page}}=1 unless $config{rebuild};
413                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
414                 }
415                 if ($atom) {
416 -                       will_render($params{page}, atompage($params{page}));
417 -                       writefile(atompage($params{page}), $config{destdir},
418 +                       my $atomp=atompage($params{page});
419 +                       will_render($params{page}, $atomp);
420 +                       writefile($atomp, $config{destdir},
421                                 genfeed("atom", $atomurl, $desc, $params{page}, @list));
422                         $toping{$params{page}}=1 unless $config{rebuild};
423                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
424 @@ -288,16 +287,21 @@
425         return $content;
426  } #}}}
427  
428 -sub rsspage ($) { #{{{
429 +sub basepage ($) { #{{{
430         my $page=shift;
431 +       
432 +       $page=htmlpage($page);
433 +       $page =~ s/\.html$//;
434 +       
435 +       return $page;
436 +} #}}}
437  
438 -       return $page.".rss";
439 +sub rsspage ($) { #{{{
440 +       return targetpage(shift, "rss");
441  } #}}}
442  
443  sub atompage ($) { #{{{
444 -       my $page=shift;
445 -
446 -       return $page.".atom";
447 +       return targetpage(shift, "atom");
448  } #}}}
449  
450  sub genfeed ($$$$@) { #{{{
451 Index: IkiWiki/Plugin/aggregate.pm
452 ===================================================================
453 --- IkiWiki/Plugin/aggregate.pm (revision 2806)
454 +++ IkiWiki/Plugin/aggregate.pm (working copy)
455 @@ -320,7 +320,7 @@
456                 # NB: This doesn't check for path length limits.
457                 eval q{use POSIX};
458                 my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
459 -               if (defined $max && length(htmlpage($page)) >= $max) {
460 +               if (defined $max && length(htmlfn($page)) >= $max) {
461                         $c="";
462                         $page=$feed->{dir}."/item";
463                         while (exists $IkiWiki::pagecase{lc $page.$c} ||
464 @@ -356,7 +356,7 @@
465         if (ref $feed->{tags}) {
466                 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
467         }
468 -       writefile(htmlpage($guid->{page}), $config{srcdir},
469 +       writefile(htmlfn($guid->{page}), $config{srcdir},
470                 $template->output);
471  
472         # Set the mtime, this lets the build process get the right creation
473 @@ -434,4 +434,8 @@
474         return "$config{srcdir}/".htmlpage($page);
475  } #}}}
476  
477 +sub htmlfn ($) { #{{{
478 +       return shift().".html";
479 +} #}}}
480 +
481  1
482 Index: IkiWiki/Plugin/linkmap.pm
483 ===================================================================
484 --- IkiWiki/Plugin/linkmap.pm   (revision 2806)
485 +++ IkiWiki/Plugin/linkmap.pm   (working copy)
486 @@ -49,9 +49,7 @@
487         my %mapitems = ();
488         foreach my $item (keys %links) {
489                 if (pagespec_match($item, $params{pages}, $params{page})) {
490 -                       my $link=htmlpage($item);
491 -                       $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
492 -                       $mapitems{$item}=$link;
493 +                       $mapitems{$item}=urlto($item, $params{destpage});
494                 }
495         }
496  
497 Index: doc/usage.mdwn
498 ===================================================================
499 --- doc/usage.mdwn      (revision 2806)
500 +++ doc/usage.mdwn      (working copy)
501 @@ -244,6 +244,10 @@
502  
503    Log to syslog(3).
504  
505 +* --usedirs
506 +
507 +  Create output files named page/index.html instead of page.html.
508 +
509  * --w3mmode, --no-w3mmode
510  
511    Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
512 Index: doc/plugins/write.mdwn
513 ===================================================================
514 --- doc/plugins/write.mdwn      (revision 2806)
515 +++ doc/plugins/write.mdwn      (working copy)
516 @@ -412,6 +412,10 @@
517  
518  This is the standard gettext function, although slightly optimised.
519  
520 +#### `urlto($$)`
521 +
522 +Construct a relative url to the first parameter from the second.
523 +
524  ## RCS plugins
525  
526  ikiwiki's support for revision control systems also uses pluggable perl
527 Index: doc/ikiwiki.setup
528 ===================================================================
529 --- doc/ikiwiki.setup   (revision 2806)
530 +++ doc/ikiwiki.setup   (working copy)
531 @@ -94,6 +94,8 @@
532         syslog => 0,
533         # To link to user pages in a subdirectory of the wiki.
534         #userdir => "users",
535 +       # To enable alternate output filenames.
536 +       #usedirs => 1,
537  
538         # To add plugins, list them here.
539         #add_plugins => [qw{goodstuff openid search wikitext camelcase
540 </pre>