tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation update 

- syntax-reference.md update (not final)
This commit is contained in:
SebastianMC 2022-10-10 10:31:41 +02:00
parent 0a6184ee0b
commit a82ec0747c
3 changed files with 3 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -45,7 +45,7 @@ Take full control of the order of your notes and folders:
## TL;DR Usage
For full version of the manual go to [./docs/manual.md](./docs/manual.md) and [./docs/syntax-reference.md](./docs/manual.md)
For full version of the manual go to [./docs/manual.md](./docs/manual.md) and [./docs/syntax-reference.md](./docs/syntax-reference.md)
> REMARK: as of this version of documentation, the manual and syntax reference are empty :-)
> **Quickstart**

2
docs/manual.md
View File

@ -1,3 +1,3 @@
Yet to be filled with content ;-)
See [syntax-reference.md](), maybe that file has already some content?
See [syntax-reference.md](./syntax-reference.md), maybe that file has already some content?

17
docs/syntax-reference.md
View File

@ -1,6 +1,6 @@
> Document is partial, creation in progress
> Please refer to [README.md](../../README.md) for usage examples
> Check [manual.md](), maybe that file has already some content?
> Check [manual.md](./manual.md), maybe that file has already some content?
# Table of contents
@ -49,20 +49,6 @@ The intention is to make it understandable to non-technical persons.
## Section
- a `section` specifies sorting for one or more folders of the vault
- a `section` starts with one or more [target-folder:](#target-folder) lines, each one specifying a folder or a folders (sub)tree
- the `target-folder:` is optional for the very first `section` in a `sorting-spec:` YAML entry.
In that case it is assumed that the target folder is the parent folder of the note containing the `sorting-spec:`
- if a `target-folder:` is specified, the above default behavior is not applicable.
- subsequent lines with `target-folder:` are collected and treated as multi-target-folder specification
- empty lines are ignored
- [comments](#Comments) are ignored as well
- one (or more) `target-folder:` lines has to be followed by [sorting instruction(s)](#sorting-instructions) for these folders
- the `sorting instruction(s)` can be ignored only for the last (or only) `target-folder:` line of `sorting-spec:`.
In that case, the default alphabetical sorting is assumed for the specified folders, treating the folders and notes equally
- occurrence of `target-folder:` line after one or more `sorting-instruction(s)` indicates a beginning of a new `section`
---
- a [section](#Section) specifies sorting for one or more folders of the vault
- a [section](#Section) starts with one or more [target-folder:](#target-folder) lines, each one specifying a folder or a folders (sub)tree
- 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.
In that case, the default alphabetical sorting is assumed for the specified folders, treating the folders and notes equally
- occurrence of [target-folder:](#target-folder) line after one or more `sorting-instruction(s)` indicates a beginning of a new [section](#Section)
## target-folder:
TBD