Embedded System Project

To include another file, the following command can be used:

!{{relative_path_to_file}}

NOTE: this command must be the only content on the line, otherwise it will be ignored.

Any occurrence of the string $DIR$ is replaced with the directory to the opened file.

Template options can be found here.

The following describes how to keep the agreed style of formatting.

In this report The Chicago Manual of Style (CMOS) will be used as style for headlines and titles. The rules are as follow:

1. Capitalize the first and last words in titles and subtitles (but see rule 7), and capitalize all other major words (nouns, pronouns, verbs, adjectives, adverbs, and some conjunctions—but see rule 4).
2. Lowercase the articles the, a, and an.
3. Lowercase prepositions, regardless of length, except when they are used adverbially or adjectivally (up in Look Up, down in Turn Down, on in The On Button, to in Come To, etc.) or when they compose part of a Latin expression used adjectivally or adverbially (De Facto, In Vitro, etc.).
4. Lowercase the common coordinating conjunctions and, but, for, or, and nor.
5. Lowercase to not only as a preposition (rule 3) but also as part of an infinitive (to Run, to Hide, etc.), and lowercase as in any grammatical function.
6. Lowercase the part of a proper name that would be lowercased in text, such as de or von.
7. Lowercase the second part of a species name, such as fulvescens in Acipenser fulvescens, even if it is the last word in a title or subtitle.

The list has been yanked from the CMOS-homepage.

Take the source and go to ZBib

Paste in the link and press cite.

If this doesn't work, you have to click on the manual entry and fill in as many of the blanks as possible.

At the (near) bottom of the page you can click the dropdown arrow on Copy to Clipboard and then Download BibTeX

Add everything in the document to report/biblio.bib. The syntax for citing is as follows:

[@cite_key, p. 30] says fooo. or Jet fuel can't melt steel beams[@waugh_here_2016].

Citation can belong to a single sentence like this, where the cite-number appears before the sentence-ending period[1].

Citation can sometimes belong to an entire paragraph. Such cases are usually a large number of postulations packed into multiple sentences. In these cases it was deemed necessary to write an entire set of sentences, all (or most) making statements needing citation, which might be from the same source(s). In such cases, it would be inefficient to refer to the same source(s) multiple times, instead of referencing once after the entire paragraph. After the final period.[1]

NOTE: Period goes after the source, and there's no space between the last word of the sentence and the source.

NOTE: The , p. 30 part is optional, and is only used when a specific page is referred.

Please see this

In order to have a checkmark (✓) character in the report, use LaTeX-syntax: \checkmark

A Dockerfile is in the /docker directory, you can build this, or just use the published image at boginw/markdown-pandoc. To use the image to compile a pdf, run the following:

./scripts/docker_build.sh

Which produces a pdf in the /dist folder, called output.pdf

Although you will not need to install anything (except a Markdown editor) as the CI will generate artifacts, including a compiled PDF, this can be helpful for taking a glimpse of what the final result might look like.

To install you'll need some prerequisites (these packages are fairly large).

sudo apt-get install texlive-latex-base -y
sudo apt-get install texlive-fonts-recommended -y
sudo apt-get install texlive-fonts-extra -y
sudo apt-get install pandoc -y
sudo apt-get install pandoc-citeproc -y

To compile, just execute the following command:

./scripts/build.sh

If no errors occurred, you should see a folder dist in the root of the project, containing the resulting PDF output.pdf.