emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Adam Porter <adam@alphapapa.net>
To: Ihor Radchenko <yantar92@posteo.net>, JD Smith <jdtsmith@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Better support admonitions blocks
Date: Thu, 4 Apr 2024 16:35:22 -0500	[thread overview]
Message-ID: <43e995d0-9a92-4be7-8c88-59ffbc234ac8@alphapapa.net> (raw)
In-Reply-To: <87r0flt5xs.fsf@localhost>

Hi Ihor, JD, et al,

On 4/4/24 12:04, Ihor Radchenko wrote:
> JD Smith <jdtsmith@gmail.com> writes:
> 
>> Pandoc recently added read/write support
>> <https://github.com/jgm/pandoc/issues/9475> for "admonitions",
>> which are a GFM construct
>> <https://github.com/orgs/community/discussions/16925> already
>> supported by other org-exporters, and on GH in markdown.  This
>> refcard
>> <https://github.com/fniessen/refcard-org-mode?tab=readme-ov-file#base-admonitions>
>> references an org #{begin,end}_{note,warning,tip,caution,important}
>> syntax which pandoc now follows (though it does not support the
>> extra admonitions like danger/error/etc.).
>> 
>> It would be nice to add org support for these 5 admonition blocks
>> to the C-c C-, org block structure templates, and perhaps allow
>> block face styling for these as well (ala org-src-block-faces).
> 
> CCing Adam. We recently discussed "highlight" blocks in the context
> of WORG publishing.

Thanks.

> I do not see much problem adding such blocks, although I am not sure
> if we want them by default.

I would tend to agree that they probably shouldn't be part of Org's
default configuration (at least, not yet--if they were to become very
widespread in usage, then maybe we could reconsider).

> What we may do is to implement something akin link's :export and 
> :active-func parameters to allow custom fontification and export. 
> (... and add a new :structure-template parameter to auto-add them to 
> structure templates)
> 
> Then, we can add optional support for all the proposed blocks that
> will define how to insert, export, and fontify them.

That would seem good to me.

As far as Worg goes, I'd be in favor of having them available on Worg by 
default; they should be useful for writing documentation.

Thanks,
Adam


      reply	other threads:[~2024-04-04 21:36 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-04 14:04 Better support admonitions blocks JD Smith
2024-04-04 17:04 ` Ihor Radchenko
2024-04-04 21:35   ` Adam Porter [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=43e995d0-9a92-4be7-8c88-59ffbc234ac8@alphapapa.net \
    --to=adam@alphapapa.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=jdtsmith@gmail.com \
    --cc=yantar92@posteo.net \
    /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).