From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kaushal Modi Subject: Name-space prefixes in ox- packages Date: Sat, 09 Sep 2017 12:09:11 +0000 Message-ID: Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="089e082566b062d3d70558c09063" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:34537) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dqeZj-0003Be-EV for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 08:09:28 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dqeZi-0003tT-0V for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 08:09:27 -0400 Received: from mail-yw0-x231.google.com ([2607:f8b0:4002:c05::231]:36574) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dqeZh-0003sK-Px for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 08:09:25 -0400 Received: by mail-yw0-x231.google.com with SMTP id v72so11108926ywa.3 for ; Sat, 09 Sep 2017 05:09:23 -0700 (PDT) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: emacs-org list --089e082566b062d3d70558c09063 Content-Type: text/plain; charset="UTF-8" Hello, I have observed that even though the exporter backend package names begin with ox-, all the variables and functions inside still start with org-. Is there a strong reason to do so? Or was that to prevent the older org-html, etc packages from breaking when they got renamed to ox-html, etc? So the question is if the new export backends should also follow the same convention. This question came up because if the ox- packages follow the convention used in core, they fail the lint check done by an external package called package-lint[1]. The lint checkers expects all variables and functions in a package FOO to have FOO- prefix. Here[2] the discussion on that package's GitHub issue thread. PS: I believe it is the same case with ob- packages. [1]: https://github.com/purcell/package-lint [2]: https://github.com/purcell/package-lint/issues/89 Thanks. -- Kaushal Modi --089e082566b062d3d70558c09063 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hello,

I have observed that even though the exporter bac= kend package names begin with ox-, all the variables and functions inside s= till start with org-.

Is there a strong reason to = do so? Or was that to prevent the older org-html, etc packages from breakin= g when they got renamed to ox-html, etc?

So the qu= estion is if the new export backends should also follow the same convention= .=C2=A0

This question came up because if the ox- p= ackages follow the convention used in core, they fail the lint check done b= y an external package called package-lint[1]. The lint checkers expects all= variables and functions in a package FOO to have FOO- prefix. Here[2] the = discussion on that package's GitHub issue thread.=C2=A0

<= /div>
PS: I believe it is the same case with ob- packages.=C2=A0
<= div>

Thanks.=C2=A0<= /div>
--

Kaushal Modi

--089e082566b062d3d70558c09063-- From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: Name-space prefixes in ox- packages Date: Sat, 09 Sep 2017 15:36:49 +0200 Message-ID: <87zia42du6.fsf@nicolasgoaziou.fr> References: Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:50912) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dqfwN-0001wb-2k for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 09:36:55 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dqfwK-0004dQ-1E for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 09:36:55 -0400 Received: from relay3-d.mail.gandi.net ([217.70.183.195]:40933) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dqfwJ-0004d2-Qq for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 09:36:51 -0400 In-Reply-To: (Kaushal Modi's message of "Sat, 09 Sep 2017 12:09:11 +0000") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Kaushal Modi Cc: emacs-org list Hello, Kaushal Modi writes: > I have observed that even though the exporter backend package names begin > with ox-, all the variables and functions inside still start with org-. > > Is there a strong reason to do so? "ox" stands for "org-export-". This is so to limit file name size. Some systems are very limited (e.g. MS-DOS). Variables and functions should really be "org-export-html..." but that would be very long. The "org" prefix is mandatory for Org variables and functions. "ox" would be misleading. Regards, -- Nicolas Goaziou From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: Name-space prefixes in ox- packages Date: Sun, 10 Sep 2017 09:56:12 +0200 Message-ID: <87377v2dib.fsf@nicolasgoaziou.fr> References: <87zia42du6.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:33606) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dqx6G-0008IV-If for emacs-orgmode@gnu.org; Sun, 10 Sep 2017 03:56:17 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dqx6F-0007Pw-MP for emacs-orgmode@gnu.org; Sun, 10 Sep 2017 03:56:16 -0400 Received: from relay2-d.mail.gandi.net ([2001:4b98:c:538::194]:50030) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dqx6F-0007MT-F6 for emacs-orgmode@gnu.org; Sun, 10 Sep 2017 03:56:15 -0400 In-Reply-To: (Kaushal Modi's message of "Sun, 10 Sep 2017 03:19:28 +0000") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Kaushal Modi Cc: emacs-org list Hello, Kaushal Modi writes: > On Sat, Sep 9, 2017 at 9:36 AM Nicolas Goaziou > wrote: > >> >> "ox" stands for "org-export-". This is so to limit file name size. Some >> systems are very limited (e.g. MS-DOS). >> > > Is that file name size that important in today's time? For some Emacs developers, it is. If Emacs drops MS-DOS support, we can reconsider this. I doubt this is going to happen any time soon. >> Variables and functions should really be "org-export-html..." but that >> would be very long. The "org" prefix is mandatory for Org variables and >> functions. "ox" would be misleading. >> > > Does this have to do with org-export--generate-copy-script (as discussed > here[1])? I don't think so. > Is the prefix requirement for "org-" more widespread than that? IIRC, it is an Emacs convention. Variables should be prefixed by the major mode's name, since Emacs has no proper namespace. Regards, -- Nicolas Goaziou 0x80A93738 From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kaushal Modi Subject: Re: Name-space prefixes in ox- packages Date: Sun, 10 Sep 2017 03:19:28 +0000 Message-ID: References: <87zia42du6.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="089e0828d2c0d635480558cd47a4" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:49438) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dqsmc-0006OA-Cg for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 23:19:43 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dqsmb-0004Ba-Cu for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 23:19:42 -0400 Received: from mail-yw0-x232.google.com ([2607:f8b0:4002:c05::232]:36118) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dqsmb-0004Au-6K for emacs-orgmode@gnu.org; Sat, 09 Sep 2017 23:19:41 -0400 Received: by mail-yw0-x232.google.com with SMTP id v72so13381363ywa.3 for ; Sat, 09 Sep 2017 20:19:41 -0700 (PDT) In-Reply-To: <87zia42du6.fsf@nicolasgoaziou.fr> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Nicolas Goaziou Cc: emacs-org list --089e0828d2c0d635480558cd47a4 Content-Type: text/plain; charset="UTF-8" On Sat, Sep 9, 2017 at 9:36 AM Nicolas Goaziou wrote: > > "ox" stands for "org-export-". This is so to limit file name size. Some > systems are very limited (e.g. MS-DOS). > Is that file name size that important in today's time? I'd be surprised if anyone using Org is using MS-DOS. But regardless, the "ox-" prefix definitely looks better than "org-export-". > Variables and functions should really be "org-export-html..." but that > would be very long. The "org" prefix is mandatory for Org variables and > functions. "ox" would be misleading. > Does this have to do with org-export--generate-copy-script (as discussed here[1])? Is the prefix requirement for "org-" more widespread than that? [1]: http://lists.gnu.org/archive/html/emacs-orgmode/2016-05/msg00231.html -- Kaushal Modi --089e0828d2c0d635480558cd47a4 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
On Sat, Sep 9,= 2017 at 9:36 AM Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:

"ox" stands for "org-export-". This is so to limit file= name size. Some
systems are very limited (e.g. MS-DOS).

Is that file name size that important in today's time? I'd be surp= rised if anyone using Org is using MS-DOS. But regardless, the "ox-&qu= ot; prefix definitely looks better than "org-export-".
= =C2=A0
Variables and functions should r= eally be "org-export-html..." but that
would be very long. The "org" prefix is mandatory for Org variabl= es and
functions. "ox" would be misleading.

Does this have to do with org-export--generate-copy-script (as disc= ussed here[1])? Is the prefix requirement for "org-" more widespr= ead than that?=C2=A0

<= /div>
--

Kaushal Modi

--089e0828d2c0d635480558cd47a4--