Multiple Documents

Insert a line containing three hyphens --- to separate the outline into multiple documents.

For example:

---
- Title
- Contents
---
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast
---
- Text:
  - Tuesday:
    - Gray skies
    - A gust of wind

If a project has multiple documents, a contents section will include headings from all documents.

Metadata

The metadata keyword will generate a section that includes information from metadata.yml.

If the outline does not indicate which metadata values to include, Muwu will display all key-value pairs.

• Unlike the title section, a metadata section displays both the key and its value.

For example:

- Title
- Metadata:
  - copyright
  - publisher
  - editor
- Contents
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast
  - Tuesday:
    - Gray skies
    - A gust of wind

In the above example, the metadata section would appear as:

copyright
2013

publisher
Raincloud Books

editor
Kerry Kyles

- Metadata:
  - date of this edition

date of this edition
2018-10-07

Navigator

The navigator keyword will create the following links to move between multiple documents:

• prev (previous)
• home
• next

If a project outline has multiple documents, Muwu will automatically generate navigator sections at the top and bottom of each document.

To generate navigator sections manually:

1. Open the file options.yml.
2. Change the option generate_navigators_automatically to false.
3. Add the navigator keyword to the outline.

For example:

---
- Navigator
- Title
- Contents
---
- Navigator
- Subcontents
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast
---
- Navigator
- Subcontents
- Text:
  - Tuesday:
    - Gray skies
    - A gust of wind

Subcontents

The subcontents keyword will build a table of subcontents only for the outline entries in enclosing document. Muwu will include the title of the project as a heading.

For example:

---
- Title
- Contents
---
- Subcontents
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast
---
- Subcontents
- Text:
  - Tuesday:
    - Gray skies
    - A gust of wind

To generate a subcontents section automatically for each document with a text section:

1. Open the file options.yml.
2. Change generate_subcontents_automatically to true.

Title

The title keyword will generate a section to show the title of the project, as found in metadata.yml.

By default, Muwu will also look for the subtitle and the author.

For example:

- Title
- Contents
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast
  - Tuesday:
    - Gray skies
    - A gust of wind

In the above example, the title section would appear as:

Distant Thunder

A Rolling Affair

Jove Moon

You can customize the title section by indicating which metadata values to include.

For example:

- Title:
  - title
  - author
  - copyright

Implicit

With an implicit outline, the headings and topics in the outline indicate a path to the source files in the text/ folder.

• Muwu will use lowercase letters for the filenames.
• Numbers are allowed.
• Muwu will convert non-word characters to underscores (_).
• Muwu will add .md as a file extension.
• Parent headings in the outline indicate a folder. Parent headings can also indicate an optional file.
• Subtopics indicate a file.

For example:

- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast

The above example would imply the following filenames within the text/ folder:

monday.md
monday/a_trip_uptown.md
monday/uncertain_forecast.md

Haml option

If Muwu cannot find a source file ending in .md, it will also look for a source file file ending in .haml.

Muwu will give priority to Markdown files ending in .md.

- Text introduction:
  - Forward
  - Dedication
- Text:
  - Monday:
    - A trip uptown
    - Uncertain forecast

introduction/forward.md
introduction/dedication.md
main/monday.md
main/monday/a_trip_uptown.md
main/monday/uncertain_forecast.md

Explicit

In an explicit outline, all parent headings and subtopics are the path to the file within the source folder.

• Muwu will allow only word characters (a-zA-Z0-9_) in a filename.
• Muwu will convert any non-word characters in the basename or extension to underscores (_).

For example:

Text introduction:
  - intro/forward.md
  - intro/dedication.md
Text main:
  - monday.md:
    - monday/a_trip_uptown.md
    - monday/uncertain_forecast.md

Flexible

A flexible outline combines features of the implicit and explicit methods.

• Outline entries that do not end with .md or .haml indicate an implicit filepath.
• Outline entries that do end with .md or .haml indicate an explicit filepath.

For example:

Text introduction:
  - intro/forward.md
  - intro/dedication.md
Text:
  - Monday:
    - A Trip Uptown
    - uncertain_forecast.md

The above example would indicate the following filenames within the text/ folder:

intro/forward.md
intro/dedication.md
main/monday.md
main/a_trip_uptown.md
uncertain_forecast.md