From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rustom Mody Subject: Re: Some orgtbl doc issues Date: Sat, 31 Aug 2013 11:31:28 +0530 Message-ID: References: <1AA0B1B9-9A50-4289-84BD-F0F1E9E7FAFB@gmail.com> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=047d7b5d33d4255bb104e53813b0 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:58878) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VFeFr-0002Cg-Ms for emacs-orgmode@gnu.org; Sat, 31 Aug 2013 02:01:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VFeFq-0006gx-43 for emacs-orgmode@gnu.org; Sat, 31 Aug 2013 02:01:51 -0400 Received: from mail-ob0-x235.google.com ([2607:f8b0:4003:c01::235]:58289) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VFeFp-0006gt-TG for emacs-orgmode@gnu.org; Sat, 31 Aug 2013 02:01:50 -0400 Received: by mail-ob0-f181.google.com with SMTP id dn14so2747263obc.12 for ; Fri, 30 Aug 2013 23:01:49 -0700 (PDT) In-Reply-To: <1AA0B1B9-9A50-4289-84BD-F0F1E9E7FAFB@gmail.com> 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-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Carsten Dominik , emacs-orgmode --047d7b5d33d4255bb104e53813b0 Content-Type: text/plain; charset=ISO-8859-1 Running just now... will answer in detail later Just want to say for now that this was prompted by a discussion on python list in which a half-dozen people expressed a wish for something like this. Nobody seemed to know/mention org and since I could not work out all the details, Ive not so far answered On Fri, Aug 30, 2013 at 10:16 PM, Carsten Dominik wrote: > Hi Rustom, > > thanks for this. > > On 16.8.2013, at 16:30, Rustom Mody wrote: > > > Ive recently been poking around in orgtbl mode and encountered some > > issues. Not sure how much is my own lack of understanding and how > > much there are some little doc issues. > > > > 1 Option names dont match > > ========================= > > > > - Its orgtbl-radio-table-templates in emacs > > - Its orgtbl-radio-tables in doc Appendix A.6.2 > > Fixed, thanks. > > > > > > > 2 Receiving string > > ================== > > > > - Seems to be "RECEIVE ORGTBL" > > It is BEGIN RECEIVE ORGTBL followed by a table name. As the example in > the manual shows. Does this have to be more explicit? > > > - String seems to be hardwired. Which may be ok if its by design. > > Yes, hardwired by design. > > > - Not clear what is the relation of this string and > > orgtbl-radio-templates > > The templates insert a BEGIN RECEIVE/END RECEIVE table template with > *proper commenting* around it in different programming modes. > I improved this in the docs. > > > - I find 1 space is fixed between RECEIVE and ORGTBL. Multiple > > allowed between ORGTBL and table-name > > OK, I have removed this restriction. > > > - Its not clear from the doc whether its "RECEIVE ORGTBL" or > > "/* RECEIVE ORGTBL" > > That depends on the programming mode. The documentation says that the > lines must be comments in the current mode, I would think that this is > clear enough. > > > - Subtle interaction between # in org and host mode comment char -- # > > in python, shell etc -- could do with some elaboration > > Can you propose something for the documentation? > > > > > > > 3 hook system > > ============= > > > > - What are the hooks for orgtbl? > > - How do the org hooks relate to the orgtbl hooks? > > - Note: orgtbl is for those who are not otherwise using orgmode > > What to you mean? Mode hooks, or hooks for specific functionality of the > table? If table commands run hooks, the corresponding trgtbl commands will > do so as well, because they simply call the table functions in an > environment where the proper keys bindings are not accessible. > > orgtbl-mode is a standard minor mode and has `orgtbl-mode-hook', similar > to all other minor modes. See the documentation of define-minor-mode. Do > you feel the manual should say so? It does not document many other hooks > in org either, because there are too many. > > > > > > 4 Long header line > > ================== > > > > I could not figure out how to split a long > > :#+ORGTBL: SEND... line > > It cannot be split. > > Regards > > - Carsten > > > > > Regards > > Rusi > > > > -- http://www.the-magus.in http://blog.languager.org --047d7b5d33d4255bb104e53813b0 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable
Running just now... will answer in detail later<= br>
Just want to say for now that this was prompted by a discussion on= python list in which a half-dozen people expressed a wish for something li= ke this.
Nobody seemed to know/mention org and since I could not work out all = the details, Ive not so far answered

On Fri, Aug 30, 2013 at 10:16 PM, Carsten = Dominik <carsten.dominik@gmail.com> wrote:
Hi Rustom,

thanks for this.

On 16.8.2013, at 16:30, Rustom Mody <rustompmody@gmail.com> wrote:

> Ive recently been poking around in orgtbl mode and encountered some > issues. =A0Not sure how much is my own lack of understanding and how > much there are some little doc issues.
>
> 1 Option names dont match
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D
>
> =A0- Its orgtbl-radio-table-templates in emacs
> =A0- Its orgtbl-radio-tables in doc Appendix A.6.2

Fixed, thanks.

>
>
> 2 Receiving string
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>
> =A0- Seems to be "RECEIVE ORGTBL"

It is BEGIN RECEIVE ORGTBL followed by a table name. =A0As the exampl= e in the manual shows. =A0Does this have to be more explicit?

> =A0- String seems to be hardwired. Which may be ok if its by design.
Yes, hardwired by design.

> =A0- Not clear what is the relation of this string and
> =A0 =A0orgtbl-radio-templates

The templates insert a BEGIN RECEIVE/END RECEIVE table template with<= br> *proper commenting* around it in different programming modes.
I improved this in the docs.

> =A0- I find 1 space is fixed between RECEIVE and ORGTBL. Multiple
> allowed between ORGTBL and table-name

OK, I have removed this restriction.

> =A0- Its not clear from the doc whether its "RECEIVE ORGTBL"= or
> =A0"/* RECEIVE ORGTBL"

That depends on the programming mode. =A0The documentation says that = the lines must be comments in the current mode, I would think that this is = clear enough.

> =A0- Subtle interaction between # in org and host mode comment char --= #
> =A0 =A0in python, shell etc -- could do with some elaboration

Can you propose something for the documentation?

>
>
> 3 hook system
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>
> =A0- What are the hooks for orgtbl?
> =A0- How do the org hooks relate to the orgtbl hooks?
> =A0- Note: orgtbl is for those who are not otherwise using orgmode

What to you mean? =A0Mode hooks, or hooks for specific functionality = of the table? =A0If table commands run hooks, the corresponding trgtbl comm= ands will do so as well, because they simply call the table functions in an= environment where the proper keys bindings are not accessible.

orgtbl-mode is a standard minor mode and has `orgtbl-mode-hook', simila= r to all other minor modes. =A0See the documentation of define-minor-mode. = =A0Do you feel the manual should say so? =A0It does not document many other= hooks in org either, because there are too many.


>
> 4 Long header line
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>
> =A0I could not figure out how to split a long
> =A0:#+ORGTBL: SEND... =A0line

It cannot be split.

Regards

- Carsten

>
> Regards
> Rusi
>




--
http://www.the-magus.in
http://blog.languager.org
--047d7b5d33d4255bb104e53813b0--