Skip to content

Conversation

@fpdotmonkey
Copy link

This changes the default behavior of note-outline so that it doesn't number the heading it generates. The heading shouldn't be numbered by default because typically this notes section isn't a part of the final published document and would change the numbers of sections that are, which can cause mistakes, e.g. writing the literal "Section 6" instead of "Section 5".

Closes #36

drafting.typ Outdated
/// Spacing between outline elements -> relative
row-gutter: 10pt,
/// Whether the outline heading should receive a number
dont-number-heading: true,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be number-headings: false? I like to avoid double-negatives in boolean flags

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

@ntjess
Copy link
Owner

ntjess commented Sep 15, 2025

@Tinggaard LGTM (after the one suggested comment fix); any thoughts? I know it should probably come with a readme example, but you mentioned upgrading the distribution script (which I'd love to support!). We can probably tackle that in another PR

This changes the default behavior of `note-outline` so that it doesn't
number the heading it generates.  The heading shouldn't be numbered by
default because typically this notes section isn't a part of the final
published document and would change the numbers of sections that are,
which can cause mistakes, e.g. writing the literal "Section 6" instead
of "Section 5".

Closes ntjess#36
@Tinggaard
Copy link
Collaborator

Yes, LGTM.

You mentioned upgrading the distribution script

Yes, that is still in the making - sorry about the delay. Life has gotten in the way.

I don't know when it will be ready, but if it is possible to make a release now, I think we should do it. There has been a few new additions since the last release, I just cannot get the build script to work, and thus have not made a PR to the official package repo.

If you have suggestions to how we should build the README going forward, I am all ears. Like I have mentioned earlier I cannot get showman to work, but maybe this is all the topic of another issue.

@fpdotmonkey
Copy link
Author

Does this require any action on my part? Happy to write an example if necessary, though I'm not quite sure what I would write as the image URL.

@Tinggaard
Copy link
Collaborator

Does this require any action on my part? Happy to write an example if necessary, though I'm not quite sure what I would write as the image URL.

For now, I think you are good - thanks! I will just await @ntjess, and hear if he has any suggestions regarding the rewrite of the CI.

heading(level: level, title)
heading(
level: level,
numbering: if number-heading { none } else { heading.numbering },
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be reversed? if number-heading { heading.numbering } else { none }

@ntjess
Copy link
Owner

ntjess commented Oct 20, 2025

Apologies for being MIA, it's been a busy year 😅 Agreed, I think the CI issues are separate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

#note-outline should probably not be numbered

3 participants