From mboxrd@z Thu Jan 1 00:00:00 1970 From: John Hendy Subject: Re: Spelled out example of org-latex-format-headline-function customization? Date: Tue, 19 Mar 2013 11:18:37 -0500 Message-ID: References: <871ubbs80b.fsf@bzg.ath.cx> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Return-path: Received: from eggs.gnu.org ([208.118.235.92]:42194) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UHzFI-0006Av-Qg for emacs-orgmode@gnu.org; Tue, 19 Mar 2013 12:18:42 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UHzFH-0006s6-6n for emacs-orgmode@gnu.org; Tue, 19 Mar 2013 12:18:40 -0400 Received: from mail-la0-x230.google.com ([2a00:1450:4010:c03::230]:59417) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UHzFG-0006rq-VI for emacs-orgmode@gnu.org; Tue, 19 Mar 2013 12:18:39 -0400 Received: by mail-la0-f48.google.com with SMTP id fq13so1282164lab.35 for ; Tue, 19 Mar 2013 09:18:38 -0700 (PDT) In-Reply-To: <871ubbs80b.fsf@bzg.ath.cx> 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: Bastien Cc: emacs-orgmode On Tue, Mar 19, 2013 at 10:51 AM, Bastien wrote: > Hi John, > > John Hendy writes: > >> Am I missing the "docstring" (not sure what that is). > > The "docstring" is the documentation string attached to a > function/command or a variable/option. > > C-h v org-latex-format-headline-function RET > > will show you the docstring of the variable. So the docstring is just the documentation definition? (In this case "Documentation: Function for formatting the headline's text..."?) > > C-h f org-latex-format-headline-default-function RET > > will show you the docstring of the function. And in this case: "(org-latex-format-headline-default-function TODO TODO-TYPE PRIORITY TEXT TAGS)"? > >> I think it would >> be wonderful to simply spell out what >> =org-latex-format-headline-default-function= *is* in plain language, >> in the customize buffer. >> >> ETA: perhaps the plain language docstring used to be there, but was >> then replaced with a function? >> - http://lists.gnu.org/archive/html/emacs-orgmode/2013-02/msg01306.html > > Yes, that's the case. Got it. So the docstring is of no use unless you know how to write the function from scratch. >> That didn't work. > > You need to > > 1) define a new function Sounds good and this was Nick's instruction as well. Thanks for the assistance! > > That's actually an area where I think we should make things simple. > Nicolas and I have been exchanging a few ideas, but nothing stable > emerges yet. > Good to know. It seems that variables *could* be passed to the format function. After all, the function takes five arguments which are all either strings or nil... so it would seem that one could have a variable like: (setq org-latex-headline-format ("string" "string" "string" "string" "string")) which would feed into the default-headline-function function. Or splitting out into separate variables. Seems like the tension is between minimizing locations to make all of these settings and ease of use (for noobs). Thanks for all the efforts! John > Best, > > -- > Bastien