aboutsummaryrefslogtreecommitdiff
path: root/doc/todo
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-07-25 02:34:48 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-07-25 02:34:48 +0000
commit2210c65083465bf8e515418cf2528e18f7326bc0 (patch)
treed943525db15d25c51d5347a41e07939c150708e9 /doc/todo
parentde9104d4e2571dcdf28659b3fd244c3c77f02740 (diff)
downloadikiwiki-2210c65083465bf8e515418cf2528e18f7326bc0.tar
ikiwiki-2210c65083465bf8e515418cf2528e18f7326bc0.tar.gz
more triage
Diffstat (limited to 'doc/todo')
-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.mdwn7
-rw-r--r--doc/todo/assumes_system_perl.mdwn16
-rw-r--r--doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn61
4 files changed, 162 insertions, 0 deletions
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/todo/Does_not_support_non-UTF8_files.mdwn b/doc/todo/Does_not_support_non-UTF8_files.mdwn
new file mode 100644
index 000000000..b78a5ebeb
--- /dev/null
+++ b/doc/todo/Does_not_support_non-UTF8_files.mdwn
@@ -0,0 +1,7 @@
+Ikiwiki does not seem to support non-UTF-8 file content, although there's no reason it should assume anything other than ASCII-compatibility from the encoding, at least if the Web interface is not used. It suffices that users use the same encoding as the templates specify. If I try to run it on `.mdwn` with content in ISO-8859-1 format, in an ISO-8859-1 locale, I get:
+
+ 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/todo/assumes_system_perl.mdwn b/doc/todo/assumes_system_perl.mdwn
new file mode 100644
index 000000000..a0405472b
--- /dev/null
+++ b/doc/todo/assumes_system_perl.mdwn
@@ -0,0 +1,16 @@
+ikiwiki 1.45 doesn't work properly for perl installs not in the system path.
+
+ie:
+
+~/tools/perl-5.8.8/perl Makefile.PL
+make
+
+fails, as the 'make' command attempts to use the perl install in PATH, rather than the one ikiwiki is being installed for.
+
+The installed bin/ikiwiki file also refers to /usr/bin/perl rather than the perl it is being installed for.
+
+> 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/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn b/doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn
new file mode 100644
index 000000000..a454d7da5
--- /dev/null
+++ b/doc/todo/should_use_a_standard_encoding_for_utf_chars_in_filenames.mdwn
@@ -0,0 +1,61 @@
+It seems that I can't use Polish characters in post title.
+When I try to do it, then I can see error message: "Błąd: bad page name".
+
+I hope it's a bug, not a feature and you fix it soon :) --[[Paweł|ptecza]]
+
+> ikiwiki only allows a very limited set of characters raw in page names,
+> this is done as a deny-by-default security thing. All other characters
+> need to be encoded in __code__ format, where "code" is the character
+> number. This is normally done for you, but if you're adding a page
+> manually, you need to handle it yourself. --[[Joey]]
+
+>> Assume I have my own blog and I want to send a new post with Polish
+>> characters in a title. I think it's totally normal and common thing
+>> in our times. Do you want to tell me I shouldn't use my native
+>> characters in the title? It can't be true ;)
+
+>> In my opinion encoding of title is a job for the wiki engine,
+>> not for me. Joey, please try to look at a problem from my point
+>> of view. I'm only user and I don't have to understand
+>> what the character number is. I only want to blog :)
+
+>> BTW, why don't you use the modified-UTF7 coding for page names
+>> as used in IMAP folder names with non-Latin letters? --[[Paweł|ptecza]]
+
+>>> Joey, do you intend to fix that bug or it's a feature
+>>> for you? ;) --[[Paweł|ptecza]]
+
+>>>> Of course you can put Polish characters in the title. but the page
+>>>> title and filename are not identical. Ikiwiki has to place some limits
+>>>> on what filenames are legal to prevent abuse. Since
+>>>> the safest thing to do in a security context is to deny by default and
+>>>> only allow a few well-defined safe things, that's what it does, so
+>>>> filenames are limited to basic alphanumeric characters.
+>>>>
+>>>> It's not especially hard to transform your title into get a legal
+>>>> ikiwiki filename:
+
+ joey@kodama:~>perl -MIkiWiki -le 'print IkiWiki::titlepage(shift).".mdwn"' "Błąd"
+ B__197____130____196____133__d.mdwn
+
+>>>>> Thanks for the hint! It's good for me, but rather not for common users :)
+
+>>>>>> Interesting... I have another result:
+>>>>>>
+>>>>>> perl -MIkiWiki -le 'print IkiWiki::titlepage(shift).".mdwn"' "Błąd"
+>>>>>> B__179____177__d.mdwn
+>>>>>>
+>>>>>> What's your locale? I have both pl\_PL (ISO-8859-2) and pl\_PL.UTF-8,
+>>>>>> but I use pl\_PL. Is it wrong? --[[Paweł|ptecza]]
+
+>>>> Now, as to UTF7, in retrospect, using a standard encoding might be a
+>>>> better idea than coming up with my own encoding for filenames. Can
+>>>> you provide a pointer to a description to modified-UTF7? --[[Joey]]
+
+>>>>> The modified form of UTF7 is defined in [RFC 2060](http://www.ietf.org/rfc/rfc2060.txt)
+>>>>> for IMAP4 protocol (please see section 5.1.3 for details).
+
+>>>>> 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]]