diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/aggregate.mdwn | 15 | ||||
| -rw-r--r-- | doc/plugins/getsource/discussion.mdwn | 2 | ||||
| -rw-r--r-- | doc/plugins/goodstuff/discussion.mdwn | 1 | ||||
| -rw-r--r-- | doc/plugins/po.mdwn | 43 | ||||
| -rw-r--r-- | doc/plugins/po/discussion.mdwn | 17 | ||||
| -rw-r--r-- | doc/plugins/rst/discussion.mdwn | 4 |
6 files changed, 71 insertions, 11 deletions
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/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 2e16cc7c4..2dc5ffdc8 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -130,7 +130,7 @@ lighttpd -------- Recent versions of lighttpd should be able to use -`$HTTP["language"]` to configure the translatted pages to be served. +`$HTTP["language"]` to configure the translated pages to be served. See [Lighttpd Issue](http://redmine.lighttpd.net/issues/show/1119) @@ -213,16 +213,16 @@ preferred `$EDITOR`, without needing to be online. Markup languages support ------------------------ -[[Markdown|mdwn]] is well supported. Some other markup languages supported -by ikiwiki mostly work, but some pieces of syntax are not rendered -correctly on the slave pages: +[[Markdown|mdwn]] and [[html]] are well supported. Some other markup +languages supported by ikiwiki mostly work, but some pieces of syntax +are not rendered correctly on the slave pages: * [[reStructuredText|rst]]: anonymous hyperlinks and internal cross-references * [[wikitext]]: conversion of newlines to paragraphs * [[creole]]: verbatim text is wrapped, tables are broken -* [[html]] and LaTeX: not supported yet; the dedicated po4a modules - could be used to support them, but they would need a security audit +* LaTeX: not supported yet; the dedicated po4a module + could be used to support it, but it would need a security audit * other markup languages have not been tested. Security @@ -266,6 +266,37 @@ to an array to support this. (If twere done, twere best done quickly.) > 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]] + +>>> I have added a sanity check for the even array problem. This was +>>> the easy part. +>>> +>>> About the hash-like vs. dump and websetup issue, +>>> I can think of a few solutions: +>>> +>>> - keep the current hash-like pairs and unmark this setting as safe +>>> for websetup: this does not solve the dump setup issue, though; +>>> - replace the array of pairs with an array of +>>> "LANGUAGECODE|LANGUAGENAME" elements, using a pipe or whatever +>>> separator seems adequate; +>>> - add support for ordered hashes to `$config`, websetup and +>>> dumpsetup, using Tie-IxHash or any similar module; +>>> - replace the array of hash-like pairs with an array of real +>>> pairs, such as `[ ['de', 'Deutsch'], ['fr', 'Français'] ]`; this +>>> brings once again the need for `$config` to support arrays of +>>> arrays, which I have already implemented in my mirrorlist branch +>>> (see [[todo/mirrorlist_with_per-mirror_usedirs_settings]] for +>>> details). +>>> +>>> Joey, which of these solutions do you prefer? Or another one? +>>> I tend to prefer the last one. --[[intrigeri]] + Pagespecs --------- diff --git a/doc/plugins/po/discussion.mdwn b/doc/plugins/po/discussion.mdwn index 27683f1ea..73858c818 100644 --- a/doc/plugins/po/discussion.mdwn +++ b/doc/plugins/po/discussion.mdwn @@ -150,6 +150,23 @@ The following analysis was done with his help. variables; according to [[Joey]], this is "Freaky code, but seems ok due to use of `quotementa`". +##### Locale::Po4a::Xhtml + +* does not run any external program +* does not build regexp's from untrusted variables + +=> Seems safe as far as the `includessi` option is disabled; the po +plugin explicitly disables it. + +Relies on Locale::Po4a::Xml` to do most of the work. + +##### Locale::Po4a::Xml + +* does not run any external program +* the `includeexternal` option makes it able to read external files; + the po plugin explicitly disables it +* untrusted variables are escaped when used to build regexp's + ##### Text::WrapI18N `Text::WrapI18N` can cause DoS 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 |