-
Notifications
You must be signed in to change notification settings - Fork 14
Files Mainfile
The Open-Science-Paper offers class options which define how the document behaves in general. Additionally there are lots of fine tuning parameters to change the look and feel of elements of the paper via a style file.
To change a class option you need to modify the options inside the square
brackets of the class call in the main file open-science-paper.Rnw. The
example below shows the class call with some the defalt values of the
Open-Science-Paper.
\documentclass[color=false, print=false, csvdata=false, gitinfo=false, linenumbers=false, sectionnumbers=false]{subdocuments/open_science_paper}This is just for illustration purposes and because this are default values you could also simplify the call to the code below to get the same result.
\documentclass{subdocuments/open_science_paper}The following list gives you an overview about the class options with the default values indicated by square brackets.
- color true/[false]: Changes between colored output and a black and white theme
- csvdata true/[false]: With csv data enabled you can use the csv file under the data folder to insert title header information into the document.
- gitinfo true/[false]: Include git information into the title header of the document. This requires the setup of git hooks which you can do by issuing the make task (make githooks). After that you need to specify the url of the git repository inside of the style file and you are done.
- print true/[false] switches between the color model rgb which is optimal for monitor display and the cmyk color model which is required for professional printing.
- linenumbers true/[false]: Switch on/off line numbers for the whole document.
- sectionnumbers true/[false]: Switch between numbered and numberless sections
- autolayout [true]/false: Switch between the nice automatic calculated typearea layout (Koma script) and a fixed geometry page layout (geometry package). You need to set the geometry inside of the style file if you choose false.
- twosidelayout true/[false]: Switch between two and one side page layout.
- reversepagelayout [false]/true reverse the order of odd and even side margins. This option can be used to start the paper on a left or right page in a two sided layout.
- resetdefaultclassoptions true/[false] resets the default options the open science paper loads the scrartcl class. After that you can modify every option via the open science paper class call. For example to change the calculated typearea you can use \documentclass[resetdefaultclassoptions=true, DIV=7]{osp/subdocuments/open_science_paper}
- If you spot a typo, feel free to edit the wiki directly
- If you don't understand something, please email ctpfaff
- If you have have a longer contribution, please contact me first
Installation
Structure and Files
Typesetting
- The title header
- The footer
- Sectioning
- Lists
- Citations
- Figures
- Tables
- Math
- Code chunks
- Code listings
Workflow