summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2010-07-11 10:46:18 +0200
committerintrigeri <intrigeri@boum.org>2010-07-11 10:46:18 +0200
commitc99d26030e6ddd7a21932e98e40a8df7d896886d (patch)
tree26056e3e2a5c7c81ebe7baf243a0bb4ae765e76e /doc
parentc9b1a4dd7d826b5e8e2d0a757ba5ecbba8d832b2 (diff)
parent1bb9157f2ab94b8306e1e2fb1a5b3ac9bbfe5772 (diff)
Merge remote branch 'upstream/master' into prv/po
Conflicts: IkiWiki/Plugin/po.pm doc/plugins/po.mdwn
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs/po_vs_templates.mdwn26
-rw-r--r--doc/bugs/support_for_openid2_logins.mdwn2
-rw-r--r--doc/examples/blog/comments.mdwn5
-rw-r--r--doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_3_4eec15c8c383275db5401c8e3c2d9242._comment9
-rw-r--r--doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_4_43ac867621efb68affa6ae2b92740cad._comment10
-rw-r--r--doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_5_e098723bb12adfb91ab561cae21b492b._comment8
-rw-r--r--doc/forum/html_source_pages_in_version_3.20100704.mdwn1
-rw-r--r--doc/forum/ikiwiki_vim_syntaxfile.mdwn21
-rw-r--r--doc/forum/recentchanges_dir_should_be_under_control_of_RCS__63__.mdwn105
-rw-r--r--doc/forum/remove_css__63__.mdwn4
-rw-r--r--doc/forum/use_php-markdown-extra_with_ikiwiki__63__.mdwn3
-rw-r--r--doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_1_66d48218361caa4c07bd714b82ed0021._comment8
-rw-r--r--doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_2_f2ee0a4dce571d329f795e52139084c0._comment8
-rw-r--r--doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_3_e388714f457ccb6ef73630179914558c._comment9
-rw-r--r--doc/ikiwiki/directive/commentmoderation.mdwn9
-rw-r--r--doc/ikiwikiusers.mdwn2
-rw-r--r--doc/news/version_3.20100515.mdwn58
-rw-r--r--doc/news/version_3.20100704.mdwn26
-rw-r--r--doc/plugins/aggregate.mdwn15
-rw-r--r--doc/plugins/contrib/field/discussion.mdwn4
-rw-r--r--doc/plugins/getsource/discussion.mdwn2
-rw-r--r--doc/plugins/goodstuff/discussion.mdwn1
-rw-r--r--doc/plugins/po.mdwn26
-rw-r--r--doc/plugins/rst/discussion.mdwn4
-rw-r--r--doc/plugins/write.mdwn5
-rw-r--r--doc/sandbox.mdwn11
-rw-r--r--doc/setup.mdwn6
-rw-r--r--doc/style.css4
-rw-r--r--doc/tips/howto_limit_to_admin_users.mdwn9
-rw-r--r--doc/tips/optimising_ikiwiki.mdwn8
-rw-r--r--doc/todo/Fix_selflink_in_po_plugin.mdwn6
-rw-r--r--doc/todo/po_needstranslation_pagespec.mdwn9
-rw-r--r--doc/usage.mdwn14
33 files changed, 359 insertions, 79 deletions
diff --git a/doc/bugs/po_vs_templates.mdwn b/doc/bugs/po_vs_templates.mdwn
index a0ccc5f53..7bc56676e 100644
--- a/doc/bugs/po_vs_templates.mdwn
+++ b/doc/bugs/po_vs_templates.mdwn
@@ -12,6 +12,32 @@ generated HTML.
This has been fixed in my po branch.
+> My commit dcd57dd5c9f3265bb7a78a5696b90976698c43aa updates the
+> bugfix in a much more elegant manner. Its main disadvantage is to
+> add an (optional) argument to IkiWiki::filter. Please review.
+
-- [[intrigeri]]
+>> Hmm. Don't like adding a fourth positional parameter to that (or
+>> any really) function.
+>>
+>> I think it's quite possible that some of the directives that are
+>> calling filter do so unnecessarily. For example, conditional,
+>> cutpaste, more, and toggle each re-filter text that comes from the
+>> page and so has already been filtered. They could probably drop
+>> the filtering. template likewise does not need to filter the
+>> parameters passed into it. Does it need to filter the template output?
+>> Well, it allows the (deprecated) embed plugin to work on template
+>> content, but that's about it.
+>>
+>> Note also that the only other plugin to provide a filter, txt,
+>> could also run into similar problems as po has, in theory (it looks at
+>> the page parameter and assumes the content is for the whole page).
+>>
+>> [[!template id=gitbranch branch=origin/filter-full author="[[joey]]"]]
+>> So, I've made a filter-full branch, where I attempt to fix this
+>> by avoiding unnecessary filtering. Can you check it and merge it into
+>> your po branch and remove your other workarounds so I can merge?
+>> --[[Joey]]
+
[[!tag patch]]
diff --git a/doc/bugs/support_for_openid2_logins.mdwn b/doc/bugs/support_for_openid2_logins.mdwn
index 139a53760..a71ed7ba9 100644
--- a/doc/bugs/support_for_openid2_logins.mdwn
+++ b/doc/bugs/support_for_openid2_logins.mdwn
@@ -20,3 +20,5 @@ However both Perl OpenID 2.x implementations have not been released and are inco
> I've tested with yahoo, and it works with the updated module. Sweet and
> [[done]] --[[Joey]]
+
+## A quick fix for the impatient running stable is simply `sudo apt-get install libnet-openid-consumer-perl -t unstable`
diff --git a/doc/examples/blog/comments.mdwn b/doc/examples/blog/comments.mdwn
index f59b44390..e22b50a34 100644
--- a/doc/examples/blog/comments.mdwn
+++ b/doc/examples/blog/comments.mdwn
@@ -1,9 +1,10 @@
[[!sidebar content="""
[[!inline pages="comment_pending(./posts/*)" feedfile=pendingmoderation
description="comments pending moderation" show=-1]]
-Comments in the moderation queue:
+Comments in the [[!commentmoderation desc="moderation queue"]]:
[[!pagecount pages="comment_pending(./posts/*)"]]
"""]]
Recent comments on posts in the [[blog|index]]:
-[[!inline pages="./posts/*/Discussion or comment(./posts/*)"]]
+[[!inline pages="./posts/*/Discussion or comment(./posts/*)"
+template="comment"]]
diff --git a/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_3_4eec15c8c383275db5401c8e3c2d9242._comment b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_3_4eec15c8c383275db5401c8e3c2d9242._comment
new file mode 100644
index 000000000..faf3ad31b
--- /dev/null
+++ b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_3_4eec15c8c383275db5401c8e3c2d9242._comment
@@ -0,0 +1,9 @@
+[[!comment format=mdwn
+ username="jeanm"
+ ip="81.56.145.104"
+ subject="do parameter missing"
+ date="2010-06-30T07:30:08Z"
+ content="""
+the site address is piaffer.org, with a link to blog just over the picture.
+tia,
+"""]]
diff --git a/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_4_43ac867621efb68affa6ae2b92740cad._comment b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_4_43ac867621efb68affa6ae2b92740cad._comment
new file mode 100644
index 000000000..d8b516f5f
--- /dev/null
+++ b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_4_43ac867621efb68affa6ae2b92740cad._comment
@@ -0,0 +1,10 @@
+[[!comment format=mdwn
+ username="http://joey.kitenet.net/"
+ nickname="joey"
+ subject="comment 4"
+ date="2010-07-04T18:16:26Z"
+ content="""
+What is the muse plugin that you have enabled? I am not familiar with it.
+
+Apparently your ikiwiki is not seeing cgi parameters that should be passed to it. This appears to be some kind of web server misconfiguration, or possibly a broken ikiwiki wrapper or broken CGI.pm.
+"""]]
diff --git a/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_5_e098723bb12adfb91ab561cae21b492b._comment b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_5_e098723bb12adfb91ab561cae21b492b._comment
new file mode 100644
index 000000000..b832d64f4
--- /dev/null
+++ b/doc/forum/The_requested_URL___47____126__jean__47__blog__47__ikiwiki.cgi_was_not_found_on_this_server./comment_5_e098723bb12adfb91ab561cae21b492b._comment
@@ -0,0 +1,8 @@
+[[!comment format=mdwn
+ username="http://joey.kitenet.net/"
+ nickname="joey"
+ subject="do parameter missing"
+ date="2010-07-08T06:04:44Z"
+ content="""
+I just debugged this problem with someone else who was using ngix-fcgi. There was a problem with it not passing CGI environment variables properly. If you're using that, it might explain your problem.
+"""]]
diff --git a/doc/forum/html_source_pages_in_version_3.20100704.mdwn b/doc/forum/html_source_pages_in_version_3.20100704.mdwn
new file mode 100644
index 000000000..b8cbb0f4e
--- /dev/null
+++ b/doc/forum/html_source_pages_in_version_3.20100704.mdwn
@@ -0,0 +1 @@
+Is this different from using the html/rawhtml plugins?
diff --git a/doc/forum/ikiwiki_vim_syntaxfile.mdwn b/doc/forum/ikiwiki_vim_syntaxfile.mdwn
new file mode 100644
index 000000000..d0f8d259e
--- /dev/null
+++ b/doc/forum/ikiwiki_vim_syntaxfile.mdwn
@@ -0,0 +1,21 @@
+Hi all,
+
+I'm teaching myself how to write syntax files for vim by fixing several issues
+(and up to certain extent, taking over the maintenance) of the vim syntax
+(highlighting) file for ikiwiki.
+
+I'd like you to document here which problems you have found, so I can hunt them
+and see if I can fix them.
+
+## Problems Found
+
+ * Arguments of directives with a value of length 1 cause the following text to
+ be highlighted incorrectly. Example:
+
+ [[!directive param1="val1" param2="1"]] more text ...
+
+ * A named wikilink in a line, followed by text, and then another wikilink,
+ makes the text in between the links to be incorrectly highlighted. Example:
+
+ \[[a link|alink]] text that appears incorrectly .... \[[link]]
+
diff --git a/doc/forum/recentchanges_dir_should_be_under_control_of_RCS__63__.mdwn b/doc/forum/recentchanges_dir_should_be_under_control_of_RCS__63__.mdwn
new file mode 100644
index 000000000..2fe97366b
--- /dev/null
+++ b/doc/forum/recentchanges_dir_should_be_under_control_of_RCS__63__.mdwn
@@ -0,0 +1,105 @@
+Hello Joey,
+
+I noticed that my Ikiwiki started to rebuild pages very slowly after my last changes
+when I upgraded Ikiwiki to version 3.20100623. Now I have the latest release 3.20100704,
+but it doesn't help me.
+
+I started to debug the problem and I found that I can see a lot of messages
+like below when I try to rebuild my wiki manually:
+
+ svn: '/path/to/ikiwiki/trunk/pages/ostatnie_zmiany' is not a working copy
+ svn: Can't open file '/path/to/ikiwiki/trunk/pages/ostatnie_zmiany/.svn/entries': No such file or directory
+ svn log exited 256
+
+"ostatnie_zmiany" is a value of `recentchangespage` parameter in my
+`ikiwiki.setup` file. It is not under control Subversion I use for Ikiwiki:
+
+ $ svn status pages/ostatnie_zmiany
+ ? pages/ostatnie_zmiany
+
+ $ ls pages/ostatnie_zmiany/*._change |wc -l
+ 100
+
+`recentchangesnum` parameter has value 100 for me and I noticed that my Ikiwiki
+takes a lot of time to parse all `._change` files. Finally it doesn't refresh
+/ostatnie_zmiany.html page.
+
+Do you think I should add `ostatnie_zmiany` directory under control of my
+Subversion repo? If it's not necessary, could you please give me any hint
+to find a reason of problem with my Ikiwiki?
+
+My best regards,
+Pawel
+
+> No, the recentchanges pages are automatically generated and should not
+> themselves be in revision control.
+>
+> Ikiwiki has recently started automatically enabing `--gettime`, but
+> it should not do it every time, but only on the initial build
+> of a wiki. It will print "querying svn for file creation and modification
+> times.." when it does this. If it's doing it every time, something
+> is wrong. (Specifically, `.ikiwiki/indexdb` must be missing somehow.)
+>
+> The support for svn with --gettime is rather poor. (While with git it is
+> quite fast.) But as it's only supposed to happen on the first build,
+> I haven't tried to speed it up. It would be hard to do it fast with svn.
+> It would be possible to avoid the warning message above, or even skip
+> processing files in directories not checked into svn -- but I'd much
+> rather understand why you are seeing this happen on repeated builds.
+> --[[Joey]]
+
+>> Thanks a lot for your reply! I've just checked my `rebuild-pages.sh`
+>> script and discovered that it contains
+>> `/usr/bin/ikiwiki --setup ikiwiki.setup --gettime` command... :D
+>> The warnings disappeared when I removed `--gettime` parameter.
+>> Sorry for confusing! :)
+>>
+>> I have `.ikiwiki/indexdb` file here, but I noticed that it has been
+>> modified about 1 minute **after** last Subversion commit:
+>>
+>> $ LANG=C svn up
+>> At revision 5951.
+>>
+>> $ LANG=C svn log -r 5951
+>> ------------------------------------------------------------------------
+>> r5951 | svn | 2010-07-06 09:02:30 +0200 (Tue, 06 Jul 2010) | 1 line
+>>
+>> web commit by xahil
+>> ------------------------------------------------------------------------
+>>
+>> $ LANG=C stat pages/.ikiwiki/indexdb
+>> File: `pages/.ikiwiki/indexdb'
+>> Size: 184520 Blocks: 368 IO Block: 131072 regular file
+>> Device: 2bh/43d Inode: 1931145 Links: 1
+>> Access: (0644/-rw-r--r--) Uid: ( 1005/ svn) Gid: ( 1005/ svn)
+>> Access: 2010-07-06 12:06:24.000000000 +0200
+>> Modify: 2010-07-06 09:03:38.000000000 +0200
+>> Change: 2010-07-06 09:03:38.000000000 +0200
+>>
+>> I believe it's the time I have to wait to see that my wiki page has been rebuilt.
+>> Do you have any idea how to find a reason of that delay? --[[Paweł|ptecza]]
+
+>>> Well, I hope that your svn post-commit hook is not running your
+>>> `rebuild-pages.sh`. That script rebuilds everything, rather than just
+>>> refreshing what's been changed.
+>>>
+>>> Using subversion is not asking for speed. Especially if your svn
+>>> repository is on a remote host. You might try disabling
+>>> recentchanges and see if that speeds up the refreshes (it will avoid
+>>> one `svn log`).
+>>>
+>>> Otherwise, take a look at [[tips/optimising_ikiwiki]]
+>>> for some advice on things that can make ikiwiki run slowly. --[[Joey]]
+
+>>>> Thanks for the hints! I don't understand it, but it seems that refreshing
+>>>> all pages has resolved the problem and now my wiki works well again :)
+>>>>
+>>>> No, I use `rebuild-pages.sh` script only when I want to rebuild
+>>>> my wiki manually, for example when you release new Ikiwiki version
+>>>> then I need to update my templates. Some of them have been translated
+>>>> to Polish by me.
+>>>>
+>>>> Fortunately my wiki and its Subversion repo are located on the same host.
+>>>> We have a lot of Subversion repos for our projects and I don't want to
+>>>> change only wiki repo for better performance. I'm rather satisfied with
+>>>> its speed. --[[Paweł|ptecza]]
diff --git a/doc/forum/remove_css__63__.mdwn b/doc/forum/remove_css__63__.mdwn
new file mode 100644
index 000000000..b90b3d864
--- /dev/null
+++ b/doc/forum/remove_css__63__.mdwn
@@ -0,0 +1,4 @@
+I removed a local.css file and pushed the changes to git but the 'compiled' wiki still shows the same css.
+Is this a bug or you are supposed to remove the css by hand?
+ikiwiki version 3.20100705
+
diff --git a/doc/forum/use_php-markdown-extra_with_ikiwiki__63__.mdwn b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__.mdwn
new file mode 100644
index 000000000..86ed70fd2
--- /dev/null
+++ b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__.mdwn
@@ -0,0 +1,3 @@
+Is it possible to use php-markdown-extra with ikiwiki?
+
+Thanks.
diff --git a/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_1_66d48218361caa4c07bd714b82ed0021._comment b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_1_66d48218361caa4c07bd714b82ed0021._comment
new file mode 100644
index 000000000..af60ecbdb
--- /dev/null
+++ b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_1_66d48218361caa4c07bd714b82ed0021._comment
@@ -0,0 +1,8 @@
+[[!comment format=mdwn
+ username="http://kerravonsen.dreamwidth.org/"
+ ip="60.241.8.244"
+ subject="PHP != Perl"
+ date="2010-07-10T12:44:15Z"
+ content="""
+Er, why? IkiWiki is written in Perl. Presumably php-markdown-extra is written in PHP, which is a completely different language.
+"""]]
diff --git a/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_2_f2ee0a4dce571d329f795e52139084c0._comment b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_2_f2ee0a4dce571d329f795e52139084c0._comment
new file mode 100644
index 000000000..ce60f4b3a
--- /dev/null
+++ b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_2_f2ee0a4dce571d329f795e52139084c0._comment
@@ -0,0 +1,8 @@
+[[!comment format=mdwn
+ username="https://www.google.com/accounts/o8/id?id=AItOawlzADDUvepOXauF4Aq1VZ4rJaW_Dwrl6xE"
+ nickname="Dário"
+ subject="comment 2"
+ date="2010-07-10T21:48:13Z"
+ content="""
+Because php-markdown-extra extends the basic markdown language (footnotes, etc.)
+"""]]
diff --git a/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_3_e388714f457ccb6ef73630179914558c._comment b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_3_e388714f457ccb6ef73630179914558c._comment
new file mode 100644
index 000000000..72ce7bb6f
--- /dev/null
+++ b/doc/forum/use_php-markdown-extra_with_ikiwiki__63__/comment_3_e388714f457ccb6ef73630179914558c._comment
@@ -0,0 +1,9 @@
+[[!comment format=mdwn
+ username="http://kerravonsen.dreamwidth.org/"
+ ip="202.173.183.92"
+ subject="I still don't get it"
+ date="2010-07-11T07:18:35Z"
+ content="""
+But if you need the \"extra\" features of Markdown, all you have to do is turn on the \"multimarkdown\" option in your configuration. It makes no sense to try to use PHP with Perl.
+
+"""]]
diff --git a/doc/ikiwiki/directive/commentmoderation.mdwn b/doc/ikiwiki/directive/commentmoderation.mdwn
new file mode 100644
index 000000000..8553b5b17
--- /dev/null
+++ b/doc/ikiwiki/directive/commentmoderation.mdwn
@@ -0,0 +1,9 @@
+The `commentmoderation` directive is supplied by the
+[[!iki plugins/comments desc=comments]] plugin, and is used to link
+to the comment moderation queue.
+
+Example:
+
+ \[[!commentmoderation desc="here is the comment moderation queue"]]
+
+[[!meta robots="noindex, follow"]]
diff --git a/doc/ikiwikiusers.mdwn b/doc/ikiwikiusers.mdwn
index e2465108a..d38b1208b 100644
--- a/doc/ikiwikiusers.mdwn
+++ b/doc/ikiwikiusers.mdwn
@@ -148,6 +148,8 @@ Personal sites and blogs
* [Jonatan Walck](http://jonatan.walck.i2p/) a weblog + wiki over [I2P](http://i2p2.de/). Also [mirrored](http://jonatan.walck.se/) to the Internet a few times per day.
* [Daniel Wayne Armstrong](http://circuidipity.com/)
* [Mukund](https://www.mukund.org/)
+* [Nicolas Schodet](http://ni.fr.eu.org/)
+* [weakish](http://weakish.github.com)
Please feel free to add your own ikiwiki site!
diff --git a/doc/news/version_3.20100515.mdwn b/doc/news/version_3.20100515.mdwn
deleted file mode 100644
index 043346c88..000000000
--- a/doc/news/version_3.20100515.mdwn
+++ /dev/null
@@ -1,58 +0,0 @@
-News for ikiwiki 3.20100515:
-
- There are two significant changes to the page.tmpl template in this version.
- If you have a locally modified version of that template, you will need to
- update it at least to contain the following in the HTML `<head>`:
-
- <TMPL_IF DYNAMIC>
- <TMPL_IF FORCEBASEURL><base href="<TMPL_VAR FORCEBASEURL>" /><TMPL_ELSE>
- <TMPL_IF BASEURL><base href="<TMPL_VAR BASEURL>" /></TMPL_IF>
- </TMPL_IF>
- </TMPL_IF>
-
- Also, the footer should be wrapped in `<TMPL_UNLESS DYNAMIC> ... </TMPL_UNLESS>`
-
- There is a new "comment()" pagespec, that can be used to match a
- comment on a page. It is recommended to use it instead of the old
- method of using a pagespec such as "internal(comment\_*)" to match
- things that looked like comments. The old pagespec will now also match
- comments that are held for moderation; likely not what you want.
-
- There have also been some changes to the style.css in this version,
- particularly to support the new openid selector. If you have a modified
- version, of style.css, updating it (or moving it to local.css) is
- recommended.
-
-ikiwiki 3.20100515 released with [[!toggle text="these changes"]]
-[[!toggleable text="""
- * Removed misc.tmpl. Now to theme ikiwiki, you only need to customise
- a single template, page.tmpl.
- * If you have a locally customised page.tmpl, it needs to be updated
- to set &lt;base&gt; when BASEURL or FORCEBASEURL is set.
- * comments: Comments pending moderation are now stored in the srcdir
- alongside accepted comments, but with a `._comment_pending` extension.
- This allows easier byhand moderation, as the "\_pending" need
- only be stripped off and the comment be committed to version control.
- * The `comment_pending()` pagespec can be used to match such unmoderated
- comments, which makes it easy to add a feed of them, or a counter
- indicating how many there are.
- * Belatedly added a `comment()` pagespec.
- * Gave comment and page editing forms some CSS and accessability love.
- * Renamed postscan hook to indexhtml, to reflect its changed position,
- and typical use.
- * inline: Call indexhtml when inlining internal pages, so their
- text can be indexed for searching.
- * Delete hooks are passed deleted internal pages.
- * openid: Incorporated a fancy openid-selector signin form.
- (Based on <http://code.google.com/p/openid-selector/>)
- * openid: Use "openid\_identifier" as the form field, as required
- by OpenID Authentication v2.0 spec.
- * Removed the openidsignup option. Instead, my recommendation is to
- leave passwordauth enabled and let people who don't have an openid use it.
- The openid selector form avoids the UI annoyance of having both openid
- and passwordauth on one form.
- * calendar: Allow negative month to be specified. -1 is last month, etc.
- (And also negative years.)
- * calendar: Display year in title of month calendar.
- * Use xhtml friendly pubdate setting.
- * remove, rename: Add guards against XSRF attacks."""]]
diff --git a/doc/news/version_3.20100704.mdwn b/doc/news/version_3.20100704.mdwn
new file mode 100644
index 000000000..9d2792ce6
--- /dev/null
+++ b/doc/news/version_3.20100704.mdwn
@@ -0,0 +1,26 @@
+ikiwiki 3.20100704 released with [[!toggle text="these changes"]]
+[[!toggleable text="""
+ * Changes to avoid display of ugly google openids, by displaying
+ a username taken from openid.
+ * API: Add new optional field nickname to rcs\_recentchanges.
+ * API: rcs\_commit and rcs\_commit\_staged are now passed named
+ parameters.
+ * openid: Store nickname based on username or email provided from
+ openid provider.
+ * git: Record the nickname from openid in the git author email.
+ * comment: Record the username from openid in the comment page.
+ * Fixed some confusion and bugginess about whether
+ rcs\_getctime/rcs\_getmtime were passed absolute or relative filenames.
+ (Make it relative like everything else.)
+ * hnb: Fixed broken use of mkstemp that had caused dangling temp files,
+ and prevented actually rendering hnb files.
+ * Use comment template on comments page of example blog.
+ * comment.tmpl: Fix up display when inline uses it to display a non-comment
+ page. (Such as a discussion page.)
+ * git: Added git\_wrapper\_background\_command option. Can be used to eg,
+ make the git wrapper push to github in the background after ikiwiki
+ runs.
+ * po: Added needstranslation() pagespec. (intrigeri)
+ * po: Added support for .html source pages. (intrigeri)
+ * comment: Fix problem moderating comments of certian pages with utf-8
+ in their name."""]] \ No newline at end of file
diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn
index bb828b05c..2925b6fba 100644
--- a/doc/plugins/aggregate.mdwn
+++ b/doc/plugins/aggregate.mdwn
@@ -5,9 +5,13 @@ This plugin allows content from other feeds to be aggregated into the
wiki. To specify feeds to aggregate, use the
[[ikiwiki/directive/aggregate]] [[ikiwiki/directive]].
-The [[meta]] and [[tag]] plugins are also recommended. Either the
-[[htmltidy]] or [[htmlbalance]] plugin is suggested, since feeds can easily
-contain html problems, some of which these plugins can fix.
+## requirements
+
+The [[meta]] and [[tag]] plugins are also recommended to be used with this
+one. Either the [[htmltidy]] or [[htmlbalance]] plugin is suggested, since
+feeds can easily contain html problems, some of which these plugins can fix.
+
+## triggering aggregation
You will need to run ikiwiki periodically from a cron job, passing it the
--aggregate parameter, to make it check for new posts. Here's an example
@@ -15,6 +19,11 @@ crontab entry:
*/15 * * * * ikiwiki --setup my.wiki --aggregate --refresh
+The plugin updates a file `.ikiwiki/aggregatetime` with the unix time stamp
+when the next aggregation run could occur. (The file may be empty, if no
+aggregation is required.) This can be integrated into more complex cron
+jobs or systems to trigger aggregation only when needed.
+
Alternatively, you can allow `ikiwiki.cgi` to trigger the aggregation. You
should only need this if for some reason you cannot use cron, and instead
want to use a service such as [WebCron](http://webcron.org). To enable
diff --git a/doc/plugins/contrib/field/discussion.mdwn b/doc/plugins/contrib/field/discussion.mdwn
index 5f4c9b942..191f8b27d 100644
--- a/doc/plugins/contrib/field/discussion.mdwn
+++ b/doc/plugins/contrib/field/discussion.mdwn
@@ -325,4 +325,8 @@ smcv's discuission of field author vs meta author above. --[[Joey]]
>>> --[[KathrynAndersen]]
+-----
+
I was just looking at HTML5 and wondered if the field plugin should generate the new Microdata tags (as well as the internal structures)? <http://slides.html5rocks.com/#slide19> -- [[Will]]
+
+> This could just as easily be done as a separate plugin. Feel free to do so. --[[KathrynAndersen]]
diff --git a/doc/plugins/getsource/discussion.mdwn b/doc/plugins/getsource/discussion.mdwn
index 45a1d62b5..3e985948b 100644
--- a/doc/plugins/getsource/discussion.mdwn
+++ b/doc/plugins/getsource/discussion.mdwn
@@ -1 +1,3 @@
It would be very cool if this plugin was enabled by default. One of the best ways to learn how to do various advanced things is to be able to "view source" on other wiki's which do things you like. -- [[AdamShand]]
+
+This plugin requires the cgi plugin. If you run a static site, you may check the [[repolist]] plugin. -- [[weakish]]
diff --git a/doc/plugins/goodstuff/discussion.mdwn b/doc/plugins/goodstuff/discussion.mdwn
new file mode 100644
index 000000000..0ad95c00a
--- /dev/null
+++ b/doc/plugins/goodstuff/discussion.mdwn
@@ -0,0 +1 @@
+What is the syntax for enabling plugins in the setup file?
diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 30bac7068..57f04a476 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -254,6 +254,26 @@ once [[intrigeri]]'s `meta` branch is merged.
An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
and `meta` branches, and thus has this additional features.
+Language display order
+----------------------
+
+Jonas pointed out that one might want to control the order that links to
+other languages are listed, for various reasons. Currently, there is no
+order, as `po_slave_languages` is a hash. It would need to be converted
+to an array to support this. (If twere done, twere best done quickly.)
+--[[Joey]]
+
+> Done in my po branch, preserving backward compatibility. Please
+> review :) --[[intrigeri]]
+
+>> Right, well my immediate concern is that using an array to hold
+>> hash-like pairs is not very clear to the user. It will be displayed
+>> in a confusing way by websetup; dumping a setup file will probably
+>> also cause it to be formatted in a confusing way. And the code
+>> seems to assume that the array length is even, and probably blows
+>> up if it is not.. and the value is marked safe so websetup can be
+>> used to modify it and break that way too. --[[Joey]]
+
Pagespecs
---------
@@ -284,6 +304,12 @@ underlay, and the underlays lack translation to a given language.
> Any simple testcase to reproduce it, please? I've never seen this
> happen yet. --[[intrigeri]]
+>> Sure, go here <http://l10n.ikiwiki.info/smiley/smileys/index.sv.html>
+>> (Currently 0% translateed) and see the 'WikiLink' link at the bottom,
+>> which goes to <http://l10n.ikiwiki.info/ikiwiki.cgi?page=ikiwiki/wikilink&from=smiley/smileys&do=create>
+>> Compare with eg, the 100% translated Dansk version, where
+>> the WikiLink link links to the English WikiLink page. --[[Joey]]
+
Double commits of po files
--------------------------
diff --git a/doc/plugins/rst/discussion.mdwn b/doc/plugins/rst/discussion.mdwn
index 38fbed6d6..3c3b03275 100644
--- a/doc/plugins/rst/discussion.mdwn
+++ b/doc/plugins/rst/discussion.mdwn
@@ -61,8 +61,8 @@ but the backlinks don't show up.
I converted one of my pages to rst:
-Before: http://kaizer.se/wiki/kupfer-mdwn
-After: http://kaizer.se/wiki/kupfer-rst
+Before: <http://kaizer.se/wiki/kupfer-mdwn>
+After: <http://kaizer.se/wiki/kupfer-rst>
I need help on a couple of points
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 15ed08d82..8071f323e 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -597,7 +597,10 @@ describes the plugin as a whole. For example:
hook(type => "genwrapper", id => "foo", call => \&genwrapper);
This hook is used to inject C code (which it returns) into the `main`
-function of the ikiwiki wrapper when it is being generated.
+function of the ikiwiki wrapper when it is being generated.
+
+The code runs before anything else -- in particular it runs before
+the suid wrapper has sanitized its environment.
## Exported variables
diff --git a/doc/sandbox.mdwn b/doc/sandbox.mdwn
index 4c8621f1c..f386adec4 100644
--- a/doc/sandbox.mdwn
+++ b/doc/sandbox.mdwn
@@ -1,15 +1,5 @@
This is the [[SandBox]], a page anyone can edit to try out ikiwiki (version [[!version ]]).
-<<<<<<< HEAD
-Test conflict.
-=======
-Testing 123.
->>>>>>> 8cc8bb52f7913e429be7e14203177ef374645718
-
-# Header
-
-## Subheader2
-
> This is a blockquote.
>
> This is the first level of quoting.
@@ -29,6 +19,7 @@ Numbered list
1. And another..
1. foo
2. bar
+ 3. quz
Bulleted list
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 03fed3aa9..266222cc3 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -102,6 +102,12 @@ After making changes to this file, you need to tell ikiwiki to use it:
% ikiwiki -setup foo.setup
+Alternatively, you can ask ikiwiki to change settings in the file for you:
+
+ % ikiwiki -changesetup foo.setup -plugin goodstuff
+
+See [[usage]] for more options.
+
## Customizing file locations
As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
diff --git a/doc/style.css b/doc/style.css
index bf000dae1..8dd3b1c15 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -91,6 +91,10 @@ nav {
text-align: center;
}
+img.img {
+ margin: 0.5ex;
+}
+
.align-left {
float:left;
}
diff --git a/doc/tips/howto_limit_to_admin_users.mdwn b/doc/tips/howto_limit_to_admin_users.mdwn
new file mode 100644
index 000000000..4d579327a
--- /dev/null
+++ b/doc/tips/howto_limit_to_admin_users.mdwn
@@ -0,0 +1,9 @@
+Enable [[plugins/lockedit]] in your setup file.
+
+For example:
+
+ add_plugins => [qw{goodstuff table rawhtml template embed typography sidebar img remove lockedit}],
+
+And to only allow admin users to edit the page, simply specify a pagespec for everything in the .setup:
+
+ locked_pages => '*',
diff --git a/doc/tips/optimising_ikiwiki.mdwn b/doc/tips/optimising_ikiwiki.mdwn
index 14d619ff8..caed75ba6 100644
--- a/doc/tips/optimising_ikiwiki.mdwn
+++ b/doc/tips/optimising_ikiwiki.mdwn
@@ -38,6 +38,14 @@ If your version of ikiwiki is not [[!version]], try upgrading. New
optimisations are frequently added to ikiwiki, some of them yielding
*enormous* speed increases.
+## run ikiwiki in verbose mode
+
+Try changing a page, and run ikiwiki with `-v` so it will tell you
+everything it does to deal with that changed page. Take note of
+which other pages are rebuilt, and which parts of the build take a long
+time. This can help you zero in on individual pages that contain some of
+the expensive things listed below.
+
## expensive inlines
Do you have an archive page for your blog that shows all posts,
diff --git a/doc/todo/Fix_selflink_in_po_plugin.mdwn b/doc/todo/Fix_selflink_in_po_plugin.mdwn
index b83d2814a..791c6c055 100644
--- a/doc/todo/Fix_selflink_in_po_plugin.mdwn
+++ b/doc/todo/Fix_selflink_in_po_plugin.mdwn
@@ -8,3 +8,9 @@ Fixed in my po branch. --[[intrigeri]]
[[!tag patch]]
> bump?
+
+>> I know I've looked at 88c6e2891593fd508701d728602515e47284180c
+>> before, and something about it just seemed wrong. Maybe it's
+>> the triviality of the sub, which it would seem to be easy to
+>> decide to refactor back into its one caller (which would reintroduce the
+>> bug). --[[Joey]]
diff --git a/doc/todo/po_needstranslation_pagespec.mdwn b/doc/todo/po_needstranslation_pagespec.mdwn
new file mode 100644
index 000000000..77449dc2b
--- /dev/null
+++ b/doc/todo/po_needstranslation_pagespec.mdwn
@@ -0,0 +1,9 @@
+Commit b225fdc44d4b3d in my po branch adds a `needstranslation()`
+PageSpec. It makes it easy to list pages that need translation work.
+Please review. --[[intrigeri]]
+
+> Looks good, cherry-picked. The only improvment I can
+> think of is that `needstranslation(50)` could match
+> only pages less than 50% translated. --[[Joey]]
+
+[[!tag patch done]]
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 2f87d60d5..840d105d2 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -32,14 +32,22 @@ These options control the mode that ikiwiki operates in.
* --setup setupfile
- In setup mode, ikiwiki reads the config file, which is really a perl
- program that can call ikiwiki internal functions.
-
The default action when --setup is specified is to automatically generate
wrappers for a wiki based on data in a setup file, and rebuild the wiki.
If you only want to build any changed pages, you can use --refresh with
--setup.
+* --changesetup setupfile
+
+ Reads the setup file, adds any configuration changes specified by other
+ options, and writes the new configuration back to the setup file. Also
+ updates any configured wrappers. In this mode, the wiki is not fully
+ rebuilt, unless you also add --rebuild.
+
+ Example, to enable some plugins:
+
+ ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar
+
* --dumpsetup setupfile
Causes ikiwiki to write to the specified setup file, dumping out