Title: Theory / Unimportant / CS / Descriptive / LaTeX / Companion +29 / 02 Structure of a LaTeX document
Tags: hasNotNewEffectReturnsMeaning FromInstruction computer_to_instruction some_instruction récupéré seen_description FromVariables hasSeenConjDef mid1516974248815 yp:TypToKind
On every note of this deck, unless a note says otherwise:
Chapter: 2

Instruction: \documentclass{d}
Page: 15
Effect: Stating that d is the document class used for this pdf.
Language: Latex
Section: 1
Variables: d a document class
Assuming: Used exactly once, beginning the document

Instruction: 11pt
Page: 16
Effect: Change default font of the document to 11pt
Language: Latex
Section: 1
Where to use it: documentclass optional argument

Instruction: \usepackage{foo_1, ..., foo_n}
Page: 16
Effect: State to use package foo_i
Language: Latex
Section: 1
Where to use it: Preambule

Instruction: \include{foo}
Page: 18
Effect: Put the content of the file foo. Starts on a newpage and ends on a new page
This file will have its own auxiliary files
Language: Latex
Section: 1.2

Instruction: \includeonly{foo_1, ..., foo_n}
Page: 18
Effect: States that following include command will be ignored if their content is not some foo_i
Language: Latex
Section: 1.2

Instruction: askinclude package
Page: 19
Effect: Ask interactively which include to process. * means all, - means none, enter means: same than last time
Language: Latex
Section: 1.2

Instruction: \excludeonly{foo_1, ... foo_n}
Page: 20
Effect: States that include should be ignored for the documents foo_i
Language: Latex
Section: 1.2

Instruction: \begin{filecontents}{foo}
bar
\end{foo}
Page: 20
Effect: If the file foo exists, write a warning
Otherwise write bar to this file, preceded by some comment abot this generating
Language: Latex
Section: 1.3
Assuming: Before document class. Begin and end are alone on their line

Instruction: \listfiles
Page: 21
Effect: list the files in compilation process
Language: Latex
Section: 1.3
Where to use it: preambule

Instruction: \opt[foo_1, ..., foo_n]{bar}
Page: 21
Effect: prints bar if some foo_i option is given according to optional package rules
Language: Latex
Section: 1.3

Instruction: \usepackage[foo_1,...,foo_n]{optional}
Page: 21
Effect: Uses package otional with foo_i options
Language: Latex
Section: 1.3

Instruction: \AskOptions
Page: 21
Effect: Asks user, at compilation, to state which options to use
Language: Latex
Section: 1.3

Variable: \ExplainOptions
Meaning: A text, displayed by \AskOptions to user, to tell which options they can choose, and their meaning
Page: 21
Language: Latex
Section: 1.3
Chapter: 2

Name: A sectionning command
Definition: produce the heading number reflectring the hierarchical level
Page: 23
Chapter: 2
Definition2: store the heading as an entry for a table of contents
Conjdef: A command which,
Definition3: save the contents of the heading to be (perhaps) used in a running head and/or foot
Definition4: format the heading

Instruction: \foo*
Page: 23
Effect: sectionning foo without number and does not produce an entry in the toc or the running head
Language: Latex
Variables: foo a sectionning command

Instruction: \sectionningCommand[bar]{buz}
Page: 23
Effect: similar to \sectionningCommand{buz} using bar in the toc for the current section
Language: Latex
Variables: sectionningCommand a sectionning command

Question: why to use a toc-entry (optional argument of a sectionning command)
Answer: In order to have formatting command applied in the body of the document and not in the toc
Page: 23
Chapter: 2
Variables: foo a sectionning command

Variable: \secnumdepth
Meaning: sectionning command should have a number iff its level is at most the value of this variable
Page: 24
Language: Latex
Section: 2.1
Chapter: 2
Typ: counter

Instruction: \addtocounter{foo}{i}
Page: 24
Effect: add the value i to the counter foo
Language: Latex
Section: 2.1

Variable: foo
Meaning: the counter with the index of the last section of kind foo
Page: 24
Language: Latex
Section: 2.1
Chapter: 2
Variables: foo a section command
Kind: Counter

Instruction: \newcounter{foo}
Page: 24
Effect: create a new counter called foo
Language: latex
Section: 2.1

Instruction: \newcounter{foo}[bar]
Page: 24
Effect: create a new counter called foo, which is set to 0 when bar is updated
Language: latex
Section: 2.1

Instruction: \@addtoreset{foo}[bar]
Page: 24
Effect: state to set foo to 0 when bar is updated
Language: latex
Section: 2.1

Instruction: \thefoo
Page: 25
Effect: A representation of the value of the counter foo
Language: latex
Section: 2.1
Variables: foo a counter

Instruction: \arabic{foo}
Page: 25
Effect: foo as a number in Arabic number
Language: latex
Section: 2.1
Variables: foo a counter

Instruction: \Alph{foo}
Page: 25
Effect: foo as a capital letter
Language: latex
Section: 2.1
Variables: foo a counter

Instruction: \@seccntformat
Page: 25
Effect: How to format the counter part of the section title
Language: latex
Section: 2.1
Variables: foo a sectioning command