Rename show parameter of [[!inline]] and [[!pagestats]] to limit

[git.ikiwiki.info.git] / doc / ikiwiki / directive / inline.mdwn

diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn
index a4632a5b4c4111151b7249ffd2a7dfa8bbb181eb..dfe3e171ff10b21d319f4ce0d52b54f066279079 100644 (file)
--- a/doc/ikiwiki/directive/inline.mdwn
+++ b/doc/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.
@@ -96,8 +98,10 @@ Here are some less often needed parameters:
 * `sort` - Controls how inlined pages are [[sorted|pagespec/sorting]].
   The default is to sort the newest created pages first.
 * `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
@@ -124,7 +128,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"]]