Merge pull request #121 from XanatosX/develop

Prepare Release version 1.2.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,25 +7,32 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+### Describe the bug
+
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+### To Reproduce
+
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+### Expected behavior
+
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+### Screenshots
+
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
+### Desktop (please complete the following information):
+
+ - [ ] Windows
+ - [ ] Linux
  - Version [e.g. 22]
 
-**Additional context**
+### Additional context
+
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,18 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+### Is your feature request related to a problem? Please describe.
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
+### Describe the solution you'd like
+
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
+
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+### Additional context
+
 Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 
 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
 
-Fixes # (issue)
+Fixes #(issue)
 
 ## Type of change
 
@@ -11,17 +11,16 @@ Please delete options that are not relevant.
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation change
 - [ ] This change requires a documentation update
 
 # How Has This Been Tested?
 
 Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
 
-- [ ] Test A
-- [ ] Test B
-
 # Checklist:
 
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
+- [ ] I have made corresponding changes to the documentation
+- [ ] I added additional features as documentation to to the user manual

docs/README.md

@@ -8,20 +8,14 @@ The applications or scripts which can be started are limited by plugins, see the
 
 ## Plugins
 
-| Name                                               | Platforms      | Application Types        | Dll Name                         | Delivered as Standard |
-| -------------------------------------------------- | -------------- | ------------------------ | -------------------------------- | --------------------- |
-| [Binary Execution Plugin][binary-execution-plugin] | Windows        | `exe`                    | [Default Plugin][default-plugin] | :heavy_check_mark:    |
-| [Script Execution Plugin][script-execution-plugin] | Windows, Linux | `bat`, `cmd`, `ps`, `sh` | [Default Plugin][default-plugin] | :heavy_check_mark:    |
-
+To get a list of all the plugins available for the application right now, go to the [plugin overview][plugin-overview].
 
 ## Getting Started
 
 - [User Manual][user-manual]
 - [Developer Manual][developer-manual]
 
 
-[default-plugin]: ./dlls/default-plugin.md
-[binary-execution-plugin]: ./plugins/binary-execution-plugin.md
-[script-execution-plugin]: ./plugins/script-execution-plugin.md
+[plugin-overview]: ./user/plugin-overview.md
 [user-manual]: ./user/user-manual.md
 [developer-manual]: ./developer/developer-manual.md

docs/dlls/default-plugin.md

@@ -11,4 +11,4 @@ Go back to the [plugin overview][plugin-overview]
 
 [binary-execution-plugin]: ../plugins/binary-execution-plugin.md
 [script-execution-plugin]: ../plugins/script-execution-plugin.md
-[plugin-overview]: ../README.md#plugins 
+[plugin-overview]: ../user/plugin-overview.md 

docs/user/add-new-function.md

@@ -0,0 +1,51 @@
+# Add a new function
+
+This documentation will tell you on how to add a new function to the application. If you are unsure what a function is check out the [what is a function][what-is-a-function] documentation.
+
+To add a new function click on `File->New Function` while being in the main window. This will open up the add function screen
+
+![add-a-function]
+
+Provide display name for the function, this will be shown on the button. The name needs to be 5 - 25 chars. If you want add an description, this will be shown as a tooltip if you hover over the button later on.
+
+![select-plugin]
+
+Select the plugin to start the application or binary. Checkout the [plugin overview][available-plugins] for more information.
+
+![additional-settings]
+
+Select the setting specific for this function. For more information about the [setting scope][setting-scope] check the documentation.
+
+If required enter any function parameters, those are arguments which are getting parsed to the script or application.
+
+Select the path to the script or application to start. To do so press the `...` next to the text field
+
+![final-function]
+
+If everything is entered as expected, press the `Ok` button. If the button is still grayed out something is wrong or could not be found.
+
+The function will now be shown in the main view like this.
+
+![function-in-tool]
+
+Showing the tooltip on hover
+
+![function-in-tool-tooltip]
+
+Press the button you created to start the tool. If this is not working you will need to check the log file for further information.
+
+## User Manual
+
+Go back to the [user manual][back]
+
+[back]: user-manual.md
+[what-is-a-function]: ./what-is-a-function.md
+[available-plugins]: ./plugin-overview.md
+[setting-scope]: ./scope-of-a-setting.md
+[main-window]: https://i.imgur.com/oswayay.png
+[add-a-function]: https://i.imgur.com/mr3Folx.png
+[select-plugin]: https://i.imgur.com/8ITUSA3.png
+[additional-settings]: https://i.imgur.com/O8va6Gd.png
+[final-function]: https://i.imgur.com/lmiIzjX.png
+[function-in-tool]: https://i.imgur.com/60cHafm.png
+[function-in-tool-tooltip]: https://i.imgur.com/8lUHaiU.png

docs/user/hotkey-overview.md

@@ -0,0 +1,18 @@
+# Hotkey Overview
+
+The application does support hotkeys to some degree, those are listed below. To find the inside of the application go to `help->hotkeys`.
+
+| Name                            | Description                                         | Available in | Key        |
+| ------------------------------- | --------------------------------------------------- | ------------ | ---------- |
+| About page                      | Open the about page for the application             | Main View    | `F1`       |
+| Abort                           | Abort the current action or close the current modal | Every Popup  | `Esc`      |
+| New Function                    | Create a new function                               | Main View    | `ctrl + n` |
+| Hide Application                | Hide the application into the system tray           | Main View    | `ctrl + h` |
+| Change the application language | Open the change language dialog                     | Main View    | `ctrl + l` |
+| Report bug                      | Report a bug found within the application           | Main View    | `F12`      |
+
+## User Manual
+
+Go back to the [user manual][back]
+
+[back]: user-manual.md

docs/user/languages.md

@@ -0,0 +1,16 @@
+# Languages
+
+The application does come with two languages right now. The default one will be detected on application start based on your system localization.
+
+You can still change the language by going to `File -> Language`
+
+Right now the following language are supported
+
+- English
+- German
+
+## User Manual
+
+Go back to the [user manual][back]
+
+[back]: user-manual.md

docs/user/plugin-overview.md

@@ -0,0 +1,17 @@
+# Plugin Overview
+
+The application does provide the following plugins.
+
+| Name                                               | Platforms      | Application Types        | Dll Name                         | Delivered as Standard |
+| -------------------------------------------------- | -------------- | ------------------------ | -------------------------------- | --------------------- |
+| [Binary Execution Plugin][binary-execution-plugin] | Windows        | `exe`                    | [Default Plugin][default-plugin] | :heavy_check_mark:    |
+| [Script Execution Plugin][script-execution-plugin] | Windows, Linux | `bat`, `cmd`, `ps`, `sh` | [Default Plugin][default-plugin] | :heavy_check_mark:    |
+
+## User Manual
+
+Go back to the [user manual][back]
+
+[back]: user-manual.md
+[binary-execution-plugin]: ../plugins/binary-execution-plugin.md
+[script-execution-plugin]: ../plugins/script-execution-plugin.md
+[default-plugin]: ../dlls/default-plugin.md

docs/user/user-manual.md

@@ -3,7 +3,17 @@
 The manual of the application. This page does list all the things you as a user should now to use the application.
 
 - [[1] Installation][installation]
-- [[2] Scope of a Setting][scope-of-a-setting]
+- [[2] Plugin Overview][plugin-overview]
+- [[3] Languages][language]
+- [[4] Add a function][add-a-function]
+  - [[4a] What is a function][what-is-a-function]
+- [[4] Scope of a Setting][scope-of-a-setting]
+- [[5] Hotkeys][hotkey-overview]
 
 [installation]: ./installation.md
-[scope-of-a-setting]: ./scope-of-a-setting.md
+[language]: ./languages.md
+[scope-of-a-setting]: ./scope-of-a-setting.md
+[add-a-function]: ./add-new-function.md
+[what-is-a-function]: ./what-is-a-function.md
+[plugin-overview]: ./plugin-overview.md
+[hotkey-overview]: ./hotkey-overview.md

docs/user/what-is-a-function.md

@@ -0,0 +1,15 @@
+# What is a function
+
+The term function in connection with the `Modular Tool Manager` is a set of data required to start a specific application or script. Those functions are displayed as buttons on the main window
+
+![main-window]
+
+`My test function` is a function which will start a specific application or script.
+
+## User Manual
+
+Go back to the [user manual][back]
+
+[back]: user-manual.md
+
+[main-window]: https://i.imgur.com/oswayay.png

src/ModularToolManager/App.axaml.cs

@@ -81,12 +81,16 @@ public override void OnFrameworkInitializationCompleted()
         {
             if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
             {
+                if (desktop is null || desktop.MainWindow is null)
+                {
+                    return;
+                }
                 desktop.ShutdownMode = Avalonia.Controls.ShutdownMode.OnExplicitShutdown;
                 if (desktop.MainWindow is IDisposable disposable)
                 {
                     disposable.Dispose();
                 }
-                desktop.MainWindow.Close();
+                desktop!.MainWindow!.Close();
                 SetupMainWindow(provider);
                 desktop.MainWindow.Show();
                 desktop.ShutdownMode = Avalonia.Controls.ShutdownMode.OnLastWindowClose;

src/ModularToolManager/Models/ApplicationStyle.cs

@@ -20,7 +20,7 @@ public class ApplicationStyle
     /// Is this a dark or light style variant
     /// </summary>
     [JsonPropertyName("mode")]
-    public ThemeVariant Variant { get; init; }
+    public ThemeVariant? Variant { get; init; }
 
     /// <summary>
     /// The name of the translation key which is getting used for the name

src/ModularToolManager/Models/Messages/DeleteFunctionMessage.cs

@@ -18,6 +18,6 @@ internal class DeleteFunctionMessage : RequestMessage<bool>
 	/// <param name="functionModel">The function to delete</param>
 	public DeleteFunctionMessage(FunctionModel functionModel)
 	{
-		Identifier = functionModel.UniqueIdentifier;
+		Identifier = functionModel.Id;
 	}
 }

src/ModularToolManager/Models/Messages/EditFunctionMessage.cs

@@ -18,6 +18,6 @@ internal class EditFunctionMessage : AsyncRequestMessage<bool>
 	/// <param name="functionModel">The function model to edit</param>
 	public EditFunctionMessage(FunctionModel functionModel)
 	{
-		Identifier = functionModel.UniqueIdentifier;
+		Identifier = functionModel.Id;
 	}
 }

src/ModularToolManager/Models/Messages/RequestApplicationVisiblity.cs

@@ -3,6 +3,6 @@
 namespace ModularToolManager.Models.Messages;
 
 /// <summary>
-/// Get the current visiblilty for the application
+/// Get the current visibility for the application
 /// </summary>
-internal class RequestApplicationVisiblity : RequestMessage<bool> { }
+internal class RequestApplicationVisibility : RequestMessage<bool> { }

src/ModularToolManager/Models/ShowOpenFileDialogModel.cs

@@ -1,12 +1,13 @@
 using Avalonia.Controls;
+using Avalonia.Platform.Storage;
 using System.Collections.Generic;
 
 namespace ModularToolManager.Models;
 
 /// <summary>
-/// Record for the openinig a file open dialog
+/// Record for the opening a file open dialog
 /// </summary>
 /// <param name="FileDialogFilters">The filter for the dialog</param>
-/// <param name="InialDirectory">The directory to start in</param>
+/// <param name="InitialDirectory">The directory to start in</param>
 /// <param name="AllowMultipleSelection">Allow selecting multiple files</param>
-public record ShowOpenFileDialogModel(List<FileDialogFilter> FileDialogFilters, string? InialDirectory, bool AllowMultipleSelection);
+public record ShowOpenFileDialogModel(List<FilePickerFileType> FileDialogFilters, string? InitialDirectory, bool AllowMultipleSelection);

src/ModularToolManager/Properties/Properties.resx

@@ -126,12 +126,15 @@
   <data name="FunctionsFile" xml:space="preserve">
     <value>functions.dat</value>
   </data>
-  <data name="GithubIssueUrl" xml:space="preserve">
+  <data name="GitHubIssueUrl" xml:space="preserve">
     <value>https://github.com/XanatosX/ModularToolManager/issues</value>
   </data>
   <data name="GitHubUrl" xml:space="preserve">
     <value>https://github.com/XanatosX/ModularToolManager/</value>
   </data>
+  <data name="GitHubUserManual" xml:space="preserve">
+    <value>https://xanatosx.github.io/ModularToolManager/user/user-manual.html</value>
+  </data>
   <data name="Icon_About" xml:space="preserve">
     <value>question_circle_regular</value>
   </data>