summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2017-09-21 12:27:28 +0200
committerJonas Smedegaard <dr@jones.dk>2017-09-21 12:27:28 +0200
commit8d8422b833aa9f06f3e783d3c7edfc9c20020ab9 (patch)
tree75d8353f00d129bdb3554d3ae56b89f73025dc78
parent688ab0d95fc9a39b288dc4ebccc42dd1ceab9a69 (diff)
Sync with ikiwiki 3.20160121.
-rw-r--r--ikiwiki/directive/inline.mdwn14
-rw-r--r--ikiwiki/directive/pagestats.mdwn13
2 files changed, 20 insertions, 7 deletions
diff --git a/ikiwiki/directive/inline.mdwn b/ikiwiki/directive/inline.mdwn
index 32fecd1..da759fc 100644
--- a/ikiwiki/directive/inline.mdwn
+++ b/ikiwiki/directive/inline.mdwn
@@ -5,7 +5,7 @@ The most common use of inlining is generating blogs and RSS or Atom feeds.
Example:
- \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
+ \[[!inline pages="blog/* and !*/Discussion" limit="10" rootpage="blog"]]
Any pages that match the specified [[PageSpec]] (in the example, any
[[SubPage]] of "blog") will be part of the blog, and the newest 10
@@ -46,9 +46,11 @@ There are many parameters you can use with the `inline`
directive. These are the commonly used ones:
* `pages` - A [[PageSpec]] of the pages to inline.
-* `show` - Specify the maximum number of matching pages to inline.
+* `limit` - Specify the maximum number of matching pages to inline.
Default is 10, unless archiving, when the default is to show all.
Set to 0 to show all matching pages.
+ In older versions of IkiWiki this parameter was called `show`, which
+ also still works.
* `archive` - If set to "yes", only list page titles and some metadata, not
full contents.
* `title` - Sets the title of the rss feed if one is generated.
@@ -98,8 +100,10 @@ Here are some less often needed parameters:
were created in the same commit, sort them by the name of the page
(equivalent to `sort="age title"`).
* `reverse` - If set to "yes", causes the sort order to be reversed.
-* `feedshow` - Specify the maximum number of matching pages to include in
- the rss/atom feeds. The default is the same as the `show` value above.
+* `feedlimit` - Specify the maximum number of matching pages to include in
+ the rss/atom feeds. The default is the same as the `limit` value above.
+ In older versions of IkiWiki this parameter was called `feedshow`, which
+ also still works.
* `feedonly` - Only generate the feed, do not display the pages inline on
the page.
* `quick` - Build archives in quick mode, without reading page contents for
@@ -126,7 +130,7 @@ Here are some less often needed parameters:
* `trail` - If set to "yes" and the [[!iki plugins/trail desc=trail]] plugin
is enabled, turn the inlined pages into a trail with next/previous links,
by passing the same options to [[ikiwiki/directive/trailitems]]. The `skip`
- and `show` options are ignored by the trail, so the next/previous links
+ and `limit` options are ignored by the trail, so the next/previous links
traverse through all matching pages.
[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/pagestats.mdwn b/ikiwiki/directive/pagestats.mdwn
index 8d904f5..ab83973 100644
--- a/ikiwiki/directive/pagestats.mdwn
+++ b/ikiwiki/directive/pagestats.mdwn
@@ -28,13 +28,22 @@ Or to display a cloud of tags related to Linux, you could use:
\[[!pagestats pages="tags/* and !tags/linux" among="tagged(linux)"]]
-The optional `show` parameter limits display to the specified number of
+The optional `limit` parameter limits display to the specified number of
pages. For instance, to show a table of the top ten pages with the most
links:
- \[[!pagestats style="table" show="10"]]
+ \[[!pagestats style="table" limit="10"]]
+
+In older versions of IkiWiki this parameter was called `show`;
+that name still works, if its value is numeric.
The optional `class` parameter can be used to control the class
of the generated tag cloud `div` or page stats `table`.
+By default, the names of pages are shown. The `show` parameter
+can be used (with a non-numeric value) to show the titles or descriptions
+of pages instead (as set by the [[meta]] directive). For example:
+
+ \[[!pagestats pages="tags/*" show="title"]]
+
[[!meta robots="noindex, follow"]]