aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHolden Rohrer <hdawg7797@yahoo.com>2019-08-14 18:17:40 -0400
committerHolden Rohrer <hdawg7797@yahoo.com>2019-08-14 18:27:05 -0400
commitc1ef53263fab863d62cc6f86b706a165fe25fd4d (patch)
tree80e5828b07d7bfb02c0d22a12adaf17af7a44809 /README.md
parent084a2fe20e538217d1d17171078c22a522d32a70 (diff)
added mini READMEs
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 26 insertions, 7 deletions
diff --git a/README.md b/README.md
index d27c46b..408d566 100644
--- a/README.md
+++ b/README.md
@@ -9,18 +9,37 @@ This repository is designed to organize and make portable all of Holden Rohrer's
- citations.tex % a citation generator and aggregator for MLA 8th Edition
- sort.py % a Python script which sorts sort.tex when called
- example.tex % an example of the capability of mla8.tex
--|jones-la % all work for AP Lang, taught by Ms Jones; see internal README for more info
--|wroblewski-world % all work for AP World, taught by Mr Wroblewski; see internal README for more info
```
+Class directories have internal READMEs which cover their content
+
## Compilation
To compile files, run `pdftex --shell-escape /dir/to/file` from this directory.
## MLA8 Formatting Usage
-Because files are called from this directory, the relative path is `mla8.tex`, which should be included in TeX documents with `\\input mla8.tex` (this method is used to allow `mla8.tex` to call `citations.tex`).
-
-In-document, mla8.tex provides a few facilities: fonts (`\\large` makes text 14pt, `\\it` italicizes text, `\\bf` bolds text; default 12pt roman Times New Roman), a running page-numbered header which can be enabled on the first page with `\\numberfirstpage`, blockquotes (`\\blockquote{Long quote}`), titles (`\\title{Title}``),and document headers (`\\name{Forename}\\last{Surname}\\teacher{Teacher}\\clas{Class}\\header`, with an optional `\\date{12 July 2019}` to use a different date than today; internal registers like `\\day` can also be set as numbers).
-
-`citations.tex` provides `\\cite`, which has internal sub-commands: `\name{Author Last name for inline citation}{Author Full Name (e.g. Zinsser, William) for citation at end}`, `\\title{Chapter/Paper Title}`, `\\contain{Book or Journal Title}` (note that `\\title` should not be used with full books for citation structure), `\\version` for book version if notable, `\\relnums` for journal issue or volume number, `\\publish` for the publisher, `\\pubdate` for the date of publication, `\\locator` for the page numbers (if chapter) or web address, and `\\pagenum` for inline citation. Internal options are `\\nameinline` which includes the name in the inline citation (or title if no author) and `\\newcitation` to prevent double citing in the final. Python scripts alphabetize the citations.
+Because files are called from this directory, the relative path is `mla8.tex`, which should be included in TeX documents with `\input mla8.tex` (this method is used to allow `mla8.tex` to call `citations.tex`).
+
+In-document, `mla8.tex` provides a few facilities:
+- fonts (`\large` makes text 14pt, `\it` italicizes text, `\bf` bolds text; default 12pt roman Times New Roman)
+- a running page-numbered header which can be enabled on the first page with `\numberfirstpage`
+- blockquotes (`\blockquote{Long quote}`)
+- titles (`\title{Title}`)
+- document headers (`\name{Forename}\last{Surname}\teacher{Teacher}\clas{Class}\header`, with an optional `\date{12 July 2019}` to use a different date than today; internal registers like `\day` can also be set as numbers).
+
+`citations.tex`, referenced by `mla8.tex` provides `\cite`, which has internal sub-commands:
+- `\name{Author Last name for inline citation}{Author Full Name (e.g. Zinsser, William) for citation at end}`
+- `\title{Chapter/Paper Title}`
+- `\contain{Book or Journal Title}` (note that `\title` should not be used with full books for citation structure)
+- `\version` for book version if notable
+- `\relnums` for journal issue or volume number
+- `\publish` for the publisher
+- `\pubdate` for the date of publication
+- `\locator` for the page numbers (if chapter) or web address
+- `\pagenum` for inline citation.
+
+Internal options are:
+- `\nameinline` which includes the name in the inline citation (or title if no author)
+- `\newcitation` to prevent double citing in the final.
+Python scripts alphabetize the citations.