diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bugs/defintion_lists_appear_to_be_disabled.mdwn | 54 | ||||
-rw-r--r-- | doc/ikiwiki/formatting.mdwn | 2 | ||||
-rw-r--r-- | doc/ikiwiki/searching.mdwn | 2 | ||||
-rw-r--r-- | doc/plugins/po.mdwn | 53 | ||||
-rw-r--r-- | doc/todo/mirrorlist_with_per-mirror_usedirs_settings.mdwn | 24 | ||||
-rw-r--r-- | doc/todo/tmplvars_plugin/discussion.mdwn | 1 |
6 files changed, 124 insertions, 12 deletions
diff --git a/doc/bugs/defintion_lists_appear_to_be_disabled.mdwn b/doc/bugs/defintion_lists_appear_to_be_disabled.mdwn new file mode 100644 index 000000000..6dac9c8b8 --- /dev/null +++ b/doc/bugs/defintion_lists_appear_to_be_disabled.mdwn @@ -0,0 +1,54 @@ +Adding text of the format + + Apple + : Pomaceous fruit of plants of the genus Malus in + the family Rosaceae. + : An american computer company. + + Orange + : The fruit of an evergreen tree of the genus Citrus. + +Does not result in expected HTML as described in the [MultiMarkdown Syntax Guide](http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/): + +Should be + + <dl xmlns="http://www.w3.org/1999/xhtml"> + <dt>Apple</dt> + <dd> + <p>Pomaceous fruit of plants of the genus Malus in + the family Rosaceae.</p> + </dd> + <dd> + <p>An american computer company.</p> + </dd> + <dt>Orange</dt> + <dd> + <p>The fruit of an evergreen tree of the genus Citrus.</p> + </dd> + </dl> + +But instead it gives: + + <p>Apple + : Pomaceous fruit of plants of the genus Malus in + the family Rosaceae. + : An american computer company.</p> + + <p>Orange + : The fruit of an evergreen tree of the genus Citrus.</p> + +> ikiwiki's markdown support does not include support for multimarkdown by +> default. If you want to enable that, you can turn on the `multimarkdown` +> option in the setup file. --[[Joey]] + +>> Sorry, I should have indicated, I have multimarkdown enabled: + + # mdwn plugin + # enable multimarkdown features? + multimarkdown => 1, + +>>Other features appear to be working, tables and footnotes for instance. See current install: <http://wiki.infosoph.org> + +>>> Ok, in that case it's a bug in the perl module. Forwarded to +>>> <http://github.com/bobtfish/text-markdown/issues#issue/6> --[[Joey]] +>>> [[!tag done]] diff --git a/doc/ikiwiki/formatting.mdwn b/doc/ikiwiki/formatting.mdwn index 2ed5cc26f..befbce9aa 100644 --- a/doc/ikiwiki/formatting.mdwn +++ b/doc/ikiwiki/formatting.mdwn @@ -7,7 +7,7 @@ called [[MarkDown]], and it works like this: Leave blank lines between paragraphs. -You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it +You can *\*emphasise\** or **\*\*strongly emphasise\*\*** text by placing it in single or double asterisks. To create a list, start each line with an asterisk: diff --git a/doc/ikiwiki/searching.mdwn b/doc/ikiwiki/searching.mdwn index 539e7193d..4c1287933 100644 --- a/doc/ikiwiki/searching.mdwn +++ b/doc/ikiwiki/searching.mdwn @@ -5,7 +5,7 @@ then="This wiki has searching **enabled**." else="This wiki has searching **disabled**."]] If searching is enabled, you can enter search terms in the search field, -as you'd expect. There are a few special things you can do to constuct +as you'd expect. There are a few special things you can do to construct more powerful searches. * To match a phrase, enclose it in double quotes. diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index dca2f5d66..65573b877 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -260,7 +260,14 @@ If a page contains a WikiLink to itself, ikiwiki does not normally turn that into a hyperlink. However, if a translated page contains a WikiLink to itself, a hyperlink is inserted, at least with the default `po_link_to` the link points to the English version of the page. Is there a -good reason for that to be done? --[[Joey]] +good reason for that to be done? --[[Joey]] + +> The commit 0113c69d4fb in my po branch might fix this. --[[intrigeri]] + +>> It may fix it in passing, but shouldn't it also be fixed for the other +>> `po_link_to` styles? (Also, if `mybestlink` is going to always +>> just return `bestlink` in this case, there seems no reason to inject +>> it.) --[[Joey]] Language display order ---------------------- @@ -280,12 +287,37 @@ That used to be so, but the bug was fixed. Does this mean that po might be replacing the only link on a page, in error? --[[Joey]] +> It would replace it. The only problematic case is when another +> plugin has its own reasons, in its `scan` hook, to add a page +> that is already there to `$links{$page}`. This other plugin's +> effect might then be changed by po's `scan` hook... which could +> be either good (better overall l10n) or bad (break the other +> plugin's goal). --[[intrigeri]] + +>> Right.. well, the cases where links are added is very small. +>> Grepping for `add_link`, it's just done by link, camelcase, meta, and +>> tag. All of these are supposed to work just link regular links +>> so I'd think that is ok. We could probably remove the currently scary +>> comment about only wanting to change the first link. --[[Joey]] + Name of toplevel index page --------------------------- Normally at the top index page of a wiki, you see the wiki name at the top. However, at the top *translated* index page, you see something -like "index.da". --[[Joey]] +like "index.da". --[[Joey]] + +> I suggest changing `Render.pm`, line 115, to replace the `$page eq 'index'` +> test with a predicate call such as isindexpage($page). Such a predicate +> function could then be overriden by the po plugin. --[[intrigeri]] + +>> Could do that, but if you have such a function it's natural to want to +>> use it elsewhere. Not clear to me it would make sense for po to override +>> such a function if it were used in some of the other places that compare +>> to index. +>> +>> The other option would be for po to override the template setting. +>> --[[Joey]] Pagespecs --------- @@ -314,14 +346,6 @@ Also, this may only happen if the page being linked to is coming from an underlay, and the underlays lack translation to a given language. --[[Joey]] -recentchanges links to po files -------------------------------- - -When a po file is changed, the recentchanges page shows a link such as -"sandbox.es". But, clicking on it goes to the English (or negotiated -language) version of the page. It would be better in this one case if -the link went direct to the translated version of the page. --[[Joey]] - Double commits of po files -------------------------- @@ -341,6 +365,15 @@ Ugly messages with empty files If there are empty .mdwn files, the po plugin displays some ugly messages. +Translation of directives +------------------------- + +If a translated page contains a directive, it may expand to some english +text, or text in whatever single language ikiwiki is configured to "speak". + +Maybe there could be a way to switch ikiwiki to speaking another language +when building a non-english page? Then the directives would get translated. + Documentation ------------- diff --git a/doc/todo/mirrorlist_with_per-mirror_usedirs_settings.mdwn b/doc/todo/mirrorlist_with_per-mirror_usedirs_settings.mdwn new file mode 100644 index 000000000..6ca9962ba --- /dev/null +++ b/doc/todo/mirrorlist_with_per-mirror_usedirs_settings.mdwn @@ -0,0 +1,24 @@ +I've got a wiki that is built at two places: + +* a static copy, aimed at being viewed without any web server, using + a web browser's `file:///` urls => usedirs is disabled to get nice + and working links +* an online copy, with usedirs enabled in order to benefit from the + language negotiation using the po plugin + +I need to use mirrorlist on the static copy, so that one can easily +reach the online, possibly updated, pages. But as documented, "pages are +assumed to exist in the same location under the specified url on each +mirror", so the generated urls are wrong. + +My `mirrorlist` branch contains a patch that allows one to configure usedirs +per-mirror. Note: the old configuration format is still supported, so this should +not break existing wikis. + +OT: as a bonus, this branch contains a patch to support {hashes,arrays} of +{hashes,arrays} in `$config`, which I missed a bit when writing the po plugin, +and decided this time it was really needed to implement this feature. + +--[[intrigeri]] + +[[!tag patch]] diff --git a/doc/todo/tmplvars_plugin/discussion.mdwn b/doc/todo/tmplvars_plugin/discussion.mdwn new file mode 100644 index 000000000..93cb9b414 --- /dev/null +++ b/doc/todo/tmplvars_plugin/discussion.mdwn @@ -0,0 +1 @@ +I find this plugin quite usefull. But one thing, I would like to be able to do is set a tmplvar e.g. in a sidebar so that it affects all Pages this sidebar is used in. --martin |