emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Damien Cassou <damien@cassou.me>
To: emacs-orgmode@gnu.org
Subject: Need for dedicated kinds of paragraphs
Date: Mon, 17 Oct 2022 08:52:24 +0200	[thread overview]
Message-ID: <8735bn2b87.fsf@cassou.me> (raw)

Hi,

I'm implementing an odt-based exporter for a French magazine named
GNU/Linux Magazine.  This magazine defines several kinds of boxes, which
are small paragraphs of a certain type among "Default", "Attention",
"Warning" and "PAO". When published, the magazine will change the
background of these boxes depending on the type (e.g., using red color
for warning boxes).

I'm not sure what kind of markup to use nor how to transcode that
markup. I tried with:

    #+BOX: attention
    This text will appear with a red background

Does that make sense? Do you have a better suggestion?

From Worg's org-syntax.html file [1], I understand that this is an
"affiliated keyword" and that it must be declared in
`org-element-affiliated-keywords' but this variable is a `defconst' so
I'm reluctant to change it in my exporter.

I have an `ox-linuxmag--paragraph' transcoder for the `paragraph' type
but I don't know how to get the value of the "BOX" keyword.

Do you have any suggestion?

If I have a look at how org-odt transcodes paragraphs, I see this
function:

    (defun org-odt-paragraph (paragraph contents info)
      "Transcode a PARAGRAPH element from Org to ODT.
    CONTENTS is the contents of the paragraph, as a string.  INFO is
    the plist used as a communication channel."
      (org-odt--format-paragraph
       paragraph contents info
       (or (org-element-property :style paragraph) "Text_20_body")
       "OrgCenter"
       "Quotations"))

Could I use the :style property? What would the markup be like to make
that work?

Thank you so much for Org!

[1] https://orgmode.org/worg/dev/org-syntax.html#Affiliated_Keywords

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

next             reply	other threads:[~2022-10-17  7:01 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-17  6:52 Damien Cassou [this message]
2022-10-17  7:25 ` Need for dedicated kinds of paragraphs Sébastien Miquel
2022-10-17 18:44   ` Damien Cassou
2022-10-17  8:16 ` Fraga, Eric
2022-10-17 11:33 ` Ihor Radchenko
2022-10-17 11:37 ` Max Nikulin

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=8735bn2b87.fsf@cassou.me \
    --to=damien@cassou.me \
    --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

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).