How to build a project from org files using ant/make?

How to build a project from org files using ant/make?

[Robert McIntyre]

Hi,

I use org-babel to produce the source and html documentation for my projects.

My projects generally look like this:

[~/tmp/org-project] $ tree
.
|-- html
|   `-- proj.html
|-- org
|   `-- proj.org
`-- src
    `-- namesace
        |-- prog_1.clj
        `-- prog_2.clj

Here prog_1.clj, prog_2.clj, and proj.html are all generated from the
proj.org file.

Because the source and html files are generated files, I don't include
them in source control.

When I download my project on another computer, I want to be able to
generate all these files again, preferably from a makefile/build.xml,
etc.

What is the best practice for doing this?  Right now, I maintain two
shell scripts called "tangle" and "weave" that invoke emacs on the
project, but these rely on my specific emacs setup.  How can I make it
possible for someone to build my project if they have emacs and
make/ant?  What are other people doing when it comes to automatically
building a project whose source files are generated from org files?

sincerely,
--Robert McIntyre

Re: How to build a project from org files using ant/make?

[Eric Schulte]

[-- Attachment #1: Type: text/plain, Size: 1758 bytes --]

Robert McIntyre <rlm@mit.edu> writes:

> Hi,
>
> I use org-babel to produce the source and html documentation for my projects.
>
> My projects generally look like this:
>
> [~/tmp/org-project] $ tree
> .
> |-- html
> |   `-- proj.html
> |-- org
> |   `-- proj.org
> `-- src
>     `-- namesace
>         |-- prog_1.clj
>         `-- prog_2.clj
>
> Here prog_1.clj, prog_2.clj, and proj.html are all generated from the
> proj.org file.
>
> Because the source and html files are generated files, I don't include
> them in source control.
>
> When I download my project on another computer, I want to be able to
> generate all these files again, preferably from a makefile/build.xml,
> etc.
>
> What is the best practice for doing this?  Right now, I maintain two
> shell scripts called "tangle" and "weave" that invoke emacs on the
> project, but these rely on my specific emacs setup.  How can I make it
> possible for someone to build my project if they have emacs and
> make/ant?  What are other people doing when it comes to automatically
> building a project whose source files are generated from org files?
>

I've attached the Makefile I use to build a pdf of my proposal from the
Org-mode source.  Notice the EMACS, BATCH_EMACS, and proposal.tex lines.
You should be able to adopt proposal.tex to export source code by
replacing org-export-as-latex with org-babel-tangle.  This setup has
worked very reliably for me and should extend naturally.

I use an init.el file to holds project-specific customization.  If you
can assume that the user has Emacs24 installed, then you need not do
anything special and can omit init.el entirely, otherwise you will have
to ensure that a recent version of Org-mode is installed and loaded.

Hope this helps -- Eric


[-- Attachment #2: Makefile --]
[-- Type: application/octet-stream, Size: 839 bytes --]

EMACS=emacs
BATCH_EMACS=$(EMACS) --batch -Q -l init.el proposal.org

all: proposal.pdf

proposal.html: proposal.org
	$(BATCH_EMACS) -f org-export-as-html

proposal.tex: proposal.org proposal.bib init.el
	$(BATCH_EMACS) -f org-export-as-latex

proposal.bib: tasks.org bib-export.el
	$(BATCH_EMACS) -l bib-export.el

proposal.pdf: proposal.tex gantt.pdf
	rm -f proposal.aux
	if pdflatex proposal.tex </dev/null; then \
		true; \
	else \
		stat=$$?; touch proposal.pdf; exit $$stat; \
	fi
	bibtex proposal
	while grep "Rerun to get" proposal.log; do \
		if pdflatex proposal.tex </dev/null; then \
			true; \
		else \
			stat=$$?; touch proposal.pdf; exit $$stat; \
		fi; \
	done

gantt.pdf: gantt.tex
	./single-fig gantt.tex

clean:
	rm -f *.aux *.log *.dvi *.blg *.bbl *.toc proposal.tex *~ *.out *.html proposal.pdf proposal.bib gantt.pdf

[-- Attachment #3: Type: text/plain, Size: 85 bytes --]


>
> sincerely,
> --Robert McIntyre
>

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/