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

[Specification 2.0]: Add entry about headings #44

Open
wants to merge 2 commits into
base: push-xvurqtxkusso
Choose a base branch
from

Conversation

vhyrro
Copy link
Member

@vhyrro vhyrro commented Aug 17, 2024

This PR adds a headings section and attempts to describe them in the most succinct way possible.

@vhyrro vhyrro requested a review from mrossinek August 17, 2024 17:03
@boltlessengineer
Copy link

Can we rename heading to section? I think it makes more sense.

heading -> section
heading title -> heading

So when we say "content of heading" we explicitly say for the text coming after the asterisks.

This will also help users from markdown-like syntax to understand how heading in Norg work differently. (heading indents all the content below)

@vhyrro
Copy link
Member Author

vhyrro commented Aug 20, 2024

I don't see any added value of changing the definitions here honestly. Since norg is more org-derived than markdown-derived I'd keep the original term and not break the existing established wording in the v1 spec. "Title" is plenty explanatory :)

@boltlessengineer
Copy link

I'm saying with the context of #43.
If we want to put heading everywhere and define a "block" node, heading itself should not do anything structural.

- * heading
** subheading
- second list item??

This will be hard to parse, way more than before.

If heading can be anywhere as a block without structuring the document, we are actually allowing title, not heading.

Then the wording is bit confusing because now we have to say "title can be placed anywhere that block item can exist".
The word "title" doesn't seem to fit here because it sounds like it has a similar meaning to "name" from +name.

This is not that important for me (compared to other suggestions I've made). Maybe it's just me trying to do unneeded stuff. Feel free to reject this proposal.

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.

2 participants