ikiwiki/doc/plugins/toc/discussion.mdwn

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]]

Why doesn't the TOC appear in the edit page preview?  It only appears when the page is finally rendered.  This makes it somewhat difficult to organize headings, saving & re-editing all the time.  My user page currently has a toc to play with: --[[sabr]]

> Fixed. --[[Joey]]

Just ran into a side effect of `\[[!toc]]` being a NOP in pages
which are inlined: pages with `\[[!template id=note text="[[!toc]]"]]`
wound up having the note rendered in feeds as "Use this template
to insert a note into a page". Worked around this by making a local
copy of the template and removing its `<TMPL_UNLESS text>...</TMPL_UNLESS>`
section. Besides needing to generate guaranteed-unique anchor names,
are there other reasons this directive couldn't be made to work on
inlined pages?  --[[schmonz]]

> Workaround: `\[[!template id=note text=" [[!toc]]"]]`
> (with whitespace) should work, because then Perl will consider
> the string to be a true value.
>
> Longer-term, my branch on [[bugs/template_creation_error]]
> aims to fix this sort of thing. --[[smcv]]

>> Workaround seems not to. Maybe whitespace is getting trimmed
>> along the way and it stays falsish. Interested in your branch;
>> sorry I can't offer precise feedback right now, but it looks sane
>> at a glance. --[[schmonz]]

How could this be tampered to make another plugin that would enable partial listing so I could make multiple "subTOCs" in the same page? For instance I'd have a `\[[!toc startlevel=1 levels=1]]` in the top of the page while after a level 1 heading I would have a `\[[!toc startlevel=2]]` with the level 2 and below headers limited by the ones below this particular level 1 header --[[iuri]]
web commit by http://jblevins.org/: A note about the toc plugin and headers in templates 2008-03-20 22:02:59 +01:00			`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]]`
web commit by http://sabr.myopenid.com/ 2008-04-13 18:48:28 +02:00
			`Why doesn't the TOC appear in the edit page preview? It only appears when the page is finally rendered. This makes it somewhat difficult to organize headings, saving & re-editing all the time. My user page currently has a toc to play with: --[[sabr]]`
toc: Add the table of contents at sanitize time, rather than at format time. This allows the toc to be displayed when previewing an edit. It also avoids headers in the page template from showing up in the toc. 2008-04-26 21:13:01 +02:00
			`> Fixed. --[[Joey]]`
template a red herring; toc vs. inline guilty 2013-09-15 04:43:36 +02:00
			Just ran into a side effect of `\[[!toc]]` being a NOP in pages
workaround noworkaround 2013-09-19 01:34:02 +02:00			which are inlined: pages with `\[[!template id=note text="[[!toc]]"]]`
template a red herring; toc vs. inline guilty 2013-09-15 04:43:36 +02:00			`wound up having the note rendered in feeds as "Use this template`
			`to insert a note into a page". Worked around this by making a local`
			copy of the template and removing its `<TMPL_UNLESS text>...</TMPL_UNLESS>`
			`section. Besides needing to generate guaranteed-unique anchor names,`
			`are there other reasons this directive couldn't be made to work on`
			`inlined pages? --[[schmonz]]`
2013-09-16 10:50:00 +02:00
workaround noworkaround 2013-09-19 01:34:02 +02:00			> Workaround: `\[[!template id=note text=" [[!toc]]"]]`
2013-09-16 10:50:00 +02:00			`> (with whitespace) should work, because then Perl will consider`
			`> the string to be a true value.`
			`>`
			`> Longer-term, my branch on [[bugs/template_creation_error]]`
			`> aims to fix this sort of thing. --[[smcv]]`
workaround noworkaround 2013-09-19 01:34:02 +02:00
			`>> Workaround seems not to. Maybe whitespace is getting trimmed`
			`>> along the way and it stays falsish. Interested in your branch;`
			`>> sorry I can't offer precise feedback right now, but it looks sane`
			`>> at a glance. --[[schmonz]]`
added a question 2015-01-19 18:06:37 +01:00
fixed formatting 2015-01-19 18:07:28 +01:00			How could this be tampered to make another plugin that would enable partial listing so I could make multiple "subTOCs" in the same page? For instance I'd have a `\[[!toc startlevel=1 levels=1]]` in the top of the page while after a level 1 heading I would have a `\[[!toc startlevel=2]]` with the level 2 and below headers limited by the ones below this particular level 1 header --[[iuri]]