Index DocType

Index documents are the primary method of structuring the semantic tree and tree graph. They are one of the central document types to this template (besides entry doctypes and post doctypes).

Markdown ๐Ÿ

Index files build the semantic tree, which can be viewed on the map page and the tree graph. They are placed in the ./_index/ directory and each file should contain a markdown outline with wikirefs that typically point to entry doctypes (but can point to any document type). They may or may not contain yaml frontmatter.

Documents should look like this (minus comments):

(escape chars โ€˜\โ€™ added to ensure raw text display)

// file: i.bonsai.md

- [\[bk.how-to-read-a-book]]
  - [\[read]]
    - [\[4-levels-of-reading]]
      - [\[elementary-reading]]
      - [\[inspectional-reading]]
      - [\[analytical-reading]]
      - [\[syntopical-reading]]

The tree may also be broken up into multiple index files:

// file: i.bonsai.md

- [\[bk.how-to-read-a-book]]
  - [\[i.read]]
// file: i.read.md

- [\[4-levels-of-reading]]
  - [\[elementary-reading]]
  - [\[inspectional-reading]]
  - [\[analytical-reading]]
  - [\[syntopical-reading]]

Both of the above examples will generate a tree that looks like this:

i.bonsai
โ””โ”€โ”€ bk.how-to-read-a-book
    โ””โ”€โ”€ i.read
        โ””โ”€โ”€ 4-levels-of-reading
          โ”œโ”€โ”€ elementary-reading
          โ”œโ”€โ”€ inspectional-reading
          โ”œโ”€โ”€ analytical-reading
          โ””โ”€โ”€ syntopical-reading