web commit by http://jblevins.org/: A note about the toc plugin and headers in templates

[ikiwiki.git] / doc / plugins / toc / discussion.mdwn

diff --git a/doc/plugins/toc/discussion.mdwn b/doc/plugins/toc/discussion.mdwn
index 3d4c2b149059f1a386f3e308794302fb2f23e7f4..d1600c9ecbe45ee67ae466799ef281bcf1e81d92 100644 (file)
--- a/doc/plugins/toc/discussion.mdwn
+++ b/doc/plugins/toc/discussion.mdwn
@@ -1 +1,6 @@
-If you are using the sidebar plugin and have a header in the sidebar it shows up in the table of contents.  I can see why this happens but it surprised me and wasn't the desired effect in my specific situation. -- [[AdamShand]]
\ No newline at end of file
+If you are using the sidebar plugin and have a header in the sidebar it shows up in the table of contents.  I can see why this happens but it surprised me and wasn't the desired effect in my specific situation. -- [[AdamShand]]
+
+A related side effect: If you use any sort of headers in the page
+template (such as placing the page title in an `<h1>`), the toc plugin
+picks it up.  I suppose it parses the entire page rather than just the
+rendered content. --[[JasonBlevins]]