Available Commands - genomizer/genomizer-documentation GitHub Wiki

Commands

Text Commands

\appName produces Genomizer

\json produces JSON

\refer\{\#1\} produces a reference from argument e.g. Figure 1

\fullref\{\#1\} produces a reference from argument e.g. Figure 1 on page 44 (Usefull when referencing appendix)

\filePath\{\#1\} produces argument

\click\{\#1\} produces argument

\term\{\#1\} produces argument

\strongTerm\{\#1\} produces argument

\class\{#1\} produces typewriter style for the class names.

\nomenclature\{\#1\}\{\#2\} Add word to nomenclature.

Argument 1 Word to add.

Argument 2 Description of the word

Image Commands

All images are included from the folder figures/

Insert single image

\addScaledImage\{\#1\}\{\#2\}

Argument 1: Percent size of image towards the text width of the page. e.g. (0.5) becomes (50%) of the page width.

Argument 2: Name of image.

Insert 90(^\circ) rotated image

\addImageVertical\{\#1\}

Argument 1: Name of image.

Insert 90(^\circ) rotated and scaled

\addScaledImageVertical\{\#1\}\{\#2\}

Argument 1: Percent size of image towards the text width of the page. e.g. (0.5) becomes (50%) of the page width.

Argument 2: Name of image.

Inserting two images

\addTwoImages\{\#1\}\{\#2\}\{\#3\}\{\#4\}

Argument 1: Image one

Argument 2: Caption for figure one

Argument 3: Figure two

Argument 4: Caption for figure two

Inserting three images

\addThreeImages\{\#1\}\{\#2\}\{\#3\}\{\#4\}\{\#5\}\{\#6\}

Argument 1: Image one

Argument 2: Caption for figure one

Argument 3: Figure two

Argument 4: Caption for figure two

Argument 5: Figure three

Argument 6: Caption for figure three

Inserting four images

\addFourImages\{\#1\}\{\#2\}\{\#3\}\{\#4\}\{\#5\}\{\#6\}\{\#7\}\{\#8\}

Argument 1: Image one

Argument 2: Caption for figure one

Argument 3: Figure two

Argument 4: Caption for figure two

Argument 3: Figure three

Argument 4: Caption for figure three

Argument 3: Figure four

Argument 4: Caption for figure four

Structures

User Story

\userstory\{\#1\}\{\#2\}

Argument 1 Story name

Argument 2. Story description

Example boxes

Create a example box \begin\{example\} and ends with \end\{example\}

Example boxes are light gray centered boxes that are automaticly enumerated. Use them to add examples to allow the reader to skip easily.