Tweaked API docs format and content. Fixed build warnings.

This commit is contained in:
Tig Kindel
2022-07-23 15:59:52 -06:00
parent aa63abb23f
commit 0dcbdb847c
17 changed files with 99 additions and 51 deletions

View File

@@ -10,7 +10,7 @@
A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
![Sample app](https://raw.githubusercontent.com/migueldeicaza/gui.cs/master/docfx/sample.gif) ![Sample app](https://raw.githubusercontent.com/migueldeicaza/gui.cs/master/docfx/images/sample.gif)
## Controls and Views ## Controls and Views

View File

@@ -0,0 +1,11 @@
Regenerate anytime with
```powershell\
docfx template export default
```
Technically, this can be deleted from the Terminal.Gui project, but it's left in place
for convenience.
See https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html

View File

@@ -1,31 +1,31 @@
*Terminal.Gui* provides a rich set of views and controls for building terminal user interfaces: *Terminal.Gui* provides a rich set of views and controls for building terminal user interfaces:
* [Button](~/api/Terminal.Gui/Terminal.Gui.Button.html) - A View that provides an item that invokes an System.Action when activated by the user. * [Button](~/api/Terminal.Gui/Terminal.Gui.Button.yml) - A View that provides an item that invokes an System.Action when activated by the user.
* [CheckBox](~/api/Terminal.Gui/Terminal.Gui.CheckBox.html) - Shows an on/off toggle that the user can set. * [CheckBox](~/api/Terminal.Gui/Terminal.Gui.CheckBox.yml) - Shows an on/off toggle that the user can set.
* [ColorPicker](~/api/Terminal.Gui/Terminal.Gui.ColorPicker.html) - Enables to user to pick a color. * [ColorPicker](~/api/Terminal.Gui/Terminal.Gui.ColorPicker.yml) - Enables to user to pick a color.
* [ComboBox](~/api/Terminal.Gui/Terminal.Gui.ComboBox.html) - Provides a drop-down list of items the user can select from. * [ComboBox](~/api/Terminal.Gui/Terminal.Gui.ComboBox.yml) - Provides a drop-down list of items the user can select from.
* [Dialog](~/api/Terminal.Gui/Terminal.Gui.Dialog.html) - A pop-up Window that contains one or more Buttons. * [Dialog](~/api/Terminal.Gui/Terminal.Gui.Dialog.yml) - A pop-up Window that contains one or more Buttons.
* [OpenDialog](~/api/Terminal.Gui/Terminal.Gui.OpenDialog.html) - A Dialog providing an interactive pop-up Window for users to select files or directories. * [OpenDialog](~/api/Terminal.Gui/Terminal.Gui.OpenDialog.yml) - A Dialog providing an interactive pop-up Window for users to select files or directories.
* [SaveDialog](~/api/Terminal.Gui/Terminal.Gui.SaveDialog.html) - A Dialog providing an interactive pop-up Window for users to save files. * [SaveDialog](~/api/Terminal.Gui/Terminal.Gui.SaveDialog.yml) - A Dialog providing an interactive pop-up Window for users to save files.
* [FrameView](~/api/Terminal.Gui/Terminal.Gui.FrameView.html) - A container View that draws a frame around its contents. Similar to a GroupBox in Windows. * [FrameView](~/api/Terminal.Gui/Terminal.Gui.FrameView.yml) - A container View that draws a frame around its contents. Similar to a GroupBox in Windows.
* [GraphView](~/api/Terminal.Gui/Terminal.Gui.GraphView.html) - A View for rendering graphs (bar, scatter etc). * [GraphView](~/api/Terminal.Gui/Terminal.Gui.GraphView.yml) - A View for rendering graphs (bar, scatter etc).
* [Hex viewer/editor](~/api/Terminal.Gui/Terminal.Gui.HexView.html) - A hex viewer and editor that operates over a file stream. * [Hex viewer/editor](~/api/Terminal.Gui/Terminal.Gui.HexView.yml) - A hex viewer and editor that operates over a file stream.
* [Label](~/api/Terminal.Gui/Terminal.Gui.Label.html) - Displays a string at a given position and supports multiple lines. * [Label](~/api/Terminal.Gui/Terminal.Gui.Label.yml) - Displays a string at a given position and supports multiple lines.
* [ListView](~/api/Terminal.Gui/Terminal.Gui.ListView.html) - Displays a scrollable list of data where each item can be activated to perform an action. * [ListView](~/api/Terminal.Gui/Terminal.Gui.ListView.yml) - Displays a scrollable list of data where each item can be activated to perform an action.
* [MenuBar](~/api/Terminal.Gui/Terminal.Gui.MenuBar.html) - Provides a menu bar with drop-down and cascading menus. * [MenuBar](~/api/Terminal.Gui/Terminal.Gui.MenuBar.yml) - Provides a menu bar with drop-down and cascading menus.
* [MessageBox](~/api/Terminal.Gui/Terminal.Gui.MessageBox.html) - Displays a modal (pup-up) message to the user, with a title, a message and a series of options that the user can choose from. * [MessageBox](~/api/Terminal.Gui/Terminal.Gui.MessageBox.yml) - Displays a modal (pup-up) message to the user, with a title, a message and a series of options that the user can choose from.
* [ProgressBar](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.html) - Displays a progress Bar indicating progress of an activity. * [ProgressBar](~/api/Terminal.Gui/Terminal.Gui.ProgressBar.yml) - Displays a progress Bar indicating progress of an activity.
* [RadioGroup](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.html) - Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time * [RadioGroup](~/api/Terminal.Gui/Terminal.Gui.RadioGroup.yml) - Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time
* [ScrollView](~/api/Terminal.Gui/Terminal.Gui.ScrollView.html) - Present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. * [ScrollView](~/api/Terminal.Gui/Terminal.Gui.ScrollView.yml) - Present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
* [ScrollBarView](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html) - display a 1-character scrollbar, either horizontal or vertical. * [ScrollBarView](~/api/Terminal.Gui/Terminal.Gui.ScrollBarView.yml) - display a 1-character scrollbar, either horizontal or vertical.
* [StatusBar](~/api/Terminal.Gui/Terminal.Gui.StatusBar.html) - A View that snaps to the bottom of a Toplevel displaying set of status items. Includes support for global app keyboard shortcuts. * [StatusBar](~/api/Terminal.Gui/Terminal.Gui.StatusBar.yml) - A View that snaps to the bottom of a Toplevel displaying set of status items. Includes support for global app keyboard shortcuts.
* [TableView](~/api/Terminal.Gui/Terminal.Gui.TableView.html) - A View for tabular data based on a System.Data.DataTable. * [TableView](~/api/Terminal.Gui/Terminal.Gui.TableView.yml) - A View for tabular data based on a System.Data.DataTable.
* [TimeField](~/api/Terminal.Gui/Terminal.Gui.TimeField.html) & [DateField](~/api/Terminal.Gui/Terminal.Gui.TimeField.html) - Enables structured editing of dates and times. * [TimeField](~/api/Terminal.Gui/Terminal.Gui.TimeField.yml) & [DateField](~/api/Terminal.Gui/Terminal.Gui.TimeField.yml) - Enables structured editing of dates and times.
* [TextField](~/api/Terminal.Gui/Terminal.Gui.TextField.html) - Provides a single-line text entry. * [TextField](~/api/Terminal.Gui/Terminal.Gui.TextField.yml) - Provides a single-line text entry.
* [TextValidateField](~/api/Terminal.Gui/Terminal.Gui.TextValidateField.html) - Text field that validates input through a ITextValidateProvider. * [TextValidateField](~/api/Terminal.Gui/Terminal.Gui.TextValidateField.yml) - Text field that validates input through a ITextValidateProvider.
* [TextView](~/api/Terminal.Gui/Terminal.Gui.TextView.html)- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations, * [TextView](~/api/Terminal.Gui/Terminal.Gui.TextView.yml)- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations,
* [TopLevel](~/api/Terminal.Gui/Terminal.Gui.Toplevel.html) - The base class for modal/pop-up Windows. * [TopLevel](~/api/Terminal.Gui/Terminal.Gui.Toplevel.yml) - The base class for modal/pop-up Windows.
* [TreeView](~/api/Terminal.Gui/Terminal.Gui.TreeView.html) - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder. * [TreeView](~/api/Terminal.Gui/Terminal.Gui.TreeView.yml) - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.
* [View](!/api/Terminal.Gui/Terminal.Gui.View.html) - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. * [View](~/api/Terminal.Gui/Terminal.Gui.View.yml) - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
* [Window](~/api/Terminal.Gui/Terminal.Gui.Window.html) - A Toplevel view that draws a border around its Frame with a title at the top. * [Window](~/api/Terminal.Gui/Terminal.Gui.Window.yml) - A Toplevel view that draws a border around its Frame with a title at the top.
* [Wizard](~/api/Terminal.Gui/Terminal.Gui.Wizard.html) - Provides navigation and a user interface to collect related data across multiple steps. * [Wizard](~/api/Terminal.Gui/Terminal.Gui.Wizard.yml) - Provides navigation and a user interface to collect related data across multiple steps.

View File

@@ -6,4 +6,4 @@ rm ../docs -Recurse -Force
#docfx --metadata #docfx --metadata
docfx --metadata --serve docfx --serve --force

View File

Before

Width:  |  Height:  |  Size: 10 MiB

After

Width:  |  Height:  |  Size: 10 MiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docfx/images/wizard.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

View File

@@ -1,6 +1,8 @@
# Terminal.Gui - Terminal UI toolkit for .NET # Terminal.Gui - Cross Platform Terminal UI toolkit for .NET
A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
![Sample](images/sample.gif)
* [Terminal.Gui Project on GitHub](https://github.com/migueldeicaza/gui.cs) * [Terminal.Gui Project on GitHub](https://github.com/migueldeicaza/gui.cs)

View File

@@ -114,6 +114,7 @@ article h4 {
-webkit-box-shadow: var(--card-box-shadow); -webkit-box-shadow: var(--card-box-shadow);
-moz-box-shadow: var(--card-box-shadow); -moz-box-shadow: var(--card-box-shadow);
box-shadow: var(--card-box-shadow); box-shadow: var(--card-box-shadow);
font-family: 'Source Code Pro', 'Courier New', Courier, monospace
} }
.subnav { .subnav {

View File

@@ -102,7 +102,7 @@
<li><a href="../api/Terminal.Gui/Terminal.Gui.TextView.html">TextView</a>- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations, </li> <li><a href="../api/Terminal.Gui/Terminal.Gui.TextView.html">TextView</a>- A multi-line text editing View supporting word-wrap, auto-complete, context menus, undo/redo, and clipboard operations, </li>
<li><a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.html">TopLevel</a> - The base class for modal/pop-up Windows.</li> <li><a href="../api/Terminal.Gui/Terminal.Gui.Toplevel.html">TopLevel</a> - The base class for modal/pop-up Windows.</li>
<li><a href="../api/Terminal.Gui/Terminal.Gui.TreeView.html">TreeView</a> - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.</li> <li><a href="../api/Terminal.Gui/Terminal.Gui.TreeView.html">TreeView</a> - A hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.</li>
<li><a href="!/api/Terminal.Gui/Terminal.Gui.View.html">View</a> - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.</li> <li><a href="../api/Terminal.Gui/Terminal.Gui.View.html">View</a> - The base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.</li>
<li><a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a> - A Toplevel view that draws a border around its Frame with a title at the top.</li> <li><a href="../api/Terminal.Gui/Terminal.Gui.Window.html">Window</a> - A Toplevel view that draws a border around its Frame with a title at the top.</li>
<li><a href="../api/Terminal.Gui/Terminal.Gui.Wizard.html">Wizard</a> - Provides navigation and a user interface to collect related data across multiple steps.</li> <li><a href="../api/Terminal.Gui/Terminal.Gui.Wizard.html">Wizard</a> - Provides navigation and a user interface to collect related data across multiple steps.</li>
</ul> </ul>

BIN
docs/images/sample.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 MiB

BIN
docs/images/sample.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/images/wizard.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

View File

@@ -5,9 +5,9 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Terminal.Gui - Terminal UI toolkit for .NET </title> <title>Terminal.Gui - Cross Platform Terminal UI toolkit for .NET </title>
<meta name="viewport" content="width=device-width"> <meta name="viewport" content="width=device-width">
<meta name="title" content="Terminal.Gui - Terminal UI toolkit for .NET "> <meta name="title" content="Terminal.Gui - Cross Platform Terminal UI toolkit for .NET ">
<meta name="generator" content="docfx 2.59.3.0"> <meta name="generator" content="docfx 2.59.3.0">
<link rel="shortcut icon" href="favicon.ico"> <link rel="shortcut icon" href="favicon.ico">
@@ -71,9 +71,10 @@
<div class="article row grid"> <div class="article row grid">
<div class="col-md-10"> <div class="col-md-10">
<article class="content wrap" id="_content" data-uid=""> <article class="content wrap" id="_content" data-uid="">
<h1 id="terminalgui---terminal-ui-toolkit-for-net">Terminal.Gui - Terminal UI toolkit for .NET</h1> <h1 id="terminalgui---cross-platform-terminal-ui-toolkit-for-net">Terminal.Gui - Cross Platform Terminal UI toolkit for .NET</h1>
<p>A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.</p> <p>A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.</p>
<p><img src="images/sample.gif" alt="Sample"></p>
<ul> <ul>
<li><a href="https://github.com/migueldeicaza/gui.cs">Terminal.Gui Project on GitHub</a></li> <li><a href="https://github.com/migueldeicaza/gui.cs">Terminal.Gui Project on GitHub</a></li>
</ul> </ul>

View File

@@ -1301,8 +1301,8 @@
}, },
"index.html": { "index.html": {
"href": "index.html", "href": "index.html",
"title": "Terminal.Gui - Terminal UI toolkit for .NET", "title": "Terminal.Gui - Cross Platform Terminal UI toolkit for .NET",
"keywords": "Terminal.Gui - Terminal UI toolkit for .NET A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. Terminal.Gui Project on GitHub Terminal.Gui API Documentation API Reference Views and controls built into the Terminal.Gui library Terminal.Gui API Overview Keyboard Event Processing Event Processing and the Application Main Loop TableView Deep Dive TreeView Deep Dive UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. UI Catalog API Reference UI Catalog Source" "keywords": "Terminal.Gui - Cross Platform Terminal UI toolkit for .NET A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. Terminal.Gui Project on GitHub Terminal.Gui API Documentation API Reference Views and controls built into the Terminal.Gui library Terminal.Gui API Overview Keyboard Event Processing Event Processing and the Application Main Loop TableView Deep Dive TreeView Deep Dive UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. UI Catalog API Reference UI Catalog Source"
}, },
"README.html": { "README.html": {
"href": "README.html", "href": "README.html",

View File

@@ -3157,15 +3157,12 @@
"version": "" "version": ""
}, },
{ {
"log_codes": [
"InvalidFileLink"
],
"type": "Conceptual", "type": "Conceptual",
"source_relative_path": "articles/views.md", "source_relative_path": "articles/views.md",
"output": { "output": {
".html": { ".html": {
"relative_path": "articles/views.html", "relative_path": "articles/views.html",
"hash": "lGm0ADuULHQBWWb0zYAZO5MmIudgHUxDp8IvKHNnIjY=" "hash": "g9sE7ikfpaAJU7igs3/Dk2ZYH3T/GKa/fDU4IYaw2yE="
} }
}, },
"is_incremental": false, "is_incremental": false,
@@ -3193,13 +3190,46 @@
"is_incremental": false, "is_incremental": false,
"version": "" "version": ""
}, },
{
"type": "Resource",
"source_relative_path": "images/sample.gif",
"output": {
"resource": {
"relative_path": "images/sample.gif"
}
},
"is_incremental": false,
"version": ""
},
{
"type": "Resource",
"source_relative_path": "images/sample.png",
"output": {
"resource": {
"relative_path": "images/sample.png"
}
},
"is_incremental": false,
"version": ""
},
{
"type": "Resource",
"source_relative_path": "images/wizard.gif",
"output": {
"resource": {
"relative_path": "images/wizard.gif"
}
},
"is_incremental": false,
"version": ""
},
{ {
"type": "Conceptual", "type": "Conceptual",
"source_relative_path": "index.md", "source_relative_path": "index.md",
"output": { "output": {
".html": { ".html": {
"relative_path": "index.html", "relative_path": "index.html",
"hash": "nONipyTdueJl9Zb0V9z/8z0QQdE08fJbUVEBVToo/Po=" "hash": "XWDyl25OXa1/jrN/f3ki6PzqMRjL/91oEdJfKGg7IR4="
} }
}, },
"is_incremental": false, "is_incremental": false,
@@ -3221,23 +3251,25 @@
"incremental_info": [ "incremental_info": [
{ {
"status": { "status": {
"can_incremental": true, "can_incremental": false,
"details": "Disable incremental build by force rebuild option.",
"incrementalPhase": "build", "incrementalPhase": "build",
"total_file_count": 0, "total_file_count": 0,
"skipped_file_count": 0 "skipped_file_count": 0,
"full_build_reason_code": "ForceRebuild"
}, },
"processors": { "processors": {
"ConceptualDocumentProcessor": { "ConceptualDocumentProcessor": {
"can_incremental": true, "can_incremental": false,
"incrementalPhase": "build", "incrementalPhase": "build",
"total_file_count": 9, "total_file_count": 9,
"skipped_file_count": 9 "skipped_file_count": 0
}, },
"ManagedReferenceDocumentProcessor": { "ManagedReferenceDocumentProcessor": {
"can_incremental": true, "can_incremental": false,
"incrementalPhase": "build", "incrementalPhase": "build",
"total_file_count": 253, "total_file_count": 253,
"skipped_file_count": 253 "skipped_file_count": 0
}, },
"ResourceDocumentProcessor": { "ResourceDocumentProcessor": {
"can_incremental": false, "can_incremental": false,

View File

@@ -114,6 +114,7 @@ article h4 {
-webkit-box-shadow: var(--card-box-shadow); -webkit-box-shadow: var(--card-box-shadow);
-moz-box-shadow: var(--card-box-shadow); -moz-box-shadow: var(--card-box-shadow);
box-shadow: var(--card-box-shadow); box-shadow: var(--card-box-shadow);
font-family: 'Source Code Pro', 'Courier New', Courier, monospace
} }
.subnav { .subnav {