Navigation Menu

Skip to content
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

Add named id to all chapters, sections, and appendices so they are easier to link to. #292

Closed
wants to merge 4 commits into from

Conversation

goodwillcoding
Copy link

I have been running @NixOsTips and linking to various parts of the manual. However automaticic id generation can change so I went over all the items and attached more properly named ids like chap- sec- appx- and so on.

@deepfire
Copy link

Is it possible to expose these links to the user, so that you can actually copy a link in the browser, without hunting for the id in the HTML source?

@deepfire
Copy link

The associated issue is NixOS/nixpkgs#3082

@@ -1,6 +1,6 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id='ssec-builtins'>
xml:id='sec-builtins'>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't change existing IDs, as that breaks existing hyperlinks to specific sections.

@edolstra
Copy link
Member

Why add all these anchors for backward compatibility? Why not just not change the existing anchors?

@goodwillcoding
Copy link
Author

I have about 100+ anchors coming along with customization to html generation which will make it easier to share the links by having them part of the title..

This way all the links have a similar naming scheme. It makes it easier to maintain, grep and so on. If you really wish I can change it all back, but I figured a consistent naming scheme would be good for all.

I certainly do not wish to goldplate anything but I thought consistency was a good idea. :)

Conflicts:
	doc/manual/release-notes.xml
@domenkozar
Copy link
Member

This is kind-of superseeded by NixOS/nixos-homepage@e0a1c8b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants