summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/calendar/discussion.mdwn8
-rw-r--r--doc/plugins/contrib/transient.mdwn38
-rw-r--r--doc/plugins/write.mdwn8
3 files changed, 45 insertions, 9 deletions
diff --git a/doc/plugins/calendar/discussion.mdwn b/doc/plugins/calendar/discussion.mdwn
index bb76a9d8b..6fc21e8ee 100644
--- a/doc/plugins/calendar/discussion.mdwn
+++ b/doc/plugins/calendar/discussion.mdwn
@@ -13,3 +13,11 @@ otherwise be invalid, so this shouldn't produce any conflicts with expected
behavior. (Right?) -- [[StevenBlack]]
> Great idea! Just implemented that and also relative years. --[[Joey]]
+
+Anyone know of a way to generate a link to the previous and next calendar pages for archive browsing? In the worst case, that requires regenerating pages on either side of the current one when something is inserted in the history, and I can't quite figure that much out. --[[JasonRiedy]]
+
+> Well, the calendar directive puts such links on the calendars. They're
+> the arrows to either side of the month or year at the top. --[[Joey]]
+
+>> Thanks. I either missed them or they appeared on an upgrade. I might make them a bit more obvious with
+>> "Previous Month" / "Next Month" links above and below the text. Someday.--[[JasonRiedy]]
diff --git a/doc/plugins/contrib/transient.mdwn b/doc/plugins/contrib/transient.mdwn
index ff2fab610..6003196b0 100644
--- a/doc/plugins/contrib/transient.mdwn
+++ b/doc/plugins/contrib/transient.mdwn
@@ -1,9 +1,35 @@
+*For discussion and the branch please see [[todo/transient pages]]. If this
+plugin is merged, this page can be renamed to act as its documentation. --[[smcv]]*
+
[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]]
-[[!template id=gitbranch branch=smcv/ready/transient author="[[Simon_McVittie|smcv]]"]]
[[!tag type/special-purpose]]
-The `transient` plugin is an implementation of [[todo/transient pages]]
-in an underlay. It's mostly useful as something other plugins can depend on;
-[[plugins/contrib/album]] puts photo-album "viewer" pages there,
-and the versions of [[plugins/autoindex]] and [[plugins/tag]] on the
-same branch optionally put their auto-generated pages there.
+The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is
+intended for pages that are automatically created and should not be committed
+to the [[RCS]]. It works in the same way as the [[basewiki]] and the underlays
+set up by the [[plugins/underlay]] plugin, so if a page in the transient
+underlay is edited via the web, the edited version is committed to the RCS
+as usual. Unlike other underlays, if a page in the transient underlay is
+superseded by an edited version in the RCS, the old transient version
+is deleted automatically.
+
+This plugin is mostly useful as something that other plugins can depend on:
+
+* [[plugins/contrib/album]] always writes photo-album "viewer" pages to the
+ transient underlay
+
+Likely future users of this plugin (the appropriate branches need to be
+merged first):
+
+* with a patch (which exists but hasn't yet been tested), [[plugins/aggregate]]
+ always writes aggregated posts into the transient underlay
+* with a patch, [[plugins/autoindex]] can be configured to auto-create missing
+ pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not
+ commit them, in which case they go in the transient underlay
+* [[plugins/comments]] can be configured to not commit comments: if so, it
+ should probably put them in the transient underlay
+* with a patch, [[plugins/recentchanges]] always writes new changes into the
+ transient underlay
+* with a patch, [[plugins/tag]] can be configured to auto-create missing
+ tag pages but not commit them, in which case they go in the transient
+ underlay
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index adc20af72..f0f79ebc7 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -1151,11 +1151,13 @@ The data structure returned for each change is:
],
}
-#### `rcs_diff($)`
+#### `rcs_diff($;$)`
+
+The first parameter is the rev from `rcs_recentchanges`.
+The optional second parameter is how many lines to return (default: all).
-The parameter is the rev from `rcs_recentchanges`.
Should return a list of lines of the diff (including \n) in list
-context, and the whole diff in scalar context.
+context, and a string containing the whole diff in scalar context.
#### `rcs_getctime($)`