emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Comments break up a paragraph when writing one-setence-per-line
Date: Sun, 3 Oct 2021 18:34:10 +0700	[thread overview]
Message-ID: <sjc4fk$76r$1@ciao.gmane.io> (raw)
In-Reply-To: <CA+G3_POOAg=DcxDWUHw6NOA3eSqUqaPGFSN7HPNLyvVCfWeL1g@mail.gmail.com>

On 03/10/2021 00:57, Tom Gillespie wrote:
> A general comment (heh) here. This is not a bug and not easily fixed.
> Line comments are their own top level element distinct from
> paragraphs. If you need something that fits in a paragraph you can use
> @@comment:@@ at the start of a line.
> 
> I agree that it is annoying, but Org line comment syntax also only
> works if it starts the line, so the behavior diverges from traditional
> code comments. It may make sense to update the docs to call them "line
> comments" instead of just comments.

Agree, if parser is not changed, I suppose, the manual and the guide 
should state very prominent that comment line disrupts current paragraph 
unlike "%" in TeX.

However there 5 users in this thread who expect that "# " or "#+latex:" 
should not be "element" and should be a part of surrounding paragraph.

Thank you for the idea with @@comment:@@, let me stress that final @@ 
should be on the next line. It is similar to my idea with a macro 
expanding to nothing. It may be documented in the manual. However I 
would expect that `org-lint' issues a warning concerning unknown 
backends to catch typos in names. By the way, `org-lint' does not like 
the variant with comment as macro.

I think, it is a bug in LaTeX backend that the following becomes 3 
separate paragraphs:

    #+macro: comment
    Beginning of a paragraph A.
    @@comment: FIXME@@
    Paragraph A continues.
    {{{comment(TODO)}}}
    End of paragraph A.

And the following is really confusing:

    How many paragraphs
    #+html: <!-- comment -->
    is here
    #+latex: %
    in LaTeX and HTML output?

LaTeX backend exports it as a continuous paragraph (an idea of a weird 
hack how to comment a line if only LaTeX export is needed). HTML backend 
believes that it is 3 paragraphs.



      reply	other threads:[~2021-10-03 11:36 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-16 16:06 Comments break up a paragraph when writing one-setence-per-line William Denton
2021-07-16 16:34 ` Bruce D'Arcus
2021-07-16 18:10   ` Kaushal Modi
2021-07-17  1:50     ` Samuel Wales
2021-07-18  8:21 ` Maxim Nikulin
2021-07-19 14:03 ` Eric S Fraga
2021-07-21 14:48   ` Maxim Nikulin
2021-07-21 15:22     ` Eric S Fraga
2021-07-21 16:13       ` Maxim Nikulin
2021-10-02 17:57         ` Tom Gillespie
2021-10-03 11:34           ` Max Nikulin [this message]

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='sjc4fk$76r$1@ciao.gmane.io' \
    --to=manikulin@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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).