Ranged elements #27

mrossinek · 2022-01-17T20:26:58Z

Adds the ranged element syntax discussed on Discord.

change spoiler syntax from | to !
implement ranged attached modifiers

You can now use the range-modifier `|` to write |*ranged markup like this
which has the benefit

of allowing arbitrary whitespace inside of it      *|.

Ranged markup elements are placed into the paragraph in which they start.
They can contain other in-line syntax like more markup, links, etc.
No detached modifiers, headings, etc. are allowed inside of them.

support things like |*/ ranged bold + italic /*|
implement general ranged element frames

- |
  If you want to include more elements inside of a single detached modifier you can use a `||` ranged element.
  This allows you to for example include code blocks inside list items:

  @code lua
  print("Hello world!")
  @end
  ---

gzagatti · 2022-01-20T03:29:09Z

For future reference, this is how a long list with ranged elements would look like.

I feel that allowing for whitespace between the list items is easier on the eyes. However, it depends on how empty lines straight after the delimiting modifiers are treated. I have assumed that the delimiting modifier only resets after the first non-empty line in which it appears. (Otherwise would it be the case of using ---~?).

Euismod nam consequat fermentum lectus curae mattis et auctor, imperdiet
magna praesent felis platea luctus orci, pulvinar nascetur nisl nulla
fringilla eleifend proin. Venenatis netus velit taciti fusce faucibus,
nunc elementum himenaeos suspendisse, at neque ridiculus lacinia.

- | 
  If you want to include more elements inside of a single detached modifier you can use a `||` ranged element.
  This allows you to for example include code blocks inside list items:

  @code lua
  print("Hello world!")
  @end
  ---

- | 
  Lorem ipsum dolor sit amet consectetur adipiscing elit hac, magnis cras
  curabitur at vulputate potenti. 

  Penatibus etiam fermentum egestas sodales litora quam blandit aptent
  taciti, leo varius primis massa suspendisse augue senectus dictumst,
  ridiculus fringilla cubilia sapien magnis non commodo tempus. 

  - |
    Hello world! The book is on the table

    @code lua
    print(1 + 1)
    @end
    ---
  - |
    @code lua
    print("blue circle")
    @end
    ---
  ---

  --|
    In botany, a fruit is the seed-bearing structure in flowering plants
    that is formed from the ovary after flowering.

    Fruits are the means by which flowering plants (also known as
    angiosperms) disseminate their seeds.
    ---

  -- oranges~

  -- bananas~

- | 
  Convallis mattis nulla habitant neque ridiculus ante libero platea,
  gravida varius sociosqu porttitor dignissim leo volutpat sociis, porta
  facilisis cum sagittis euismod dolor eget. 

  Lorem sit pharetra fermentum eleifend tristique inceptos platea semper
  convallis ullamcorper, et sagittis tellus sodales cubilia dis eu dolor.
  ---

Non curae lobortis ac erat orci dis hac dui, commodo elementum blandit at
arcu placerat sagittis penatibus eleifend, nisl consectetur faucibus
turpis fringilla volutpat mi. Rutrum semper sociis lectus nullam integer
duis posuere, phasellus et cras nibh ornare amet ad vitae, proin nascetur
sodales facilisi eros elit.

I think that the above does not look very bad on the eyes, but the excessive use of --- can be a bit polluting and gets mixed when using sub-items.

Another option would be to use a similar rule that is used for heading. The list only breaks after ---. The next list item is indicated by the delimiter - |. However, this approach would not allow for a list inside of a list as in the example above.

Euismod nam consequat fermentum lectus curae mattis et auctor, imperdiet
magna praesent felis platea luctus orci, pulvinar nascetur nisl nulla
fringilla eleifend proin. Venenatis netus velit taciti fusce faucibus,
nunc elementum himenaeos suspendisse, at neque ridiculus lacinia.

- | 
  If you want to include more elements inside of a single detached modifier you can use a `||` ranged element.
  This allows you to for example include code blocks inside list items:

  @code lua
  print("Hello world!")
  @end

- | 
  Lorem ipsum dolor sit amet consectetur adipiscing elit hac, magnis cras
  curabitur at vulputate potenti. 

  Penatibus etiam fermentum egestas sodales litora quam blandit aptent
  taciti, leo varius primis massa suspendisse augue senectus dictumst,
  ridiculus fringilla cubilia sapien magnis non commodo tempus. 

  @code lua
  print(1 + 1)
  @end

  --|
    In botany, a fruit is the seed-bearing structure in flowering plants
    that is formed from the ovary after flowering.

    Fruits are the means by which flowering plants (also known as
    angiosperms) disseminate their seeds.

  -- oranges~

  -- bananas~

- | 
  Convallis mattis nulla habitant neque ridiculus ante libero platea,
  gravida varius sociosqu porttitor dignissim leo volutpat sociis, porta
  facilisis cum sagittis euismod dolor eget. 

  Lorem sit pharetra fermentum eleifend tristique inceptos platea semper
  convallis ullamcorper, et sagittis tellus sodales cubilia dis eu dolor.

- |
  What we've done is terminated the heading and started out a new 
  paragraph that is no longer "underneath" the heading itself.
---

Non curae lobortis ac erat orci dis hac dui, commodo elementum blandit at
arcu placerat sagittis penatibus eleifend, nisl consectetur faucibus
turpis fringilla volutpat mi. Rutrum semper sociis lectus nullam integer
duis posuere, phasellus et cras nibh ornare amet ad vitae, proin nascetur
sodales facilisi eros elit.

mrossinek · 2022-01-20T20:42:48Z

Thanks for the input! The final syntax will definitely be closer to your second example because all the intermediate --- will not be required. I.e. a - | will automatically be closed by the next - |. The fact that this means we will not be able to nest lists of the same level within a - | is fine by me since that would not really make sense anyways.
We will formalize this PR a bit more on the weekend 👍

Lists and Quotes are now a subtype of detached modifiers with actually allow an entire `paragraph` node (instead of just `paragraph_segment`) to be placed inside of them. This has the benefit of allowing `_line_break` which means we can avoid an excessive use of the (soon to be introduced) ranged segments.

A proof of concept idea. Bound to change!

src/scanner.cc

mrossinek · 2022-01-21T19:45:29Z

src/scanner.cc

+            /* TODO: what is this?
            auto can_have_modifier = [&]()
            {
                return !m_ActiveModifiers[(VERBATIM_OPEN - BOLD_OPEN) / 2];
            };
+            */


@vhyrro do we really need this?

mrossinek · 2022-01-21T19:46:04Z

src/scanner.cc

            {
-                if (can_have_modifier())
-                    m_ActiveModifiers.set((found_attached_modifier->second - BOLD_OPEN) / 2);
+                // if (can_have_modifier())


It was used here but it was causing issues when implementing ranged modifiers and removing it didn't seem to break anything..

src/scanner.cc

mrossinek · 2022-01-21T19:48:03Z

grammar.js

+                // TODO(mrossinek): I do not see the need for this. If we do
+                // need it, we need to extract it into _paragraph again because
+                // having it here would cause the ends of detached modifiers
+                // like quotes and lists to break.
+                // optional(
+                //     $._paragraph_break,
+                // ),


@vhyrro what's your take on this?

mrossinek · 2022-01-22T17:23:06Z

We need to be a bit stricter on how to close the ranged attached modifiers. Currently, the following will be closed prematurely:

|` some long verbatim with `where I show verbatim markup` and finally want to close `|

Instead of the ranged_attached_modifier closing at the end, it will close at `where which is not desired.

EDIT: Fixed in c0c4002

This allows us to write what would normally be non-ranged attached modifiers inside of ranged-modifiers without affecting their range. This is very useful because it allows us to write verbatim attached modifiers within ranged verbatim attached modifiers without messing up their range. For example: |` In Neorg, verbatim text is written like so: `This is verbatim.` `|

mrossinek · 2022-01-25T20:34:51Z

Currently, the following case of nested modifiers is broken:

*bold /italic/_*

The _ is messing things up. I have not yet been able to track down what change caused this problem. I may need to do a bisect but unfortunately these commits are rather large.. Let's see..

Ported implementation from #27.

mrossinek · 2022-04-03T13:10:34Z

Now that the ranged attached modifiers and the newest indent segment implementation have both been ported to #35 I am closing this PR.

All previously commented issues have been resolved, too 👍

mrossinek added 3 commits January 17, 2022 21:13

breaking: change spoiler markup | -> !

22b3f83

refactor: paragraph grammar

7a2ad56

feat: implement ranged attached modifiers

ea57e95

mrossinek requested a review from vhyrro January 17, 2022 20:26

mrossinek self-assigned this Jan 17, 2022

feat: improve ranged attached modifiers

2b6f4cf

mrossinek added 3 commits January 20, 2022 22:35

Merge branch 'main' into ranged-elements

0b92a00

feat: [WIP] indent segment node

7205a2a

A proof of concept idea. Bound to change!

mrossinek commented Jan 21, 2022

View reviewed changes

mrossinek added 8 commits January 21, 2022 21:22

refactor: store ranged modifier status per markup

f0c5f7a

fix: remove faulty comment

d92874f

refactor: actually use m_Previous

c95826e

feat: nested ranged modifiers

690a322

More indent segment levels

769969d

ci: increase fuzzing timeout

9d28b8f

Merge branch 'main' into ranged-elements

61c2dab

test: more ranged modifier tests

5596553

mrossinek added 6 commits January 22, 2022 18:36

fix: more strict check for ranged attached modifier end

7406fb9

fix: also reset active modifiers after detached modifier

e2a90d1

fix: single | inside markup

61bf912

fix: only set attached modifier if non-verbatim

bdc56d9

fix: can_have_modifier check

b403962

mrossinek mentioned this pull request Jan 30, 2022

[FEATURE REQUEST] Add notes to todo list items nvim-neorg/neorg#341

Closed

1 task

mrossinek added a commit that referenced this pull request Apr 3, 2022

feat: ranged attached modifiers

e4f7ed3

Ported implementation from #27.

mrossinek closed this Apr 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ranged elements #27

Ranged elements #27

mrossinek commented Jan 17, 2022 •

edited

Loading

gzagatti commented Jan 20, 2022

mrossinek commented Jan 20, 2022

mrossinek Jan 21, 2022

mrossinek Jan 21, 2022

mrossinek Jan 21, 2022

mrossinek commented Jan 22, 2022 •

edited

Loading

mrossinek commented Jan 25, 2022

mrossinek commented Apr 3, 2022

Ranged elements #27

Ranged elements #27

Conversation

mrossinek commented Jan 17, 2022 • edited Loading

gzagatti commented Jan 20, 2022

mrossinek commented Jan 20, 2022

mrossinek Jan 21, 2022

Choose a reason for hiding this comment

mrossinek Jan 21, 2022

Choose a reason for hiding this comment

mrossinek Jan 21, 2022

Choose a reason for hiding this comment

mrossinek commented Jan 22, 2022 • edited Loading

mrossinek commented Jan 25, 2022

mrossinek commented Apr 3, 2022

mrossinek commented Jan 17, 2022 •

edited

Loading

mrossinek commented Jan 22, 2022 •

edited

Loading