clarify which case fails

[ikiwiki.git] / doc / plugins / contrib / sidebar2.mdwn

diff --git a/doc/plugins/contrib/sidebar2.mdwn b/doc/plugins/contrib/sidebar2.mdwn
index 01aeaf558c5706524c8aa1f74b4fe4a3345a0764..574bdeaab11f8e936495dbf69f97ed710211501d 100644 (file)
--- a/doc/plugins/contrib/sidebar2.mdwn
+++ b/doc/plugins/contrib/sidebar2.mdwn
@@ -31,6 +31,13 @@ etc.
 The default, which gives the behaviour of the sidebar plugin, is
 `global_sidebars => ["sidebar", "sidebar", "*"]`.
 
+*Remark: It would be more sensible to have a list of lists, as the following example, but I did not manage to do so because of [[this bug|bugs/structured_config_data_is_mangled]].*
+
+    global_sidebars => [
+      ["var1", "page1", "pagespec1"],
+      ["var2", "page2", "pagespec2"],
+      ]
+
 # Improvements over sidebar plugin
 
 * You can add several "sidebars" to your wiki. For example, to have a sidebar, a submeno that appear only in pages documentations, and a footer, your `global_sidebars` would be:
@@ -66,12 +73,12 @@ template variable, the directive applies to the value given in the argument.
 For example, the following command forces the `footer` sidebar to appear on the
 current page.
 
-    [[!sidebar var=footer]]
+    \[[!sidebar var=footer]]
 
 The following command forces the `footer` sidebar to appaer, containing the
 content given in argument.
 
-    [[!sidebar var=footer content="TEST"]]
+    \[[!sidebar var=footer content="TEST"]]
 
 # Which pages to render?
 
@@ -82,3 +89,7 @@ handled by this plugin.
 2. If the page contains the [[sidebar|ikiwiki/directive/sidebar]] directive with no `content` argument, the first rule for the considered template variable is applied, disregarding the pagespec.
 3. If none of the above, the first rule having its pagespec patching the current page is applied.
 4. If none of the above, the variable is left empty.
+
+# Download and install
+
+Code and documentation: [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Sidebar2]].