en/static/graph.toml

root_node = "Documentation"

[nodes.Documentation]
text = """
## Installation

For now, if you want to try en, you must build it yourself.

In an environment with a |Rust toolchain|https://rustup.rs/ and Git installed, run:

`
git clone https://codeberg.org/jutty/en
cd en
cargo build --release
`

The en binary will be in `target/release/en`.

You can start it and point it to an address, port and graph:

`
en --host localhost --port 3003 --graph ./graph.toml
`

See |CLI| for defaults and details on the CLI options.

## Graph Syntax

The graph is a TOML file. You can create nodes by adding text such as:

`
[nodes.Computer]
text = "A computer is a machine capable of executing arbitrary instructions."
`

If you need longer text, it's more convenient to use triple quotes:

`
[nodes.Computer]
text = \"""
A computer is a machine capable of executing arbitrary instructions.
\"""
`

Some special syntax is allowed inside the node text. See |Syntax| for supported features.

A node can have several other attributes. See |Node| for details on all of them.

## Connections

Nodes can have connections between each other.

To add a simple connection without any associated properties, you can simply add links:

`
[nodes.Quark]
text = "A subatomic particle that forms hadrons."

links = [ "Particle", "Hadron" ]
`

This will create two outgoing connections from Quark: to Particle and to Hadron. It will also list Quark as an incoming connection in these nodes' pages.

If you want to add properties to the connection, you can use the connection syntax:

`
[[nodes.Quark.connections]]
to = "Particle physics"
anchor = "particle"
`

This will create a connection from Quark to "Particle physics", and the first occurrence of the word "particle" in the text of Quark gets anchored to this connection.
"""

[nodes.Node] # foo
text = """
A node is defined in your graph file starting with a table header of the form:

`
[nodes.ID]
`

Where `ID` is an identifier of your choice.

While the |TOML| specification is quite flexible regarding what characters can make up this identifier, it's recommended that you keep it simple and use only letters and numbers. See |AnchorSyntax| for more details on why.

## Fields

Nodes can have several optional fields that alter how en interprets and displays them.

- `title`: The main heading shown at the top of the page and tab title
- `text`: The textual content that is shown when the node is accessed
- `redirect`: Where to redirect any attempt to access the node
- `links`: An array of identifiers for other nodes to which this node is connected
- `hidden`: Whether this node should be listed in the index and tree pages. This won't prevent the node from being found or linked to directly through its ID

## Example

`
[nodes.Citrus]
title = "Citrus Trees"
hidden = false
text = "Citrus is a |genus| of trees known mainly for its fruits."
redirect = "Citric"
links = [ "Orange", "Lemon", "Lime", "Grapefruit", ]

[[nodes.Citrus.connections]]
from = "Citrus"
to = "Citric acid"
`

### Default values

The example above has all fields in it for completeness, but all fields have default values and are therefore optional. This means that explicitly writing `hidden = false` is the same as not setting it at all.

The default values for unset fields are:

- `title`: Same as the identifier
- `text`: An empty string (i.e. `text = ""`)
- `redirect`: An empty string
- `links`: An empty array (i.e. `links = []`)
- `hidden`: `false`
"""

[nodes.CLI]
title = "CLI Options"
text = """ # bb
You can set the hostname, port and graph file path using CLI options:

For the hostname, use `-h` or `--hostname`:

`
en -h localhost
en --hostname 10.120.0.5
`

If unspecified, the default is `0.0.0.0`.

For the port, use `-p` or `--port`:

`
en -p 3003
en --port 3000
`

If unspecified, the default is to use a random available port assigned by the operating system.

For the graph path, use `-g` or `--graph`:

`
en -g graph.toml
en --g ./static/my-graph.toml
`

If unspecified, the default is `./static/graph.toml`.

You can combine these options as you wish:

`
en -h localhost -p 3000
en -p 3003 --host localhost --graph ./graph.toml
en --g ./graph.toml -p 1312
`

If an option is specified more than once, the last use will override any previous ones.

"""

[nodes.Syntax]
text= """

## Anchors

Anchors follow the following syntax:

`
anchor|destination
`

For example:

`
docs|/node/Documentation
`

If the left side contains spaces, you need a leading `|` character:

`
|en docs|https://en.jutty.dev/node/Documentation
`

If you have a trailing character that you don't want to be considered as part of the destination, you can separate it with a third `|`:

`
This gem|PreciousStone|, though green, was not an emerald.
`

To make a plain address clickable, wrap it in two `|` characters:

`
|https://en.jutty.dev|
`

### Node anchors

We saw above an example like `docs|/node/Documentation`, but there is a shorter syntax for node anchors.

If the address doesn't contain any `/` or `:` characters, it will be interpreted as a node ID:

`
particles|ParticlePhysics
`

This allows you to specify what to display as the anchor text, but just the ID wrapped inside two `|` characters also works:

`
|Documentation|
`

Because en can resolve IDs case insensitively (with priority to case-sensitive matches), you can also write the above anchor as `|documentation|`.

In summary, all of the anchors below are valid and lead to the same page:

`
|en Syntax|https://en.jutty.dev/node/Syntax|
|en Syntax|https://en.jutty.dev/node/Syntax
Syntax|https://en.jutty.dev/node/Syntax

Syntax|/node/syntax

|syntax|Syntax
Syntax|syntax
Syntax|syntax|

|Syntax|
|syntax|
`

While flexible, this can sometimes be ambiguous. See |AnchorSyntax| for some caveats regarding anchors.

"""

[nodes.AnchorSyntax]
title = "Anchor Syntax"
text = """
Anchor syntax can be very concise, but some situations lead to ambiguity.

In short, following these two rules should keep you out of trouble:

- Avoid special characters in your node IDs
- When needed, use full three-pipe `|text|destination|` syntax to fix ambiguity

## Punctuation in destinations

Consider this example:

`
|gem|PreciousStone
|PreciousStone|,
`

Both point to the node with ID `PreciousStone`, as they indeed _seem_ to. But if we didn't treat punctuation differently, we'd have:

`
|a|b
|a|b
`

For this reason, some symbols are treated specially at the trailing boundary of anchors.

Punctuation won't be considered as a possible destination, so you can write the previous example and have it behave as expected.

This also means you can't have punctuation symbols as node IDs or as their first character.

These are the punctuation symbols that are treated specially:

`
, . : ; ? ! ( ) ' "
`

## Plural node anchors

Something similar applies to the lowercase letter `s`:

`
We found three |boat|s at the marina.
`

This conveniently lets you write plural words as anchors to their singular form without having to write:

`
We found three boats|boat at the marina.
`

Which is annoyting to write and also makes the raw text a lot noisier.

Unlike with punctuation, this doesn't mean you can't have a node with the ID `s`. You can, but you'll have to write your anchors to it always with a trailing pipe:

`
The |letter s|s| is important so we dedicated a whole page to it: |s|!
`

## Spaced node anchors

Like punctuation, node IDs can't have spaces. If you write a node anchor with spaces, it will be collapsed:

`
This |Node Anchor| will work as if it were |Node Anchor|NodeAnchor|.
`

As long as you don't have a page with the ID `NodeanchoR` and another with the ID `NodeAnchor`, this shouldn't be a problem.

Because node ID resolution redirects to a lowercase match as a fallback to an exact match, you can write:

`
The next |precious stone| was stolen in 1973.
`

And the visible text will be preserved as "precious stone" but be able to point to an ID such as `PreciousStone`.

## URL detection

en must differentiate node anchors from outgoing URLs:

`
|sample|Example|
|sample|https://example.com|

|Example|
|https://example.com|
`

It does this by looking at the destination and checking if it contains a `:` or `/`, so also avoid these in your node IDs.

"""

[nodes.en]
text = """
en is a tool to write non-linear, connected pieces of text and have their references mapped out as a graph of connected information.

It works by ingesting a TOML file containing your node specification and serving it as a website that allows nodes to be browsed, searched and listed in relation to each other or as a shallow tree of nodes.

## Motivation

en was created out of the desire to write complex, long-form descriptions of a personal worldview without being constrained or getting stuck trying to mimic the linearity of a typical philosophy book.

It's described as a "writing instrument" because it's not so much about the presentation or even the web format. While that's the medium for this particular implementation, you can notice en serves its raw data in both TOML and JSON. It's first and foremost about mapping out and structuring written thoughts.

Because en is defined in simple configuration files, you can add new pages easily from a few lines and start connecting them. Instead of having to create a dedicated file or resource for each new entry you find deserving of observation, with its own beginning and end, its own "I'm empty, fill me to completion" demeanor, you can stay in the flow of your sprawling thoughts. This is meant to fit the specific wiring of minds whose thoughts spread and fork quickly and often, whether to great depth or across wide expanses.

"""

links = [ "Graph" ]

[[nodes.en.connections]]
to = "TOML"
anchor = "TOML"

[nodes.Graph]
text = """
A graph is a data structure composed of connected (and disconnected) nodes.

A familiar example is that of a social network. Each account can be thought of as a node and the "follow" and "follower" relationships can be thought of as edges (connections). A node may have many or few connections, and the nodes it is connected to are meaningful to understand how it fits into the whole.

en uses this concept to create a writing tool, allowing you to map out complex thoughts as a web of connected texts.
"""

[nodes.TOML]
text = """
TOML is a configuration format that can be easily read and understood by humans and machines alike.

To learn more about TOML, you can visit its website at |https://toml.io|.

To see the TOML declaration that translates into the rendered graph you are reading right now, visit the "TOML Graph" link on the top navigation bar.
"""

[nodes.Acknowledgments]
text = """
en is only possible thanks to a number of projects and people:

- |The Rust Programing Language|https://rust-lang.org/
- Tokio|https://tokio.rs/
- Axum|https://github.com/tokio-rs/axum
- Tera|https://keats.github.io/tera/
- Serde|https://serde.rs/ and the |toml crate|https://github.com/toml-rs/toml
"""

[nodes.Test]
hidden = true
text = """

This node is just for testing syntax rendering, but I appreciate your curiosity.

`
|en purple|https://purple.en/n/purple
cyan|https://cyan.en/n/cyan

|en Giraffe|/node/Giraffe
|Gorilla|/node/Gorilla
Crow|/node/Crow

|Circle|Circle
Circle|Circle
|Circle|
`

|en purple|https://purple.en/n/purple
cyan|https://cyan.en/n/cyan

|en Giraffe|/node/Giraffe
Crow|/node/Crow

Circle|Circle
|Circle|

These `|anchors|` are inside `|backticks|Backtick` and should `|not render|https://test.com` as backticks but as `|raw text|` instead. This `|syntax is|` now `being demonstrated|https://test.com` here.

Well |have I ever found such a long anchor in my entire life|Nowhere|, have I?

This failed to parse due to a misunderstanding about what `parts.push(peaker.next().unwrap_or_else(|| unreachable!() ));` really meant.

This greedy anchor is |at the end of a line|Somewhere
This greedy anchor is |at the end of a line|Somewhere|
This greedy anchor is |at the end of a line with a period|Somewhere|.
This inline code is `at the end of a line`
This inline code is `at the end of a line with a period`.

---

For trailing characters you don't want as part of destination, add a third `|`:

`
This gem|PreciousStone|, though green, was not an emerald.
`

Which renders as:

This gem|PreciousStone|, though green, was not an emerald.

Supported for punctuation only.

### Node anchors

We saw example `docs|/node/Documentation`, but shorter syntax exists.

## Green
## Green
## Green
## Purple
## Purple
## Purple
## Cyan
### Cyan
#### Cyan
### Cyan
## Cyan
## Épistème
## Épistème
## Epistème
## Epistēmē
### Epistēmē
#### Epistēmē
#### Epistēmē

|en Syntax|https://en.jutty.dev/node/Syntax|
|en Syntax|https://en.jutty.dev/node/Syntax
Syntax|https://en.jutty.dev/node/Syntax

Syntax|/node/syntax

|syntax|Syntax
Syntax|syntax
Syntax|syntax|

|Syntax|
|syntax|
`"""

[meta.config]
content_language = "en"
footer_credits = false
footer_text = """
made by jutty|https://jutty.dev • acknowledgments|Acknowledgments • |source code|https://codeberg.org/jutty/en
"""