From: "Berry, Charles" <ccberry@health.ucsd.edu>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: "Juan Manuel Macías" <maciaschain@posteo.net>,
orgmode <emacs-orgmode@gnu.org>
Subject: Re: Way to mark contents of an Org special block as verbatim?
Date: Sun, 9 Jan 2022 03:01:13 +0000 [thread overview]
Message-ID: <561D83E2-47BF-4AC2-B2AD-24B08D614845@health.ucsd.edu> (raw)
In-Reply-To: <CAFyQvY1UhuV9qZA_f9W=_dgusxgFOfg+P2GH95yvBd_2FueUUQ@mail.gmail.com>
> On Jan 8, 2022, at 3:29 PM, Kaushal Modi <kaushal.modi@gmail.com> wrote:
>
>> What am I missing?
>>
>> It seems like you want your derived backend to transcode special blocks somewhat differently than the parent backend. And adding a special block export filter doesn't quite do the job.
>
> I tried out the example Juan posted and it works perfectly well. But
> it would require to user to do something similar for each arbitrary
> new special block they need. E.g. #+being_katex, #+begin_tikz,
> #+begin_tikzjax (could be anything!) where the content needs to be
> kept unmodified.
>
Right, so maybe use `(member type <list of accepted types>)' rather than '(equals type "newlatex")' in the3 example below.
>> For that purpose, you should write a special block transcoder - perhaps falling back to the parent backend for block types you do not wish to handle as described above.
>
> Can you please point me to an example?
>
A simple one here:
#+begin_src emacs-lisp
;; minimal backend with latex parent
(org-export-define-derived-backend 'newlatex 'latex
:translate-alist
'((special-block . org-newlatex-special-block)))
;; special block transcoder
(defun org-newlatex-special-block (special-block contents info)
"Newlatex special block transcoder."
(let
((type (org-element-property :type special-block)))
(if (equal type "newlatex")
(format "{{<FOO>}}\n%s{{<//FOO>}}\n" contents)
;; not `newlatex` so default to latex transcoder
(org-export-with-backend 'latex special-block contents info))))
#+end_src
Eval the above, then use this as an example by copying the following
src block to an org buffer and entering
M-; (org-export-to-buffer 'newlatex "*Org NEW LATEX Export*" nil nil nil t) RET
#+begin_src org
,#+begin_newlatex
This is the new content
,#+end_newlatex
,#+attr_latex: :caption \MyCaption{HeadingA}
,#+BEGIN_proof
dot-dot-dot
,#+END_proof
#+end_src
I get an *Org NEW LATEX Export* buffer like this:
#+begin_example
{{<FOO>}}
This is the new content
{{<//FOO>}}
\begin{proof}
dot-dot-dot
\MyCaption{HeadingA}
\end{proof}
#+end_example
>> Block specific customizations could rely on a backend specific attribute.
>
> Yes, I am doing block-specific customization (like support
> #+attr_shortcode above special blocks here[1]). But I don't know how
> to get back the original content of the special block because the
> `contents` arg received by the exporter's org-hugo-special-block
> already has the Org entities, and sub/super replacements done.
>
> [1]: https://urldefense.com/v3/__https://github.com/kaushalmodi/ox-hugo/blob/458142675bb5a0e7ee26ecea07d75c10aa52184b/ox-hugo.el*L2872__;Iw!!LLK065n_VXAQ!xZhh--YwGpo06BbAHLF_A2MY_4mk4gBxHgFG3InZakP_7mdFDpyBNMgqvDVvBimzWQ$
next prev parent reply other threads:[~2022-01-09 3:02 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-06 17:00 Way to mark contents of an Org special block as verbatim? Kaushal Modi
2022-01-06 18:27 ` Juan Manuel Macías
2022-01-06 19:14 ` Kaushal Modi
2022-01-06 19:33 ` Juan Manuel Macías
2022-01-06 19:46 ` Kaushal Modi
2022-01-08 21:52 ` Berry, Charles
2022-01-08 23:29 ` Kaushal Modi
2022-01-09 3:01 ` Berry, Charles [this message]
2022-01-09 4:03 ` Kaushal Modi
2022-01-09 16:58 ` Kaushal Modi
2022-01-09 19:57 ` Berry, Charles
2022-01-09 20:01 ` Nicolas Goaziou
2022-01-09 21:53 ` Kaushal Modi
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=561D83E2-47BF-4AC2-B2AD-24B08D614845@health.ucsd.edu \
--to=ccberry@health.ucsd.edu \
--cc=emacs-orgmode@gnu.org \
--cc=kaushal.modi@gmail.com \
--cc=maciaschain@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).