support for replacement algorithms and for xrefs to steps #217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 16, 2020
| node.innerHTML = html; | ||
|
|
||
| let labeledStepEntries: StepBiblioEntry[] = []; | ||
| let replaces = node.getAttribute('replaces-step'); |
There was a problem hiding this comment.
Should we remove this attribute from the output?
There was a problem hiding this comment.
Ecmarkup doesn't really clean up after itself, as a rule - all the emu-whatever tags are in the output, etc.
There was a problem hiding this comment.
Fine. We should reconsider that.
There was a problem hiding this comment.
Opened #218 to track.
michaelficarra
approved these changes
Jun 17, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the ability to reference steps, both with
emu-xrefs and by marking algorithms as replacing steps (the latter so that they can have the appropriate numbering).You can label steps using the
1. [label="foo"] Step.syntax introduced in tc39/ecmarkdown#74, and you can refer to them with<emu-xref href="#step-foo"></emu-xref>or<emu-alg replaces-step="foo">. The xref will automatically be populated with the appropriate step number (just the number itself, so you still need to write out "step", and possibly the name of the algorithm if it isn't clear). The labeled algorithm will automatically adopt the numbering of the labeled step, including for nested steps.Now that we have support for replacement algorithms there is no longer a need to manually override the starting number for a list. I enforce that you do not, and that you do not write "step 1" or whatever, with the linter.
Fixes #192.
Marked as draft until a version of ecmarkdown with support for the
[label=""]syntax is published.Corresponding ecmarkdown PR at tc39/ecmarkdown#74. Corresponding ecma262 PR at tc39/ecma262#2052.
Since it's hard to review the CSS in the PR, here's a screenshot of the new
algorithm-replacementsbaseline: