search

WICG / cq-usecases

Use cases and requirements for standardizing element queries.
Other
184 stars 24 forks source link

Anchor links? #12

Closed jehoshua02 closed 9 years ago

jehoshua02 commented 10 years ago

Would it be easy or worth it to add anchor tags throughout the document to link to individual paragraphs in issues and things?

peterwilsoncc commented 10 years ago

tabatkins/bikeshed is used to generate the document, it automatically generates IDs for headings that can be referenced. Paragraphs do not have IDs - presume becuase they are likely to change/be reordered.

jehoshua02 commented 10 years ago

Yeah, and I just realized it's in github. Could easily link to source code. On Sep 2, 2014 7:32 PM, "Peter Wilson" notifications@github.com wrote:

tabatkins/bikeshed https://github.com/tabatkins/bikeshed/ is used to generate the document, it automatically generates IDs for headings that can be referenced. Paragraphs do not have IDs - presume becuase they are likely to change/be reordered.

— Reply to this email directly or view it on GitHub https://github.com/ResponsiveImagesCG/eq-usecases/issues/12#issuecomment-54241556 .

marcoscaceres commented 9 years ago

We usually link to definitions or concepts instead of sections or paragraphs. I would suggest closing this, as BS will automatically generate the appropriate anchor points.

tabatkins commented 9 years ago

Yeah, headings, definitions, issues, and a few other small things auto-generate IDs with Bikeshed, and get clickable permalinks. That's generally all you need.

(If, for example, there's a list that you want to make linkable, manually adding an ID to the <li> or <dt> will make Bikeshed generate clickable permalinks as well.)