refactor: captures

[danilshvalov]

This pull request was aimed at improving the extensibility of orgmode captures. At first, I just wanted to add an option to append and prepend empty lines after refiling. It turned out to be a bit more complicated than I thought, so I decided to do a little refactoring. I am ready to change anything else that needed to be changed in orgmode captures, if necessary.

P.S. empty lines were also added.

[danilshvalov]

I also added subtemplates to reduce duplication. Now the user can specify the subtemplates as follows:

{
  e = {
    description = 'Event',
    subtemplates = {
      r = {
        description = 'recurring',
        template = '** %?\n %T',
        target = '~/org/calendar.org',
        headline = 'recurring'
      },
      o = {
        description = 'one-time',
        template = '** %?\n %T',
        target = '~/org/calendar.org',
        headline = 'one-time'
      },
    },
  },
}

[kristijanhusak]

Thanks for the PR.
Generally looks ok, but I don't think we need empty_lines option since it can be achieved with \n, unless I'm missing something.

[kristijanhusak]

This can be achieved with \n in the template, there's no need to define it. For example:

    j = {
      description = 'Journal',
      -- Add 3 empty lines before and 3 lines after
      template = '\n\n\n* TODO %?\n\n\n',
      target = '~/sync/org/journal.org'
    },

[danilshvalov]

See my comment why it doesn't work.

[danilshvalov]

Generally looks ok, but I don't think we need empty_lines option since it can be achieved with \n, unless I'm missing something.

This doesn't work if you add text to the headline. Sample template:

{
  description = "Test",
  template = "\n\n** text with newlines",
  target = "~/org/tmp.org",
  headline = "Test",
}

Result after double use of the template:

* Test
** text with newlines
** text with newlines

With empty lines it works:

{
  description = "Test",
  template = "** text with newlines",
  target = "~/org/tmp.org",
  headline = "Test",
  empty_lines = {
    before = 2,
  },
}

Result:

* Test


** text with newlines


** text with newlines

[kristijanhusak]

This is happening because of this line https://github.com/nvim-orgmode/orgmode/blob/master/lua/orgmode/capture/init.lua#L154

This trims the empty lines before. We need to have this headline in order to be able to properly promote/demote depending on destination.

We can handle this in 2 ways:

1. Leave it as it is without the empty_lines, which would still allow adding empty lines after with \n
2. Refactor the capturing to pass around the whole capture file (https://github.com/nvim-orgmode/orgmode/blob/master/lua/orgmode/capture/init.lua#L151) instead of only the first headline. Then handle the item(s) accordingly where they are handled now and add the spacing.

I'd prefer the first since it's a smaller change, but you can also try the 2nd option if you want.
I'm not exactly sure what's the use case for empty lines before.
If you have a template that adds the lines after, and if you use it consistently, you should have proper spacing before and after when you add the headline.

[danilshvalov]

Okay, I'll see what I can do. Another advantage of empty_lines is that it does not affect the user's buffer. If I add newlines at the beginning of the content, then the capture buffer starts to look like this:

** text with newlines

Emacs orgmode also has the option empty_lines: https://orgmode.org/manual/Template-elements.html

[kristijanhusak]

Emacs orgmode also has the option empty_lines: orgmode.org/manual/Template-elements.html

Ah, ok, wasn't aware of this. I thought this is not part of Emacs. We generally try to follow as much as possible.
Could you just move it to properties key as they show it in the document?

[danilshvalov]

Emacs orgmode also has the option empty_lines: orgmode.org/manual/Template-elements.html

Ah, ok, wasn't aware of this. I thought this is not part of Emacs. We generally try to follow as much as possible. Could you just move it to properties key as they show it in the document?

Done

[danilshvalov]

I have made the following changes:

1. Now the user can specify a number instead of a table for the empty_lines field (like in Emacs).
2. Now the buffer empty lines before and after are deleted (like in Emacs).

[kristijanhusak]

There are a lot of duplicate commits. Can you please squash them?

[danilshvalov]

There are a lot of duplicate commits. Can you please squash them?

Done

[kristijanhusak]

We are almost there. Let's just tweak the empty lines thing as I explained in the comment and I think it's good to go.

[kristijanhusak]

Everything looks great now, thanks!

[kristijanhusak]

@danilshvalov just please rebase from master since there are some conflicts.

[danilshvalov]

@danilshvalov just please rebase from master since there are some conflicts.

Sorry for the long delay. Done

[kristijanhusak]

Thanks!