Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Jun 23, 2020
1 parent e1cbfca commit ddbcdc3
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
9 changes: 6 additions & 3 deletions guide/2011503.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Graph view

A zettelkasten is a [directed graph](https://en.wikipedia.org/wiki/Directed_graph), and <2017401> is a subset of this graph established by having zettels branch off to other zettels.
A zettelkasten is a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). Neuron also has the notion of <2017401>, which is a subset of this graph established by having zettels "branch off" to other zettels.

## z-index

The z-index page (at `/z-index.html`; also linked in the footer) displays your Zettelkasten folgezettel graph. Neuron detects if there are any cycles in the graph (use `cf` to resolve cycles). Then, it detects all <2012301> in the graph, and displays the <2017401> for each cluster.
The z-index page (at `/z-index.html`; also linked in the header) displays the zettelkasten <2017401> for all <2012301> in the zettelkasten graph.

## Uplinks and Backlinks

Uplinks are a kind of backlinks. Specifically an **uplink tree** of a zettel is the subset of the <2017401> which branch off to the zettel. Uplink tree is displayed above the zettel; other backlinks are displayed below.
A backlink of a zettel is a zettel that links to it. If that link is a folgezettel link, it is called an "uplink".

An **uplink tree** of a zettel is the subset of the <2017401> which branch off to the zettel. Uplink tree is displayed above the zettel; other backlinks are displayed below.

Use `?cf` (see <2011504?cf>) to eject something out of a zettel's uplink tree.
17 changes: 13 additions & 4 deletions guide/2011504.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,22 @@ linked zettel.

If your link is merely a reference to another zettel, and you do not wish it to
be part of the <2017401?cf>, but only the graph connection, use the `cf`[^cf] query
flag (eg: `<ef3dke98?cf>`). Neuron will link the zettels, but the link would be
ignored when building the <2017401?cf>. This is especially useful to resolve
cycles and ensure sensible clusters.
flag (eg: `<ef3dke98?cf>`).

```markdown
This is a zettel file, which refers to another zettel without
strongly linking to it:

* <ef3dke98?cf>
```

Neuron will link the zettels, but the link would be
ignored when building the <2017401?cf>. This is especially useful to ensure sensible
clusters.

## Advanced linking

* [[2011506]]
* <2011506>

[^cf]:
> The abbreviation cf. (short for the Latin: *confer/conferatur*, both meaning "compare") is used in writing to refer the reader to other material to make a comparison with the topic being discussed. [Wikipedia](https://en.wikipedia.org/wiki/Cf.)
Expand Down
2 changes: 1 addition & 1 deletion neuron/src/lib/Neuron/Web/ZIndex.hs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ renderZIndex (Theme.semanticColor -> themeColor) ZIndex {..} = do
el "ul" $ renderForest forest
where
countNounBe noun nounPlural = \case
1 -> show 1 <> noun
1 -> "1 " <> noun
n -> show n <> " " <> nounPlural

renderErrors :: DomBuilder t m => Map ZettelID ZettelError -> NeuronWebT t m ()
Expand Down

0 comments on commit ddbcdc3

Please sign in to comment.