Skip to content

Commit b39ef60

Browse files
committed
Update of README.md to reflect most recent state of the plugin and its features
1 parent c9ea86d commit b39ef60

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
## Freely arrange notes and folders in File Explorer (https://obsidian.md plugin)
1616

1717
Take full control of the order of your notes and folders by:
18-
- **drag and drop** via boookmarks integration, and
19-
- **config-driven** sorting, allowing the fullest range of finegrained ordering
18+
- **config-driven** sorting with wide variety of options, allowing the fullest range of fine-grained ordering, or
19+
- **drag and drop** via bookmarks integration.
2020

2121
The simplest usage scenario is to sort items via drag and drop:
2222

@@ -32,8 +32,10 @@ More advanced capabilities available through config-driven sorting:
3232
- treat folders and files equally or distinctively, you decide
3333
- fine-grained folder-level or even notes-group-level specification
3434
- support for fully manual order
35-
- list notes and folders names explicitly, or use prefixes or suffixes only
35+
- list notes and folders names explicitly in desired order
36+
- use prefixes or suffixes notation only for more flexibility
3637
- wildcard names matching supported
38+
- extract numbers and dates from titles and sort by them
3739
- group and sort notes and folders by notes custom metadata
3840
- support for automatic sorting by standard and non-standard rules
3941
- mixing manual and automatic ordering also supported
@@ -42,8 +44,8 @@ More advanced capabilities available through config-driven sorting:
4244
- grouping by prefix or suffix or prefix and suffix
4345
- different sorting rules per group even inside the same folder
4446
- simple to use yet versatile configuration options
45-
- order configuration stored directly in your note(s) front matter
46-
- use a dedicated `sorting-spec:` key in YAML
47+
- configuration stored directly in your note(s) front matter
48+
- use a dedicated `sorting-spec:` key in note properties (aka _metadata_ aka _frontmatter_ aka _YAML_)
4749
- folders not set up for the custom order remain on the standard Obsidian sorting
4850
- support for imposing inheritance of order specifications with flexible exclusion and overriding logic
4951

@@ -81,7 +83,7 @@ An illustrative image which shows the reverse alphabetical order applied to the
8183
> - the behavior depends on what files and subfolders you have in your folder
8284
> - changing the sorting order via the standard Obsidian UI button won't affect your folder, unless...
8385
> - ...unless you deactivate the custom sorting via clicking the ribbon button to make it ![Inactive](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-inactive.png)
84-
> - for clarity: the underlying file of the note `sortspec` is obviously `sortspec.md`
86+
> - for clarity: the underlying file name of the note `sortspec` is obviously `sortspec.md`
8587
> - in case of troubles refer to the [TL;DR section of advanced README.md](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/advanced-README.md#tldr-usage)
8688
> - feel free to experiment! The plugin works in a non-destructive fashion, and it doesn't modify the content of your vault.
8789
> It only changes the order in which the files and folders are displayed in File Explorer
@@ -119,7 +121,7 @@ There are short videos here [How to create or edit a multi‐line property in Ob
119121
---
120122
## Basic automatic sorting methods
121123

122-
The list of basic automatic sorting orders includes:
124+
The list of automatic sorting orders includes:
123125
- ` order-asc: a-z` - **alphabetical order**, aka natural
124126
- 'a' goes before 'z' and numbers are treated specifically and 2 goes before 11
125127
- ` order-desc: a-z` - **reverse alphabetical order**, aka reverse natural, aka descending alphabetical
@@ -153,12 +155,32 @@ The list of basic automatic sorting orders includes:
153155
- for sub-folders the modification date of the most recently modified contained note is taken as folder's modification date
154156
- sub-folders not containing any notes are pushed to the bottom, alphabetically
155157

156-
> Remark:
157-
> In the above list the `-asc` stems from `Ascending` and `-desc` stems from `Descending`
158+
> Remarks:
159+
> In the above list the `-asc` stems from `Ascending` and `-desc` stems from `Descending`.
160+
> The `order-desc:` and `order-asc:` can be replaced with more concise `<` and `>` varians, for example `< a-z` instead of `order-asc: a-z`
161+
162+
...and additional orders and modifiers:
163+
- `standard`, `ui selected` - apply whatever order is selected in Obsidian UI of File Explorer
164+
- `by-bookmarks-order` - reflect the order of selected group of items in Bookmarks
165+
- `files-first` or `folders-first` - self explaining
166+
- `vsc-unicode` or `unicode-charcode` - tricky for geeks
167+
- `by-metadata:` modifier to use specific metadata for sorting
168+
- `,` separator to specify two levels of sorting. When combining folder-level and group-level sorting this allows for up to 4 sorting levels
169+
- `advanced recursive modified` or `advanced recursive created` - a more verbose names for `advanced modified` and `advanced created`
170+
171+
## Patterns to extract numbers or dates from file and folder titles
172+
173+
- `\R+`, `\.R+` or `\-R+` for Roman numbers
174+
- `\d+`, `\.d+` or `\-d+` for plain numbers or compound plain numbers
175+
- `\a+` to extract the last word from title
176+
- `\[yyyy-mm-dd]`, `\[yyyy-dd-mm]`, `\[dd-Mmm-yyyy]`, `\[Mmm-dd-yyyy]`, `\[yyyy-Www (mm-dd)]`, `\[yyyy-Www]` or `\[yyyy-WwwISO]`
177+
158178

159179
## Manual sorting
160180

161-
The **manual ordering of notes and folders** is also done via the sorting configuration.
181+
The **manual ordering of notes and folders** can have two meanings:
182+
- by drag & drop, and this is done via Bookmarks integration, enabled by default, or
183+
- by explicitly listing files and folders in the desired order. This is done via the sorting configuration.
162184
Refer to the [TL;DR section of advanced README.md](https://github.com/SebastianMC/obsidian-custom-sort/blob/master/docs/advanced-README.md#tldr-usage) for examples and instructions
163185

164186
## Ribbon icon
@@ -167,11 +189,10 @@ Click the ribbon icon to toggle the plugin between enabled and suspended states.
167189

168190
States of the ribbon icon on large-screen devices (desktops, laptops and tablets like iPad):
169191

170-
- ![Inactive](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-inactive.png) Plugin suspended. Custom sorting NOT applied.
192+
- ![Inactive](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-inactive.png) Custom sorting NOT applied. Plugin suspended or enabled, but the custom sorting was not (yet) applied.
171193
- ![Active](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-active.png) Plugin active, custom sorting applied.
172194
- ![Error](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-error.png) Syntax error in custom sorting configuration.
173-
- ![General Error](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-general-error.png) Plugin suspended. General error.
174-
- ![Sorting not applied](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-not-applied.png) Plugin enabled, but the custom sorting was not applied.
195+
- ![General Error](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-general-error.png) Plugin suspended. Critical error like File Explorer view not available.
175196
- ![Static icon](https://raw.githubusercontent.com/SebastianMC/obsidian-custom-sort/master/docs/icons/icon-mobile-initial.png) (Only on large-screen mobile devices like iPad).
176197
Plugin enabled. but the custom sorting was not applied.
177198

0 commit comments

Comments
 (0)