Enable use of fragment identifiers for linking to section of a html page about doconce HOT 6 CLOSED

Do we need to keep the first type of internal links using ___sec or can we just phase them out and avoid adding another flag? Do you have any idea if they are documented and used for other purposes?

from doconce.

I fear phasing them out would lead to a lot (?) of broken links on the internet, so I think it better to enable both options. I do not know if hpl used some established standard, a quick google search seems to indicate not.

from doconce.

In thinking a bit more about this, this is maybe part of a bigger discussion, around whether to make such major changes the default, with the previous situation enabled using a flag, or optional, using a new flag...

from doconce.

I looked into this and will try to propose a solution soon. Correct me if I am wrong but it seems to me that ___sec is used only in TOCs so we do not need to worry about consistency: if you compile a document to html you'll get a new TOC as I describe below, if you do not those ___sec in the html file will still work. Unless maybe one is mixing new and old html files, but that sounds like bad practice to me.

___sec is used in TOCs when a heading has no label. However, I can create a label from the heading's title as GitHub does (this seems to work fine href=re.sub('\W+', '-', title.lower()).strip('-'). Example: a heading ### how !. to cite? ### gives href='how-to-cite'. When the user requires a TOC, this href will be used in the links in the TOC and in the anchors in the headings.

from doconce.

It looks like ___sec is used by default in all html output for all or most headings. However, it is only used to create links when a TOC is requested (I think).

Your solutions sounds fine. It looks like commas are also skipped from labels, e.g. https://docs.carpentries.org/topic_folders/governance/bylaws.html#eligibility-rights-and-termination-for-voting-members. Non-standard characters, such as the Norwegian 'æ', 'ø' and 'å' are also problematic. These should maybe be replaced with 'ae', 'o' and 'a' (or 'ae', 'oe' and 'aa' as is sometimes done).

from doconce.

Your implementation in #86 looks good to me! Thanks!

from doconce.