emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Diego Zamboni <diego@zzamboni.org>
To: Diego Zamboni <diego@zzamboni.org>, Org-mode <emacs-orgmode@gnu.org>
Subject: Re: ox-* vs org-* naming convention?
Date: Mon, 8 Jun 2020 08:57:53 +0200	[thread overview]
Message-ID: <CAGY83Ee-szSvq7zkv7DgP_j-BWPnjC8g00TXZgkTs9QkDsT=-Q@mail.gmail.com> (raw)
In-Reply-To: <87pnaayuf1.fsf@wi.uni-muenster.de>

Hi Kaushal and Jens,

Thanks for your feedback, and also for the idea for the workaround
used in ox-re-reveal - that's a nice one :)

Given the special meanings of both the org- and ox- prefixes, I will
insist on keeping the current naming, and maybe take a stab at coming
up with a PR for https://github.com/purcell/package-lint/issues/89.

Cheers,
--Diego

On Mon, Jun 8, 2020 at 7:54 AM Jens Lechtenboerger
<lechten@wi.uni-muenster.de> wrote:
>
> On 2020-06-07, Diego Zamboni wrote:
>
> > Hi,
> >
> > I am working on submitting a new set of exporters I've been working on
> > (https://gitlab.com/zzamboni/ox-leanpub) to MELPA, and I received
> > feedback [1] about the discrepancy between the package names
> > (ox-leanpub-*) and the functions they define (org-leanpub-*). This is
> > also flagged by =package-lint=.
> >
> > [1] https://github.com/melpa/melpa/pull/6942
> >
> > [...]
> >
> > I would appreciate any feedback about this - what are strong arguments
> > for or against insisting in this convention vs just adapting to the
> > rules suggested by package-lint?
>
> Hi there,
>
> for org-re-reveal, I use a small wrapper ox-re-reveal.el [2], whose
> commentary explains this:
>
> ;; Org export back-ends have file names starting with "ox-".
> ;; However, such files typically define variables and functions
> ;; starting with "org-", which causes errors by package-lint.  To
> ;; define variables and functions with the usual prefix "org-" while
> ;; avoiding errors by package-lint, code is located in
> ;; org-re-reveal.el.
> ;; However, the prefix "ox-" is hard-coded in org.el and used to load
> ;; back-ends in `org-export-backends'.  With this file, you can
> ;; customize `org-export-backends' and add `re-reveal'.  Then, when
> ;; pressing `C-c C-e', this file will be loaded, which loads
> ;; org-re-reveal.el.
>
> Best wishes
> Jens
>
> [2] https://gitlab.com/oer/org-re-reveal/-/blob/master/ox-re-reveal.el


  reply	other threads:[~2020-06-08  6:58 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-07 16:30 Diego Zamboni
2020-06-07 20:53 ` Kaushal Modi
2020-06-08  5:54 ` Jens Lechtenboerger
2020-06-08  6:57   ` Diego Zamboni [this message]
2020-06-09 19:13     ` Diego Zamboni
2020-06-10 16:57       ` Diego Zamboni
2020-06-10 18:00         ` Kaushal Modi
2020-09-03 10:09         ` Bastien

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='CAGY83Ee-szSvq7zkv7DgP_j-BWPnjC8g00TXZgkTs9QkDsT=-Q@mail.gmail.com' \
    --to=diego@zzamboni.org \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: ox-* vs org-* naming convention?' \
    /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 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).