diff options
Diffstat (limited to 'doc')
34 files changed, 469 insertions, 74 deletions
diff --git a/doc/branches.mdwn b/doc/branches.mdwn new file mode 100644 index 000000000..4accc21ca --- /dev/null +++ b/doc/branches.mdwn @@ -0,0 +1,22 @@ +In order to refer to a branch in one of the [[git]] repositories, for +example when submitting a [[patch]], you can use the +[[templates/gitbranch]] template. For example: + + \[[!template id=gitbranch branch=yourrepo/amazingbranch author="\[[yourname]]"]] + +Branches referred to in open [[bugs]] and [[todo]]: + +[[!inline pages="(todo/* or bugs/*) and link(/branches) and !link(bugs/done) +and !link(todo/done) and !*/*/*" show=0 archive=yes]] + +Long-lived branches in the main git repository: + +* `debian-stable` is used for updates to the old version included in + Debian's stable release, and `debian-testing` is used for updates to + Debian's testing release. (These and similar branches will be rebased.) +* `ignore` gets various branches merged to it that [[Joey]] wishes to ignore + when looking at everyone's unmerged changes. +* `pristine-tar` contains deltas that + [pristine-tar](http://kitenet.net/~joey/code/pristine-tar) + can use to recreate released tarballs of ikiwiki + diff --git a/doc/bugs/Pages_with_non-ascii_characters_like_öäå_in_name_not_found_directly_after_commit.mdwn b/doc/bugs/Pages_with_non-ascii_characters_like_öäå_in_name_not_found_directly_after_commit.mdwn new file mode 100644 index 000000000..e7cb43bee --- /dev/null +++ b/doc/bugs/Pages_with_non-ascii_characters_like_öäå_in_name_not_found_directly_after_commit.mdwn @@ -0,0 +1,10 @@ +At least my setup on kapsi.fi always prints 404 Not Found after adding a page with non-ascii characters in name. But the page exists and is visible after the 404 with url encoding and the blog page is inlined correctly on the feed page. + +Apparently ikiwiki.info does not complain with 404. Should the character encoding be set in wiki config? + +Happens also after editing the page. Here's an example: + + * page name displayed in 404: http://mcfrisk.kapsi.fi/skiing/posts/Iso-Sy%F6te%20Freeride%202011%20Teaser.html?updated + * page name in the blog feed: http://mcfrisk.kapsi.fi/skiing/posts/Iso-Sy%C3%B6te%20Freeride%202011%20Teaser.html + +Difference is in the word Iso-Syöte. Pehaps also the browsers is part of the game, I use Iceweasel from Debian unstable with default settings. diff --git a/doc/bugs/enumerations_of_dates_not_formatted_correctly.mdwn b/doc/bugs/enumerations_of_dates_not_formatted_correctly.mdwn new file mode 100644 index 000000000..4a78ea3f9 --- /dev/null +++ b/doc/bugs/enumerations_of_dates_not_formatted_correctly.mdwn @@ -0,0 +1,11 @@ +When an enumeration contains entries starting with ordinal numbers, e.g., for lists of meeting dates, ikiwiki turns them all into the 1st. + +Testcase: + +*The following lists should read: 1. January, 27. March, 99. November, 42. April* +**But instead it reads:** + +* 1. January +* 27. March +* 99. November +* 42. April diff --git a/doc/bugs/no_search_button__44___hence_can__39__t_do_search_in_w3m_at_ikiwiki.info.mdwn b/doc/bugs/no_search_button__44___hence_can__39__t_do_search_in_w3m_at_ikiwiki.info.mdwn new file mode 100644 index 000000000..2d600fdbb --- /dev/null +++ b/doc/bugs/no_search_button__44___hence_can__39__t_do_search_in_w3m_at_ikiwiki.info.mdwn @@ -0,0 +1,32 @@ +If I browse <http://ikiwiki.info> in [emacs-w3m](http://www.emacswiki.org/emacs/emacs-w3m) (without Javascript), I +can't do a [[search|plugins/search]]: the text field is there (so I can +enter my search request), but there seems to be no way to make +actually a search request (i.e., no button). + +(A remark on how it works now in the other browsers: +In the more "complete" +browsers (Chromium etc.), the request is done by pressing Enter in the +text field.) +--Ivan Z. + +I see, no Javascript is probably involved in using the search form; +the code is simply: + + <form method="get" action="/ikiwiki.cgi" id="searchform"> + <div> + <input type="text" id="searchbox" name="P" value="" size="16" + /> + </div> + </form> + +So, if the semantics suggested by HTML is such that such a form is to +be submitted by some default form submitting action in the UI and it +doesn't really require a button to be functional, then I'd say it's +not an ikiwiki's problem, but a missing feature in the UI of emacs-w3m +or the underlying w3m... Perhaps I'll report this issue to them. --Ivan Z. + +[[!tag done]] +There is no problem at all! +I'm sorry for this hassle! +In emacs-w3m, there is the <code>w3m-submit-form</code> command +(<kbd>C-c C-c</kbd>) to submit the form at point; it works.--Ivan Z. diff --git a/doc/bugs/po:_might_not_add_translated_versions_of_all_underlays.mdwn b/doc/bugs/po:_might_not_add_translated_versions_of_all_underlays.mdwn new file mode 100644 index 000000000..66d16bf23 --- /dev/null +++ b/doc/bugs/po:_might_not_add_translated_versions_of_all_underlays.mdwn @@ -0,0 +1,10 @@ +[[plugins/po]]'s `checkconfig` looks in the `underlaydirs`, but plugins that +add underlays typically do so in their own `checkconfig`. + +As far as I can see, this will result in it not adding translated versions +of underlays added by a plugin that comes after it in `$config{add_plugins}`; +for instance, if you have `add_plugins => qw(po smiley)`, you'll probably +not get the translated versions of `smileys.mdwn`. (I haven't tested this.) + +To see them all, `po` should use `last => 1` when registering the hook. +--[[smcv]] diff --git a/doc/css_market/kirkambar.css b/doc/css_market/kirkambar.css index 76d9ba771..e756a1260 100644 --- a/doc/css_market/kirkambar.css +++ b/doc/css_market/kirkambar.css @@ -40,7 +40,7 @@ pre, tt, code { monospace; } -pre, tt, code, tr.changeinfo, #blogform { +pre, tt, code, tr.changeinfo, .blogform { color: inherit; background-color: #f6f6f0; } diff --git a/doc/examples/blog/posts/ugachaka/discussion.mdwn b/doc/examples/blog/posts/ugachaka/discussion.mdwn deleted file mode 100644 index 387db1f52..000000000 --- a/doc/examples/blog/posts/ugachaka/discussion.mdwn +++ /dev/null @@ -1 +0,0 @@ -jackie chan vs chuck norris. diff --git a/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall.mdwn b/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall.mdwn new file mode 100644 index 000000000..08187e6f2 --- /dev/null +++ b/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall.mdwn @@ -0,0 +1,16 @@ +My server got hacked by an EXIM vulnerability, and so I reimaged the system. After installing ikiwiki I can't get it to accept my old setup file, and I'm not sure what to do. + +I'm running debian stable with security updates. Running setup I get. +Can't use an undefined value as an ARRAY reference at /usr/share/perl5/IkiWiki/Setup/Standard.pm line 33. +That line in the source file has something todo with wrappers. Also since the reinstall there is no /etc/ikiwiki/auto.setup + +After futzing with it for over an hour I tried installing the debian backports version, and get a new different error. + +Can't exec "git": No such file or directory at /usr/share/perl5/IkiWiki/Plugin/git.pm line 169. +Cannot exec 'git pull origin': No such file or directory +'git pull origin' failed: at /usr/share/perl5/IkiWiki/Plugin/git.pm line 195. +Can't exec "git": No such file or directory at /usr/share/perl5/IkiWiki/Plugin/git.pm line 169. +Cannot exec 'git log --max-count=100 --pretty=raw --raw --abbrev=40 --always -c -r HEAD -- .': No such file or directory +'git log --max-count=100 --pretty=raw --raw --abbrev=40 --always -c -r HEAD -- .' failed: + +Any ideas how I can get ikiwiki working again? diff --git a/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall/comment_1_87a360155ff0502fe08274911cc6a53f._comment b/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall/comment_1_87a360155ff0502fe08274911cc6a53f._comment new file mode 100644 index 000000000..fa974765f --- /dev/null +++ b/doc/forum/Can__39__t_get_ikiwiki_working_again_after_reinstall/comment_1_87a360155ff0502fe08274911cc6a53f._comment @@ -0,0 +1,8 @@ +[[!comment format=mdwn + username="https://www.google.com/accounts/o8/id?id=AItOawkpwzlIQkUFJvJ8dF2-Y-sQklGpVB1fTzk" + nickname="Daniel" + subject="Fixed." + date="2011-01-19T10:18:16Z" + content=""" +Oops forgot to install git. Could have used a more helpful error message. +"""]] diff --git a/doc/forum/ikiwiki_+_mathjax/comment_2_ddb7a4d59bbe7145167d122a146e8f65._comment b/doc/forum/ikiwiki_+_mathjax/comment_2_ddb7a4d59bbe7145167d122a146e8f65._comment new file mode 100644 index 000000000..af15e0875 --- /dev/null +++ b/doc/forum/ikiwiki_+_mathjax/comment_2_ddb7a4d59bbe7145167d122a146e8f65._comment @@ -0,0 +1,11 @@ +[[!comment format=mdwn + username="https://www.google.com/accounts/o8/id?id=AItOawnl3JHr3pFPOZMsKgx11_mLCbic1Rb3y8s" + nickname="patrick" + subject="comment 2" + date="2011-01-09T09:48:23Z" + content=""" +Hi Carl, +That's great news, I've been looking for a solution like this for some time. +would you mind sharing your patch or write up a small howto? +Thanks +"""]] diff --git a/doc/forum/link_to_an_image_inside_the_wiki_without_inlining_it.mdwn b/doc/forum/link_to_an_image_inside_the_wiki_without_inlining_it.mdwn index e92cc1b1c..3f2713678 100644 --- a/doc/forum/link_to_an_image_inside_the_wiki_without_inlining_it.mdwn +++ b/doc/forum/link_to_an_image_inside_the_wiki_without_inlining_it.mdwn @@ -1,3 +1,5 @@ +[[!template id=gitbranch branch=wtk/linktoimageonly author="[[wtk]]"]] + how can I create a link to an image which is part of the wiki, without having it inserted in my page? I tought this: @@ -67,3 +69,4 @@ Any hints? --[[jerojasro]] linktext => $params{text}, noimageinline => 1); +> [[patch]]: I've updated this plugin for the current ikiwiki. --[[wtk]] diff --git a/doc/git.mdwn b/doc/git.mdwn index 5943097e6..ce20938f4 100644 --- a/doc/git.mdwn +++ b/doc/git.mdwn @@ -69,22 +69,5 @@ think about merging them. This is recommended. :-) ## branches -In order to refer to a branch in one of the above git repositories, for -example when submitting a [[patch]], you can use the -[[templates/gitbranch]] template. +Current branches of ikiwiki are listed on [[branches]]. -Some of the branches included in the main repository include: - -* `gallery` contains the [[todo/Gallery]] plugin. It's not yet merged - due to license issues. Also some bits need to be tweaked to make it - work with the current *master* branch again. -* `wikiwyg` adds [[todo/wikiwyg]] support. It is unmerged pending some - changes. -* `debian-stable` is used for updates to the old version included in - Debian's stable release, and `debian-testing` is used for updates to - Debian's testing release. (These and similar branches will be rebased.) -* `ignore` gets various branches merged to it that Joey wishes to ignore - when looking at everyone's unmerged changes. -* `pristine-tar` contains deltas that - [pristine-tar](http://kitenet.net/~joey/code/pristine-tar) - can use to recreate released tarballs of ikiwiki diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn index c6a23ce3c..49b993d55 100644 --- a/doc/ikiwiki/directive/inline.mdwn +++ b/doc/ikiwiki/directive/inline.mdwn @@ -116,6 +116,3 @@ Here are some less often needed parameters: in conjunction with this one. [[!meta robots="noindex, follow"]] - -A related directive is the [[ikiwiki/directive/edittemplate]] directive, which allows -default text for a new page to be specified. diff --git a/doc/news/version_3.20101112.mdwn b/doc/news/version_3.20101112.mdwn deleted file mode 100644 index ad591445f..000000000 --- a/doc/news/version_3.20101112.mdwn +++ /dev/null @@ -1,17 +0,0 @@ -ikiwiki 3.20101112 released with [[!toggle text="these changes"]] -[[!toggleable text=""" - * txt: Fix display when used inside a format directive. - * highlight: Ensure that other, more-specific format plugins, - like txt are used in preference to this one in case of ties. - * htmltidy, sortnaturally: Add missing checkconfig hook - registration. Closes: #[601912](http://bugs.debian.org/601912) - (Thanks, Craig Lennox and Tuomas Jormola) - * git: Use author date, not committer date. Closes: #[602012](http://bugs.debian.org/602012) - (Thanks, Tuomas Jormola) - * Fix htmlscrubber\_skip to be matched on the source page, not the page it is - inlined into. Should allow setting to "* and !comment(*)" to scrub - comments, but leave your blog posts unscrubbed, etc. - * comments: Make postcomment() pagespec work when previewing a comment, - including during moderation. - * comments: Make comment() pagespec also match comments that are being - posted."""]]
\ No newline at end of file diff --git a/doc/news/version_3.20110122.mdwn b/doc/news/version_3.20110122.mdwn new file mode 100644 index 000000000..74dd0bf96 --- /dev/null +++ b/doc/news/version_3.20110122.mdwn @@ -0,0 +1,10 @@ +ikiwiki 3.20110122 released with [[!toggle text="these changes"]] +[[!toggleable text=""" + * inline: Pass feed titles to templates and add title and rel attributes + to feed links. (Giuseppe Bilotta) + * inline: Use class rather than id for feedlinks and blogform. + (Giuseppe Bilotta) + * comments: Fix XSS security hole due to missing validation of page name. + CVE-2011-0428 (Thanks, Dave B.) + * rename: Fix crash when renaming a page that is linked to by a page + in an underlay."""]]
\ No newline at end of file diff --git a/doc/patch.mdwn b/doc/patch.mdwn index b570d995c..7d0f9847c 100644 --- a/doc/patch.mdwn +++ b/doc/patch.mdwn @@ -5,7 +5,8 @@ If you post a patch to the [[todo]] or [[bugs]] list, or elsewhere, once it's ready to be applied, add a 'patch' tag so it will show up here. If your patch is non-trivial and might need several iterations to get -right, please consider publishing a [[git]] branch. +right, or you'd just like to make it easy for [[Joey]] to apply it, +please consider publishing a [[git]] [[branch|branches]]. [[!inline pages="(todo/* or bugs/*) and link(patch) and !link(bugs/done) and !link(todo/done) and !*/Discussion" rootpage="todo" archive="yes"]] diff --git a/doc/sandbox.mdwn b/doc/sandbox.mdwn index 049abee0f..42f9f3f36 100644 --- a/doc/sandbox.mdwn +++ b/doc/sandbox.mdwn @@ -1,6 +1,8 @@ +[[!tag test]] + Hello, world! -test...id +test...id Morjo $\sin(x)$ This is the [[SandBox]], a page anyone can edit to try out ikiwiki (version [[!version ]]). diff --git a/doc/sandbox/dateenumeration.mdwn b/doc/sandbox/dateenumeration.mdwn new file mode 100644 index 000000000..adc40bd23 --- /dev/null +++ b/doc/sandbox/dateenumeration.mdwn @@ -0,0 +1,4 @@ +* 1. January +* 23. February +* 99. March +* 7. November diff --git a/doc/security.mdwn b/doc/security.mdwn index 4fa531eb1..52d9d3dc0 100644 --- a/doc/security.mdwn +++ b/doc/security.mdwn @@ -453,3 +453,13 @@ preview or moderation of comments with such a configuration. These problems were discovered on 12 November 2010 and fixed the same hour with the release of ikiwiki 3.20101112. ([[!cve CVE-2010-1673]]) + +## javascript insertation via insufficient checking in comments + +Dave B noticed that attempting to comment on an illegal page name could be +used for an XSS attack. + +This hole was discovered on 22 Jan 2011 and fixed the same day with +the release of ikiwiki 3.20110122. A fix was backported to Debian squeeze, +as version 3.20100815.5. An upgrade is recommended for sites +with the comments plugin enabled. ([[!cve CVE-2011-0428]]) diff --git a/doc/style.css b/doc/style.css index aa27d8866..922b82a75 100644 --- a/doc/style.css +++ b/doc/style.css @@ -179,7 +179,7 @@ div.recentchanges { width: 60%; } -#blogform { +.blogform, #blogform { padding: 10px 10px; border: 1px solid #aaa; background: #eee; @@ -274,7 +274,7 @@ div.progress-done { .tags { display: none; } .feedbutton { display: none; } #searchform { display: none; } - #blogform { display: none; } + .blogform, #blogform { display: none; } #backlinks { display: none; } } diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 4fd2bf501..d189fa073 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -1,10 +1,5 @@ [[Ikiwiki]] uses many templates for many purposes. By editing its templates, -you can fully customise this site. - -Templates are located in `/usr/share/ikiwiki/templates` by default; -the `templatedir` setting can be used to make another directory be -searched first. Customised templates can also be placed inside the -"templates/" directory in your wiki's source. +you can fully customise its appearance, and avoid duplicate content. Ikiwiki uses the HTML::Template module as its template engine. This supports things like conditionals and loops in templates and is pretty @@ -16,17 +11,19 @@ easy to learn. All you really need to know to modify templates is this: * To use one block of text if a variable is set and a second if it's not, use `<TMPL_IF variable>text<TMPL_ELSE>other text</TMPL_IF>` -[[!if test="enabled(template)" then=""" +[[!if test="enabled(template) or enabled(edittemplate)" then=""" ## template pages +Template pages are regular wiki pages that are used as templates for other +pages. +"""]] + +[[!if test="enabled(template)" then=""" The [[!iki ikiwiki/directive/template desc="template directive"]] allows -wiki pages to be used as templates, filled out and inserted into other -pages in the wiki. +template pages to be filled out and inserted into other pages in the wiki. """]] [[!if test="enabled(edittemplate)" then=""" -## default content for new pages - The [[!iki ikiwiki/directive/edittemplate desc="edittemplate directive"]] can be used to make new pages default to containing text from a template page, which can be filled out as the page is edited. @@ -34,18 +31,30 @@ page, which can be filled out as the page is edited. [[!if test="(enabled(template) or enabled(edittemplate)) and enabled(inline)" then=""" +These template pages are currently available: + [[!inline pages="templates/* and !*.tmpl and !templates/*/* and !*/discussion" feeds=no archive=yes sort=title template=titlepage -rootpage=templates postformtext="Add a new template named:"]] +rootpage=templates postformtext="Add a new template page named:"]] """]] -## wiki templates +## template files + +Template files are unlike template pages in that they have the extension +`.tmpl`. Template files are used extensively by Ikiwiki to generate html. +They can contain html that would not normally be allowed on a wiki page. + +Template files are located in `/usr/share/ikiwiki/templates` by default; +the `templatedir` setting can be used to make another directory be +searched first. Customised template files can also be placed inside the +"templates/" directory in your wiki's source -- files placed there override +ones in the `templatedir`. -These templates are used to build the wiki. The aim is to keep almost all -html out of ikiwiki and in the templates. +Here is a full list of the template files used: * `page.tmpl` - Used for displaying all regular wiki pages. This is the - key template to customise. [[!if test="enabled(pagetemplate)" then=""" + key template to customise to change the look and feel of Ikiwiki. + [[!if test="enabled(pagetemplate)" then=""" (The [[!iki ikiwiki/directive/pagetemplate desc="pagetemplate directive"]] can be used to make a page use a different template than `page.tmpl`.)"""]] * `rsspage.tmpl` - Used for generating rss feeds for blogs. diff --git a/doc/templates/discussion.mdwn b/doc/templates/discussion.mdwn index efeedf448..c202ecf40 100644 --- a/doc/templates/discussion.mdwn +++ b/doc/templates/discussion.mdwn @@ -20,3 +20,5 @@ Am I missing something? --[[jwalzer]] > If there isn't a suitable variable (I don't think there is a list at > the moment), a [[plugin|plugins/write]] to add one would be about 10 > lines of perl - you'd just need to define a `pagetemplate` hook. --[[smcv]] + +Is there a list of all the available variables somewhere, or do I just grep the source for TMPL_VAR? And is there a way to refer to a variable inside of a wiki page or does it have to be done from a template? Thanks. -- [[AdamShand]] diff --git a/doc/templates/gitbranch.mdwn b/doc/templates/gitbranch.mdwn index 962420940..4fdf937ff 100644 --- a/doc/templates/gitbranch.mdwn +++ b/doc/templates/gitbranch.mdwn @@ -1,5 +1,5 @@ <span class="infobox"> -Available in a [[!taglink /git]] repository.<br /> +Available in a [[!taglink /git]] repository [[!taglink branch|/branches]].<br /> Branch: <TMPL_VAR branch><br /> Author: <TMPL_VAR author><br /> </span> @@ -13,6 +13,4 @@ these parameters: (e.g. github/master)</li> <li>author - the author of the branch</li> </ul> - -It also automatically tags the branch with `/git`. </TMPL_UNLESS> diff --git a/doc/todo/Tags_list_in_page_footer_uses_basename.mdwn b/doc/todo/Tags_list_in_page_footer_uses_basename.mdwn index e2221bb84..603e82b20 100644 --- a/doc/todo/Tags_list_in_page_footer_uses_basename.mdwn +++ b/doc/todo/Tags_list_in_page_footer_uses_basename.mdwn @@ -6,3 +6,6 @@ I think the tag list should always contain the full path to the tag, with the ta > What if tagbase is not used? I know this would clutter up the display of > my tags on several wikis, including this one. --[[Joey]] + +>> Since Giuseppe's patches to fix [[bugs/tag_behavior_changes_introduced_by_typed_link_feature]], +>> the tag list has what Josh requested, but only if a tagbase is used. [[done]] --[[smcv]] diff --git a/doc/todo/autoindex_should_use_add__95__autofile.mdwn b/doc/todo/autoindex_should_use_add__95__autofile.mdwn index 9f3fd71f1..908c85cb4 100644 --- a/doc/todo/autoindex_should_use_add__95__autofile.mdwn +++ b/doc/todo/autoindex_should_use_add__95__autofile.mdwn @@ -3,7 +3,7 @@ so the latter should probably use the former. --[[smcv]] ---- -[[!template id=gitbranch branch=smcv/autoindex-autofile author="[[smcv]]"]] +[[!template id=gitbranch branch=smcv/ready/autoindex-autofile author="[[smcv]]"]] I'm having trouble fixing this: @@ -69,6 +69,8 @@ manually-created version, but that doesn't necessarily mean we don't want > when a page is deleted, nothing will ever re-create it behind ones back. > --[[Joey]] +>> Fair enough, I'll make autoindex do that. --s + ## autoindex The autoindex machinery records a more complex set. Items are added to the @@ -110,3 +112,7 @@ and > I doubt there is any good reason for this behavior. These are probably > bugs. --[[Joey]] + +>> OK, I believe my updated branch gives `autoindex` the same behaviour +>> as auto-creation of tags. The `auto-del-create-del` and +>> `create-del-auto` use cases work the same as for tags on my demo wiki. --s diff --git a/doc/todo/configurable_markdown_path.mdwn b/doc/todo/configurable_markdown_path.mdwn new file mode 100644 index 000000000..931f98025 --- /dev/null +++ b/doc/todo/configurable_markdown_path.mdwn @@ -0,0 +1,10 @@ +[[!template id=gitbranch branch=wtk/mdwn author="[[wtk]]"]] + +summary +======= + +Make it easy to configure the Markdown implementation used by the +[[plugins/mdwn]] plugin. With this patch, you can set the path to an +external Markdown executable in your ikiwiki config file. If you do +not set a path, the plugin will use the usual config options to +determine which Perl module to use. diff --git a/doc/todo/feed_enhancements_for_inline_pages.mdwn b/doc/todo/feed_enhancements_for_inline_pages.mdwn index 5a7b1f839..2a922ec35 100644 --- a/doc/todo/feed_enhancements_for_inline_pages.mdwn +++ b/doc/todo/feed_enhancements_for_inline_pages.mdwn @@ -2,7 +2,173 @@ A few patches to clean up and improve feed management for inline pages. +(I moved the picked/scratched stuff at the bottom.) + +* the (now first) patch tries to define the default description for a feed based not only on the wiki name, + but also on the current page name. The actual way this is built might not be the optimal one, + so I'm open to suggestions + + > I don't really like using "wikiname/page" as the name of the feed. It's + > a bit too mechanical. I'd be ok with using just the page name, + > with a fallback to wikiname for the toplevel index. Or maybe + > something like "$wikiname's $page". + > + > Also, shouldn't `pagetitle` be run on the page name? (Haven't checked.) + > --[[Joey]] + + >> The rewritten patch now sets the feed title using the page title, and the feed description + >> using the page _description_, both obtained from meta if possible. If there is no page + >> description, then we use the page title combined with the wiki name. I introduce a new + >> configuration key to customize the actual automatic description. + + >>> The feed title part of this seems unnecessary. As far as I can see, + >>> ikiwiki already uses the page title as the feed title; TITLE in the + >>> rsspage.tmpl is handled the same as TITLE in page.tmpl. --[[Joey]] + + >>>> I'm afraid this is not the case in the ikiwiki I have. It might be the effect of some kind of interaction of + >>>> this with the next patch, but apparently I need both to ensure that the proper title is being used. + + >>>> Some further analysis: before my patch, the feed title would be set to + >>>> `pagetitle($page)`, or to the wiki name if the pagetitle was index. As + >>>> it turns out, in my setup (see below for details) this happens quite + >>>> often on my `dirN.mdwn` index pages, where I would like to have `dirN` + >>>> as title instead. Plus, unless I'm mistaken, `pagetitle()` doesn't + >>>> actually use `meta` information, which my patch does. So I still think + >>>> the title part of the patch is worth it. As a bonus, it also allows title + >>>> customization by the `title=` parameter as offered in another patch. + +* the (now second) patch passes uses the included rather than the including page for the URL. This is + actually a forgotten piece from my previous patch (now upstream) to base the feed name on the + included rather than the including page, and it's only relevant for nested inline pages. + + > I have a vague memory of considering doing this before, and not, + > because there is actually no guarantee that the inlined page (that + > itself contains an inline) will generate an url. It could be excluded; + > it could be an internal page; it could use a conditional to omit the + > inline when not inlined. + + >> I would say that in this cases my patch wouldn't change anything because + >> either the code would still act as before or it wouldn't be triggered at + >> all. --GB + + > Also, I think that `destpage` gets set wrong. And I think that + > `get_inline_content` is called with the source page, rather than the + > destpage, and so could generate urls that don't work on the destpage. + + >> `destpage` getting set wrong is probably a bug that should be + >> fixed, but I must say I haven't come across it (yet). + >> `get_inline_content` is called with both the source and dest page, + >> and in my experience the urls have always been generated correctly. + + > All in all, this is an edge case, and currently seems to work ok, so + > why change it? --[[Joey]] + + >> Because it does not work ok for me. I have a number of directories `dir1/`, `dir2/`, `dir3/` + >> each with a corresponding `dir1.mdwn`, `dir2.mdwn`, `dir3.mdwn` etc that is basically just + >> an inline instruction. Then my index.mdwn inlines `dir[123]`. Without these two patches, the + >> `dir[123]` feeds get the wrong title. + +* the (new) fourth patch introduces a `feedtitle` parameter to override the feed title. I opted for + not squashing it with the second patch to allow you to scrap this but still get the other, in case + you're not too happy about having a plethora of parameters + + > This seems clearly a good idea, since there is already a "description" + > parameter. But, by analogy with that parameter, it should just be + > called "title". --[[Joey]] + + >> I'll rework the patch to that effect. + +* a fifth patch introduces an `id` parameter to allow setting the HTML id attribute in the + blogpost/feedlinks template. Since we replace their id with a class (first patch), this brings + back the possibility for direct CSS customization and JavaScript manipulation based on id. + + > That sort of makes sense, but it somehow seems wrong that "id" should + > apply to only cruft at the top of the inline, and not the entire div + > generated for it. --[[Joey]] + + >> Good point. I'll look into a way to move the id to the `inlinepage` div, although I guess + >> that falling back to `id`ing the `feedlink` div in the feedonly case would be ok. + + >> After looking into it, I hit again the same naive error I did while + >> working on inline the first time: there is no "outer" div that + >> encloses all of the generated content: each inlined page has its + >> "inlinepage"-classed div, and the lot of them is prefixed by either + >> the feedlinks or postform template output. So the only way to "id" + >> a whole block of inlines is by adding a wrapping div that encloses + >> the whole product of the inline directive. I can do that if you + >> believe it's worth it. + +* 30a4de2aa3ab29dd9397c2edd91676e80bc06feb "urlto: prevent // when {url} ends with /" + + > The `url` in the setup file should not end in a slash. Probably more + > things get ugly doubled slashes if someone does that. --[[Joey]] + + >> I was not aware of this. Did I miss it or is it just not documented? + >> Also, grepping through the current official code (core and plugins) + >> there is only one other place that looks like it could be affected + >> by the `url` config ending in slash, and it's the `$local_url` + >> stuff in `IkiWiki.pm`, but that code does terminal double-slash + >> sanitation itself. So it would seem that my proposed patch would + >> lift the restriction about the terminal / (an otherwise unnecessary + >> restriction) without affecting much, as long as `url` users rely on + >> the core functions to build paths with it (as in the next patch). + +* 57a9b5c4affda9e855f09a64747e5225d6254079 "inline: use urlto instead of manually building the RSS url" + + > Well, that seems ok. 3 parameter urlto should give us an absolute url. + > + > But we have to be careful and verify that it will always produce + > exactly the same url as before. Changing the feed url unnecessarily + > can probably flood aggregators or something... --[[Joey]] + + >> AFAICS, the feed url would only change in the case of /-terminating + >> `$config{url}`, and even then only if the preceding urlto sanitation patch + >> was included too. + + +----- + * the first patch simply replaces the id attribute in the default template for feedlinks with a class attribute by the same name. This is necessary in pages with multiple inlines to guarantee correctness -* the second patch tries to define the default description for a feed based not only on the wiki name, but also on the current page name. The actual way this is built might not be the optimal one, so I'm open to suggestions -* the third patch passes the feed titles to the templates, changing the default templates to use these as title attributes for the links. a rel="alternate" attribute is also included -* the fourth patch introduces a feedlinks parameter to the inline directive, to allow for the specifications of the locations where the feed links should appear. Currently, two options are allowed (head and body), plus both and none with obvious significance + + > Ok, but blogform.tmpl has the same problem. And either change can need + > CSS changes. (blogform in particular is used in style.css as an id.) + > So this needs more documentation and associated work. --[[Joey]] + + >> I didn't include blogform in the change because the case of two + >> blog post forms in the same page is probably extremely rare. But + >> then again I remember doing having them in one of my ikiwiki + >> draftings, so I rewrote the patch to include blogform. I had + >> checked the distributed CSS for #feedlinks references, without + >> finding any. The new patch does include CSS changes for the + >> \#blogform -> .blogform change. I have no idea on where to document + >> this change though. + + >>> Picked. NEWSed. --[[Joey]] + + +* the (former) third patch passes the feed titles to the templates, changing the default templates to use these as title attributes for the links. a rel="alternate" attribute is also included + + > Seems reasonable. Cherry-picked. Note that the title attribute + > will be shown by browsers as a tooltip. So I made it say + > "$name (RSS feed)" + + >> Good, thanks. + +* the (former) fourth patch introduces a feedlinks parameter to the inline directive, to allow for the specifications of the locations where the feed links should appear. Currently, two options are allowed (head and body), plus both and none with obvious significance + + > Hmm. This doesn't affect the feed links in the blogform.tmpl. Anyway, + > this is not something I see a real benefit of making configurable above + > the template editing level. I don't see any point whatsoever of + > allowing to turn off the feed links in the `<head>` -- they are not + > user-visible, and IIRC that is the recommended and most portable way + > to encode the information for feed discovery agents (rather than + > putting it in the body). And the sorry state of "modern" browsers, + > such as chromium's support for RSS means that it still makes sense to + > have user-visible feed buttons. If that changed, it would make sense to + > modify ikiwiki to globally remove them. --[[Joey]] + + >> I was actually quite surprised myself by the lack of automatic feed + >> discovery in chromium (although I noticed there's a sort-of + >> official plugin to do it). Overall, I believe your critique is + >> well-founded, I'll scratch this patch. + diff --git a/doc/todo/inline_raw_files.mdwn b/doc/todo/inline_raw_files.mdwn index 100c07288..58920cc12 100644 --- a/doc/todo/inline_raw_files.mdwn +++ b/doc/todo/inline_raw_files.mdwn @@ -1,4 +1,4 @@ -[[!template id=gitbranch branch=wtk/master author="[[wtk]]"]] +[[!template id=gitbranch branch=wtk/raw_inline author="[[wtk]]"]] summary ======= @@ -59,3 +59,8 @@ usage >> >> --[[wtk]] +>>> I haven't heard anything in a while, so I've reorganized my version +>>> history and rebased it on the current ikiwiki head. Perhaps now it +>>> will be easier to merge or reject. Note the new branch name: +>>> `raw_inline`. I'll open separate todo items for items mentioned in my +>>> previous comment. --[[wtk]] diff --git a/doc/todo/latex.mdwn b/doc/todo/latex.mdwn index 76bb69c9e..5a8bdcad2 100644 --- a/doc/todo/latex.mdwn +++ b/doc/todo/latex.mdwn @@ -9,7 +9,7 @@ of the ikiwiki [[/logo]]. > [[users/JasonBlevins]] has also a plugin for including [[LaTeX]] expressions (by means of `itex2MML`) -- [[plugins/mdwn_itex]] (look at his page for the link). --Ivan Z. ->> I've [updated](http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/mdwn_itex/) Jason's plugin for ikiwiki 3.x. --W. Trevor King +>> I've [[updated|mdwn_itex]] Jason's plugin for ikiwiki 3.x. --[[wtk]] ---- diff --git a/doc/todo/mdwn_itex.mdwn b/doc/todo/mdwn_itex.mdwn new file mode 100644 index 000000000..3e304fa76 --- /dev/null +++ b/doc/todo/mdwn_itex.mdwn @@ -0,0 +1,22 @@ +[[!template id=gitbranch branch=wtk/mdwn_itex author="[[wtk]]"]] + +summary +======= + +Extend the [[plugins/mdwn]] plugin to support [itex][] using Jacques +Distler's [itex2MML][]. + +notes +===== + +This is an updated form of [[users/JasonBlevins]]' plugin. You can +see the plugin [in action][example] on my blog. The blog post lists a +few additional changes you may need to make to use the plugin, +including changing your page template to a MathML-friendly doctype and +disabling plugins like [[plugins/htmlscrubber]] and +[[plugins/htmltidy]] which would otherwise strip out the generated +MathML. + +[itex]: http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html +[itex2MML]: http://golem.ph.utexas.edu/~distler/blog/itex2MML.html +[example]: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/mdwn_itex/ diff --git a/doc/todo/org_mode.mdwn b/doc/todo/org_mode.mdwn new file mode 100644 index 000000000..3e9d95376 --- /dev/null +++ b/doc/todo/org_mode.mdwn @@ -0,0 +1,24 @@ +[[!template id=gitbranch branch=wtk/org author="[[wtk]]"]] + +summary +======= + +Add a plugin for handling files written in [org-mode][]. + +notes +===== + +This is an updated form of [Manoj Srivastava's plugin][MS]. You can +see the plugin [in action][example] on my blog. + +For reasons discussed in the [[reStructuredText plugin|plugins/rst]], +wikilinks and other ikiwiki markup that inserts raw HTML can cause +problems. Org-mode provides a [means for processing raw HTML][raw], +but Ikiwiki currently (as far as I know) lacks a method to escape +inserted HTML depending on which plugins will be used during the +[[htmlize phase|plugins/write#index11h3]]. + +[org-mode]: http://orgmode.org/ +[MS]: http://www.golden-gryphon.com/blog/manoj/blog/2008/06/08/Using_org-mode_with_Ikiwiki/ +[example]: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Git/notes/ +[raw]: http://orgmode.org/manual/Quoting-HTML-tags.html diff --git a/doc/todo/transient_pages.mdwn b/doc/todo/transient_pages.mdwn index 1a35dddb1..c08d54228 100644 --- a/doc/todo/transient_pages.mdwn +++ b/doc/todo/transient_pages.mdwn @@ -12,8 +12,8 @@ suggests: added. This would also be useful for autoindex, as suggested on -[[plugins/autoindex/discussion]]. I'd also like to use it for -[[plugins/contrib/album]]. +[[plugins/autoindex/discussion]] and [[!debbug 544322]]. I'd also like +to use it for [[plugins/contrib/album]]. It could also be used for an [[todo/alias_directive]]. @@ -22,10 +22,20 @@ It could also be used for an [[todo/alias_directive]]. -------------------------- [[!template id=gitbranch branch=smcv/ready/transient author="[[smcv]]"]] -[[!template id=gitbranch branch=smcv/ready/transient-recentchanges author="[[smcv]]"]] -[[!template id=gitbranch branch=smcv/ready/transient-tag author="[[smcv]]"]] [[!tag patch]] +Related branches: + +* `ready/tag-test`: an extra regression test for tags +* either `transient-relative` or `transient-relative-api`: avoid using `Cwd` + on initialization +* `ready/transient-aggregate`: use for aggregate +* `ready/transient-autoindex`: optionally use for autoindex, + which is [[!debbug 544322]] (includes autoindex-autofile from + [[todo/autoindex should use add__95__autofile]]) +* `ready/transient-recentchanges`: use for recentchanges +* `ready/transient-tag`: optionally use for tag (includes tag-test) + I think this branch is now enough to be useful. It adds the following: If the `transient` plugin is loaded, `$srcdir/.ikiwiki/transient` is added @@ -148,6 +158,9 @@ Not done yet (in that branch, at least): transient underlay too (they'll naturally migrate over time). I haven't tested this yet, it's just a proof-of-concept. + > Now renamed to `ready/transient-aggregate`; it does seem to work fine. + > --s + > I can confirm that the behavior of autoindex, at least, is excellent. > Haven't tried tag. Joey, can you merge transient and autoindex? --JoeRayhawk @@ -197,6 +210,22 @@ Not done yet (in that branch, at least): >> >> it for those simple cases then? (demand-calculate wikistatedir) >> >> --[[Joey]] +>> >>> The reason that transientdir needs to be absolute is that it's +>> >>> added as an underlay. +>> >>> +>> >>> We could avoid using `Cwd` by taking the extra commit from either +>> >>> `smcv/transient-relative` or `smcv/transient-relative-api`; +>> >>> your choice. I'd personally go for the latter. +>> >>> +>> >>> According to git grep, [[plugins/po]] already wants to look at +>> >>> the underlaydirs in its checkconfig hook, so I don't think +>> >>> delaying calculation of the underlaydir is viable. (I also noticed +>> >>> a bug, +>> >>> [[bugs/po:_might_not_add_translated_versions_of_all_underlays]].) +>> >>> +>> >>> `underlaydirs` certainly needs to have been calculated by the +>> >>> time `refresh` hooks finish, so `find_src_files` can use it. --s + >> * Unsure about the use of `default_pageext` in the `change` >> hook. Is everything in the transientdir really going >> to use that pageext? Would it be better to look up the @@ -217,6 +246,9 @@ Not done yet (in that branch, at least): >> >> transient page has the same extension as its replacement? >> >> --[[Joey]] +>> >>> Good idea, that'll be true for web edits at least. +>> >>> Commit added. --s + -------------------------- ## An earlier version diff --git a/doc/users/adamshand.mdwn b/doc/users/adamshand.mdwn index 6127a8d70..429f4f668 100644 --- a/doc/users/adamshand.mdwn +++ b/doc/users/adamshand.mdwn @@ -1,5 +1,5 @@ [[!meta title="Adam Shand"]] -New IkiWiki user, long time wiki user. :-) +New IkiWiki user (well not really "new" anymore), long time wiki user. :-) <http://adam.shand.net/iki/> diff --git a/doc/users/wtk.mdwn b/doc/users/wtk.mdwn new file mode 100644 index 000000000..a34473577 --- /dev/null +++ b/doc/users/wtk.mdwn @@ -0,0 +1,6 @@ +[[!meta title="W. Trevor King"]] + +* Git branch: `wtk`. +* [Ikiwiki-based blog][blog] + +[blog]: http://www.physics.drexel.edu/~wking/unfolding-disasters/ |