New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate informative heading links #1713

Closed
andrewdavidwong opened this Issue Feb 2, 2016 · 4 comments

Comments

Projects
None yet
2 participants
@andrewdavidwong
Member

andrewdavidwong commented Feb 2, 2016

The auto-generated ToC on each page creates links like this:

https://www.qubes-os.org/intro/#tocAnchor-1-1-1

These work fine, but they aren't informative to humans. The above link points to the same target as this (human-informative) one:

https://www.qubes-os.org/intro/#what-is-qubes

It would be nice to find some way of automatically generating the second type of link (and providing it as the target of a link icon next to each heading) so that people can paste them in emails and elsewhere on the web.

@bnvk, do you know if there's any way to do this?

@andrewdavidwong andrewdavidwong added this to the Documentation/website milestone Feb 2, 2016

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Feb 2, 2016

@axon-qubes yah, I noticed that when I was doing the site re-working. I actually had to patch the JS library a little bit to even be able to customize it the way I did. I suppose I could dig into again with the improvement you suggest, at some point in time :)

bnvk commented Feb 2, 2016

@axon-qubes yah, I noticed that when I was doing the site re-working. I actually had to patch the JS library a little bit to even be able to customize it the way I did. I suppose I could dig into again with the improvement you suggest, at some point in time :)

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Feb 2, 2016

Member

That would be great, thanks!

Member

andrewdavidwong commented Feb 2, 2016

That would be great, thanks!

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong May 25, 2016

Member

Somewhat serious issue with the current state:

Updating the page by inserting a new heading can shift the heading numbers so that existing links will point to the wrong heading. For example, if I insert a new section with a heading at the top of the Intro page, this link will point to the "wrong" section: https://www.qubes-os.org/intro/#tocAnchor-1-1-1

Member

andrewdavidwong commented May 25, 2016

Somewhat serious issue with the current state:

Updating the page by inserting a new heading can shift the heading numbers so that existing links will point to the wrong heading. For example, if I insert a new section with a heading at the top of the Intro page, this link will point to the "wrong" section: https://www.qubes-os.org/intro/#tocAnchor-1-1-1

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Oct 15, 2016

Member

Thanks for fixing this, @marmarek!

Member

andrewdavidwong commented Oct 15, 2016

Thanks for fixing this, @marmarek!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment