From: Eric Schulte <schulte.eric@gmail.com>
To: Nicolas Goaziou <n.goaziou@gmail.com>
Cc: Christian Wittern <cwittern@gmail.com>,
emacs-orgmode@gnu.org, Eric Schulte <schulte.eric@gmail.com>
Subject: Re: Should comments break paragraphs?
Date: Wed, 17 Jul 2013 06:54:28 -0600 [thread overview]
Message-ID: <871u6xmjnf.fsf@gmail.com> (raw)
In-Reply-To: <87sizexuj9.fsf@gmail.com> (Nicolas Goaziou's message of "Tue, 16 Jul 2013 19:51:38 +0200")
Nicolas Goaziou <n.goaziou@gmail.com> writes:
> Eric Schulte <schulte.eric@gmail.com> writes:
>
>> So are you proposing to remove comments from Org-mode entirely?
>
> Certainly not.
>
Great, then I think we're much closer together on this than I originally
thought.
>
> I'm on the "good enough" side and I simply suggest to live with it.
> Also, if you badly need inline comments, there's the empty "comment"
> macro:
>
> #+MACRO: comment
>
> Some text {{{comment(This is my comment)}}} and some more.
>
I'm not suggesting adding inline comments, only that comment lines be
treated as "" instead of "\n".
>
>> But if we treat comments as semantically empty, then maybe they should
>> be ignored by the parser?
>
> Yes, we can ignore them at the parser level. But what about the rest of
> Org? There are many places that do not rely on the parser and do not
> ignore comments (lists being an example, agenda being another one, and
> I'm pretty sure comments at some locations can break Babel too).
>
> Something could be done, but again, it would certainly not be
> a one-liner in org-element.el or ox.el.
>
I'm happy to work to fix places where babel is breaking comments.
>
>>> Even if you move it to ox.el, this is not an acceptable solution. Think
>>> about the following example
>>>
>>> - item 1
>>>
>>> # with a comment
>>>
>>> - item 2
>>>
>>> If you simply delete matching lines, you break the list.
>>>
>>
>> Yes, I would argue that this list should be broken, because with or
>> without the comment the items are separated by two blank lines.
>
> On the other hand, visually, this list looks perfectly correct.
>
>> In my opinion comments as semantically empty lines is a simple rule
>> for both users and parsers to understand.
>
> Comments are already almost semantically empty lines. That's why:
>
> Text
> # Comment
> Other Text
>
> generates two paragraphs in Org (and in every back-end excepted `latex',
> but that's a different problem). They basically act as a paragraph
> separator, much like blank lines.
>
> Also, note that if they really are empty lines, they cannot be inlined
> within paragraphs either.
>
Sorry I was unclear, see above, by "semantically empty" I meant
replacing comment lines with "" instead of the current behavior (except
in the latex exporter) which replaces them with "\n".
Cheers,
>
>
> Regards,
--
Eric Schulte
http://cs.unm.edu/~eschulte
next prev parent reply other threads:[~2013-07-17 12:56 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-15 18:48 Should comments break paragraphs? Kodi Arfer
2013-07-15 18:54 ` Nicolas Goaziou
2013-07-15 22:46 ` Christian Wittern
2013-07-16 6:53 ` Rainer M Krug
2013-07-16 6:59 ` Nicolas Goaziou
2013-07-16 7:09 ` Rainer M Krug
2013-07-16 7:40 ` Nicolas Goaziou
2013-07-16 8:09 ` Rainer M Krug
2013-07-16 8:19 ` Andreas Leha
2013-07-16 8:44 ` Nicolas Goaziou
2013-07-16 8:55 ` Andreas Leha
2013-07-16 17:08 ` Eric S Fraga
2013-07-16 8:26 ` Nicolas Goaziou
2013-07-16 8:21 ` Fabrice Popineau
2013-07-16 8:27 ` Fabrice Popineau
2013-07-16 15:46 ` Eric Schulte
2013-07-16 16:01 ` Nicolas Goaziou
2013-07-16 16:59 ` Eric Schulte
2013-07-16 17:51 ` Nicolas Goaziou
2013-07-17 5:28 ` Bastien
2013-07-17 7:17 ` Nicolas Goaziou
2013-07-17 8:15 ` Bastien
2013-07-17 9:00 ` Nicolas Goaziou
2013-07-17 12:57 ` Bastien
2013-07-17 13:21 ` Rainer M Krug
2013-07-17 13:52 ` Rasmus
2013-07-17 16:10 ` Eric S Fraga
2013-07-18 7:02 ` Christian Moe
2013-07-18 8:31 ` Eric Abrahamsen
2013-07-18 8:50 ` Rasmus
2013-07-18 9:50 ` Eric Abrahamsen
2013-07-18 8:47 ` Rasmus
2013-07-17 13:28 ` Eric Schulte
2013-07-17 14:30 ` Bastien
2013-07-17 13:47 ` Nicolas Goaziou
2013-07-17 18:48 ` Eric S Fraga
2013-07-17 19:04 ` Nicolas Goaziou
2013-07-17 20:18 ` Eric S Fraga
2013-07-17 7:11 ` Suvayu Ali
2013-07-17 12:54 ` Eric Schulte [this message]
2013-07-17 13:52 ` Nicolas Goaziou
2013-07-17 22:05 ` Andreas Leha
2013-07-17 22:11 ` Eric Schulte
2013-07-17 22:34 ` Andreas Leha
2013-07-18 11:23 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871u6xmjnf.fsf@gmail.com \
--to=schulte.eric@gmail.com \
--cc=cwittern@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=n.goaziou@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.