]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/patchqueue/index.html_allowed.mdwn
escape
[git.ikiwiki.info.git] / doc / patchqueue / index.html_allowed.mdwn
index 5690d24a75f160a30f82842515e94498268e639b..f8bf15ac464bc22b20436d7d7afff40e8c4be18b 100644 (file)
-Instead of having files foo.html "in front of" foo/, I prefer to have foo/index.html. This patch allows that. Specifically, foo/index.type is translated to $links{'foo/'}, and bestlink looks for either "foo" or "foo/" when linking to pages. There are other miscellaneous changes that go with that:
+This page used to be used for two patches, one of which is applied
+providing the usedirs option for output. The remaining patch, discussed
+below, concerns wanting to use foo/index.mdwn source files and get an
+output page name of foo, rather than foo/index. --[[Joey]]
 
-1. backlinks from "foo/bar" to "foo/" trim common prefixes as long as there would be something left when the trimming is done (i.e. don't trim "foo/")
-2. parentlinks for "foo/" are the same as for "foo", except one directory higher
-3. rewrite parentlinks so that bestlink is called at each level
-4. basename("foo/") => basename("foo")
-5. links to "foo/" are translated to "foo/index.html" rather than "foo/.html". (Links to "foo/" might be preferred, but that causes an infinite loop in writefile, because apparently dirname("foo/") == "foo/" on my system for reasons that aren't clear to me.)
-6. pagetitle("foo/") => pagetitle("foo")
+---
 
-In case whitespace gets garbled, I'm also leaving a copy of the patch on [my site](http://ikidev.betacantrips.com/patches/index.patch). It should apply cleanly to a freshly unpacked ikiwiki-1.40. You can also see it in action [here](http://ikidev.betacantrips.com/one/). --Ethan
+I independently implemented a similar, but smaller patch.
+(It's smaller because I only care about rendering; not CGI, for example.)
+The key to this patch is that "A/B/C" is treated as equivalent
+to "A/B/C/index".
+Here it is:  --Per Bothner
 
-    diff -urx .svn ikiwiki/IkiWiki/Render.pm ikidev/IkiWiki/Render.pm
-    --- ikiwiki/IkiWiki/Render.pm      2007-01-11 15:01:51.000000000 -0800
-    +++ ikidev/IkiWiki/Render.pm       2007-01-15 18:38:34.000000000 -0800
-    @@ -40,6 +40,7 @@
-               my $dir;
-               1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
-                       defined $dir &&
-    +                  $p_trimmed=~m/^\Q$dir\E(?:.)/ &&
-                       $p_trimmed=~s/^\Q$dir\E// &&
-                       $page_trimmed=~s/^\Q$dir\E//;
-                              
-    @@ -57,10 +58,18 @@
-       my $path="";
-       my $skip=1;
-       return if $page eq 'index'; # toplevel
-    -  foreach my $dir (reverse split("/", $page)) {
-    +  if ($page =~ m{/$}){
-    +          $page =~ s{/$}{};
-    +          $path="../";
-    +  }
-    +
-    +  while ($page =~ m!([^/]+)$!) {
-    +          my $last = $1;
-    +          $page =~ s!/?[^/]+$!!;
-               if (! $skip) {
-                       $path.="../";
-    -                  unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
-    +                  my $target = abs2rel(htmlpage(bestlink($page, $last)), $page);
-    +                  unshift @ret, { url => $path.$target, page => pagetitle($last) };
-               }
-               else {
-                       $skip=0;
-    diff -urx .svn ikiwiki/IkiWiki.pm ikidev/IkiWiki.pm
-    --- ikiwiki/IkiWiki.pm     2007-01-12 12:47:09.000000000 -0800
-    +++ ikidev/IkiWiki.pm      2007-01-15 16:56:58.000000000 -0800
-    @@ -185,6 +185,7 @@
-     sub basename ($) { #{{{
-       my $file=shift;
-     
-    +  $file=~s!/$!!;
-       $file=~s!.*/+!!;
-       return $file;
-     } #}}}
-    @@ -211,12 +212,14 @@
-       my $type=pagetype($file);
-       my $page=$file;
-       $page=~s/\Q.$type\E*$// if defined $type;
-    +  $page=~s#index$## if $page=~m{/index$};
-       return $page;
-     } #}}}
-     
-     sub htmlpage ($) { #{{{
-       my $page=shift;
-     
-    +  return $page."index.html" if $page=~m{/$};
-       return $page.".html";
-     } #}}}
-     
-    @@ -300,6 +303,7 @@
-       my $page=shift;
-       my $link=shift;
-       
-    +  $page =~ s!/$!!;
-       my $cwd=$page;
-       if ($link=~s/^\/+//) {
-               # absolute links
-    @@ -314,6 +318,9 @@
-               if (exists $links{$l}) {
-                       return $l;
-               }
-    +          if (exists $links{$l.'/'}){
-    +                  return $l.'/';
-    +          }
-               elsif (exists $pagecase{lc $l}) {
-                       return $pagecase{lc $l};
-               }
-    @@ -344,6 +351,7 @@
-               $page=~s/__(\d+)__/&#$1;/g;
-       }
-       $page=~y/_/ /;
-    +  $page=~s!/$!!;
+    --- IkiWiki/Render.pm~  2007-01-11 15:01:51.000000000 -0800
+    +++ IkiWiki/Render.pm   2007-02-02 22:24:12.000000000 -0800
+    @@ -60,9 +60,9 @@
+            foreach my $dir (reverse split("/", $page)) {
+                    if (! $skip) {
+                            $path.="../";
+    -                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
+    +                       unshift @ret, { url => abs2rel(htmlpage(bestlink($page, $dir)), dirname($page)), page => pagetitle($dir) };
+                    }
+    -               else {
+    +               elsif ($dir ne "index") {
+                            $skip=0;
+                    }
+            }
+
+    --- IkiWiki.pm~ 2007-01-12 12:47:09.000000000 -0800
+    +++ IkiWiki.pm  2007-02-02 18:02:16.000000000 -0800
+    @@ -315,6 +315,12 @@
+                    elsif (exists $pagecase{lc $l}) {
+                            return $pagecase{lc $l};
+                     }
+    +               else {
+    +                   my $lindex = $l . "/index";
+    +                   if (exists $links{$lindex}) {
+    +                       return $lindex;
+    +               }
+    +               }
+             } while $cwd=~s!/?[^/]+$!!;
      
-       return $page;
+            if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
+
+Note I handle setting the url; slightly differently.
+Also note that an initial "index" is ignored.  I.e. a
+page "A/B/index.html" is treated as "A/B".
+
+> Actually, your patch is shorter because it's more elegant and better :)
+> I'm withdrawing my old patch, because yours is much more in line with
+> ikiwiki's design and architecture.
+> I would like to make one suggestion to your patch, which is:
+
+    diff -urX ignorepats clean-ikidev/IkiWiki/Plugin/inline.pm ikidev/IkiWiki/Plugin/inline.pm
+    --- clean-ikidev/IkiWiki/Plugin/inline.pm   2007-02-25 12:26:54.099113000 -0800
+    +++ ikidev/IkiWiki/Plugin/inline.pm 2007-02-25 14:55:21.163340000 -0800
+    @@ -154,7 +154,7 @@
+                        $link=htmlpage($link) if defined $type;
+                        $link=abs2rel($link, dirname($params{destpage}));
+                        $template->param(pageurl => $link);
+    -                   $template->param(title => pagetitle(basename($page)));
+    +                   $template->param(title => titlename($page));
+                        $template->param(ctime => displaytime($pagectime{$page}));
+
+                        if ($actions) {
+    @@ -318,7 +318,7 @@
+                my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
+
+                $itemtemplate->param(
+    -                   title => pagetitle(basename($p), 1),
+    +                   title => titlename($p, 1),
+                        url => $u,
+                        permalink => $u,
+                        date_822 => date_822($pagectime{$p}),
+    diff -urX ignorepats clean-ikidev/IkiWiki/Render.pm ikidev/IkiWiki/Render.pm
+    --- clean-ikidev/IkiWiki/Render.pm  2007-02-25 12:26:54.745833000 -0800
+    +++ ikidev/IkiWiki/Render.pm        2007-02-25 14:54:01.564715000 -0800
+    @@ -110,7 +110,7 @@
+        $template->param(
+                title => $page eq 'index'
+                        ? $config{wikiname}
+    -                   : pagetitle(basename($page)),
+    +                   : titlename($page),
+                wikiname => $config{wikiname},
+                parentlinks => [parentlinks($page)],
+                content => $content,
+    diff -urX ignorepats clean-ikidev/IkiWiki.pm ikidev/IkiWiki.pm
+    --- clean-ikidev/IkiWiki.pm 2007-02-25 12:26:58.812850000 -0800
+    +++ ikidev/IkiWiki.pm       2007-02-25 15:05:22.328852000 -0800
+    @@ -192,6 +192,12 @@
+        return $untainted;
      } #}}}
+
+    +sub titlename($;@) { #{{{
+    +   my $page = shift;
+    +   $page =~ s!/index$!!;
+    +   return pagetitle(basename($page), @_);
+    +} #}}}
+    +
+     sub basename ($) { #{{{
+        my $file=shift;
+
+
+> This way foo/index gets "foo" as its title, not "index". --Ethan