diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bugs/recentchanges_feed_links.mdwn | 7 | ||||
-rw-r--r-- | doc/bugs/relative_date_weird_results.mdwn | 4 | ||||
-rw-r--r-- | doc/bugs/unicode_chars_in_wikiname_break_auth.mdwn | 16 | ||||
-rw-r--r-- | doc/plugins/relativedate.mdwn | 2 | ||||
-rw-r--r-- | doc/plugins/write.mdwn | 8 | ||||
-rw-r--r-- | doc/tips/Git_repository_and_web_server_on_different_hosts.mdwn | 61 | ||||
-rw-r--r-- | doc/tips/laptop_wiki_with_git/discussion.mdwn | 5 | ||||
-rw-r--r-- | doc/todo/clear_page_to_delete.mdwn | 10 | ||||
-rw-r--r-- | doc/todo/httpauth_feature_parity_with_passwordauth.mdwn | 11 | ||||
-rw-r--r-- | doc/users/jasonblevins.mdwn | 11 | ||||
-rw-r--r-- | doc/users/joshtriplett.mdwn | 13 |
11 files changed, 142 insertions, 6 deletions
diff --git a/doc/bugs/recentchanges_feed_links.mdwn b/doc/bugs/recentchanges_feed_links.mdwn index 8871c8702..ef0f9d1c4 100644 --- a/doc/bugs/recentchanges_feed_links.mdwn +++ b/doc/bugs/recentchanges_feed_links.mdwn @@ -98,3 +98,10 @@ to turn on? --Chapman Flack >>>>>> --[[JasonBlevins]], 2008-10-17 [[JasonBlevins]] nailed it, [[done]] --[[Joey]] + +> Thanks for applying the patch (and improving it). There's still one small issue: +> the old opening div tag still needs to be removed (it's hard to see the removed line +> with the pastie color scheme). +> --[[JasonBlevins]], 2008-10-18 + +>> Thanks, missed that when I had to hand-apply the patch. --[[Joey]] diff --git a/doc/bugs/relative_date_weird_results.mdwn b/doc/bugs/relative_date_weird_results.mdwn new file mode 100644 index 000000000..9f35e47f7 --- /dev/null +++ b/doc/bugs/relative_date_weird_results.mdwn @@ -0,0 +1,4 @@ +I just submitted a new bug, and... after clicking "save", my brand new bug page displays, at the bottom: "Last edited 6 hours and 3 minutes ago". Timezone issue, I guess? (Hint: I'm in France) -- [[intrigeri]] + +> Yep, it wasn't including a timezone in the machine parseable time. +> [[done]] --[[Joey]] diff --git a/doc/bugs/unicode_chars_in_wikiname_break_auth.mdwn b/doc/bugs/unicode_chars_in_wikiname_break_auth.mdwn new file mode 100644 index 000000000..5d5e90f7a --- /dev/null +++ b/doc/bugs/unicode_chars_in_wikiname_break_auth.mdwn @@ -0,0 +1,16 @@ +I spent hours trying to understand why my wiki suddenly refused me to log in (using passwordauth). +The failure message was always: `login failed, perhaps you need to turn on cookies?` + +Inspecting the cookie information (thanks to Iceweasel's webdeveloper add-on), I realized there were some weird-looking encoded chars in the cookie name. + +Replacing "ยท" with "-" in `wikiname` fixed this login issue. + +> Hmm, Recai sent me a patch a long time ago to handle utf-8 here by encoding +> the wikiname. But it doesn't seem to work, somehow the encoded utf-8 +> value still doesn't make it through. (CGI::Session seems to have underermined utf-8 +> issues too.) Seems like I will have to possibly break some sessions and +> entity-encode the wikiname in the cookie.. [[done]]. --[[Joey]] + +(BTW, such a char was replaced by -I don't remember what encoding thingie- in my setup file, when running `ikiwiki-transition setupformat`.) + +> Thanks for the heads up, fixed that too. --[[Joey]] diff --git a/doc/plugins/relativedate.mdwn b/doc/plugins/relativedate.mdwn index ecbdf68bf..121bce477 100644 --- a/doc/plugins/relativedate.mdwn +++ b/doc/plugins/relativedate.mdwn @@ -1,4 +1,4 @@ -[[!template id=plugin name=prettydate author="[[Joey]]"]] +[[!template id=plugin name=relativedate author="[[Joey]]"]] [[!tag type/date]] This plugin lets dates be displayed in relative form. Examples: "2 days ago", diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 884c7eefb..857d176d5 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -196,7 +196,6 @@ generating the page. hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); - [[Templates|wikitemplates]] are filled out for many different things in ikiwiki, like generating a page, or part of a blog page, or an rss feed, or a cgi. This hook allows modifying the variables available on those @@ -361,6 +360,13 @@ This hook is called whenever ikiwiki normally saves its state, just before the state is saved. The function can save other state, modify values before they're saved, etc. +### displaytime + + hook(type => "displaytime", id => "foo", call => \&display); + +This hook can be registered to override the regular `displaytime` function. +Only the last displaytime hook will be used. + ### renamepage hook(type => "renamepage", id => "foo", call => \&renamepage); diff --git a/doc/tips/Git_repository_and_web_server_on_different_hosts.mdwn b/doc/tips/Git_repository_and_web_server_on_different_hosts.mdwn new file mode 100644 index 000000000..58940b89f --- /dev/null +++ b/doc/tips/Git_repository_and_web_server_on_different_hosts.mdwn @@ -0,0 +1,61 @@ +One may want to provide ikiwiki hosting with [[rcs/git]]+ssh access and web +server located at different hosts. Here's a description for such +a setup, using password-less SSH as a way of communication between +these two hosts. + +Git server +========== + +Let's create a user called `ikiwiki_example`. This user gets SSH +access restricted to GIT pull/push, using `git-shell` as a shell. + +The root (bare) repository: + +- is stored in `~ikiwki_example/ikiwiki_example.git` +- is owned by `ikiwiki_example:ikiwiki_example` +- has permissions 0700 + +The master repository's post-update hook connects via SSH to +`webserver` as user `ikiwiki_example`, in order to run +`~/bin/ikiwiki.update` on `webserver`; this post-update hook, located +in `~ikiwki_example/ikiwiki_example.git/hooks/post-update`, is +executable and contains: + + #!/bin/sh + /usr/bin/ssh ikiwiki_example@webserver bin/ikiwiki.update + +Password-less SSH must be setup to make this possible; one can +restrict `gitserver:ikiwiki_example` to be able to run only the needed +command on the web server, using such a line in +`webserver:~ikiwiki_example/.ssh/authorized_keys`: + + command="bin/ikiwiki.update",from="gitserver.example.com",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-rsa ... + +Web server +========== + +Let's create a user called `ikiwiki_example` on `webserver`. She needs +to have write permission to the destination directory. + +The working tree repository (`srcdir`): + +- is stored in `~ikiwki_example/src` +- is owned by `ikiwiki_example:ikiwiki_example` +- has permissions 0700 +- has the following origin: `ikiwiki_example@gitserver:ikiwiki_example.git` + +The CGI wrapper is generated with ownership set to +`ikiwiki_example:ikiwiki_example` and permissions `06755`. + +Password-less SSH must be setup so that `ikiwiki_example@webserver` is +allowed to push to the master repository. As told earlier, SSH access +to `ikiwiki_example@gitserver` is restricted to GIT pull/push, which +is just what we need. + +The Git wrapper is generated in `~ikiwiki_example/bin/ikiwiki.update`: + + git_wrapper => '/home/ikiwiki_example/bin/ikiwiki.update' + +As previously explained, this wrapper is run over SSH by the master +repository's post-update hook; it pulls updates from the master +repository and triggers a wiki refresh. diff --git a/doc/tips/laptop_wiki_with_git/discussion.mdwn b/doc/tips/laptop_wiki_with_git/discussion.mdwn index 234833ca7..6ce72ae7b 100644 --- a/doc/tips/laptop_wiki_with_git/discussion.mdwn +++ b/doc/tips/laptop_wiki_with_git/discussion.mdwn @@ -5,3 +5,8 @@ Or, was this last remark about rebuilding after pulling meant to apply to rebuil [[DavidBremner]] * *Updated* Now that I play with this a bit, this seems not so important. Having a seperate sync operation that I run from the laptop is no big deal, and lets me update the parts of my site not yet managed by ikiwiki at the same time. + +* Ok, I have finally finished to set this up. I have a question for you :) Is it mandatory to have a locally running webserver on the laptop ? I mean, do I need to setup the CGI wrapper on the laptop ? Is it possible to just add/edit/delete/whatever, git commit all the stuff and git push back to the server ? Thank you. --[[xma]] + +> Of course you don't need a web server on the laptop. It is useful for +> previewing pages before publishing them though. --[[Joey]] diff --git a/doc/todo/clear_page_to_delete.mdwn b/doc/todo/clear_page_to_delete.mdwn index 1a0d3f008..ccb7634e5 100644 --- a/doc/todo/clear_page_to_delete.mdwn +++ b/doc/todo/clear_page_to_delete.mdwn @@ -14,3 +14,13 @@ question is really: Re vandalism in general, I am generally happy using git-revert to kill the offending change. --[[Joey]] + +I don't think we need a second way to delete pages, which would probably be +used by the only few people who will learn it's possible by random +documentation reading, find it useful, *and* remember it. -- [[intrigeri]] + +On the other hand, clearing the page's whole content essentially means deleting +the page. That's what the user intended to do in this case. The information +content of an empty vs. a deleted page is essentially the same, I'd say. But +having ikiwiki remove those stale pages would save some (minimal, admittedly) +time needed for manual clean-up. --[[tschwinge]] diff --git a/doc/todo/httpauth_feature_parity_with_passwordauth.mdwn b/doc/todo/httpauth_feature_parity_with_passwordauth.mdwn new file mode 100644 index 000000000..8a338ece1 --- /dev/null +++ b/doc/todo/httpauth_feature_parity_with_passwordauth.mdwn @@ -0,0 +1,11 @@ +The only way to have a private ikiwiki, with a shared user database for static pages and CGI authentication, is to use [[plugins/httpauth]]. It would be good for httpauth to be on par with [[plugins/passwordauth]], +i.e. to allow registering users, resetting passwords, and changing passwords; supporting some kind of +`account_creation_password` configuration option would be nice, too. + +I'll probably propose patches implementing this at some point. +I've not had a single look at the code yet, but it may be nice to factorize +the relevant passwordauth code, instead of rewriting it completely in httpauth. + +-- [[intrigeri]] + +[[wishlist]] diff --git a/doc/users/jasonblevins.mdwn b/doc/users/jasonblevins.mdwn index 52420f7c9..a07d5d14b 100644 --- a/doc/users/jasonblevins.mdwn +++ b/doc/users/jasonblevins.mdwn @@ -1,3 +1,5 @@ +[[!meta title="Jason Blevins"]] + I'm currently hosting a private ikiwiki for keeping research notes which, with some patches and a (currently unreleased) plugin, will convert inline LaTeX expressions to MathML. I'm working towards a @@ -9,3 +11,12 @@ we're at it, why not SVG). My (also MathML-enabled) homepage: <http://jblevins.org/> (still using Blosxom...maybe one day I'll convert it to ikiwiki...) + +Current issues of interest: + + * [[bugs/recentchanges_feed_links]] + * [[bugs/HTML_inlined_into_Atom_not_necessarily_well-formed]] + * [[plugins/toc/discussion]] + * [[todo/BibTeX]] + * [[todo/svg]] + * [[todo/Option_to_make_title_an_h1?]] diff --git a/doc/users/joshtriplett.mdwn b/doc/users/joshtriplett.mdwn index f32d23bb7..f85c068c3 100644 --- a/doc/users/joshtriplett.mdwn +++ b/doc/users/joshtriplett.mdwn @@ -1,10 +1,15 @@ [[!meta title="Josh Triplett"]] -Josh Triplett; `josh@{freedesktop.org,kernel.org,psas.pdx.edu}`. +Email: `josh@{joshtriplett.org,freedesktop.org,kernel.org,psas.pdx.edu}`. + +[Josh Triplett's homepage](http://joshtriplett.org) Proud user of ikiwiki. -Currently working on scripts to convert MoinMoin and TWiki wikis to ikiwikis -backed by a git repository, including full history. +Currently working on scripts to convert MoinMoin and TWiki wikis to +ikiwikis backed by a git repository, including full history. +Available from the following repositories, though not well-documented: -> I've written about how I converted from Mediawiki here: <http://iki.u32.net/Mediawiki_Conversion/> Are you ever going to release your scripts? --[[sabr]] + git clone git://svcs.cs.pdx.edu/git/wiki2iki/moin2iki + git clone git://svcs.cs.pdx.edu/git/wiki2iki/html-wikiconverter + git clone git://svcs.cs.pdx.edu/git/wiki2iki/twiki |