>>>> 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.
+>>>>> 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
----
First pass over Tumov's patch -- which doesn't cleanly apply anymore, so
-I'll attach an updated and slightly modified version below.
-
-* `urlto()` is O(N) to the number of pages in the wiki, which leads to
- O(N^2) behavior, which could be a scalability problem. This happens because
- of the lookup for `$to` in `%renderedfiles`, which shouldn't be necessary
- most of the time. Couldn't it just be required that `$to` be a html page
- name on input? Or require it be a non-html page name and always run
- htmlpage on it.
+I'll attach an updated and modified version below. --[[Joey]]
+
* As we discussed in email, this will break handling of `foo/index.mdwn`
pages. Needs to be changed to generate `foo/index/index.html` for such
pages (though not for the toplevel `index`).
+
+ >> Can someone elaborate on this? What's broken about it? Will pages
+ >> foo/index/index.html include foo/index in their parentlinks? --Ethan
+
+ >>> Presently the patch does not move `foo/index.type` as `foo/index/index.html`, but renders
+ >>> it as `foo/index.html`, not because I particularly want that (except for the top-level one, of
+ >>> course), but because it could be done :). This, however, conflicts with a `foo.mdwn`
+ >>> rendered as `foo/index.html`. The easiest and cleanest way to fix this, is to simply
+ >>> not handle `index` in such a special manner -- except for the top-level one. --[[tuomov]]
+
+ >>>> Oh, I see, this patch doesn't address wanting to use foo/index.mdwn as
+ >>>> an input page. Hmm. --Ethan
+
+ >>>>> No, it doesn't. I originally also was after that, but after discussing the
+ >>>>> complexities of supporting that with Joey, came up with this simpler scheme
+ >>>>> without many of those issues. It is the output that I primarily care about, anyway,
+ >>>>> and I do, in fact, find the present input file organisation quite nice. The output
+ >>>>> locations just aren't very good for conversion of an existing site to ikiwiki, and do
+ >>>>> make for rather ugly URLs with the .html extensions. (I do often type some URLs
+ >>>>> out of memory, when they're gone from the browser's completion history, and the
+ >>>>> .html makes that more laboursome.)
+
+ >>>>>> I support your decision, but now this wiki page serves two different patches :).
+ >>>>>> Can we split them somehow?
+ >>>>>> What are the complexities involved?
+ >>>>>> I think I overcomplicated it a little with my patch, and Per Bothner's gets
+ >>>>>> much closer to the heart of it. --Ethan
+
* This does make the resulting wikis much less browsable directly on the
filesystem, since `dir` to `dir/index.html` conversion is only handled by web
servers and so you end up browsing to a directory index all the time.
Wouldn't it be better to make the links themselves include the index.html?
+ (Although that would mean that [[bugs/broken_parentlinks]] would not be
+ fixed en passant by this patch..)
+
+ > Yes, the sites are not that browsable on the FS (I blame the browsers
+ > for being stupid!), but linking to the directory produces so much
+ > cleaner URLs for the Web, that I specifically want it. This is,
+ > after all, an optional arrangement.
+
+ >> It's optional for *now* ... I suppose that I could make adding the
+ >> index.html yet another option. I'm not _that_ fond of optioons
+ >> however. --[[Joey]]
+
+ >>> It is worth noting, that with this patch, you _can_ render the local
+ >>> copy in the present manner, while rendering the Web copy under
+ >>> directories. So no extra options are really needed for local browsing,
+ >>> unless you also want to serve the same copy over the Web, which I
+ >>> doubt. --[[tuomov]]
+
* Some of the generated links are missing the trailing / , which is
innefficient since it leads to a http redirect when clicking on that
link. Seems to be limited to ".." links, and possibly only to
parentlinks. (Already fixed it for "." links.)
+
+ > The solution seems to be to add to `urlto` the following snippet,
+ > which might also help with the next point. (Sorry, no updated patch
+ > yet. Should be on my way out in the cold anyway...)
+
+ if ( !length $to ) {
+ return baseurl($from);
+ }
+
+ >> Indeed, this brings the number of abs2rels closer to par, as well
+ >> as fixing the .. links. --[[Joey]]
+
* It calles abs2rel about 16% more often with the patch, which makes it
a bit slower, since abs2rel is not very efficient. (This omits abs2rel
calls that might be memoized away already.) This seems to be due to one
that can be cleaned up somehow, perhaps by making `htmlpage` more
generic.
-This is only a first pass, I have not yet audited all the plugins to see if
-any are broken by the changes.
+ > Something like `targetpage(basename, extension)`?
+
+ >> Yes exactly. It might also be possible to remove htmlpage from the
+ >> plugin interface entirely (in favour of urlto), which would be a
+ >> good time to make such a changes. Not required to accept this patch
+ >> though.
+
+ >>> [...] in fact, all uses of htmlpage in the plugins are used to
+ >>> construct an absolute address: the absolute url in most cases, so an `absurl`
+ >>> call could be added to be used instead of htmlpage
+ >>> --[[tuomov]]
+
+ >>>> Or it could use urlto("index", $page) instead. --[[Joey]]
---[[Joey]]
+ >>>>> That is, however, a relative URL, and maybe an absolute one
+ >>>>> is wanted. Perhaps `urlto($targetpage)` should return the
+ >>>>> absolute version --[[tuomov]]
-Updated version of Tumov's patch follows:
+* > and something else in the
+ > aggregate plugin (above), that I also think isn't what's wanted:
+ > aren't `foo.html` pages also "rendered", so that they get moved as `foo/index.html`?
+ > --[[tuomov]]
+
+ >> Yes, the aggregate plugin will save the files as foo.html in the
+ >> sourcedir, and that will result in foo/index.html in the web site, same
+ >> as any other page. --[[Joey]]
+
+* `img.pm` makes some assumptions about name of the page that will be
+ linking to the image, which are probably broken.
+
+* The changes to htmlpage's behavior probably call for the plugin
+ interface version number to be changed.
+
+Latest version of my patch... with most of the stuff that's been discussed, including `targetpage`.
+Also available [here](http://iki.fi/tuomov/use_dirs-20070221.diff). (BTW, this posting, applying, and
+updating of plain-old-diffs containing all the previous changes is starting to be painful. Reminds
+me why I use darcs..) --[[tuomov]]
<pre>
+Index: IkiWiki.pm
+===================================================================
+--- IkiWiki.pm (revision 2806)
++++ IkiWiki.pm (working copy)
+@@ -14,7 +14,7 @@
+ use Exporter q{import};
+ our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
+ bestlink htmllink readfile writefile pagetype srcfile pagename
+- displaytime will_render gettext
++ displaytime will_render gettext urlto targetpage
+ %config %links %renderedfiles %pagesources);
+ our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
+ our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
+@@ -73,6 +73,7 @@
+ sslcookie => 0,
+ httpauth => 0,
+ userdir => "",
++ usedirs => 0
+ } #}}}
+
+ sub checkconfig () { #{{{
+@@ -224,10 +225,21 @@
+ return $page;
+ } #}}}
+
++sub targetpage ($$) { #{{{
++ my $page=shift;
++ my $ext=shift;
++
++ if (! $config{usedirs} || $page =~ /^index$/ ) {
++ return $page.".".$ext;
++ } else {
++ return $page."/index.".$ext;
++ }
++} #}}}
++
+ sub htmlpage ($) { #{{{
+ my $page=shift;
+-
+- return $page.".html";
++
++ return targetpage($page, "html");
+ } #}}}
+
+ sub srcfile ($) { #{{{
+@@ -393,6 +405,7 @@
+
+ return "$config{url}/" if ! defined $page;
+
++ $page=htmlpage($page);
+ $page=~s/[^\/]+$//;
+ $page=~s/[^\/]+\//..\//g;
+ return $page;
+@@ -422,6 +435,32 @@
+ $config{timeformat}, localtime($time)));
+ } #}}}
+
++sub beautify_url ($) { #{{{
++ my $url=shift;
++
++ $url =~ s!/index.html$!/!;
++ $url =~ s!^$!./!; # Browsers don't like empty links...
++
++ return $url;
++} #}}}
++
++sub urlto ($$) { #{{{
++ my $to=shift;
++ my $from=shift;
++
++ if (! length $to) {
++ return beautify_url(baseurl($from));
++ }
++
++ if (! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
++ $to=htmlpage($to);
++ }
++
++ my $link = abs2rel($to, dirname(htmlpage($from)));
++
++ return beautify_url($link);
++} #}}}
++
+ sub htmllink ($$$;@) { #{{{
+ my $lpage=shift; # the page doing the linking
+ my $page=shift; # the page that will contain the link (different for inline)
+@@ -457,7 +496,8 @@
+ "\">?</a>$linktext</span>"
+ }
+
+- $bestlink=abs2rel($bestlink, dirname($page));
++ $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
++ $bestlink=beautify_url($bestlink);
+
+ if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
+ return "<img src=\"$bestlink\" alt=\"$linktext\" />";
Index: IkiWiki/Render.pm
===================================================================
---- IkiWiki/Render.pm (revision 2700)
+--- IkiWiki/Render.pm (revision 2806)
+++ IkiWiki/Render.pm (working copy)
@@ -32,8 +32,8 @@
my @links;
Index: IkiWiki/Plugin/inline.pm
===================================================================
---- IkiWiki/Plugin/inline.pm (revision 2700)
+--- IkiWiki/Plugin/inline.pm (revision 2806)
+++ IkiWiki/Plugin/inline.pm (working copy)
@@ -110,8 +110,8 @@
my $ret="";
if (exists $params{rootpage} && $config{cgiurl}) {
-@@ -151,8 +151,7 @@
+@@ -150,10 +150,7 @@
+ # Don't use htmllink because this way the
# title is separate and can be overridden by
# other plugins.
- my $link=bestlink($params{page}, $page);
+- my $link=bestlink($params{page}, $page);
- $link=htmlpage($link) if defined $type;
- $link=abs2rel($link, dirname($params{destpage}));
-+ $link=urlto($link, $params{destpage});
- $template->param(pageurl => $link);
+- $template->param(pageurl => $link);
++ $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
$template->param(title => pagetitle(basename($page)));
$template->param(ctime => displaytime($pagectime{$page}));
-@@ -205,15 +204,17 @@
+
+@@ -205,15 +202,17 @@
}
if ($rss) {
genfeed("atom", $atomurl, $desc, $params{page}, @list));
$toping{$params{page}}=1 unless $config{rebuild};
$feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
-@@ -288,16 +289,25 @@
+@@ -288,16 +287,21 @@
return $content;
} #}}}
+-sub rsspage ($) { #{{{
+sub basepage ($) { #{{{
-+ my $page=shift;
+ my $page=shift;
+
+ $page=htmlpage($page);
+ $page =~ s/\.html$//;
+
+ return $page;
+} #}}}
-+
- sub rsspage ($) { #{{{
- my $page=shift;
- return $page.".rss";
-+ return basepage($page).".rss";
++sub rsspage ($) { #{{{
++ return targetpage(shift, "rss");
} #}}}
sub atompage ($) { #{{{
- my $page=shift;
-
+- my $page=shift;
+-
- return $page.".atom";
-+ return basepage($page).".atom";
++ return targetpage(shift, "atom");
} #}}}
sub genfeed ($$$$@) { #{{{
-Index: ikiwiki.in
+Index: IkiWiki/Plugin/aggregate.pm
+===================================================================
+--- IkiWiki/Plugin/aggregate.pm (revision 2806)
++++ IkiWiki/Plugin/aggregate.pm (working copy)
+@@ -320,7 +320,7 @@
+ # NB: This doesn't check for path length limits.
+ eval q{use POSIX};
+ my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
+- if (defined $max && length(htmlpage($page)) >= $max) {
++ if (defined $max && length(htmlfn($page)) >= $max) {
+ $c="";
+ $page=$feed->{dir}."/item";
+ while (exists $IkiWiki::pagecase{lc $page.$c} ||
+@@ -356,7 +356,7 @@
+ if (ref $feed->{tags}) {
+ $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
+ }
+- writefile(htmlpage($guid->{page}), $config{srcdir},
++ writefile(htmlfn($guid->{page}), $config{srcdir},
+ $template->output);
+
+ # Set the mtime, this lets the build process get the right creation
+@@ -434,4 +434,8 @@
+ return "$config{srcdir}/".htmlpage($page);
+ } #}}}
+
++sub htmlfn ($) { #{{{
++ return shift().".html";
++} #}}}
++
+ 1
+Index: IkiWiki/Plugin/linkmap.pm
===================================================================
---- ikiwiki.in (revision 2700)
-+++ ikiwiki.in (working copy)
-@@ -46,6 +46,7 @@
- "sslcookie!" => \$config{sslcookie},
- "httpauth!" => \$config{httpauth},
- "userdir=s" => \$config{userdir},
-+ "usedirs!" => \$config{usedirs},
- "exclude=s@" => sub {
- push @{$config{wiki_file_prune_regexps}}, $_[1];
- },
+--- IkiWiki/Plugin/linkmap.pm (revision 2806)
++++ IkiWiki/Plugin/linkmap.pm (working copy)
+@@ -49,9 +49,7 @@
+ my %mapitems = ();
+ foreach my $item (keys %links) {
+ if (pagespec_match($item, $params{pages}, $params{page})) {
+- my $link=htmlpage($item);
+- $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
+- $mapitems{$item}=$link;
++ $mapitems{$item}=urlto($item, $params{destpage});
+ }
+ }
+
Index: doc/usage.mdwn
===================================================================
---- doc/usage.mdwn (revision 2700)
+--- doc/usage.mdwn (revision 2806)
+++ doc/usage.mdwn (working copy)
@@ -244,6 +244,10 @@
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
Index: doc/plugins/write.mdwn
===================================================================
---- doc/plugins/write.mdwn (revision 2700)
+--- doc/plugins/write.mdwn (revision 2806)
+++ doc/plugins/write.mdwn (working copy)
@@ -412,6 +412,10 @@
ikiwiki's support for revision control systems also uses pluggable perl
Index: doc/ikiwiki.setup
===================================================================
---- doc/ikiwiki.setup (revision 2700)
+--- doc/ikiwiki.setup (revision 2806)
+++ doc/ikiwiki.setup (working copy)
@@ -94,6 +94,8 @@
syslog => 0,
# To add plugins, list them here.
#add_plugins => [qw{goodstuff openid search wikitext camelcase
-Index: IkiWiki.pm
-===================================================================
---- IkiWiki.pm (revision 2700)
-+++ IkiWiki.pm (working copy)
-@@ -14,7 +14,7 @@
- use Exporter q{import};
- our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
- bestlink htmllink readfile writefile pagetype srcfile pagename
-- displaytime will_render gettext
-+ displaytime will_render gettext urlto
- %config %links %renderedfiles %pagesources);
- our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
- our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
-@@ -72,6 +72,7 @@
- sslcookie => 0,
- httpauth => 0,
- userdir => "",
-+ usedirs => 0
- } #}}}
-
- sub checkconfig () { #{{{
-@@ -226,7 +227,11 @@
- sub htmlpage ($) { #{{{
- my $page=shift;
-
-- return $page.".html";
-+ if (! $config{usedirs} || $page =~ /^index$/ || $page =~ /\/index$/) {
-+ return $page.".html";
-+ } else {
-+ return $page."/index.html";
-+ }
- } #}}}
-
- sub srcfile ($) { #{{{
-@@ -390,6 +395,7 @@
-
- return "$config{url}/" if ! defined $page;
-
-+ $page=htmlpage($page);
- $page=~s/[^\/]+$//;
- $page=~s/[^\/]+\//..\//g;
- return $page;
-@@ -419,6 +425,29 @@
- $config{timeformat}, localtime($time)));
- } #}}}
-
-+sub beautify_url ($) { #{{{
-+ my $url=shift;
-+
-+ $url =~ s!/index.html$!/!;
-+ $url =~ s!^$!./!; # Browsers don't like empty links...
-+
-+ return $url;
-+} #}}}
-+
-+sub urlto ($$) { #{{{
-+ my $to=shift;
-+ my $from=shift;
-+
-+ if (length $to &&
-+ ! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
-+ $to=htmlpage($to);
-+ }
-+
-+ my $link = abs2rel($to, dirname(htmlpage($from)));
-+
-+ return beautify_url($link);
-+} #}}}
-+
- sub htmllink ($$$;@) { #{{{
- my $lpage=shift; # the page doing the linking
- my $page=shift; # the page that will contain the link (different for inline)
-@@ -454,7 +483,8 @@
- "\">?</a>$linktext</span>"
- }
-
-- $bestlink=abs2rel($bestlink, dirname($page));
-+ $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
-+ $bestlink=beautify_url($bestlink);
-
- if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
- return "<img src=\"$bestlink\" alt=\"$linktext\" />";
</pre>