me too

[git.ikiwiki.info.git] / doc / plugins / calendar.mdwn

diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index efc8ee25c2aa9ad1c6d2cd4261434d9c92d8a542..8d18ed081e0a9e6e43c379272b033119b75edd7a 100644 (file)
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -1,3 +1,5 @@
+[[!template id=plugin name=calendar author="[[ManojSrivastava]]"]]
+[[!tag type/widget]]

 
 This plugin provides a [[ikiwiki/directive/calendar]] [[ikiwiki/directive]].
 The directive displays a calendar, similar to the typical calendars shown on
 
 This plugin provides a [[ikiwiki/directive/calendar]] [[ikiwiki/directive]].
 The directive displays a calendar, similar to the typical calendars shown on


@@ -13,10 +15,18 @@ pages from templates (overriding the existing ones).
 * `archive_pagespec` - [[ikiwiki/PageSpec]] of pages to include in the
   archives, if option `calendar_autocreate` is on. It defaults to `*`.
 * `calendar_autocreate` - Control whether new archive pages are created as
 * `archive_pagespec` - [[ikiwiki/PageSpec]] of pages to include in the
   archives, if option `calendar_autocreate` is on. It defaults to `*`.
 * `calendar_autocreate` - Control whether new archive pages are created as

-  needed. It defaults to being done only if (at least) one of options
-  `archivebase` and `calendar_autocreate_commit` are set.
-* `calendar_autocreate_commit` -  If set, causes new archive pages to be
-  checked into version control. Defaults to 1.
+  needed. It defaults to being done only if option `archivebase` is set.
+* `calendar_fill_gaps` - If set (and `calendar_autocreate` is set as well),
+  build calendar pages of empty years and months (but does not build pages older
+  than the older page, and younger than the younger page of the pagespec). If
+  not, those empty calendar pages will be skipped. *Please note:*
+  * The archive pages will not be automatically updated if this option changes.
+    It is up to the user to delete relevant pages, and rebuild the wiki.
+  * When `calendar_fill_gaps` is set, and a post is deleted, making the
+    corresponding year/month empty, the corresponding page is left, and shows
+    an empty calendar. This is on purpose, not to break any external link
+    pointing to this particular page. If you do not like it, delete the
+    relevant pages, and rebuild the wiki.

 
 ## CSS
 
 
 ## CSS