doc/plugins/contrib/i18nheadinganchors/discussion.mdwn

   1 I would not be comfortable with merging this into headinganchors and enabling it by
   2 default for two main reasons:
   3
   4 * it adds a new dependency on [[!cpan Text::Unidecode]]
   5 * Text::Unidecode specifically documents its transliteration as not being stable
   6   across versions
   7
   8 There are several "slugify" libraries available other than Text::Unidecode.
   9 It isn't clear to me which one is the best. Pandoc also documents
  10 [an algorithm for generating slugs](http://pandoc.org/MANUAL.html#extension-auto_identifiers),
  11 and it would be nice if our fallback implementation (with i18n disabled) was compatible
  12 with Pandoc's, at least for English text.
  13
  14 However! In HTML5, IDs are allowed to contain anything except _space characters_
  15 (space, newline, tab, CR, FF), so we could consider just passing non-ASCII
  16 through the algorithm untouched. This [example link to a Russian
  17 anchor name](#пример) (the output of putting "example" into English-to-Russian
  18 Google Translate) hopefully works? (Use a small browser window to make it
  19 clearer where it goes)
  20
  21 > Can we assume Ikiwiki generates HTML5 all the time? I thought that was still a
  22 > setting off by default... --[[anarcat]]
  23
  24 >> ikiwiki always generates HTML5, since 3.20150107. The `html5` option has
  25 >> been repurposed to control whether we generate new-in-HTML5 semantic
  26 >> markup like `<section>` and `<nav>` (`html5` enabled), or HTML4 equivalents
  27 >> like `<div>` with a class (`html5` disabled). The default is still off,
  28 >> although I should probably either toggle it to on or remove the option
  29 >> altogether in the next release. --s
  30
  31 So perhaps we could try this Unicode-aware version of what Pandoc documents:
  32
  33 * Remove footnote links if any (this might have to be heuristic, or we could
  34   skip this step for a first implementation)
  35 * Take only the plain text, no markup (passing the heading through HTML::Parser
  36   and collecting only the text nodes would be the fully-correct version of this,
  37   or we could fake it with regexes and be at least mostly correct)
  38 * Strip punctuation, using some Unicode-aware definition of what is punctuation:
  39   perhaps `s/[^-\w_. ]//gu;` (delete anything that is not a (Unicode-aware) word
  40   character, hyphen-minus, underscore, dot or space)
  41 * Replace spaces with hyphen-minus
  42 * Force to lower-case with `lc`
  43 * Strip leading digits and punctuation
  44 * If the string is empty, use `section`
  45 * If we already generated a matching identifier, append `-1`, `-2`, etc. until we find
  46   an unused identifier
  47
  48 (Or to provide better uniqueness, we could parse the document looking for any existing
  49 ID, then append `-1`, `-2` to each generated ID until there is no collision.)
  50
  51 This would give us, for example, `## Visiting 北京` → `id="visiting-北京"`
  52 (whereas Text::Unidecode would instead transliterate, resulting in
  53 `id="visiting-bei-jing"`).
  54
  55 To use these IDs in fragments, I would be inclined to rely on browsers
  56 supporting [IRIs](https://tools.ietf.org/html/rfc3987): `<a href="#visiting-北京">`.
  57
  58 --[[smcv]]
  59
  60 > I guess this makes sense. I just wonder how well this is actually supported in all
  61 > browsers.. I looked around and suspect this will work in more recent browsers, but,
  62 > as an example, https://caniuse.com/ doesn't have that feature listed in their
  63 > tables. :) -- [[anarcat]]
  64
  65 >> That might well indicate that all major browsers have always supported it so
  66 >> there is no need to check. I don't see any particular reason why a browser vendor
  67 >> would not want to accept arbitrary non-whitespace as a valid anchor.
  68 >>
  69 >> In practice, minor or old browsers are probably insecure anyway, so I don't care
  70 >> too much about supporting them perfectly... --s
  71
  72 ----
  73
  74 Documentation says:
  75
  76 > _Also note that all heading attributes are overriden with the ID tag. If this
  77 > is not desirable, we'd need to fire up a full HTML::Parser or do some more
  78 > regex magic to preserve the attributes other than id= which we want to keep._
  79
  80 I think this is a bug, particularly if you are using Pandoc's
  81 [header attributes](http://pandoc.org/MANUAL.html#extension-header_attributes)
  82 or similar.
  83
  84 > It's not a bug, it's a limitation. :) But sure, it's a thing. It's an issue in
  85 > headinganchors as well of course. -- [[anarcat]]
  86
  87 I think we should try to use an existing ID before generating our own, with the
  88 generation step as a fallback, just like Pandoc does. If a htmlize layer like
  89 Text::MultiMarkdown or Pandoc is generating worse IDs than this plugin, the
  90 the right solution to that is to send a bug report / feature request to
  91 make its IDs as good as this plugin's, or turn off ID generation in the
  92 htmlize layer, or stop using Text::MultiMarkdown.
  93
  94 --[[smcv]]
  95
  96 > Agreed. However, the situation I was in was that multimarkdown *and* the
  97 > headinganchors plugins had issues I had to fix. So it was better and easier
  98 > for me to just override whatever attributes were there for testing and
  99 > fixing this in the short term... -- [[anarcat]]
 100
 101 ----
 102
 103 <pre>Some long scrollable text
 104 .
 105 .
 106 .
 107 .
 108 .
 109 .
 110 .
 111 .
 112 .
 113 .
 114 .
 115 .
 116 .
 117 .
 118 .
 119 .
 120 .
 121 <span id="пример">Example fragment ID in Russian should point here</span>
 122 .
 123 .
 124 .
 125 .
 126 .
 127 .
 128 .
 129 .
 130 .
 131 .
 132 .
 133 .
 134 .
 135 .
 136 .
 137 .
 138 .
 139 .
 140 .
 141 .
 142 .
 143 .
 144 .</pre>
 145
 146 > This works for me on ` Mozilla/5.0 (X11; Linux x86_64; rv:50.0) Gecko/20100101 Firefox/50.0` on Debian stretch, FWIW. --[[anarcat]]