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

Support linking to steps. #1831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support linking to steps. #1831

wants to merge 1 commit into from

Commits on Dec 6, 2020

  1. Support linking to steps.

    Specifications often have algorithms with many (nested) ordered lists.
    In those algorithms, steps often refer to other steps by number. But
    those numbers currently have to be maintained manually and, when steps
    are inserted, that can lead to a cascade of updated step number
    references below. Worse, when two changes are in-flight to the same
    algorithm, the step numbers are almost ensured to go wrong because
    neither change need textually conflict with the other.
    
    This change to bikeshed permits items in an ordered list to be given an
    ID and referenced by name.
    
    1. This is a traditional item.
    1. {#myid} This is an item with an ID.
    1. This items references [[#myid]].
    
    The reference is turned into the string “step 2”. This also works for
    nested steps where the reference will say something like “step 2.1.3”.
    agl committed Dec 6, 2020
    Configuration menu
    Copy the full SHA
    fde732f View commit details
    Browse the repository at this point in the history