Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Fernando Cerqueira committed Sep 19, 2023
1 parent c58a3be commit 022f07a
Show file tree
Hide file tree
Showing 6 changed files with 152 additions and 268 deletions.
1 change: 1 addition & 0 deletions PromptPlus.sln
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{191C90E6-4
docs\migrateversion.md = docs\migrateversion.md
docs\snapshot.md = docs\snapshot.md
docs\validators.md = docs\validators.md
whatsnew.md = whatsnew.md
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SliderSwitchSamples", "Samples\SliderSwitchSamples\SliderSwitchSamples.csproj", "{3702034B-7D26-4BC3-AB1E-864C2EE2D785}"
Expand Down
87 changes: 21 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

## Table of Contents

- [What's new - previous versions](whatsnew.md)
- [Features](#features)
- [Migrate Version V3.3 to V4.0](#migrate-version)
- [Console Engine](#console-engine)
Expand All @@ -32,73 +33,27 @@
- [License](#license)
- [API Reference](https://fracerqueira.github.io/PromptPlus/apis/apis.html)

## What's new in V4.0.5

- Added new global propety 'ExtraExceptionInfo' to write extra console exception info
- Added new global propety 'DisableToggleTooltip' to disable toggle Tooltip
- Added new global propety 'ShowOnlyExistingPagination' to disable Page information when pagination not exists
- Added new Method DisableToggleTooltip(bool value) to overwrite default DisableToggleTooltip in control
- Added new Method ShowOnlyExistingPagination(bool value) to overwrite default Overwrite default Show pagination only if exists in control
- Added new item to Enum FilterMode : 'Disabled'. This item disable filter feature in coletions
- Improved to not show text prompt when text value is null or empty
- Improved terminal mode detection (for Windows 11 Versions)
- Rebuilt FIGlet to MIT License
- Fixed credits (MIT License Copyright)
- Fixed bug PromptPlus not restore StyleSchema when ResetColor
- Fixed Spell checking (Breaking Changes)
- SugestionInput to SuggestionInput
- Controls: MaskEdit/AddTolist/Input
- SugestionOutput to SuggestionOutput
- Controls: MaskEdit/AddTolist/Input
- MaxLenght to MaxLength
- Controls: AutoComplete/AddTolist/Input
- StyleControls.Sugestion to StyleControls.Suggestion
- StyleSchemaExtensions.Sugestion to StyleSchemaExtensions.Suggestion
- PromptPlusException.Plataform to PromptPlusException.Platform

**Special thanks to [ividyon](https://github.com/ividyon) for spell checking corrections, all documentation, fixed credits (MIT License Copyright) and wrong method/property names**

## What's new in V4.0.4

- Fixed bug PromptPlus not restore terminal original setting when shutdown application
- Fixed bug Autocomplete does not change result when backspace is pressed during search
- Added Property CurrentBuffer in console drive to return Current Buffer running (Primary/Secondary)
- Added SwapBuffer command to switch Primary/Secondary buffer (Valid only When console 'ansi' supported)
- Renamed 'AlternateScreen' to 'RunOnBuffer'. Now executes a custom action on TargetBuffer and returns to CurrentBuffer
- Refactored console drivers initialization, control options initialization
- Added auto create Environment 'PromptPlusConvertCodePage' to custom automate convert codepage to unicode-codepage
- Default value is = '850;65001'

## What's new in V4.0.3

- New control to switch Alternate screen
- Fixed bug Console does not change foreground/background color correctly
- Fixed bug Control ProgressBar
- Not show gradient when set ProgressBarType.Fill
- Improve testability of result classes/struct (Internal to public)

## What's new in V4.0.2

- New Control Pipeline
- PromptPlus.Pipeline(T startvalue)
- Changed WaitControl to take context value in tasks and return context in result
- There are small break-changes
- Add Answer key check equals "Yes"/"No" using config values
- IsYesResponseKey(this ConsoleKeyInfo keyinfo)
- IsNoResponseKey(this ConsoleKeyInfo keyinfo)

## What's new in V4.0.X

### Newest controls and color improvement and layout

![](./docs/images/calendar1.gif)
![](./docs/images/chartbar1.gif)
![](./docs/images/multiselectbrowser1.gif)
![](./docs/images/treeview1.gif)
![](./docs/images/treeview2.gif)
![](./docs/images/waittask1.gif)
![](./docs/images/progressbar1.gif)
## What's new in the latest version
### V4.0.6
[**Top**](#table-of-contents)

- Bug fixed: grouped item ordering. The sort option will be ignored
- Bug fixed: 'AcceptInput' method causes failure by not allowing navigation keys to be selected.
- Affeted Controls : AddtoList/Input
- Improvement : Direct writes to standard error output stream
- New Commands : OutputError()
- Sample with commemts in project [ConsoleFeatures Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Escaping format characters color
- Global property : IgnoreColorTokens
- New Commands : EscapeColorTokens()/AcceptColorTokens()
- Sample with commemts in project [ConsoleFeatures Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Group items in the select control
- Sample with commemts in project SelectBasicSamples
- New feature: Add separator line in the select control
- Sample with commemts in project [SelectBasic Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/SelectBasicSamples)

**Special thanks to [ividyon](https://github.com/ividyon) for suggesting improvements and actively participating in this release**

## Features
[**Top**](#table-of-contents)

Expand Down
84 changes: 18 additions & 66 deletions Src/NugetREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,72 +10,24 @@ PromptPlus **Supports 4/8/24-bit colors** in the terminal with auto-detection of

**PromptPlus** was developed in C# with the **netstandard2.1**, **.NET 6** and **.NET 7** target frameworks.

## What's new in V4.0.5

- Added new global propety 'ExtraExceptionInfo' to write extra console exception info
- Added new global propety 'DisableToggleTooltip' to disable toggle Tooltip
- Added new global propety 'ShowOnlyExistingPagination' to disable Page information when pagination not exists
- Added new Method DisableToggleTooltip(bool value) to overwrite default DisableToggleTooltip in control
- Added new Method ShowOnlyExistingPagination(bool value) to overwrite default Overwrite default Show pagination only if exists in control
- Added new item to Enum FilterMode : 'Disabled'. This item disable filter feature in coletions
- Improved to not show text prompt when text value is null or empty
- Improved terminal mode detection (for Windows 11 Versions)
- Rebuilt FIGlet to MIT License
- Fixed credits (MIT License Copyright)
- Fixed bug PromptPlus not restore StyleSchema when ResetColor
- Fixed Spell checking (Breaking Changes)
- SugestionInput to SuggestionInput
- Controls: MaskEdit/AddTolist/Input
- SugestionOutput to SuggestionOutput
- Controls: MaskEdit/AddTolist/Input
- MaxLenght to MaxLength
- Controls: AutoComplete/AddTolist/Input
- StyleControls.Sugestion to StyleControls.Suggestion
- StyleSchemaExtensions.Sugestion to StyleSchemaExtensions.Suggestion
- PromptPlusException.Plataform to PromptPlusException.Platform

**Special thanks to [ividyon](https://github.com/ividyon) for spell checking corrections, all documentation, fixed credits (MIT License Copyright) and wrong method/property names**

## What's new in V4.0.4

- Fixed bug PromptPlus not restore terminal original setting when shutdown application
- Fixed bug Autocomplete does not change result when backspace is pressed during search
- Added Property CurrentBuffer in console drive to return Current Buffer running (Primary/Secondary)
- Added SwapBuffer command to switch Primary/Secondary buffer (Valid only When console 'ansi' supported)
- Renamed 'AlternateScreen' to 'RunOnBuffer'. Now executes a custom action on TargetBuffer and returns to CurrentBuffer
- Refactored console drivers initialization, control options initialization
- Added auto create Environment 'PromptPlusConvertCodePage' to custom automate convert codepage to unicode-codepage
- Default value is = '850;65001'

## What's new in V4.0.3

- New control to switch Alternate screen
- Fixed bug Console does not change foreground/background color correctly
- Fixed bug Control ProgressBar
- Not show gradient when set ProgressBarType.Fill
- Improve testability of result classes/struct (Internal to public)

## What's new in V4.0.2

- New Control Pipeline
- PromptPlus.Pipeline(T startvalue)
- Changed WaitControl to take context value in tasks and return context in result
- There are small break-changes
- Add Answer key check equals "Yes"/"No" using config values
- IsYesResponseKey(this ConsoleKeyInfo keyinfo)
- IsNoResponseKey(this ConsoleKeyInfo keyinfo)

## What's new in V4.0.X

- Fixed duplicate tooltip in calendar
- New console engine
- Supports 4/8/24-bit colors
- Auto-detection of the current terminal's capabilities
- New commands
- New support feature colors
- All controls have been improved to accept color customization, new features and new design.
- Added new filter for colletion by "Contains" or "StartsWith"
- Added powerful new controls (eg: Switch Alternate screen, Pipeline, Calendar, Chartbar, Treeview, wait tasks Parallel/Sequential,
## What's new in V4.0.6

- Bug fixed: grouped item ordering. The sort option will be ignored
- Bug fixed: 'AcceptInput' method causes failure by not allowing navigation keys to be selected.
- Affeted Controls : AddtoList/Input
- Improvement : Direct writes to standard error output stream
- New Commands : OutputError()
- Sample with commemts in project [ConsoleFeatures Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Escaping format characters color
- Global property : IgnoreColorTokens
- New Commands : EscapeColorTokens()/AcceptColorTokens()
- Sample with commemts in project [ConsoleFeatures Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Group items in the select control
- Sample with commemts in project SelectBasicSamples
- New feature: Add separator line in the select control
- Sample with commemts in project [SelectBasic Samples](https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/SelectBasicSamples)

**Special thanks to [ividyon](https://github.com/ividyon) for suggesting improvements and actively participating in this release**

## **PromptPlus Controls - Sample Usage**

Expand Down
86 changes: 18 additions & 68 deletions Src/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,75 +29,25 @@ PromptPlus was developed in C# with target frameworks:
- .NET 6
- .NET 7

*** What's new in V4.0.5 ***
*** What's new in V4.0.6 ***
----------------------------
- Added new global propety 'ExtraExceptionInfo' to write extra console exception info
- Added new global propety 'DisableToggleTooltip' to disable toggle Tooltip
- Added new global propety 'ShowOnlyExistingPagination' to disable Page information when pagination not exists
- Added new Method DisableToggleTooltip(bool value) to overwrite default DisableToggleTooltip in control
- Added new Method ShowOnlyExistingPagination(bool value) to overwrite default Overwrite default Show pagination only if exists in control
- Added new item to Enum FilterMode : 'Disabled'. This item disable filter feature in coletions
- Improved to not show text prompt when text value is null or empty
- Improved terminal mode detection (for Windows 11 Versions)
- Rebuilt FIGlet to MIT License
- Fixed credits (MIT License Copyright)
- Fixed bug PromptPlus not restore StyleSchema when ResetColor
- Fixed bug Exception trying to filter Select prompt with description
- Fixed Spell checking (Breaking Changes)
- SugestionInput to SuggestionInput
- Controls: MaskEdit/AddTolist/Input
- SugestionOutput to SuggestionOutput
- Controls: MaskEdit/AddTolist/Input
- MaxLenght to MaxLength
- Controls: AutoComplete/AddTolist/Input
- StyleControls.Sugestion to StyleControls.Suggestion
- StyleSchemaExtensions.Sugestion to StyleSchemaExtensions.Suggestion
- PromptPlusException.Plataform to PromptPlusException.Platform

Special thanks to ividyon(https://github.com/ividyon) for spell checking corrections, all documentation, fixed credits (MIT License Copyright) and wrong method/property names

*** What's new in V4.0.4 ***
----------------------------
- Fixed bug PromptPlus not restore terminal original setting when shutdown application
- Fixed bug Autocomplete does not change result when backspace is pressed during search
- Added Property CurrentBuffer in console drive to return Current Buffer running (Primary/Secondary)
- Added SwapBuffer command to switch Primary/Secondary buffer (Valid only When console 'ansi' supported)
- Renamed 'AlternateScreen' to 'RunOnBuffer'. Now executes a custom action on TargetBuffer and returns to CurrentBuffer
- Refactored console drivers initialization, control options initialization
- Added auto create Environment 'PromptPlusConvertCodePage' to custom automate convert codepage to unicode-codepage
- Default value is = '850;65001'

*** What's new in V4.0.3 ***
---------------------------
- New control to switch Alternate screen
- Fixed bug Console does not change foreground/background color correctly
- Fixed bug Control ProgressBar
- Not show gradient when set ProgressBarType.Fill
- Improve testability of result classes/struct (Internal to public)

*** What's new in V4.0.2 ***
---------------------------

- New Control Pipeline
- PromptPlus.Pipeline(T startvalue)
- Changed WaitControl to take context value in tasks and return context in result
- There are small break-changes
- Add Answer key check equals "Yes"/"No" using config values
- IsYesResponseKey(this ConsoleKeyInfo keyinfo)
- IsNoResponseKey(this ConsoleKeyInfo keyinfo)

*** What's new in V4.0.X ***
----------------------------
- Fixed duplicate tooltip in calendar
- New console engine
- Supports 4/8/24-bit colors
- Auto-detection of the current terminal's capabilities
- New commands
- New support feature colors
- All controls have been improved to accept color customization, new features and new design.
- Added new filter for colletion by "Contains" or "StartsWith"
- Added powerful new controls (eg: Switch Alternate screen, Pipeline, Calendar, Chartbar, Treeview, wait tasks Parallel/Sequential,
8 progress bar types, wait timer, 19 spinners types, Gradient colors and more)

- Bug fixed: grouped item ordering. The sort option will be ignored
- Bug fixed: 'AcceptInput' method causes failure by not allowing navigation keys to be selected.
- Affeted Controls : AddtoList/Input
- Improvement : Direct writes to standard error output stream
- New Commands : OutputError()
- Sample with commemts in project ConsoleFeatures Samples(https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Escaping format characters color
- Global property : IgnoreColorTokens
- New Commands : EscapeColorTokens()/AcceptColorTokens()
- Sample with commemts in project ConsoleFeatures Samples(https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/ConsoleFeaturesSamples)
- New feature: Group items in the select control
- Sample with commemts in project SelectBasicSamples
- New feature: Add separator line in the select control
- Sample with commemts in project SelectBasic Samples(https://github.com/FRACerqueira/PromptPlus/tree/main/Samples/SelectBasicSamples)

**Special thanks to ividyon(https://github.com/ividyon) for suggesting improvements and actively participating in this release**

**PromptPlus Controls - Sample Usage**
--------------------------------------
Expand Down
Loading

0 comments on commit 022f07a

Please sign in to comment.