From 8808bf7e80d9ec15b70b751b2834b2314d08b140 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 14 Sep 2024 20:17:47 +0000 Subject: [PATCH] Docs changes --- docs/plugin_repom.plugin.heidi.generated.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/plugin_repom.plugin.heidi.generated.md b/docs/plugin_repom.plugin.heidi.generated.md index b9d2e7f9..8de43793 100644 --- a/docs/plugin_repom.plugin.heidi.generated.md +++ b/docs/plugin_repom.plugin.heidi.generated.md @@ -40,3 +40,19 @@ Example configuration: - `ConfigFilename`: The portable-configurration filename (without path). Most likely `portable_settings.txt` - `ExecutableFilename`: The full executable of Heidi. +In order to let RepoM know what database configuration should be linked to what git repository the following should be added in the comment section when editing a database configuration in the Heidi's session manager. + +- `repo`: Selector of the git repository (required, string) +- `name`: Name of the title in the RepoM menu (required, string) +- `order`: Order of appearance in RepoM. This is only applicable when multiple databases are linked to the same repository (optional, integer, default `0`) + +Example: + +```text +#repo:RepoM +#name:"RepoM Test database" +#order:31 +``` + +![Screenshot](HeidiSQL.png) +![Screenshot](HeidiInRepoM.png)