-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Most ghastly link fragment anchor names #10868
Comments
In general:
Regarding:
This link should not change. Doxygen tries to keep these hashes stable and only change them when there is no other way. |
I have never used Doxygen. I am just trying to make a hyperlink to a place in somebody else's document that was created with apparently Doxygen. It's good that there is |
Best to ask the creator of the document whether it is reasonable that you link to the mentioned place or should link to another place. |
By the way, come to think about it, the very long IDs are overkill. The most internal links needed in a single web page could be handled by |
@jidanni The IDs are md5 hashes for the signature of the item they link to. So they should be quite persistent. If you think about member overloads, you'll quickly understand that a readable anchor is not really possible in general. Otherwise you end up with something like this where a |
Excuse me, I've not even heard of Doxygen for five minutes. In fact my only contact with it was trying to make a permalink to
https://gdal.org/doxygen/classOGRGeometry.html#:~:text=Centroid()
which you see I have managed to do via Google
:~:
stuff, and risky "()" to make sure I got to the right spot. But that's life.Yes, I would rather have used real HTML links that will work in all browsers, like the ones Doxygen makes,
https://gdal.org/doxygen/classOGRGeometry.html#a91787f669b2a148169667e270e7e40df
but did you notice that ghastly
#a91787f669b2a148169667e270e7e40df
there at the end?How long will that last? Till the next revision?
And OK, even if it is a permalink, it is not a permalink that one can be proud of or that one can know where one is going before arriving.
Let's see how the other folks do it:
(No need to click it. I'm just showing how the URL is composed:)
https://gdal.org/user/ogr_sql_dialect.html#ogr-geom-area
There, nice, clean, low key. The perfect balance between...
We're talking the Zen masters of link fragment naming!
Maybe users need to manually choose the names. I don't know. All I know is it's better that those
godforsakenobnoxiousbarcode-like ASCII porridge Doxygen style link fragments.Also, I noticed they managed to keep the name of their document system out of the URL. But maybe that's configurable...
The text was updated successfully, but these errors were encountered: