Skip to content
Damien Drix edited this page Feb 11, 2014 · 5 revisions

Collaborative Research with Github Wikis / Gollum

  • entirely client-based, backed by a git repo
  • git repo is all you need
  • can be browed online on github
  • can be served locally via gollum

Inserting Maths

Supported through MathJax.

Inline \(x^2\) equation, or display mode:

$$x^2$$

Inserting References

References: use local script to collate, display with include:pagename-refs tag.

Citekeys must remain plain text: {Butko:2007ft}, not Butko:2007ft so that the files remain easy to edit in plain-text mode.

We use javascript to display them in the web browser:

  • hovering on citekey shows formatted citation
  • clicking on citekey opens PDF file from repo

Users are responsible for displaying them the way they want.

Reference collation

Runs from a python/ruby script stored in the repo.

  • go through all the modified pages
  • collect citekeys
  • generate references page
  • collect PDFs and copy to repo

Each user needs to provide a script that takes a citekey as an input and returns a bibtex entry as a result.