emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <n.goaziou@gmail.com>
To: Eric Schulte <schulte.eric@gmail.com>
Cc: Christian Wittern <cwittern@gmail.com>, emacs-orgmode@gnu.org
Subject: Re: Should comments break paragraphs?
Date: Tue, 16 Jul 2013 18:01:12 +0200	[thread overview]
Message-ID: <87wqoqxznb.fsf@gmail.com> (raw)
In-Reply-To: <87fvvev771.fsf@gmail.com> (Eric Schulte's message of "Tue, 16 Jul 2013 09:46:26 -0600")

Hello,

Eric Schulte <schulte.eric@gmail.com> writes:

> When Org-mode is used as a document preparation language inline comments
> are very useful.  The use case being notes on the surrounding material
> which are not to be published.  Both HTML and LaTeX support comments and
> at least in LaTeX they are extensively used (in my experience) and can
> be very helpful.

Again, Org is neither LaTeX nor HTML.

> Stripping lines starting with "^ *#[^+]" is a trivial pre-processing
> step, and would support the traditional Org-mode comments which (as I
> recall) could previously appear mid paragraph without causing
> problems.

> The attached patch worked on some small example files for me.

As I explained in a previous post, it's only a kludge hiding the real
problem: comments cannot appear anywhere, even if we don't take export
into account. Actually, handling comments during export is the easiest
part of the problem.

> From ce4c30ebe56d4cd66810bca48824d8841e7b130d Mon Sep 17 00:00:00 2001
> From: Eric Schulte <schulte.eric@gmail.com>
> Date: Tue, 16 Jul 2013 09:44:59 -0600
> Subject: [PATCH] support inline comments w/o breaking paragraphs
>
> * lisp/org-element.el (org-element-parse-buffer): Strip inline comments
>   as a pre-processing step before exporting.

The parser is unrelated to the export process, so export pre-processing
shouldn't happen in org-element.el. Also, parsing a buffer mustn't
modify it in the process.

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.


Regards,

-- 
Nicolas Goaziou

  reply	other threads:[~2013-07-16 16:01 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 [this message]
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
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

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wqoqxznb.fsf@gmail.com \
    --to=n.goaziou@gmail.com \
    --cc=cwittern@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=schulte.eric@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 public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).