Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 5.44 KB

README.md

File metadata and controls

116 lines (87 loc) · 5.44 KB
Raw

pandoc-apa

A Sublime Text build system / Visual Studio Code task runner for writing APA manuscripts with Pandoc formatted markdown

Installation

Pandoc

You need Pandoc to use the pandoc templates. You can find it here: https://pandoc.org/installing.html

LaTeX / Word

You'll need a LaTeX distribution to build the APA formatted pdf files (e.g., MikTex or MacTex), or Microsoft Word to convert markdown to .docx files.

Filters

Pandoc doesn't yet support cross referencing figures and tables. You'll need a Python distribution to install two filters to be able to do this. The filters are pandoc-fignos and pandoc-tablenos. You can find links and installation instructions here https://github.com/tomduck/pandoc-fignos

Usage

Sublime Text

Copy the pandoc and sublime directories from this repository wherever your Packages folder is located in Sublime Text. For example, if the contents of this repository are not already in a folder called pandoc-apa, make a folder called pandoc-apa in Sublime text's User directory and copy contents there.

Where to copy pandoc and sublime folders:

  • Windows: C:\Users\username\AppData\Roaming\Sublime Text 3\Packages\User\pandoc-apa
  • OSX: /Users/username/Library/Application Support/Sublime Text 3/Packages/User/pandoc-apa

Usage:

  • Press ctrl + b to build to pdf (or cmd+b)

  • Press ctrl + shift + b to build to docx (or cmd+shift+b)

  • You can also go to Tools > Build System > Pandoc APA, then if you select Tools > Build Width you can see the different options. Default is .pdf. Markdown to LaTeX will convert a pandoc markdown document to a .tex file. Run will convert to .docx.

  • In a document, type apayaml, then press Tab. It will generate a YAML header. Or you can do this from Tools > Snippets > "Insert Pandoc ..."

Visual Studio Code

Copy the .vscode and pandoc directories to where your main markdown file is located. Open the folder containing your markdown file as a vscode workspace. Press Ctrl+Shift+B to run the build task or press F1 then type task, select "run task", then choose one of the Pandoc APA options.

Instead of copying the pandoc-apa contents for each project, you can now create a workspace with multiple root folders in vs code. Make a .code-workspace file where your main .md file is located with something like this, where the second path is pointing to the pandoc-apa directory:

{
	"folders": [
		{
            "name": "this-workspace",
			"path": "."
		},
		{
            "name": "pandoc-apa",
			"path": "../pandoc-apa"
		}
	],
	"settings": {
		"files.exclude": {
			"example": true
		},
        "editor.insertSpaces": true
	}
}

Pandoc YAML Metadata Block

These templates makes heavy use of the pandoc metadata block at the beginning of your document. I've also provided a snippet you can use to insert the metadata and fill in what is needed (Tools > Snippets). Most of the commands used in the apa6 package are fields that can be used in the YAML header. See documentation for more details: http://mirror.hmc.edu/ctan/macros/latex/contrib/apa6/apa6.pdf. Fields used in this template are:

  • mode
    • Set to man, doc, or jou. This is the only absolutely necessary option to generate a file with no errors.
  • title
    • Main title of the document. Consistent with the pandoc variable.
  • subtitle
    • Running head title. Consistent with the pandoc variable.
  • author
    • List of authors. Put multiple authors on one line to group by affiliation. Consistent with the pandoc variable.
  • institute
    • List of affiliations. Won't work with docx. You have to add this manually.
  • twogroups, threegroups, ... , sixgroups
    • Set one of these to true if grouping authors by different affiliations, as in the twogroup YAML example. If anyone of these options are not set, it will use the standard \author{} command.
  • authornote
    • A note that will be placed at the bottom of the title page, or footnote if in jou mode.
  • bibliography
    • Location of your bibtex references file, whatever pandoc-citeproc will read. Can add multiple fields for multiple files.
  • date
    • Place anything typed here as you would in the \note{} apa6 latex command.
  • keywords
    • List of keywords that will show under the abstract. See YAML metadata example.
  • abstract
    • The abstract text of the manuscript.
  • floatsintext (optional)
    • If this field is present and set to true, it will keep figures and tables with text or at the end of the document.
  • classoption (optional)
    • A list of options that the apa6 package will understand. See link to manual above. Don't use the LaTeX options jou, man, or doc here. Use the dedicated YAML field mode instead. If the field isn't used, it defaults to manuscript mode. Also the longtable option is already specified since it's necessary for pandoc to work with tables. Don't enter it twice. Some useful options may be noextraspace, draftfirst, etc...
  • joucommands (optional)
    • If you are in journal mode and want to use the other journal commands, the commands are as follows (also see the link to the apa6 manual for more details).
    • leftheader
    • journal
    • volume
    • ccoppy
    • copnum
  • colorlinks (optional)
    • Colorize links and citations.

You can try additional fields not mentioned here:

https://pandoc.org/MANUAL.html#variables-set-by-pandoc