From 6c2163d596dccf794ef47cf828c209432db2bca3 Mon Sep 17 00:00:00 2001 From: "http://www.cse.unsw.edu.au/~willu/" Date: Sat, 2 Aug 2008 21:52:48 -0400 Subject: update to actual generated example --- ...map_is_inconsistent_about_bare_directories.mdwn | 81 +++++++++++++++++----- 1 file changed, 63 insertions(+), 18 deletions(-) (limited to 'doc/bugs/map_is_inconsistent_about_bare_directories.mdwn') diff --git a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn index 479db3e0f..07c8851b1 100644 --- a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn +++ b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn @@ -1,26 +1,71 @@ The [[plugins/map]] plugin has inconsistent behaviour. In particular, I have in my wiki some directory structures holding files without wikitext pointers (I point directly to the files from elsewhere). For example, imagine the following file structure in the source dir: -* Assignments.mdwn -* Assignments - * 2004 - * Assign1.pdf - * Assign2.pdf - * 2005 - * Assign1.pdf - * Assign2.pdf - * 2006 - * etc., etc. + ; ls -R dirA dirB + dirA: + subA subB + + dirA/subA: + filea.mdwn fileb.mdwn + + dirA/subB: + filec.mdwn filed.mdwn + + dirB: + subA subC + + dirB/subA: + filea.mdwn + + dirB/subC: + fileb.mdwn filec.mdwn When I use map to make a map of this, the result looks more like this: -* Assignments # this is a link to the correct page - * 2004 # this has a create link - * Assign1.pdf - * Assign2.pdf - * Assign1.pdf - * Assign2.pdf - * etc., etc. + -Note that while the 2004 directory exists with a create link, the 2005 and 2006 (etc) directories are missing from the site map. +Note that while the dirA/subA directory exists with a create link, the dirA/subB directory is missing from the map. Interstingly, dirB/subC is shown in the map. If you add a second file to dirB/subA then dirB/subC disappears as well. I could imagine including all 'bare' directories in the map, and I could imagine including no 'bare' directories in the map. Just including the first bare directory seems a strange intermediate point. -- cgit v1.2.3 From 35a3559ebe6fe5fbcfc655629ff7458414885a54 Mon Sep 17 00:00:00 2001 From: "http://www.cse.unsw.edu.au/~willu/" Date: Sat, 2 Aug 2008 22:14:26 -0400 Subject: Add patch to bug report --- ...map_is_inconsistent_about_bare_directories.mdwn | 49 +++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) (limited to 'doc/bugs/map_is_inconsistent_about_bare_directories.mdwn') diff --git a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn index 07c8851b1..c1f388001 100644 --- a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn +++ b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn @@ -66,6 +66,53 @@ When I use map to make a map of this, the result looks more like this: -Note that while the dirA/subA directory exists with a create link, the dirA/subB directory is missing from the map. Interstingly, dirB/subC is shown in the map. If you add a second file to dirB/subA then dirB/subC disappears as well. +Note that while the dirA/subA directory exists with a create link, the dirA/subB directory is missing from the map. Interestingly, dirB/subC is shown in the map. If you add a second file to dirB/subA then dirB/subC disappears as well. I could imagine including all 'bare' directories in the map, and I could imagine including no 'bare' directories in the map. Just including the first bare directory seems a strange intermediate point. + +Attached is a [[patch]] that fixes the issue. The current map code makes one pass over the sorted list of pages. This adds an initial pass that goes through and makes sure that all parent directories are included. With this initial pass added, the following pass could probably be simplified. + +Note: This patch adds items to a map while it is in a foreach loop over a sorted list of keys from that same map. Changing a map while iterating through it is normally problematic. I'm assuming the sort insulates the code from this - I do not need to iterate over any of the newly added elements. + + diff --git a/IkiWiki/Plugin/map.pm b/IkiWiki/Plugin/map.pm + index 5b6a843..142073d 100644 + --- a/IkiWiki/Plugin/map.pm + +++ b/IkiWiki/Plugin/map.pm + @@ -67,6 +67,37 @@ sub preprocess (@) { #{{{ + # are removed. + add_depends($params{page}, join(" or ", keys %mapitems)); + + + # Include all the parent directories in the map + + my $lastbase=""; + + foreach my $item (sort keys %mapitems) { + + $item=~s/^\Q$common_prefix\E\/// + + if defined $common_prefix && length $common_prefix; + + my $itembase=IkiWiki::dirname($item); + + if ($itembase ne $lastbase) { + + # find the common dir + + my @a=split(/\//, $itembase); + + my @b=split(/\//, $lastbase); + + my $common_dir=""; + + while (@a && @b && $a[0] eq $b[0]) { + + if (length $common_dir) { + + $common_dir.="/"; + + } + + $common_dir.=shift(@a); + + shift @b; + + } + + # add all the dirs down to the current base + + while (@a) { + + if (length $common_dir) { + + $common_dir.="/"; + + } + + $common_dir.=shift(@a); + + $mapitems{$common_dir}='' + + unless defined $mapitems{$common_dir}; + + } + + $lastbase = $itembase; + + } + + } + + + # Create the map. + my $parent=""; + my $indent=0; -- cgit v1.2.3 From 4cdf41df0cd1383f50060922ea9dafb8c5323051 Mon Sep 17 00:00:00 2001 From: "http://www.cse.unsw.edu.au/~willu/" Date: Sat, 2 Aug 2008 22:20:53 -0400 Subject: small patch update --- doc/bugs/map_is_inconsistent_about_bare_directories.mdwn | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'doc/bugs/map_is_inconsistent_about_bare_directories.mdwn') diff --git a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn index c1f388001..6e9dc104d 100644 --- a/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn +++ b/doc/bugs/map_is_inconsistent_about_bare_directories.mdwn @@ -75,15 +75,17 @@ Attached is a [[patch]] that fixes the issue. The current map code makes one pa Note: This patch adds items to a map while it is in a foreach loop over a sorted list of keys from that same map. Changing a map while iterating through it is normally problematic. I'm assuming the sort insulates the code from this - I do not need to iterate over any of the newly added elements. diff --git a/IkiWiki/Plugin/map.pm b/IkiWiki/Plugin/map.pm - index 5b6a843..142073d 100644 + index 5b6a843..16de45e 100644 --- a/IkiWiki/Plugin/map.pm +++ b/IkiWiki/Plugin/map.pm - @@ -67,6 +67,37 @@ sub preprocess (@) { #{{{ + @@ -67,6 +67,39 @@ sub preprocess (@) { #{{{ # are removed. add_depends($params{page}, join(" or ", keys %mapitems)); + # Include all the parent directories in the map + my $lastbase=""; + + my $commonbase = ""; + + $commonbase = $common_prefix if defined $common_prefix && length $common_prefix; + foreach my $item (sort keys %mapitems) { + $item=~s/^\Q$common_prefix\E\/// + if defined $common_prefix && length $common_prefix; @@ -92,7 +94,7 @@ Note: This patch adds items to a map while it is in a foreach loop over a sorted + # find the common dir + my @a=split(/\//, $itembase); + my @b=split(/\//, $lastbase); - + my $common_dir=""; + + my $common_dir=$commonbase; + while (@a && @b && $a[0] eq $b[0]) { + if (length $common_dir) { + $common_dir.="/"; -- cgit v1.2.3