From: Mark Elston <m_elston@comcast.net>
To: org-mode emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Hook Function Examples
Date: Sun, 24 Jan 2010 22:21:21 -0800 [thread overview]
Message-ID: <4B5D3861.400@comcast.net> (raw)
In-Reply-To: <2417.1264397075@gamaville.dokosmarshall.org>
On 1/24/2010 9:24 PM, Nick Dokos wrote:
> Mark Elston<m_elston@comcast.net> wrote:
>
>> I am trying to make use of some of the hooks for exporting and haven't
>> found any docs about what they take or how to make use of them (elisp
>> is *not* my native language).
>>
>
> The Emacs Lisp Reference manual has a section (23.1: Hooks) on hooks,
> but I'm not sure how helpful it will be to you. The most important note
> is that "normal" hook variables are, by convention, named
> <foo>-hook. "normal" means that the functions that are added to the hook
> take no arguments and return no useful values.
>
>> In particular, I am trying to figure out how to use the following
>> to see if any of them are going to help me:
>>
>> org-export-preprocess-hook
>> org-export-preprocess-after-tree-selection-hook
>> org-export-preprocess-final-hook
>>
>> Any examples of a hook function for these would help a lot. In
>> particular, what are the parameters, is the point "looking at"
>> anything in particular, etc.
>>
>
> Use the source, Luke! (erm... Mark!)
>
> C-h v org-export-preprocess-hook<RET>
>
> gives me:
>
> (org-export-blocks-preprocess)
>
Thanks, Nick. I had checked a few hooks (but not that one) and
couldn't find any that had any functions assigned.
> so we have here an example of a hook function!
>
> C-h f org-export-blocks-preprocess<RET>
>
> gives you the function's doc string, including a link to where it is
> defined, and clicking on the link will take you to the function: no
> params (it is a "normal" hook after all), and I think you can make no
> assumptions about the context. In particular, the above function wraps
> everything in a save-excursion, goes to the beginning of the buffer and
> searches for interesting things, doing something on each interesting
> thing it finds.
OK. From what I read I am assuming that a buffer is created with some
already-processed (though not completely) org data as its initial
content. Then, at some point, these hook functions are called on this
new buffer. I assume this is the case since you wouldn't want to go
modifying the original buffer - though this is not stated anywhere that
I can find.
Some hook functions apparently *do* take parameters (e.g.
org-cycle-hook, etc) and I wasn't sure about the ones that didn't
mention any.
I was just trying to find my way and didn't have a map of what was
where. Even the org-export-blocks-preprocess() function is a little
difficult to wade through for someone not really familiar with elisp.
I think I have pieced it together, though. This may give me what I need
to do what I want (remove some specific kinds of headers when creating
certain LaTeX files).
Are my assumptions above correct, then?
Mark
next prev parent reply other threads:[~2010-01-25 6:21 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-01-25 0:40 Hook Function Examples Mark Elston
2010-01-25 5:24 ` Nick Dokos
2010-01-25 6:21 ` Mark Elston [this message]
2010-01-25 15:48 ` Nick Dokos
2010-01-28 18:22 ` Carsten Dominik
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=4B5D3861.400@comcast.net \
--to=m_elston@comcast.net \
--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).