diff --git a/docs/Ordering.md b/docs/Ordering.md index 6c3d6c39..f97903d2 100644 --- a/docs/Ordering.md +++ b/docs/Ordering.md @@ -12,41 +12,56 @@ A `comparer` compares two repositories resulting in an order between the two. Th ## Comparers -### az-comparer@1 +- [`az-comparer@1`](#az-comparer1) +- [`composition-comparer@1`](#composition-comparer1) +- [`score-comparer@1`](#score-comparer1) +- [`sum-comparer@1`](#sum-comparer1) -Compares two repositories by a given property. +These comparers are available by using the corresponding plugin. +- [`last-opened-comparer@1`](#last-opened-comparer1) -Comparer specific properties: +### `az-comparer@1` + +Compares two repositories by a given property alphabetically in ascending order. + +Properties: - `property`: Repository property. Currently, only `Name`, and `Location` are supported. Otherwise, comparison will always result in `0`. (optional) - `weight`: The weight of this comparer. The higher the weight, the higher the impact. -### composition-comparer@1 +### `composition-comparer@1` Compares two repositories by a composition of comparers. -Comparer specific properties: +Properties: - `comparers`: List of comparers. The first comparer not resulting in `0` will be used as final result. -### score-comparer@1 +### `score-comparer@1` Compares two repositories by a repository score. The calculation of the repository score is defined in the score provider. -Comparer specific properties: +Properties: - `score-provider`: The score provider to calculate a score for a repository. (optional) -### sum-comparer@1 +### `sum-comparer@1` Compares two repositories by the sum of the results of the comparers. -Comparer specific properties: +Properties: - `comparers`: A list of comparers. The sum of the results of the comparers will be used as final result. + +### `last-opened-comparer@1` + +Compares two repositories by the timestamp of the last action RepoM performed on the repository. + +Properties: + +- `weight`: The weight of this comparer. The higher the weight, the higher the impact. ## Scorers ** Could not find include 'RepositoriesScorerConfigurationTests.CoreScorersMarkdown.verified.md' ** - diff --git a/docs/RepoM.Plugin.Heidi.md b/docs/RepoM.Plugin.Heidi.md index 5f9ae21f..fc212f7d 100644 --- a/docs/RepoM.Plugin.Heidi.md +++ b/docs/RepoM.Plugin.Heidi.md @@ -1,6 +1,6 @@ # Heidi -This module integrates with a portable [HeidiSQL](https://www.heidisql.com/) installation. The portable Heidi DB saves it's database configuration in a portable configuration file. +This module integrates with a portable [HeidiSQL](https://www.heidisql.com/) installation. The portable Heidi DB saves its database configuration in a portable configuration file. This module monitors this file and provides an action menu and a variable provider to access this information. To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.