Update docs for heidi

coenm · Aug 6, 2023 · 9e5898b · 9e5898b
1 parent 2590d53
commit 9e5898b
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 8 deletions.
diff --git a/docs/HeidiInRepoM.png b/docs/HeidiInRepoM.png
diff --git a/docs/HeidiSQL.png b/docs/HeidiSQL.png
diff --git a/docs/RepoM.Plugin.Heidi.md b/docs/RepoM.Plugin.Heidi.md
@@ -1,6 +1,7 @@
 # Heidi
 
-*todo description*
+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 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. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
@@ -23,10 +24,27 @@ The following default configuration is used:
 
 Properties:
 
-- `ConfigPath`: The full directory where the configuration is stored.
-- `ConfigFilename`: The configurration filename (without path)
+- `ConfigPath`: The full directory where the portable configuration file is stored.
+- `ConfigFilename`: The portable-configurration filename (without path). Most likely `portable_settings.txt`
 - `ExecutableFilename`: The full executable of Heidi. <!-- endInclude -->
 
+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)
+
 ## heidi-databases@1 <!-- include: _plugins.heidi.action. path: /docs/mdsource/_plugins.heidi.action.include.md -->
 
 <!-- todo, improve docs -->

diff --git a/docs/mdsource/RepoM.Plugin.Heidi.source.md b/docs/mdsource/RepoM.Plugin.Heidi.source.md
@@ -1,9 +1,27 @@
 # Heidi
 
-*todo description*
+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 monitors this file and provides an action menu and a variable provider to access this information.
 
 include: _plugin_enable
 
 include: DocsModuleSettingsTests.DocsModuleSettings_HeidiPackage#desc.verified.md
 
+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)
+
 include: _plugins.heidi.action
diff --git a/src/RepoM.Plugin.Heidi/PersistentConfiguration/HeidiConfigV1.cs b/src/RepoM.Plugin.Heidi/PersistentConfiguration/HeidiConfigV1.cs
@@ -5,12 +5,12 @@ namespace RepoM.Plugin.Heidi.PersistentConfiguration;
 public class HeidiConfigV1
 {
     /// <summary>
-    /// The full directory where the configuration is stored.
+    /// The full directory where the portable configuration file is stored.
     /// </summary>
     public string? ConfigPath { get; init; }
 
     /// <summary>
-    /// The configurration filename (without path)
+    /// The portable-configurration filename (without path). Most likely `portable_settings.txt`
     /// </summary>
     public string? ConfigFilename { get; init; }
 

diff --git a/...edDocs/DocsModuleSettingsTests.DocsModuleSettings_HeidiPackage#desc.verified.md b/...edDocs/DocsModuleSettingsTests.DocsModuleSettings_HeidiPackage#desc.verified.md
@@ -17,6 +17,6 @@ The following default configuration is used:
 
 Properties:
 
-- `ConfigPath`: The full directory where the configuration is stored.
-- `ConfigFilename`: The configurration filename (without path)
+- `ConfigPath`: The full directory where the portable configuration file is stored.
+- `ConfigFilename`: The portable-configurration filename (without path). Most likely `portable_settings.txt`
 - `ExecutableFilename`: The full executable of Heidi.