Project

General

Profile

Actions

Feature #20720

open

Every section header in the documentation should have an id for easy linking

Added by Brett Smith about 1 year ago. Updated 7 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
Story points:
1.0

Description

This makes it easier to help users in email and chat.

Guessing one story point just because of the sheer number of them.

This story does not need to include an interface to get the id. That would be a good improvement too, but personally I can live with getting it from dev tools. We can make a separate ticket if it's not trivial enough to include here.

Actions #1

Updated by Brett Smith about 1 year ago

  • Target version set to To be scheduled
Actions #2

Updated by Brett Smith about 1 year ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz about 1 year ago

A lot of sections have section ids but don't have an easy anchor link that you can click to get the link. This can be solved technically by adding that link, and generating anchors automatically for sections that don't have them. Something to implement as a Zenweb page generation pass, I think.

Example:

https://www.commonwl.org/v1.2/CommandLineTool.html

If you hover over a section, you see a section marker ยง that you can click on to get a link to that section.

Actions #4

Updated by Peter Amstutz 7 months ago

  • Tracker changed from Idea to Feature
Actions #5

Updated by Peter Amstutz 7 months ago

  • Target version changed from To be scheduled to Future
Actions

Also available in: Atom PDF