emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Jack Henahan <jhenahan@me.com>
To: emacs-orgmode@gnu.org
Subject: Re: Specifying the tangle filename based on the source filename?
Date: Sun, 28 Jan 2018 13:13:50 -0500	[thread overview]
Message-ID: <m1bmhdvokh.fsf@me.com> (raw)
In-Reply-To: <BC7B8EF8-6790-4164-9AAA-070BCAF133C0@zzamboni.org>

I do something similar, and I use a snippet like this

#+begin_src emacs-lisp
  (defun the-in-the-org-lib-p ()
    (and (f-this-file)
         (f-child-of? (f-this-file) the-org-lib-directory)))

  (defun the-org-lib-hook ()
    (if (the-in-the-org-lib-p)
        (progn
          (setq-local org-babel-default-header-args:emacs-lisp
                      `((:tangle . ,(f-expand (f-swap-ext (f-filename (f-this-file)) "el") the-lib-directory))
                        (:noweb . "yes"))))))

    (add-hook 'org-mode-hook 'the-org-lib-hook)
#+end_src

`the-org-lib-directory' points to where all my Org config sources are,
while `the-lib-directory' points to where the tangled files go. My Org
files then have a structure like

org/whatever.org

* Configuring Whatever Features
** Requirements :noexport:
#+begin_src emacs-lisp
  ;; -*- lexical-binding: t; -*-
  ;;; whatever.el --- Whatever functionality
     
  (require 'whatever)
#+end_src
** Some Subfeature
Explain how we use the feature
#+begin_src emacs-lisp
  (my-configuration 'stuff)
#+end_src

** Provides :noexport:
#+begin_src emacs-lisp
  (provide 'whatever)

  ;;; whatever.el ends here
#+end_src

I have some additional configuration to tangle my lib files on save, and
to regenerate the top-level documentation so that (in theory) the README
is always up to date with the configuration. The :noexport: tags remove
the noise of require and provides when I export.

Diego Zamboni <diego@zzamboni.org> writes:

> Hi,
>
> I’ve been converting many of my configuration files to org-mode to better document them (examples:
> https://github.com/zzamboni/dot_emacs/blob/master/init.org, https://github.com/zzamboni/dot_elvish/blob/master/rc.org). Usually I
> have a line like the following at the top of each org file:
>
> #+PROPERTY: header-args:emacs-lisp :tangle init.el
>
> So that all the code blocks in the file are, by default, tangled to the corresponding config file. I was wondering if it might be
> possible to avoid hardcoding the output file (“init.el” in this example) and instead derive it from the source filename (“init.org” in
> this case). I’ve looked a bit through the manual and although I found the {{{input-file}}} macro, I couldn’t get it to work.
>
> Thanks for any help,
> —Diego

next prev parent reply	other threads:[~2018-01-28 18:14 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-28 13:54 Specifying the tangle filename based on the source filename? Diego Zamboni
2018-01-28 18:13 ` Jack Henahan [this message]
2018-01-28 20:15   ` Diego Zamboni
2018-01-28 20:47 ` Grant Rettke
2018-01-28 21:07   ` Diego Zamboni

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=m1bmhdvokh.fsf@me.com \
    --to=jhenahan@me.com \
    --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

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).