Ibidem makes it easier to write academic papers with citations. It uses a markdown to LaTeX conversion:
- We write a file on a superset of markdown's syntax.
- Ibidem converts it to a LaTeX file.
Currently it has only been tested in Linux and OS X using SBCL.
-
Run
git clone https://github.com/stefandevai/ibidem && cd ibidem
on a terminal. -
Run
make && cd bin/
to build the program. -
Run
./ibidem input-path -o output-path
, whereinput-path
is the markdown file andoutput-path
is the path and name of the output.tex
file.
-
Run
git clone https://github.com/stefandevai/ibidem && cd ibidem
on a terminal. -
Run the SBCL's REPL and enter
(load "ibidem.asd")
. -
Run
(ibidem:create input-path output-path)
whereinput-path
is the markdown file andoutput-path
is the path and name of the output.tex
file.
We use a superset of Markdown's syntax in order to allow meta information about the text, citations and bibliography sources.
If we want to have a latex header, we write a header at the beginning of the markdown file containing the following format and parameters:
---
author: "Your Name"
date: "25/10/1917"
location: "A location"
---
If we want to have citations in our text, we can write a bibliography block. This can usually be placed at the end of the file:
~~~bibliography
---
id: "[source-unique-id]"
type: "[citation-type]"
author: "Author's Full Name"
title: "Source's Title"
journal: "Source's Journal"
year: "Publication year"
volume-issue: "[volume]([issue])"
---
---
id: "jacoby"
type: "article"
author: "William G. Jacoby"
title: "Public attitudes toward government spending"
journal: "American Journal of Political Science"
year: "1994"
volume-issue: "38(2)"
---
~~~
Each block piece is described in isolation here:
~~~bibliography
[This is a bibliography block. It expects citation source blocks.]
~~~
~~~bibliography
---
[This is a citation source block. It expects parameters about a single source.]
---
---
[You can have multiple citation source blocks.]
---
~~~
Within the text, you can have citations in the following format:
c[source-unique-id:pages]
E.g.
c[jacoby:334-336]