Skip to content

Commit

Permalink
Merge branch 'feature/update-docs' of https://github.com/coenm/RepoM
Browse files Browse the repository at this point in the history
…into feature/update-docs
  • Loading branch information
coenm committed Sep 14, 2024
2 parents f45bdad + 8808bf7 commit ce118c8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/plugin_repom.plugin.heidi.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit ce118c8

Please sign in to comment.