Skip to content

Commit

Permalink
fix: standard ranged tags examples (#12)
Browse files Browse the repository at this point in the history
* fix: Standard ranged tags examples

* fix: Properly escape standard ranged tags examples.
  • Loading branch information
Klafyvel authored Mar 12, 2023
1 parent 95e646a commit edefad6
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions 1.0-specification.norg
Original file line number Diff line number Diff line change
Expand Up @@ -867,14 +867,14 @@ version: 1.0
carryover tags}[strong carryover tag] to each one of them.

**** Examples
`|example`:
`\|example`:
|example
|example
* This is an example heading.
|end
|end

`|comment`:
`\|comment`:
|example
|comment
This is a very long comment with some content
Expand All @@ -885,15 +885,15 @@ version: 1.0
|end
|end

`|details`:
`\|details`:
|example
|details
* Here is some hidden markup!
Wowzers.
|end
|end

`|group`:
`\|group`:
|example
#color red
|group
Expand All @@ -908,11 +908,11 @@ version: 1.0

**** Edge Cases and Semantic Interpretation
A commonly arising question is "how are these interpreted at parse time?" - can you link to
elements within `|comment` tags? What governs the behavior of these differing tags?
elements within `\|comment` tags? What governs the behavior of these differing tags?

The answer may be illustrated simply by showing how these tags are implemented.
As mentioned in the {*** macro tags} section, all tag types (apart from the macro tag) are a
macro invocation under the hood. Below are the implementations for `|comment` and `|group`,
macro invocation under the hood. Below are the implementations for `\|comment` and `\|group`,
respectively:
- :
|example
Expand All @@ -926,10 +926,10 @@ version: 1.0
=end
|end

The `|comment` tag evaluates to /no value/. Anything that is placed within a comment during
The `\|comment` tag evaluates to /no value/. Anything that is placed within a comment during
invocation (the `...` parameter) is simply dropped. Because of this it is *not* possible to
link to elements within comment tags. The `|group` tag returns everything that you give
it, because of this it *is* possible to freely link to any element within a `|group`.
link to elements within comment tags. The `\|group` tag returns everything that you give
it, because of this it *is* possible to freely link to any element within a `\|group`.

To summarize - the behavior of each individual standard ranged tag is fully governed by its
implementation - see the [semantics document] for more details.
Expand Down

0 comments on commit edefad6

Please sign in to comment.