Project

General

Profile

Bug #11907

Usermanual: show anchors

Added by Roman Lebedev 4 months ago. Updated 3 months ago.

Status:
Triaged
Priority:
Medium
Assignee:
-
Category:
Usermanual
Target version:
-
Start date:
01/03/2018
Due date:
% Done:

20%

Affected Version:
git master branch
System:
all
bitness:
64-bit
hardware architecture:
amd64/x86

Description

Followup for https://github.com/darktable-org/dtorg/issues/11
Some(?) section headings have anchors, but none have the actual links.
E.g. either see either http://rawspeed.org/#getting-source-code or https://www.darktable.org/about/faq/#faq-red-borders for how it should be done properly.
This is a major PITA for me, every time i want to link to the section, i have to dig in the sourceview.

History

#1 Updated by Tobias Ellinghaus 4 months ago

  • % Done changed from 0 to 100
  • Status changed from New to Fixed

I added the links to the website version of the manual. Not all sections have proper ids yet, so some links might still change (the ones looking like "ch03s02s08"). But once those are sorted out our manual will be much more stable wrt. external links as newly added chapters or sections will no longer change the links.

#2 Updated by Roman Lebedev 3 months ago

  • % Done changed from 100 to 0
  • Status changed from Fixed to New

Not quite there yet.
On https://www.darktable.org/usermanual/en/correction_group.html#denoise_profiled, there are these sections "Usage", "profile", ...
And they don't have anchors.

#3 Updated by Tobias Ellinghaus 3 months ago

  • % Done changed from 0 to 20
  • Priority changed from High to Medium
  • Status changed from New to Triaged

Because I only added them up to h4. Do you need them for lower levels, too? If so we would need someone going through the usermanual, adding ids to all those low levels. Currently the anchors are auto generated and not stable, so using them for links is error prone.

#4 Updated by Roman Lebedev 3 months ago

Tobias Ellinghaus wrote:

Because I only added them up to h4.

Do you need them for lower levels, too?

Yes, absolutely.

If so we would need someone going through the usermanual, adding ids to all those low levels.

Uhm, they are not/can not be auto-generated from the heading itself?
Because if the heading is changed, then that is effectively a different section.

Currently the anchors are auto generated and not stable, so using them for links is error prone.

That is still better than going into source code to get the anchor.
Or, these 'unstable' should not be there at all.

Also available in: Atom PDF