|
| 1 | +# Obsidian versions compatibility |
| 2 | + |
| 3 | +> | :exclamation: To avoid issues resulting from breaking changes in Obsidian always use the newest version of the plugin| |
| 4 | +> |----------------------------------------------| |
| 5 | +> | - Obsidian 1.7.2 - update the plugin to 3.1.0 or newer --> More details in a dedicated section below.| |
| 6 | +> | - Obsidian 1.6.3 - update the plugin to 2.1.11 or newer --> More details in a dedicated section below.| |
| 7 | +> | - Obsidian 1.6.0 - update the plugin to 2.1.9 or newer --> More details in a dedicated section below.| |
| 8 | +> | - Obsidian 1.5.4 - update the plugin to 2.1.7 or newer --> More details in a dedicated section below.| |
| 9 | +
|
| 10 | +--- |
| 11 | +> | :exclamation: Breaking changes in Obsidian 1.7.2 - update the plugin to 3.1.0 or newer| |
| 12 | +> |----------------------------------------------| |
| 13 | +> |
| 14 | +> Obsidian team introduced some more breaking changes in a not-backward-compatible way starting from Obsidian 1.7.2. |
| 15 | +> |
| 16 | +> The observed issues were minor and related to initial automatic application of custom sorting. |
| 17 | +> 1. The custom sort plugin is **unable to automatically apply the custom sort on start** |
| 18 | + > - when the File Explorer is not visible on app start |
| 19 | +> - for the _Lazy Plugin Loader_ plugin occurs by definition |
| 20 | +> - prevalent on mobile |
| 21 | +> |
| 22 | +> The release 3.1.0 fixed some of the scenarios by introducing a delay in initial auto-application |
| 23 | +> of custom sorting. The delay is by default set to 1 second and can be increased up to 30 seconds, |
| 24 | +> which can be needed for large vaults, large number of plugins or on mobile. |
| 25 | +> |
| 26 | +> At the same time, when the File Explorer is not visible on app start, the custom sorting can't be |
| 27 | +> applied automatically by definition: there is no instance of File Explorer. This is an unfortunate |
| 28 | +> side effect of the [deferred views](https://docs.obsidian.md/Plugins/Guides/Understanding+deferred+views) |
| 29 | +> introduced by Obsidian 1.7.2. |
| 30 | +> There is no cure for this scenario and the custom sorting has to be applied manually when the |
| 31 | +> File Explorer is eventually displayed. The simplest way is to click the ribbon icon (on desktop) |
| 32 | +> or use the command 'sort-on' on mobile. |
| 33 | +> |
| 34 | +> 2. The custom sort plugin **keeps showing the notifications** with each change to any note |
| 35 | +> |
| 36 | +> The release 3.1.0 fixed this fully |
| 37 | +> |
| 38 | +> --- |
| 39 | +> For more details of the observed misbehaviors you can go to: |
| 40 | +> - [#161: Find out how to automatically apply custom sort on app start / vault (re)load etc.](https://github.com/SebastianMC/obsidian-custom-sort/issues/161) |
| 41 | +> - [#162: \[bug\]\[minor\] Obsidian 1.7.2 breaking changes - when File Explorer is not displayed an attempt to apply custom sort fails with error](https://github.com/SebastianMC/obsidian-custom-sort/issues/162) |
| 42 | +> - [#163: Obsidian 1.7.2 - automatic sorting fails when launching Obsidian](https://github.com/SebastianMC/obsidian-custom-sort/issues/163) |
| 43 | +> - [#165: Obsidian 1.7.3 - Constant Notifications "Custom sorting ON" and "Parsing custom sorting specification SUCCEEDED!"](https://github.com/SebastianMC/obsidian-custom-sort/issues/165) |
| 44 | +> - [#169: Not working on mobile](https://github.com/SebastianMC/obsidian-custom-sort/issues/169) |
| 45 | +> |
| 46 | +
|
| 47 | +--- |
| 48 | +> | :exclamation: Breaking changes in Obsidian 1.6.3 causing a minor issue - update the plugin to 2.1.11 or newer| |
| 49 | +> |----------------------------------------------| |
| 50 | +> |
| 51 | +> Obsidian team introduced yet another breaking change in 1.6.3 probably related to plugin's lifecycle or File Explorer module lifecycle. |
| 52 | +> In result, due to race condition, the custom sort order is not always applied automatically after app reload or vault reload. |
| 53 | +> Manual (re)application is needed via ribbon click of via 'sort on' command. |
| 54 | +> The [2.1.11](https://github.com/SebastianMC/obsidian-custom-sort/releases/tag/2.1.11) release of the plugin fixes this inconvenience. |
| 55 | +> |
| 56 | +> For more details of the observed misbehavior (of not updated plugin) you can go to [#147](https://github.com/SebastianMC/obsidian-custom-sort/issues/147) |
| 57 | +
|
| 58 | +--- |
| 59 | +> | :exclamation: Breaking changes in Obsidian 1.6.0 (and newer) - update the plugin to 2.1.9 or newer| |
| 60 | +> |----------------------------------------------| |
| 61 | +> |
| 62 | +> Obsidian team introduced some breaking changes in File Explorer sorting code in a not-backward-compatible way starting from Obsidian 1.6.0. |
| 63 | +> |
| 64 | +> The **custom sort** plugin starting from release **2.1.9** was adjusted to work correctly with these breaking changes in Obsidian 1.6.0 and newer. |
| 65 | +> The plugin remains backward compatible, so you can safely update the plugin for Obsidian earlier than 1.6.0 |
| 66 | +> |
| 67 | +> For more details of the observed misbehavior (of not updated plugin) you can go to [#145](https://github.com/SebastianMC/obsidian-custom-sort/issues/145) |
| 68 | +
|
| 69 | +--- |
| 70 | +> | :exclamation: Breaking changes in Obsidian 1.5.4 (and newer) - update the plugin to 2.1.7 or newer| |
| 71 | +> |----------------------------------------------| |
| 72 | +> |
| 73 | +> Obsidian team introduced some breaking changes in File Explorer in a not-backward-compatible way starting from Obsidian 1.5.4. |
| 74 | +> |
| 75 | +> The **custom sort** plugin starting from release **2.1.7** was adjusted to work correctly with these breaking changes in Obsidian 1.5.4 and newer. |
| 76 | +> The plugin remains backward compatible, so you can safely update the plugin for Obsidian earlier than 1.5.4 |
| 77 | +> |
| 78 | +> For more details of the observed misbehavior (of not updated plugin) you can go to [#131](https://github.com/SebastianMC/obsidian-custom-sort/issues/131) or [#135](https://github.com/SebastianMC/obsidian-custom-sort/issues/135) or [#139](https://github.com/SebastianMC/obsidian-custom-sort/issues/139) |
| 79 | +> |
| 80 | +
|
0 commit comments