Comments in VO

[noelhenson]

There are times when I would like to put comments in my outlines that I don't want seen by post-processors like otl2html and otl2tags. Currently I work around the issue by choosing something like '[[[' or '\' or 'XX' and use 'grep -v' to skip those lines. It has also come up over the years that it would be nice to be able to add some kind of additional formatting information to certain headings and/or body texts. And now we have the conceal functionality (TY, Vince!) included by default. So...

How do you mark up your outlines with comments?
Should we add a spec to the VO files specification for a specific type of syntax for comments or other 'hidden' types of format information (character styles?)?

The following example is not an assertion of what we should do. It is just an example of what is doable.
Heading blah blah {{{ hidden comment and or formattion information }}}
subheading
subheading {{{ more hidden/ignored stuff }}}
{{{ Hidden Heading and branch
subheading that is hidden/ignored
subheading that is hidden/ignored

Concealing could hide them most of the time. Post-processors could be easily modified to ignore or even make use of the information in them.

Again, this is just something to think about. So, thoughts?

[jostber]

On 16.10.14,18:54, Noel Henson wrote:

There are times when I would like to put comments in my outlines that I don't want seen by post-processors like otl2html and otl2tags. Currently I work around the issue by choosing something like '[[[' or '\' or 'XX' and use 'grep -v' to skip those lines. It has also come up over the years that it would be nice to be able to add some kind of additional formatting information to certain headings and/or body texts. And now we have the conceal functionality (TY, Vince!) included by default. So...

How do you mark up your outlines with comments?
Should we add a spec to the VO files specification for a specific type of syntax for comments or other 'hidden' types of format information (character styles?)?

The following example is not an assertion of what we should do. It is just an example of what is doable.
Heading blah blah {{{ hidden comment and or formattion information }}}
subheading
subheading {{{ more hidden/ignored stuff }}}
{{{ Hidden Heading and branch
subheading that is hidden/ignored
subheading that is hidden/ignored

Concealing could hide them most of the time. Post-processors could be easily modified to ignore or even make use of the information in them.

Again, this is just something to think about. So, thoughts?

I use the standard # for comments, but more formatting options might be good
like the Hidden Heading. Could make it more flexible for conversion to other
formats as well.

Jostein

[noelhenson]

On 10/19/2014 05:50 AM, Jostein Berntsen wrote:

On 16.10.14,18:54, Noel Henson wrote:

There are times when I would like to put comments in my outlines
that I don't want seen by post-processors like otl2html and otl2tags.
Currently I work around the issue by choosing something like '[[[' or
'\' or 'XX' and use 'grep -v' to skip those lines. It has also come
up over the years that it would be nice to be able to add some kind of
additional formatting information to certain headings and/or body
texts. And now we have the conceal functionality (TY, Vince!) included
by default. So...

How do you mark up your outlines with comments?
Should we add a spec to the VO files specification for a specific
type of syntax for comments or other 'hidden' types of format
information (character styles?)?

The following example is not an assertion of what we should do. It
is just an example of what is doable.
Heading blah blah {{{ hidden comment and or formattion information }}}
subheading
subheading {{{ more hidden/ignored stuff }}}
{{{ Hidden Heading and branch
subheading that is hidden/ignored
subheading that is hidden/ignored

Concealing could hide them most of the time. Post-processors could
be easily modified to ignore or even make use of the information in them.

Again, this is just something to think about. So, thoughts?

I use the standard # for comments, but more formatting options might
be good
like the Hidden Heading. Could make it more flexible for conversion to
other
formats as well.

Jostein

—
Reply to this email directly or view it on GitHub
#89 (comment).

'#' is good. I like that. I could easily modify otl2html and otl2tags
(and other scripts if they support comments). Should a heading that
starts with '#' cause just itself or it and its descendents to be ignored?

Any other ideas out there?

I am confused, again, by the use of flexible. Do you mean to make the
comment marker configurable? That would be a bit more difficult to
implement in post processing.

-Noel

[mcepl]

@jostber ping?

[jostber]

On 27.09.15,10:32, Matěj Cepl wrote:

@jostber ping?

I believe it was Noel that suggested this earlier this year?

[mcepl]

I believe it was Noel that suggested this earlier this year?

Sure, but he finished with some questions to you?

[jostber]

On 27.09.15,10:40, Matěj Cepl wrote:

I believe it was Noel that suggested this earlier this year?

Sure, but he finished with some questions to you?

I will check this again and send a reply. Thanks.

[jostber]

@noelhenson , have you checked if you can use the # notation for comments here?

[noelhenson]

I have.
s before, post processors can either ignore or have an option to ignore
lines where the first non-whitespace character is '#'. There is no
folding syntax for '#' yet, but it should be pretty easy to add; just
copy one of the other types we have. The conceal syntax would allow for
hiding of the comment itself but unfortunately vim cannot collapse a
fold into 0 lines.

On 09/27/2015 12:48 PM, Jostein Berntsen wrote:

Noel, have you checked if you can use the # notation for comments here?

—
Reply to this email directly or view it on GitHub
#89 (comment).