summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs.mdwn3
-rw-r--r--doc/bugs/discussion_removal.mdwn2
-rw-r--r--doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn78
-rw-r--r--doc/todo/Does_not_support_non-UTF8_files.mdwn (renamed from doc/bugs/Does_not_support_non-UTF8_files.mdwn)2
-rw-r--r--doc/todo/assumes_system_perl.mdwn (renamed from doc/bugs/assumes_system_perl.mdwn)2
-rw-r--r--doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn (renamed from doc/bugs/i18n_characters_in_post_title.mdwn)2
-rw-r--r--doc/usage.mdwn5
7 files changed, 91 insertions, 3 deletions
diff --git a/doc/bugs.mdwn b/doc/bugs.mdwn
index 2e06d7ca0..eb1f6d549 100644
--- a/doc/bugs.mdwn
+++ b/doc/bugs.mdwn
@@ -2,6 +2,7 @@ This is ikiwiki's bug list. Link bugs to [[bugs/done]] when done.
Also see the [Debian bugs](http://bugs.debian.org/ikiwiki).
-[[inline pages="bugs/* and !bugs/done and !link(bugs/done) and !bugs/*/*"
+[[inline pages="bugs/* and !bugs/done and !bugs/discussion and
+!link(bugs/done) and !bugs/*/*"
feedpages="created_after(bugs/no_commit_mails_for_new_pages)"
actions=yes rootpage="bugs" postformtext="Add a new bug titled:" show=0]]
diff --git a/doc/bugs/discussion_removal.mdwn b/doc/bugs/discussion_removal.mdwn
index af3c6c1cb..ef84a9b74 100644
--- a/doc/bugs/discussion_removal.mdwn
+++ b/doc/bugs/discussion_removal.mdwn
@@ -1,3 +1,5 @@
If a page has a discussion page, which is then removed, ikiwiki seems not
to notice that the discussion page has gone away, and does not update the
link to it in the action bar.
+
+> Reprocued with 2.5 --[[Joey]]
diff --git a/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn b/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn
new file mode 100644
index 000000000..3c892906c
--- /dev/null
+++ b/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn
@@ -0,0 +1,78 @@
+I noticed when generating my wiki that all of my RSS feeds were
+getting regenerated even when I edited only a page that did not affect
+any feed.
+
+I found that the problem only occurs in the presence of a file that
+contains \[[inline pages="*"]].
+
+> How is this unexpected? By inlining _every_ page in the wiki, you're
+> making that page depend on every other page; any change to any page in
+> the wiki will result in the inlining page and its rss feed needing to be
+> updated to include the changed page.
+>
+> At best, this is a [[wishlist]] optimisation item -- it would be nice if inline could
+> somehow know that since it's only displaying N pages, a change to the
+> N+1th page that its PageSpec matches is a no-op.
+> --[[Joey]]
+
+Here's a short script for replicating the bug. Just cut and paste this
+to a shell, (it will only muck in a new /tmp/ikiwiki-test directory
+that it will create):
+
+ cd /tmp
+ mkdir ikiwiki-test; cd ikiwiki-test; mkdir src
+ echo '\[[inline pages="blog/*"]]' > src/myblog.mdwn
+ mkdir src/blog; echo "A blog entry" > src/blog/entry.mdwn
+ echo 'use IkiWiki::Setup::Standard {
+ srcdir => "src",
+ destdir => "output",
+ url => "http://example.com",
+ templatedir => "/dev/null",
+ underlaydir => "/dev/null",
+ rss => 1,
+ wrappers => [],
+ verbose => 1,
+ refresh => 1
+ }' > setup
+ ikiwiki --setup setup
+ ls -l --time-style=full-iso output/myblog/index.rss
+ echo "not a blog entry" > src/not-a-blog.mdwn
+ ikiwiki --setup setup
+ ls -l --time-style=full-iso output/myblog/index.rss
+ echo '\[[inline pages="*"]]' > src/archives.mdwn
+ ikiwiki --setup setup
+ ls -l --time-style=full-iso output/myblog/index.rss
+ echo "still not blogging" >> src/not-a-blog.mdwn
+ ikiwiki --setup setup
+ ls -l --time-style=full-iso output/myblog/index.rss
+
+Here's the tail of the output that I see for this command:
+
+ $ echo "not a blog entry" > src/not-a-blog.mdwn
+ $ ikiwiki --setup setup
+ refreshing wiki..
+ scanning not-a-blog.mdwn
+ rendering not-a-blog.mdwn
+ done
+ $ ls -l --time-style=full-iso output/myblog/index.rss
+ -rw-r--r-- 1 cworth cworth 459 2007-06-01 06:34:36.000000000 -0700 output/myblog/index.rss
+ $ echo '\[[inline pages="*"]]' > src/archives.mdwn
+ $ ikiwiki --setup setup
+ refreshing wiki..
+ scanning archives.mdwn
+ rendering archives.mdwn
+ done
+ $ ls -l --time-style=full-iso output/myblog/index.rss
+ -rw-r--r-- 1 cworth cworth 459 2007-06-01 06:34:37.000000000 -0700 output/myblog/index.rss
+ $ echo "still not blogging" >> src/not-a-blog.mdwn
+ $ ikiwiki --setup setup
+ refreshing wiki..
+ scanning not-a-blog.mdwn
+ rendering not-a-blog.mdwn
+ rendering archives.mdwn, which depends on not-a-blog
+ done
+ $ ls -l --time-style=full-iso output/myblog/index.rss
+ -rw-r--r-- 1 cworth cworth 459 2007-06-01 06:34:38.000000000 -0700 output/myblog/index.rss
+
+It looks like the rendering of archives.mdwn is also silently
+generating myblog/index.rss.
diff --git a/doc/bugs/Does_not_support_non-UTF8_files.mdwn b/doc/todo/Does_not_support_non-UTF8_files.mdwn
index 7d4cace7a..b78a5ebeb 100644
--- a/doc/bugs/Does_not_support_non-UTF8_files.mdwn
+++ b/doc/todo/Does_not_support_non-UTF8_files.mdwn
@@ -3,3 +3,5 @@ Ikiwiki does not seem to support non-UTF-8 file content, although there's no rea
Malformed UTF-8 character (unexpected non-continuation byte 0x74, immediately after start byte 0xe4) in substitution iterator at /usr/local/share/perl/5.8.8/IkiWiki.pm line 640.
I hope Ikiwiki is not part of the UTF-8 monoculturist movement...
+
+[[wishlist]]
diff --git a/doc/bugs/assumes_system_perl.mdwn b/doc/todo/assumes_system_perl.mdwn
index 9df61bc80..a0405472b 100644
--- a/doc/bugs/assumes_system_perl.mdwn
+++ b/doc/todo/assumes_system_perl.mdwn
@@ -12,3 +12,5 @@ The installed bin/ikiwiki file also refers to /usr/bin/perl rather than the perl
> I will acdept sufficiently nonintrusive patches to make ikiwiki work better on strange systems like
> yours, but do not plan to work on it myself, since I do not use systems
> where /usr/bin/perl is not a sane default. --[[Joey]]
+
+[[wishlist]]
diff --git a/doc/bugs/i18n_characters_in_post_title.mdwn b/doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn
index 8bd25bfd1..a454d7da5 100644
--- a/doc/bugs/i18n_characters_in_post_title.mdwn
+++ b/doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn
@@ -57,3 +57,5 @@ I hope it's a bug, not a feature and you fix it soon :) --[[Paweł|ptecza]]
>>>>> There is a Perl [Unicode::IMAPUtf7](http://search.cpan.org/~fabpot/Unicode-IMAPUtf7-2.01/lib/Unicode/IMAPUtf7.pm)
>>>>> module at the CPAN, but probably it hasn't been debianized yet :( --[[Paweł|ptecza]]
+
+[[wishlist]]
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 57cdba167..a8bb92d68 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -236,8 +236,9 @@ configuration options of their own.
* --numbacklinks n
- Controls how many backlinks should be displayed maximum. Excess backlinks
- will be hidden in a popup. Default is 10. Set to 0 to disable this feature.
+ Controls how many backlinks should be displayed at the bottom of a page.
+ Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
+ disable this feature.
* --userdir subdir