-
Notifications
You must be signed in to change notification settings - Fork 265
Split into multiple files to avoid complicated merges #23
Description
We should consider splitting this document into multiple files to avoid complicated merges and allow for a clearer structure. I'd recommend a file structure like this:
/README.md ; actual summary of the project; annotated TOC
/guide/01-introduction-and-goals/README.md ; introduction and goals
/guide/01-introduction-and-goals/image-for-ch1.png ; some picture
/guide/02-your-first-document/REAMDE.md ; first doc
...
Before I actually make the PR though, I'd like to nail down what the TOC should look like. This is what we have right now:
- What is LaTeX?
- Why use LaTeX?
- Set up for LaTeX
- First LaTeX file
- A deeper look
- Multilingual usage
- Paragraph and section
- Making a table of contents
- Footnotes
- What is a package?
- Table
- Adding images
- Insert code into LaTeX
- Additional Tools
Here's what I'd propose:
-
Preface and Installation
Encompasses what/why, setup, and 'hello, world'. Gives a link to the section on multilingual support. Uses TeXworks as a 'click play' editor that's already installed with all major distributions.
-
Introduction
Explains 'hello, world' example and introduces the concept of packages via another example. Introduces build tools like Arara that will be used in the rest of the document's examples (What should we do about compile steps? #22). Introduces other editors like Texmaker, TeXShop, Kile, Emacs, and Vim. Drives home the 'LaTeX is a markup language' point -- it's editor-agnostic.
-
Organizing Your Document
Sectioning, tables of contents, and cross-referencing. Footnotes, images, tables, and LOFs/LOTs.
-
More sections as time goes on…