Skip to content

Commit a82ec07

Browse files
author
SebastianMC
committed
Documentation update
- syntax-reference.md update (not final)
1 parent 0a6184e commit a82ec07

File tree

3 files changed

+3
-18
lines changed

3 files changed

+3
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Take full control of the order of your notes and folders:
4545

4646
## TL;DR Usage
4747

48-
For full version of the manual go to [./docs/manual.md](./docs/manual.md) and [./docs/syntax-reference.md](./docs/manual.md)
48+
For full version of the manual go to [./docs/manual.md](./docs/manual.md) and [./docs/syntax-reference.md](./docs/syntax-reference.md)
4949
> REMARK: as of this version of documentation, the manual and syntax reference are empty :-)
5050
5151
> **Quickstart**

docs/manual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Yet to be filled with content ;-)
22

3-
See [syntax-reference.md](), maybe that file has already some content?
3+
See [syntax-reference.md](./syntax-reference.md), maybe that file has already some content?

docs/syntax-reference.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> Document is partial, creation in progress
22
> Please refer to [README.md](../../README.md) for usage examples
3-
> Check [manual.md](), maybe that file has already some content?
3+
> Check [manual.md](./manual.md), maybe that file has already some content?
44
55
# Table of contents
66

@@ -49,20 +49,6 @@ The intention is to make it understandable to non-technical persons.
4949

5050
## Section
5151

52-
- a `section` specifies sorting for one or more folders of the vault
53-
- a `section` starts with one or more [target-folder:](#target-folder) lines, each one specifying a folder or a folders (sub)tree
54-
- the `target-folder:` is optional for the very first `section` in a `sorting-spec:` YAML entry.
55-
In that case it is assumed that the target folder is the parent folder of the note containing the `sorting-spec:`
56-
- if a `target-folder:` is specified, the above default behavior is not applicable.
57-
- subsequent lines with `target-folder:` are collected and treated as multi-target-folder specification
58-
- empty lines are ignored
59-
- [comments](#Comments) are ignored as well
60-
- one (or more) `target-folder:` lines has to be followed by [sorting instruction(s)](#sorting-instructions) for these folders
61-
- the `sorting instruction(s)` can be ignored only for the last (or only) `target-folder:` line of `sorting-spec:`.
62-
In that case, the default alphabetical sorting is assumed for the specified folders, treating the folders and notes equally
63-
- occurrence of `target-folder:` line after one or more `sorting-instruction(s)` indicates a beginning of a new `section`
64-
65-
---
6652
- a [section](#Section) specifies sorting for one or more folders of the vault
6753
- a [section](#Section) starts with one or more [target-folder:](#target-folder) lines, each one specifying a folder or a folders (sub)tree
6854
- the [target-folder:](#target-folder) is optional for the very first [section](#Section) in a `sorting-spec:` YAML entry.
@@ -76,7 +62,6 @@ The intention is to make it understandable to non-technical persons.
7662
In that case, the default alphabetical sorting is assumed for the specified folders, treating the folders and notes equally
7763
- occurrence of [target-folder:](#target-folder) line after one or more `sorting-instruction(s)` indicates a beginning of a new [section](#Section)
7864

79-
8065
## target-folder:
8166

8267
TBD

0 commit comments

Comments
 (0)