emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: emacs-orgmode@gnu.org
Subject: Re: [RFC] [PATCH] ox-latex: support :float no with caption for minted listings
Date: Sun, 24 Aug 2014 21:54:21 +0200	[thread overview]
Message-ID: <87tx514qaa.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87d2bqpvgr.fsf@gmail.com> (Aaron Ecay's message of "Sat, 23 Aug 2014 20:44:36 -0400")

Hello,

Aaron Ecay <aaronecay@gmail.com> writes:

> Why is the compatibility=false option needed?  I can’t figure this
> out.

This is in my local copy of the minted manual, in "7 Known issues". It
may be outdated, though.

> “Pretty” source code export in all cases requires adding certain packages
> to the default, as explained in the docstring of ‘org-latex-listings’.
> The patch adds discussion of the caption requirement there, so there is
> no “if” about the documentation.
>
> I don’t understand what you’re saying about introducing “support” for
> the caption package.  The patch uses one specific feature of the caption
> package in one specific place to accomplish one specific goal.  There
> are no other changes needed anywhere else in the codebase than these
> couple of lines in one function (plus the documentation).

With your patch latex back-end can produce "\captionof" macros. This is
what I call (partial) "support" from Org: knowing the macro.

Again, using this macro is an error in the default configuration.
Besides not doing using it at all, there are usually two ways to solve
the problem:

  1. Add the package in the default package list, so the combination
     still works out of the box for anyone. E.g., `rotating' package.
     Use with care, more packages is a higher risk of incompatibilites
     between them. The lighter counterpart of `caption' package may be
     safe though.

     OTOH, once the package is in the default package list, it can be
     used everywhere in the back-end. This can be an advantage if there
     are several places that could use \captionof.

  2. Suggest, through docstring or manual, to the user to require
     a specific package if he wants to benefit from the feature. E.g.,
     `booktabs'.

     Usually, the situation makes it obvious that such a package is
     required (e.g. ":environment longtabu" or ":booktabs t").
     Unfortunately, this is not the case here. Under some
     circumstances, :float nil needs `caption' (or its lighter
     counterpart). I find it a bit too magical.

     Note there is also :caption attribute which is used in tables and
     special blocks, but not in source blocks, which may come handy
     here.


WDYT?


Regards,

-- 
Nicolas Goaziou

  parent reply	other threads:[~2014-08-24 19:54 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-23  7:36 [RFC] [PATCH] ox-latex: support :float no with caption for minted listings Aaron Ecay
2014-08-23 19:47 ` Nicolas Goaziou
2014-08-23 20:27   ` Aaron Ecay
2014-08-23 23:56     ` Nicolas Goaziou
2014-08-24  0:44       ` Aaron Ecay
2014-08-24  6:51         ` Nicolas Richard
2014-08-24 19:54         ` Nicolas Goaziou [this message]
2014-08-28  5:03           ` Aaron Ecay
2014-08-28  9:19             ` Nicolas Goaziou
2014-09-19 19:04               ` Aaron Ecay
2014-09-19 20:13                 ` Nicolas Goaziou
2014-09-23  3:09                   ` Aaron Ecay
2014-09-23 19:48                     ` Nicolas Goaziou
2014-09-28  4:07                       ` Aaron Ecay
2014-09-28  7:09                         ` Nicolas Goaziou
2014-09-28 12:00                         ` Rasmus

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=87tx514qaa.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --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).