aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 22:58:48 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 22:58:48 +0000
commit88830016154d99a0155e1cee58582e9f32dcca51 (patch)
treebcb92fbcb40f36d94de660d9fe5ddb6477ca06a4 /doc
parent26c2c63c97e6bfa704357503fdfd8d8834838851 (diff)
downloadikiwiki-88830016154d99a0155e1cee58582e9f32dcca51.tar
ikiwiki-88830016154d99a0155e1cee58582e9f32dcca51.tar.gz
* Change meta tags to use html entity-escaped text for values, so that
quotes and such can be represented in title tags. * Depend and build-depend on HTML::Parser for HTML::Entities which is used for the above. * Make --rebuild also cause --aggregate to re-download and write aggregated pages. * Avoid outputting duplicate meta info. * Include title metadata on aggregated posts for capitalised and un-munged titles.
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/aggregate.mdwn2
-rw-r--r--doc/plugins/meta.mdwn3
-rw-r--r--doc/usage.mdwn4
3 files changed, 8 insertions, 1 deletions
diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn
index 85152170f..4cd5b57ac 100644
--- a/doc/plugins/aggregate.mdwn
+++ b/doc/plugins/aggregate.mdwn
@@ -13,7 +13,7 @@ aggregated feeds.
## setup
Make sure that you have the [[html]] plugin enabled, as the created pages are
-in html format. The [[tag]] plugin is also recommended.
+in html format. The [[meta]] and [[tag]] plugins are also recommended.
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
diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index 238233e11..32392ed54 100644
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -40,6 +40,9 @@ If the field is not treated specially (as the link and title fields are),
the metadata will be written to the generated html page as a &lt;meta&gt;
header.
+The field value is treated as HTML entity-escaped text, so you can include
+a quote in the text by writing `&quot;` and so on.
+
This plugin is included in ikiwiki, but it is not enabled by default. If
it is enabled, the title of this page will say it is.
[[meta title="meta plugin (enabled)"]]
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index a6ded5ec2..aab5330b6 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -71,6 +71,10 @@ These options control the mode that ikiwiki is operating in.
If the aggregate plugin is enabled, this makes ikiwiki poll configured
feeds and save new posts to the srcdir.
+ Note that to rebuild previously aggregated posts, use the --rebuild option
+ along with this one. --rebuild will also force feeds to be polled even if
+ they were polled recently.
+
# CONFIG OPTIONS
These options configure the wiki. Note that plugins can add additional