aboutsummaryrefslogtreecommitdiff
path: root/doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2017-05-16 11:29:30 +0100
committerSimon McVittie <smcv@debian.org>2017-05-16 12:08:55 +0100
commit01f2a843602ad19716db9e17f93c943e0c71cff9 (patch)
tree7d891eaeda20ed40cd3dc76bfe3fd7adf5bd0fdc /doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn
parent49de9594b71159d2a1755c80a096f1886b5fb05c (diff)
downloadikiwiki-01f2a843602ad19716db9e17f93c943e0c71cff9.tar
ikiwiki-01f2a843602ad19716db9e17f93c943e0c71cff9.tar.gz
color: Use markup for the preserved CSS, not character data
This still smuggles it past the sanitize step, but avoids having other plugins that want to capture text content without markup (notably toc) see the CSS as if it was text content.
Diffstat (limited to 'doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn')
-rw-r--r--doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn b/doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn
index f97e5c5db..d627091ea 100644
--- a/doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn
+++ b/doc/bugs/color_plugin_produces_artifacts_in_table-of-contents.mdwn
@@ -16,6 +16,11 @@ Reason for this behaviour is:
1. the toc plugin removes everything except plain text from headers in the toc
1. if the toc plugin is executed before the color plugin in the format hook it sees the special syntax and clobbers the toc, otherwise it just removes the color markup
+> The bug here is that the color plugin's special syntax does not
+> gracefully degrade to "render nothing", which I have now [[fixed|done]]
+> by putting the color bits through a value attribute instead of
+> character data. --[[smcv]]
+
# Solutions
There are a few possible solutions to this depending on how it should work:
@@ -26,6 +31,12 @@ There are a few possible solutions to this depending on how it should work:
I would propose implementing the second option because visual markers in headers are useful to convey additional information very fast and this information should be preserved in the toc. Example: Bug or task/project tracker with color conveying status of the bug or task.
+> This is really a separate feature request: copy non-`<a>` markup
+> in headings into the TOC. I don't think this necessarily makes
+> sense in general. In particular, any `id` attributes on child
+> elements must not be passed through because that would make
+> the ID non-unique. --[[smcv]]
+
It seems you can stuff anything into ordered lists (according to w3.orgs doku), so apart from stylistic reasons and suboptimal display of links in headers (see below) I don't see any problems with markup in the toc.
# Patch