From: John Hendy <jw.hendy@gmail.com>
To: Bastien <bzg@altern.org>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Spelled out example of org-latex-format-headline-function customization?
Date: Tue, 19 Mar 2013 11:18:37 -0500 [thread overview]
Message-ID: <CA+M2ft_=Vau46G97tnkkBrbDY8wwRUTSdSHLDBRoMexH0sk24A@mail.gmail.com> (raw)
In-Reply-To: <871ubbs80b.fsf@bzg.ath.cx>
On Tue, Mar 19, 2013 at 10:51 AM, Bastien <bzg@altern.org> wrote:
> Hi John,
>
> John Hendy <jw.hendy@gmail.com> 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.
<snip>
>> That didn't work.
>
> You need to
>
> 1) define a new function
<snip>
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
next prev parent reply other threads:[~2013-03-19 16:18 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-19 2:56 Spelled out example of org-latex-format-headline-function customization? John Hendy
2013-03-19 15:51 ` Bastien
2013-03-19 16:18 ` John Hendy [this message]
2013-03-19 16:30 ` Charles Berry
2013-03-19 16:37 ` 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='CA+M2ft_=Vau46G97tnkkBrbDY8wwRUTSdSHLDBRoMexH0sk24A@mail.gmail.com' \
--to=jw.hendy@gmail.com \
--cc=bzg@altern.org \
--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).