The Living Thing / Notebooks :

Academic writing workflow

Minimising the friction of of advertising my thoughts in order to maximise the chance a clever thought makes it out there.

Beautiful typesetting with LaTeX

“Documenting my academic writing workflow and how to improve it”, or, “How I learned to stop worrying and love text files”.

See also text editors, LaTeX, citation management, scientific computation workflow, plain text blogging, markdown.

Contents

Science writing blogs

This blog, and virtually all my notes, are in plain text files on my computer, published online as plain html files. It’s an informal open notebook.

I had to jump through some hoops to make this work, because I need mathematical markup support and basic citation management. Vanilla, non-academic plain text blogging is simpler. But even this academic stuff is not complicated.

Why bother?

Open notebook science is a thing. It improves reproducibility of research. Personally speaking, it keeps me more rigorous, knowing that the public can see what I am doing, and which half-cocked opinions I am holding. It encourages people to contact me about my ideas.

Further, having a bunch of plain text files is the most simple, convenient and reliable way of taking notes. I’d do it this way even if it weren’t going to be online.

If you want more in-depth justifications for open notebooks, see Caleb McDaniel or Ben Marwick’s slide deck.

Other examples of online notebooks

Technical details

I publish notes online using Pelican. I see plain text files; you see fancy online HTML. The HTML is automatically served by github pages, which is fast and free. The citations are handled through Zotero. This is a work in progress. This workflow is OK, but I’m experimenting with some alternate preview tools such as marked, and restview.

Nafiul Islam gives some clever shortcuts on getting live preview using livereload.

But for now I mostly edit the text using Atom, and just GO. The process looks like this:

Screencap of my text editor

On software choice

There are lots of tools to do this. There are in fact a few hundred static site generators for plain text blogging.

Writing papers

literate-coding-type

Writing papers, especially collaboratively, is a whole other story; you need better media management and citations etc. You might want to try a scientific notebook such as jupyter, knitr etc, which will generate the requisite diagrams etc. rticles, in particular, takes the scientific computation tools and turns them to generating photo-ready journal submissions.

Shut up, just give me minimally painful LaTeX collaboration without any bonus reproducible science features

But if plain LaTeX writing is what you want, And you need to work with collaborators of different technical expertise levels, across various quirky LaTeX setups, here are some options.

  • teletype enables generic live collaborative document editing (atom-only for now)

  • ShareLaTeX is an open source online collaborative article editor. They also have a hosted version.

    • Work together on a single version
    • View collaborator edits
    • No complicated LaTeX installation
    • Restore to any older version
    • Access your work from anywhere in the world
    • Work offline and sync your files via Dropbox and GitHub
  • Overleaf is not open source, but somewhat prettier.

    I haven’t used it for a while either.

    Real-time collaboration in your browser We compile your project for you so you can see the results right away. There’s no software to install, so you can start writing and collaborating instantly.

    Our real-time preview also makes it great for learning — you can see how your final project looks as you type.

  • papernow is more radical (and more ugly) again.

    Create, edit and (optionally) display a journal article, entirely in GitHub.

    In contrast to the more traditional process of submit > peer review > publish at PeerJ, or even the less formal preprints at PeerJ Preprints or arXiv, Paper Now is an experiment to see where the future may go with scholarly communication. Initially, it may be that co-authors collaborate either privately or publicly on GitHub and then proceed to submitting to PeerJ or other journals for formal peer-review or preprinting. Or perhaps this is where the traditional medium of publication begins to diverge. There is no end goal other than to see what the academic community wants, which is why this is completely open to fork, extend, and build upon.

Emailing word files between collaborators

You have gone beyond my ability to help you.

To read