heidi

coenm · Sep 14, 2024 · c49d2b0 · c49d2b0
1 parent 1353ef5
commit c49d2b0
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 2 deletions.
diff --git a/docs_old/HeidiInRepoM.png → docs/HeidiInRepoM.png b/docs_old/HeidiInRepoM.png → docs/HeidiInRepoM.png
diff --git a/docs_old/HeidiSQL.png → docs/HeidiSQL.png b/docs_old/HeidiSQL.png → docs/HeidiSQL.png
diff --git a/docs/mdsource/plugin_repom.plugin.heidi.30.md b/docs/mdsource/plugin_repom.plugin.heidi.30.md
@@ -0,0 +1,17 @@
+
+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)
diff --git a/docs/mdsource/plugin_repom.plugin.heidi.generated.source.md b/docs/mdsource/plugin_repom.plugin.heidi.generated.source.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)
diff --git a/src/RepoM.ActionMenu.CodeGen/Templates/DocsPlugin.scriban-txt b/src/RepoM.ActionMenu.CodeGen/Templates/DocsPlugin.scriban-txt
@@ -48,8 +48,8 @@ To use this module, make sure it is enabled in RepoM by opening the menu and nav
 {{~ include 'plugin.configuration.scriban-txt' ~}}
 {{ else }}
 This plugin has no configuration.
-{{~ end ~}}
-
+{{ end ~}}
+{{~ include '30' }}
 {{~ if array.size(plugin.ActionMenus) > 0  ~}}
 This module contains the following methods, variables and/or constants:
   {{~ for member in plugin.ActionMenus ~}}

diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs
@@ -36,6 +36,7 @@ public class DocsModuleSettingsTests
         "WebBrowserPackage",
         "LuceneQueryParserPackage",
         "SonarCloudPackage",
+        "HeidiPackage",
     ];
 
     public DocsModuleSettingsTests()