Devonthink Markdown

Mark Felt: The Man Who Brought Down the White House. Quite the same Wikipedia. Markdown is being used, more and more, for all kinds of writing. A simple search for Markdown on a site like MacUpdate will yield many options for Markdown editors. In fact, DEVONthink supports creating and editing Markdown documents. natively. Get Mark Felt: The Man Who Brought Down the White House Cinema, Blu-ray, VOD and DVD Release Date, Trailers, News & Reviews. A Markdown note in DEVONthink, rendered as HTML by default with a hidden preference. All in all this shows that DEVONthink is highly customizable. Often, there are more ways than one to do something. Since DEVONthink does support full-text search, Christian’s cheat will work: you can use note identifiers and put these IDs where you want to.

With COVID-19 running wild here in Quebec we are homeschooling this year. One of the ways that the government evaluates the progress of homeschool students is by asking parents to submit a portfolio. Since I’m primarily responsible for English classes I need to have records. I already use DevonThink as a data repository, so that’s where the homeschooling records are going.

English Journal

Every time we spend some time working on English I create a journal entry as a new Markdown in Devonthink. I thought about keeping one large document and continually appending to it but several small documents seems more searchable and gives me accurate timestamps and geolocations, (if we ever travel again). The journal entries are all kept in a Homeschool > English Journal group.

Since creating a new markdown document several times a week is kind of slow I made a template, and added a button to the menu bar in Devonthink to create a new English Journal entry with one click.

Creating a Devonthink Template

As a fairly new Devonthink user this was my first foray into using templates. I assumed there would be some sort of template editor in Devonthink but there isn’t. You can create an existing document as a template or copy an existing template in Finder. There are also two kinds of templates: normal, and “smart” templates. Normal templates aren’t completely dumb – they have some placeholders that can be replaced by dynamic values, (things like Date, Time, or the user’s name). Smart templates are a bundle of files, including an AppleScript file. The AppleScript file is the main file in the template and controls everything. There can be other files in the bundle, (like a template.md file), and the AppleScript file can refer to those files. I ended up with a Smart template, with some minimal smarts.

The script in my template opens my “Home” database, makes sure the Homeschool > English Journal group exists, then creates a new markdown document in the English Journal group based on the English Journal.md file. The script is relatively simple:

The markdown file is pretty simple too. %time% and %longDate% Worms 2 armageddon for mac. are Devonthink placeholders to put the date & time into the journal entry.

I may adjust it to prompt for a title for each entry, and to add my current location to the text of each entry.

One-Click Template Use

With a working template bundle, (in ~/Library/Application Support/DEVONthink 3/Templates.noindex), it was time to put a button in the Devonthink menu bar:

How to put a template in the Devonthink toolbar:

Move the template bundle into ~/Library/Application Support/DEVONthink 3/Templates.noindex/Toolbar
Restart Devonthink
Go to View > Customize Toolbar in Devonthink
Drag the “English” button to the Toolbar.

While View > Customize Toolbar is open you can choose to show the Icon and Text in the toolbar if you want.

Set an icon for the toolbar button:

It is possible to set a custom icon for the toolbar button, (by default it’s a gear). Devonthink has a weird way of setting the icon, (weird in a good way): set the icon of the template bundle in Finder. Devonthink takes whatever icon Finder thinks the template should have and puts it in the toolbar.

How to customize a file’s icon on macOS:

Open the image you want to use as a custom icon, (in Preview, or wherever).
Copy the image, (Command-C, or Edit > Copy).
Option-click the file that will get the custom icon.
Select “Get Info” from the menu.
Click the file icon in the “Get Info” window so it’s highlighted.
Command-V to paste the image you copied in Step 2 as the custom icon.

If you ever want to remove the custom icon to back to the Get Info window and Command-X to remove it.

Mobile Entry?

This system only works on my computer. I’d like to have a mobile option but in this moment it’s not a pressing need.

Some alternative apps and tools to help you in your academic work.

Writing
2.1 Online Tools

Getting something done efficiently and well starts with choosing the right tools for the job, and the most common aren’t necessarily always the most useful. This is a list of some recommended alternatives, they are free unless marked ‘$’.

111

In addition to the stuff that comes bundled with your operating system (MS OneNote, Mac Notes) you should probably be aware of these…

Evernote: if you don’t use Evernote already, you should probably start now! Keep the stuff you find on the web, take clippings, organise and tag relevant information, find it when you need it.
nvAlt (notational velocity): simply keep all those text snippets and notes in an easy to access place. Also use markdown for formatting and turn notes into webpages via Simplenote.
Simplenote: Similar functionality and feel to nvAlt for those who prefer to keep things entirely online.
Bear: new note and writing app on the Mac AppStore, looks smooth, nice illustrations of bears!
DevonThink ($): info organiser, a bit like a file manager but with lots of extras, good for managing lots of project-related documents/images/data-files etc.

222

Proxy server for mac os x. Starts with the standard WYSIWYG apps, then gets progressively geekier; higher up the list generally means, easier to learn, less control; lower down means, more learning required but also more control. Best classic games for mac.

MSWord ($): you know what Word is; but, just because everybody uses it, that doesn’t necessarily make it the best tool for what you want to do. Remember that there are alternative, sometimes better and easier ways to work.
OpenOffice (also LibreOffice, NeoOffice ($, Mac only) etc): like MSWord but free! Uses the OpenDocument standard which has been adopted by the UK government, this would seem to indicate a high degree of reliability so don’t be perturbed by the fact it’s OpenSource free software. In general these do pretty much what MSOffice does. Can read and produce MSWord .docx files etc.
OmmWriter ($-if-you-want): distraction-free writing! If you find all MSWord’s buttons are a temptation to distraction, try this, it’s just you and your writing on the screen. Very minimal! Ommmmmmmm….
Scrivener ($): writing software designed for writers rather than people who only want to write letters. Too many features to describe here, best take a look at the website.

Plain text tools

We are now heading into the realm of WYSIWYM (what you see is what you mean); with this sort of software you are often creating your documents by separating out the ‘logic’ (i.e. the role or function of a piece of text ) from what a piece of text looks like. For instance, a ‘level one header’ always indicates that the bit of text that it precedes is somehow ‘higher up’ in the document structure than the text preceded by a ‘level two header’, but the headers themselves may need to look very different depending on which academic style you are using in your document. This type of software allows/requires you to manage these things separately; this means that you can ensure document styling is entirely consistent.

Multimarkdown Composer (markdown): probably the most developed of the many, many markdown editors available (maybe Ulysses is up there too). As you write you add special symbols to your different bits of text to indicate their role, e.g. level one headers are marked by preceding #. level two headers by ##, etc. Markdown (and ‘multimarkdown’ which adds extra goodies) is very straightforward to learn and allows the writer to create many types of document (HTML webpages, MSWord, OpenDocument, PDF etc) all from one source.
Atom (plain text editor): a general purpose plain text editor, built for programmers really but as it’s ‘hackable’ it can be adapted to just about any purpose. There are extensions(‘packages’) which allow/help you to write and preview various types of markdown… and to do just about anything else might want to with plain text!
Aquamacs (Emacs, Vim etc): Aquamacs is a Mac-friendly version of the venerable Emacs, which normally runs inside a terminal. In general terms it’s the same as Atom above, a text editor, but it’s much older, better established and therefore with even more possibilities - you can manage your to-do list, maintain a calendar and read your mail in Emacs, if you want.
Texts (Trial period, then $): looks more like a ‘normal’ WYSIWYG-style editor but actually uses a clever piece of software called Pandoc to create different types of documents from your text (which is actually markdown formatted by the app to not look like it). If you set it up properly it will do all the generation and formatting of your citations and bibliography for you. It will There is a 30-day trial version available, then it costs $19 to buy a licence.

333

Devonthink Markdown Text

Online Tools

Gingko: an alternative way of viewing a structured document. It’s easiest to just look at how it works on the website. Probably not for everyone but if you like it and it helps you organise your thinking/writing, why not?!
Authorea: Another more conventional online writing tool that can use either markdown or (the very wonderful but rather complex) LaTeX.

A note about LaTeX

LaTeX is also a form of ‘mark-up’ like the HTML used to make web-pages. It is used more in the ‘hard’ sciences and mathematics but there are good reasons to think about using it for social science writing too; citations and bibliographies can be generated and formatted automatically, internal references are generated and managed automatically, headers are numbered and formatted appropriately, and more importantly, in general you don’t have to think about document formatting at all and can concentrate on your content. For more information about getting started have a look at these guides:

Devonthink Markdown Pro

Be aware, the learning curve is steep but the results can be worth the effort.

If you want to try LaTeX without all the messing about installing various (quite large) bits of software there are online services you can use to see if you like how it works.

For example, Overleaf

444

Correctly citing your sources and providing references is a fundamental academic skill, the software mentioned here will help you get it right.

Zotero: a bibliographic information manager to keep a track of all that reading you’re doing and, more importantly to make it easier to insert correct citations and a reference list in your papers and essays. To get the most out of Zotero you will need to install 3 different components; the Zotero desktop app, the browser plug-in, and the word-processor software add-ons that link Zotero to MSWord/OpenOffice. Once you’ve got all these installed and linked together then you can capture bibliographic info from the web (e.g. from publisher websites or Google Scholar search results), manage the info in the desktop app, and add it (all correctly formatted in a style of your choice) to your essay/paper.
Colwiz: I just noticed this so am adding it to the list (10/01/17). Similar functionality to Zotero and friends, online and desktop versions for all OSs (desktop and mobile). Design is very simple and clean, there’s a browser add-on to suck up bibliographic info from webpages, and word-processor plug-ins to help with your writing. It’s developed by people from the Univ. of Oxford and seems to be a worthy contender for your attention. It also has a ‘social’ aspect in that it includes collaboration and communication tools. I just wish they’d change the name…
Mendeley: like Zotero but does a bit more file management for you, if you like that sort of thing. Similar functionality to Zotero, slicker design.
Papers ($): Similar to the above but for people who like to spend money on things they can get for free…
Cite-u-like: online service to store your bibliographic data.
Bibsonomy: as above but with more of sharing/social media feel.

For the geekier…

Bibdesk: a bibliography manager that uses the bibtex format, aimed primarily at integration with LaTeX writing tools but adaptable to other apps, I use it for writing in markdown.
JabRef: as above but integrates a bit better with other apps, there’s a Firefox plug-in (JabFox) which helps grab bibliographic info from webpages. NB. this seems to require the Zotero plug-in to be installed too.

555

Checkvist: if you like to plan your writing from the structure then an outliner might be a good way to get started. Checkvist allows you to make outlines - hierarchical lists - to which you can add text notes, deadlines, links etc. Then, if you like, you can export these and use them as a heading structure for a word-processor document. Of course, you can also just use it as a normal to-do list.
The Outliner of Giants: despite it’s silly name, this is a pretty good app. It’s available online and as a ‘Chrome App’(I think…). There are free and paid versions, it’s very versatile and you can include, by using markdown, images, quotes etc in your outlines. Afaik, you can also email material into the nodes on your outline, if that’s your bag!

666

PDF Shrinkers: if you need to send or share PDFs it’s often a good idea to try to compress them first, as they can get very large very quickly. Online compression services can often reduce the size of a PDF by 80-90%.

and lots of other similar services.

Aeon Timeline ($): A timeline editor that, as well as being a fantastic bit of software, has the additional bonus that it integrates with Scrivener (see above), so especially useful if you are writing history, or anything with a time-based sequence of events as a framework. Unfortunately, costs $50 but a 15% academic discount is available.
DevonAgent ($): from the same company as DevonThink (see above), a super-sophisticated tool for performing customised web-searches and storing the results.
Silk: super-adaptable online database and visualisation site; maps, graphs, all kinds of charts. Data import (e.g. from Excel etc) can be tricky but the results are great.