v1.5.0

README.md

@@ -316,6 +316,16 @@ Run [`Open-PSWorkItemConsole`](docs\Open-PSWorkItemConsole.md) or its alias *`wi
 
 If you select an item from the table, it will populate the form fields. You can then update, complete, or remove the item. To create a new item, it is recommended that you first clear the form (`Options - Clear Form`). Enter the PSWorkItem details and click the `Add PSWorkItem` button.
 
+You can also manage categories.
+
+![add category](images/tui-addcategory.png)
+
+![set category](images/tui-setcategory.png)
+
+You can right-click a task in the table to get detailed information.
+
+![task details](images/tui-taskdetail.png)
+
 __IMPORTANT__ This command relies on a specific version of the Terminal.Gui assembly. You might encounter version conflicts from modules that use older versions of this assembly like `Microsoft.PowerShell.ConsoleGuiTools`. You may need to load this module first in a new PowerShell session.
 
 ## User Preferences
@@ -400,6 +410,6 @@ rowid        : 19
 ## Future Tasks or Commands
 
 - Password protection options.
-- A TUI form for managing categories
+- Update the TUI management console to show database details
 
 If you have an enhancement suggestion, please submit it as an [Issue](https://github.com/jdhitsolutions/PSWorkItem/issues).

changelog.md

@@ -1,18 +1,24 @@
 # Changelog for PSWorkItem
 
 ## [Unreleased]
+
+## [1.5.0] - 2023-10-06
+
 ### Added
+
 - Added a feature in `Open-PSWorkItemConsole` to allow the user to right-click on a table row and display PSWorkItem details in a pop-up window.
-- Added menu choices in Open-PSWorkItemConsole` to manage categories.
+- Added menu choices in `Open-PSWorkItemConsole` to manage categories.
 - Added additional verbose output.
 
 ### Changed
+
 - Modified private helper functions to support Verbose output.
 - Renamed localized string data file to match module name.
 
 ### Fixed
+
 - Fixed typo in strings file
-- Fixed `Open-PSWorkItemConsole` to refresh report table when modifiying or removing PSWorkItems.
+- Fixed `Open-PSWorkItemConsole` to refresh report table when modifying or removing PSWorkItems.
 - Fixed bug in `Remove-PSWorkItemCategory` that wasn't detecting the category value from the dynamic parameter.
 
 ## [1.4.0] - 2023-09-29
@@ -259,7 +265,8 @@ This is a major update with significant changes. If this is your first time inst
 - Initial files
 - Created Module outline
 
-[Unreleased]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.4.0..HEAD
+[Unreleased]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.5.0..HEAD
+[1.5.0]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.4.0..v1.5.0
 [1.4.0]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.3.1..v1.4.0
 [1.3.1]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.3.0..v1.3.1
 [1.3.0]: https://github.com/jdhitsolutions/PSWorkItem/compare/v1.2.0..v1.3.0
@@ -275,4 +282,4 @@ This is a major update with significant changes. If this is your first time inst
 [0.4.0]: https://github.com/jdhitsolutions/PSWorkItem/commit/303837de0fc6ca807e121c3d6fad5b851b25cf7f
 [0.3.0]: https://github.com/jdhitsolutions/PSWorkItem/commit/e4a290dd256dc6d86d6b6893113668985c8add61
 [0.2.0]: https://github.com/jdhitsolutions/PSWorkItem/commit/1ea8c57448e4e687d1f81fa4f4515c4dbfea4048
-[0.1.0]: https://github.com/jdhitsolutions/PSWorkItem/commit/fdb4255d4b5f605e03deab409829c13ed5166945
+[0.1.0]: https://github.com/jdhitsolutions/PSWorkItem/commit/fdb4255d4b5f605e03deab409829c13ed5166945

docs/Open-PSWorkItemConsole.md

@@ -9,7 +9,7 @@ schema: 2.0.0
 
 ## SYNOPSIS
 
-Open the PSWorkItem management console
+Open the PSWorkItem management TUI-based console
 
 ## SYNTAX
 
@@ -21,6 +21,10 @@ Open-PSWorkItemConsole [-Path <String>] [<CommonParameters>]
 
 This command will launch a terminal-based console for managing PSWorkItems. You can select items from the table which will populate the entry forms. You can then modify the work item and click Set-PSWorkItem, or you can mark the item as complete or remove it. To enter a new PSWorkItem, use Options - Clear Form. Enter your new item, selecting a category from the list, and click the Add New PSWorkItem button. You cannot set a progress value when creating a new work item.
 
+You can right-click a task in the table to show detailed information.
+
+Use the category menu options to add, set, or remove a category.
+
 You can also enter a different database path by entering the path in the Database field, or using Options - Open database. Use the Reset Form option to reset the form with your default settings.
 
 ## EXAMPLES
@@ -75,12 +79,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 You cannot specify a PSWorkItem completion date using this tool.
 
-If you have difficulty seeing the cursor in text fields, and you are running in Windows Terminal, you might try changing the cursor in your Windows Terminal profile setting.
+If you have difficulty seeing the cursor in text fields, and you are running in Windows Terminal, you might try changing the cursor in your Windows Terminal profile setting. The TUI color scheme is also influenced by the Windows Terminal color scheme. It will have a different appearance under different Windows Terminal color schemes.
 
 IMPORTANT: This command relies on a specific version of Terminal.Gui assembly. You might encounter version conflicts from modules that use older versions of this assembly like Microsoft.PowerShell.ConsoleGuiTools. You may need to load this module first in a new PowerShell session.
 
 ## RELATED LINKS
 
+[New-PSWorkItem](New-PSWorkItem.md)
+
 [Get-PSWorkItem](Get-PSWorkItem.md)
 
 [Set-PSWorkItem](Set-PSWorkItem.md)

en-us/PSWorkItem-help.xml

@@ -10,7 +10,8 @@
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>When you setup a new PSWorkItem database, it will define the default categories of Personal, Work, Project, and Other. You may want to add categories. The category must be defined before you can use it. The category will not be added if it already exists unless you use -Force. Or if you need to update a category description you can re-add it with -Force. If the category name needs to be edited, remove the category and re-add it.</maml:para>
+      <maml:para>When you setup a new PSWorkItem database, it will define the default categories of Personal, Work, Project, and Other. You may want to add categories. The category must be defined before you can use it. The category will not be added if it already exists unless you use -Force.</maml:para>
+      <maml:para>It is recommended that you use proper casing for your category names and that they be single words.</maml:para>
     </maml:description>
     <command:syntax>
       <command:syntaxItem>
@@ -2365,11 +2366,13 @@ ColumnIndex ColumnName  ColumnType
       <command:verb>Open</command:verb>
       <command:noun>PSWorkItemConsole</command:noun>
       <maml:description>
-        <maml:para>Open the PSWorkItem management console</maml:para>
+        <maml:para>Open the PSWorkItem management TUI-based console</maml:para>
       </maml:description>
     </command:details>
     <maml:description>
       <maml:para>This command will launch a terminal-based console for managing PSWorkItems. You can select items from the table which will populate the entry forms. You can then modify the work item and click Set-PSWorkItem, or you can mark the item as complete or remove it. To enter a new PSWorkItem, use Options - Clear Form. Enter your new item, selecting a category from the list, and click the Add New PSWorkItem button. You cannot set a progress value when creating a new work item.</maml:para>
+      <maml:para>You can right-click a task in the table to show detailed information.</maml:para>
+      <maml:para>Use the category menu options to add, set, or remove a category.</maml:para>
       <maml:para>You can also enter a different database path by entering the path in the Database field, or using Options - Open database. Use the Reset Form option to reset the form with your default settings.</maml:para>
     </maml:description>
     <command:syntax>
@@ -2425,8 +2428,8 @@ ColumnIndex ColumnName  ColumnType
     </command:returnValues>
     <maml:alertSet>
       <maml:alert>
-        <maml:para>You cannot specify a completion date using this tool. You must manage categories using the module commands.</maml:para>
-        <maml:para>If you have difficulty seeing the cursor in text fields, and you are running in Windows Terminal, you might try changing the cursor in your Windows Terminal profile setting.</maml:para>
+        <maml:para>You cannot specify a PSWorkItem completion date using this tool.</maml:para>
+        <maml:para>If you have difficulty seeing the cursor in text fields, and you are running in Windows Terminal, you might try changing the cursor in your Windows Terminal profile setting. The TUI color scheme is also influenced by the Windows Terminal color scheme. It will have a different appearance under different Windows Terminal color schemes.</maml:para>
         <maml:para>IMPORTANT: This command relies on a specific version of Terminal.Gui assembly. You might encounter version conflicts from modules that use older versions of this assembly like Microsoft.PowerShell.ConsoleGuiTools. You may need to load this module first in a new PowerShell session.</maml:para>
       </maml:alert>
     </maml:alertSet>
@@ -2451,6 +2454,10 @@ ColumnIndex ColumnName  ColumnType
         <maml:linkText>Online Version:</maml:linkText>
         <maml:uri>https://bit.ly/48zfOB8</maml:uri>
       </maml:navigationLink>
+      <maml:navigationLink>
+        <maml:linkText>New-PSWorkItem</maml:linkText>
+        <maml:uri></maml:uri>
+      </maml:navigationLink>
       <maml:navigationLink>
         <maml:linkText>Get-PSWorkItem</maml:linkText>
         <maml:uri></maml:uri>
@@ -2467,6 +2474,18 @@ ColumnIndex ColumnName  ColumnType
         <maml:linkText>Complete-PSWorkItem</maml:linkText>
         <maml:uri></maml:uri>
       </maml:navigationLink>
+      <maml:navigationLink>
+        <maml:linkText>Add-PSWorkItemCategory</maml:linkText>
+        <maml:uri></maml:uri>
+      </maml:navigationLink>
+      <maml:navigationLink>
+        <maml:linkText>Set-PSWorkItemCategory</maml:linkText>
+        <maml:uri></maml:uri>
+      </maml:navigationLink>
+      <maml:navigationLink>
+        <maml:linkText>Remove-PSWorkItemCategory</maml:linkText>
+        <maml:uri></maml:uri>
+      </maml:navigationLink>
     </command:relatedLinks>
   </command:command>
   <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

functions/public/Open-PSWorkItemConsole.ps1

@@ -66,7 +66,7 @@ Function Open-PSWorkItemConsole {
     $MenuItem4 = [Terminal.Gui.MenuItem]::New('Documentation', '', { ShowHelp })
     $MenuItem4.Shortcut = 'F1'
     $MenuItem5 = [Terminal.Gui.MenuItem]::New('Open Project Repository', '', { Start-Process 'https://github.com/jdhitsolutions/PSWorkItem' })
-    $MenuItem6 = [Terminal.Gui.MenuItem]::New('File GitHub Issue', '', { Start-Process 'https://github.com/jdhitsolutions/PSWorkItem/issues/new/choose' })
+    $MenuItem6 = [Terminal.Gui.MenuItem]::New('Report a GitHub Issue', '', { Start-Process 'https://github.com/jdhitsolutions/PSWorkItem/issues/new/choose' })
     $MenuItem7 = [Terminal.Gui.MenuItem]::New('Open Help Online', '', { Start-Process 'https://bit.ly/48zfOB8' })
 
     $MenuBarItem1 = [Terminal.Gui.MenuBarItem]::New('_Help', @($MenuItem4, $MenuItem7,$MenuItem5, $MenuItem6, $MenuItem3))