🧮 Numbering improvements for custom containers #790
Merged
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
rowanc1
commented
Nov 30, 2023
fwkoch
reviewed
Nov 30, 2023
| obj, | ||
| { optional: [...NUMBERING_KEYS, ...NUMBERING_OPTIONS], alias: NUMBERING_ALIAS }, | ||
| // Do not add warnings on this filter process | ||
| { property: '', messages: { errors: [], warnings: [] }, keepExtraKeys: true }, |
There was a problem hiding this comment.
You can also use suppressErrors/suppressWarnings - which will just prevent logging entirely.
fwkoch
reviewed
Nov 30, 2023
| HEADING_KEYS.forEach((headingKey) => { | ||
| if (headings && !defined(value[headingKey])) { | ||
| // This will be validated next! | ||
| value[headingKey] = true; |
fwkoch
reviewed
Nov 30, 2023
| export const NUMBERING_OPTIONS = ['enumerator', 'headings']; | ||
|
|
||
| const HEADING_KEYS = ['heading_1', 'heading_2', 'heading_3', 'heading_4', 'heading_5', 'heading_6']; | ||
| export const NUMBERING_KEYS = ['figure', 'equation', 'table', 'code', ...HEADING_KEYS]; |
There was a problem hiding this comment.
And then I guess this just works with the enumerate transform, since it already increments count based on kind. Nice.
There was a problem hiding this comment.
Yeah, I was impressed at how much of this already just worked and all we needed to do was to be less strict in validation!
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 opens up the numbering dictionary to any item, and also allows figure directives (and notebook cells) to set the kind of a container directly. The two of these combined allow for numbering and referencing of custom container types.