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

Documentation updates (added examples for sorting by Roman and compound Roman)

This commit is contained in:
SebastianMC 2022-08-06 17:01:20 +02:00
parent d301b9ff3c
commit 38e9be7b09
3 changed files with 164 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -9,6 +9,8 @@ Take full control of the order of your notes and folders in File Explorer
- order configuration stored directly in your note(s) front matter - order configuration stored directly in your note(s) front matter
- use a dedicated key in YAML - use a dedicated key in YAML
## Table of contents
## TL;DR Usage ## TL;DR Usage
For full version of the manual go to [./docs/manual.md]() and [./docs/syntax-reference.md]() For full version of the manual go to [./docs/manual.md]() and [./docs/syntax-reference.md]()
@ -247,6 +249,48 @@ The effect is:
![Order by numerical suffix](./docs/svg/by-suffix.svg) ![Order by numerical suffix](./docs/svg/by-suffix.svg)
### Example 10: Sample book structure with Roman numbered chapters
Roman numbers are also supported. This example uses the `\R+` token in connection with the wildcard `...`
The line `Chapter \.R+ ...` says: notes (or folders) with a name starting with 'Chapter ' followed by a Roman number (e.g. I, or iii or x) should be grouped.
Then ` < a-z` (the leading space indentation is important) tells to use ascending order by that number (alphabetical is equivalent to ascending for numbers)
```yaml
---
sorting-spec: |
target-folder: Book
Preface
Chapter \R+ ...
< a-z
Epi...
---
```
it gives:
![Book - Roman chapters](./docs/svg/roman-chapters.svg)
### Example 11: Sample book structure with compound Roman number suffixes
Roman compound numbers are also supported. This example uses the `\.R+` token (a Roman compound number with '.' as separator) in connection with the wildcard `...` (and the important SPACE inbetween).
The line `... \.R+` says: notes (or folders) with a name ending with a compound Roman number (e.g. I, or i.iii or iv.vii.x) should be grouped with ascending order by that compound number (no additional specification of sorting defaults to alphabetical or ascending for numbers)
```yaml
---
sorting-spec: |
target-folder: Research pub
Summ...
... \.R+
Final...
---
```
the result is:
![Book - Roman compond suffixes](./docs/svg/roman-suffix.svg)
## Location of sorting specification YAML entry ## Location of sorting specification YAML entry
You can keep the custom sorting specifications in any of the following locations (or in all of them): You can keep the custom sorting specifications in any of the following locations (or in all of them):

60
docs/svg/roman-chapters.svg Normal file
View File

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" viewBox="-.5 -.5 314.5 187" width="314.5" height="187">
<defs/>
<metadata> Produced by OmniGraffle 7.20\n2022-08-06 14:46:09 +0000</metadata>
<g id="Roman_chapters" stroke-opacity="1" fill-opacity="1" stroke="none" fill="none" stroke-dasharray="none">
<title>Roman chapters</title>
<g id="Roman_chapters_Layer_1">
<title>Layer 1</title>
<g id="Graphic_8">
<rect x="0" y="27" width="314" height="159.5" fill="#e9e9e9"/>
</g>
<g id="Graphic_2">
<text transform="translate(18 29.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Book</tspan>
</text>
</g>
<g id="Graphic_4">
<text transform="translate(35 51.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Preface</tspan>
</text>
</g>
<g id="Graphic_5">
<text transform="translate(35 73.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Chapter I - How it all began</tspan>
</text>
</g>
<g id="Graphic_6">
<text transform="translate(35 95.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Chapter V - Expect the unexpected</tspan>
</text>
</g>
<g id="Graphic_7">
<text transform="translate(35 117.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Chapter XIII - Why?</tspan>
</text>
</g>
<g id="Graphic_9">
<rect x="0" y="0" width="175.5" height="27" fill="white"/>
<rect x="0" y="0" width="175.5" height="27" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
<text transform="translate(5 2.753441)" fill="black">
<tspan font-family="Helvetica Neue" font-weight="bold" font-size="17" fill="black" x="0" y="17">My Vault</tspan>
</text>
</g>
<g id="Graphic_27">
<text transform="translate(35 139.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Chapter L - Happy ending?</tspan>
</text>
</g>
<g id="Graphic_30">
<path d="M 4.5 35.56818 L 7 40.56818 L 9.5 35.56818 Z" fill="black"/>
</g>
<g id="Graphic_32">
<text transform="translate(35 161.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Epilogue</tspan>
</text>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

60
docs/svg/roman-suffix.svg Normal file
View File

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" viewBox="-.5 -.5 314.5 187" width="314.5" height="187">
<defs/>
<metadata> Produced by OmniGraffle 7.20\n2022-08-06 14:27:13 +0000</metadata>
<g id="Roman_sections" stroke-opacity="1" fill-opacity="1" stroke="none" fill="none" stroke-dasharray="none">
<title>Roman sections</title>
<g id="Roman_sections_Layer_1">
<title>Layer 1</title>
<g id="Graphic_8">
<rect x="0" y="27" width="314" height="159.5" fill="#e9e9e9"/>
</g>
<g id="Graphic_2">
<text transform="translate(18 29.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Research pub</tspan>
</text>
</g>
<g id="Graphic_4">
<text transform="translate(35 51.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Summary</tspan>
</text>
</g>
<g id="Graphic_5">
<text transform="translate(35 73.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Why is this needed? I</tspan>
</text>
</g>
<g id="Graphic_6">
<text transform="translate(35 95.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Additional rationale. I.iii</tspan>
</text>
</g>
<g id="Graphic_7">
<text transform="translate(35 117.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">All the details. vii</tspan>
</text>
</g>
<g id="Graphic_9">
<rect x="0" y="0" width="175.5" height="27" fill="white"/>
<rect x="0" y="0" width="175.5" height="27" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
<text transform="translate(5 2.753441)" fill="black">
<tspan font-family="Helvetica Neue" font-weight="bold" font-size="17" fill="black" x="0" y="17">My Vault</tspan>
</text>
</g>
<g id="Graphic_27">
<text transform="translate(35 139.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">The promising outcomes. L</tspan>
</text>
</g>
<g id="Graphic_30">
<path d="M 4.5 35.56818 L 7 40.56818 L 9.5 35.56818 Z" fill="black"/>
</g>
<g id="Graphic_32">
<text transform="translate(35 161.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">Final words</tspan>
</text>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB