- From: r12a via GitHub <sysbot+gh@w3.org>
- Date: Thu, 20 Apr 2017 17:00:07 +0000
- To: public-i18n-archive@w3.org
> And, another question: Why do we start section IDs with |h_|? Because when i added ids at some point (can't remember whether in this doc or another) i found i was introducing clashes with other ids in the document that referred to similar topics. Adding the h_ makes it clear that were dealing with a h_eading, and usually removes the ambiguity. We don't have to have it, but we need to be more vigilant, if not, that we don't duplicate ids. Btw, we do have a rule that ids for <dfn> elements should normally start with dfn_. This is for similar reasons, but tends to be particularly useful because when referring back to that definition from elsewhere, it's clear that the link is pointing to a definition. > I think we better not do so, as they are the most visible IDs in the > document and we would have a cleaner URL with simpler IDs. > > Looks like ReSpec manual suggests to keep them simple, too: > https://github.com/w3c/respec/wiki/section Respec documentation also suggests using h2 everywhere, which i think is a VERY BAD idea. It's convenient only if you're hand writing the code. Try to edit that code in a wysiwyg editor, or view the file without respec code being available (eg. on a plane) and you lose the hierarchy of the page headings. Bad idea. -- GitHub Notification of comment by r12a Please view or discuss this issue at https://github.com/w3c/alreq/issues/13#issuecomment-295814559 using your GitHub account
Received on Thursday, 20 April 2017 17:00:20 UTC