From b69312c683a6e6f7f8a70d5f75a2faa01646321f Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Thu, 3 Aug 2023 08:38:15 -0500 Subject: [PATCH] Polish nav.adoc --- spring-shell-docs/modules/ROOT/nav.adoc | 152 +++++++++--------- .../modules/ROOT/pages/appendices.adoc | 2 - .../modules/ROOT/pages/index.adoc | 24 ++- .../modules/ROOT/pages/introduction.adoc | 17 -- .../modules/ROOT/pages/using-shell.adoc | 9 -- 5 files changed, 85 insertions(+), 119 deletions(-) delete mode 100644 spring-shell-docs/modules/ROOT/pages/appendices.adoc delete mode 100644 spring-shell-docs/modules/ROOT/pages/introduction.adoc delete mode 100644 spring-shell-docs/modules/ROOT/pages/using-shell.adoc diff --git a/spring-shell-docs/modules/ROOT/nav.adoc b/spring-shell-docs/modules/ROOT/nav.adoc index 9dd8eb7b..a1f181b8 100644 --- a/spring-shell-docs/modules/ROOT/nav.adoc +++ b/spring-shell-docs/modules/ROOT/nav.adoc @@ -1,88 +1,86 @@ -* xref:index.adoc[] -* xref:introduction.adoc[] +* xref:index.adoc[Overview] * xref:getting-started.adoc[] -* xref:using-shell.adoc[] * xref:using-shell-basics.adoc[] -* xref:using-shell-basics-reading.adoc[] +** xref:using-shell-basics-reading.adoc[] * xref:using-shell-commands.adoc[] -* xref:using-shell-commands-registration.adoc[] -* xref:using-shell-commands-registration-programmatic.adoc[] -* xref:using-shell-commands-registration-annotation.adoc[] -* xref:using-shell-commands-registration-legacyannotation.adoc[] -* xref:using-shell-commands-organize.adoc[] -* xref:using-shell-commands-availability.adoc[] -* xref:using-shell-commands-exceptionhandling.adoc[] -* xref:using-shell-commands-exceptionhandling-resolving.adoc[] -* xref:using-shell-commands-exceptionhandling-mappings.adoc[] -* xref:using-shell-commands-exceptionhandling-annotation.adoc[] -* xref:using-shell-commands-hidden.adoc[] -* xref:using-shell-commands-helpoptions.adoc[] -* xref:using-shell-commands-interactionmode.adoc[] -* xref:using-shell-commands-builtin.adoc[] -* xref:using-shell-commands-builtin-help.adoc[] -* xref:using-shell-commands-builtin-clear.adoc[] -* xref:using-shell-commands-builtin-exit.adoc[] -* xref:using-shell-commands-builtin-stacktrace.adoc[] -* xref:using-shell-commands-builtin-script.adoc[] -* xref:using-shell-commands-builtin-history.adoc[] -* xref:using-shell-commands-builtin-completion.adoc[] -* xref:using-shell-commands-builtin-version.adoc[] -* xref:using-shell-commands-writing.adoc[] +** xref:using-shell-commands-registration.adoc[] +** xref:using-shell-commands-registration-programmatic.adoc[] +** xref:using-shell-commands-registration-annotation.adoc[] +** xref:using-shell-commands-registration-legacyannotation.adoc[] +** xref:using-shell-commands-organize.adoc[] +** xref:using-shell-commands-availability.adoc[] +** xref:using-shell-commands-exceptionhandling.adoc[] +*** xref:using-shell-commands-exceptionhandling-resolving.adoc[] +*** xref:using-shell-commands-exceptionhandling-mappings.adoc[] +*** xref:using-shell-commands-exceptionhandling-annotation.adoc[] +** xref:using-shell-commands-hidden.adoc[] +** xref:using-shell-commands-helpoptions.adoc[] +** xref:using-shell-commands-interactionmode.adoc[] +** xref:using-shell-commands-builtin.adoc[] +*** xref:using-shell-commands-builtin-help.adoc[] +*** xref:using-shell-commands-builtin-clear.adoc[] +*** xref:using-shell-commands-builtin-exit.adoc[] +*** xref:using-shell-commands-builtin-stacktrace.adoc[] +*** xref:using-shell-commands-builtin-script.adoc[] +*** xref:using-shell-commands-builtin-history.adoc[] +*** xref:using-shell-commands-builtin-completion.adoc[] +*** xref:using-shell-commands-builtin-version.adoc[] +** xref:using-shell-commands-writing.adoc[] * xref:using-shell-options.adoc[] -* xref:using-shell-options-basics.adoc[] -* xref:using-shell-options-basics-programmatic.adoc[] -* xref:using-shell-options-basics-annotation.adoc[] -* xref:using-shell-options-basics-legacyannotation.adoc[] -* xref:using-shell-options-short.adoc[] -* xref:using-shell-options-arity.adoc[] -* xref:using-shell-options-positional.adoc[] -* xref:using-shell-options-optional.adoc[] -* xref:using-shell-options-default.adoc[] -* xref:using-shell-options-validation.adoc[] -* xref:using-shell-options-label.adoc[] -* xref:using-shell-options-types.adoc[] -* xref:using-shell-options-naming.adoc[] +** xref:using-shell-options-basics.adoc[] +*** xref:using-shell-options-basics-programmatic.adoc[] +*** xref:using-shell-options-basics-annotation.adoc[] +*** xref:using-shell-options-basics-legacyannotation.adoc[] +** xref:using-shell-options-short.adoc[] +** xref:using-shell-options-arity.adoc[] +** xref:using-shell-options-positional.adoc[] +** xref:using-shell-options-optional.adoc[] +** xref:using-shell-options-default.adoc[] +** xref:using-shell-options-validation.adoc[] +** xref:using-shell-options-label.adoc[] +** xref:using-shell-options-types.adoc[] +** xref:using-shell-options-naming.adoc[] * xref:using-shell-completion.adoc[] * xref:using-shell-building.adoc[] * xref:using-shell-components.adoc[] -* xref:using-shell-components-flow.adoc[] -* xref:using-shell-components-ui.adoc[] -* xref:using-shell-components-ui-render.adoc[] -* xref:using-shell-components-ui-stringinput.adoc[] -* xref:using-shell-components-ui-pathinput.adoc[] -* xref:using-shell-components-ui-pathsearch.adoc[] -* xref:using-shell-components-ui-confirmation.adoc[] -* xref:using-shell-components-ui-singleselect.adoc[] -* xref:using-shell-components-ui-multiselect.adoc[] +** xref:using-shell-components-flow.adoc[] +** xref:using-shell-components-ui.adoc[] +*** xref:using-shell-components-ui-render.adoc[] +*** xref:using-shell-components-ui-stringinput.adoc[] +*** xref:using-shell-components-ui-pathinput.adoc[] +*** xref:using-shell-components-ui-pathsearch.adoc[] +*** xref:using-shell-components-ui-confirmation.adoc[] +*** xref:using-shell-components-ui-singleselect.adoc[] +*** xref:using-shell-components-ui-multiselect.adoc[] * xref:using-shell-tui.adoc[] -* xref:using-shell-tui-intro.adoc[] -* xref:using-shell-tui-views.adoc[] -* xref:using-shell-tui-views-box.adoc[] -* xref:using-shell-tui-views-list.adoc[] +** xref:using-shell-tui-intro.adoc[] +** xref:using-shell-tui-views.adoc[] +*** xref:using-shell-tui-views-box.adoc[] +*** xref:using-shell-tui-views-list.adoc[] * xref:using-shell-customization.adoc[] -* xref:using-shell-customization-styling.adoc[] -* xref:using-shell-customization-logging.adoc[] -* xref:using-shell-customization-commandnotfound.adoc[] -* xref:using-shell-customization-singlecommand.adoc[] +** xref:using-shell-customization-styling.adoc[] +** xref:using-shell-customization-logging.adoc[] +** xref:using-shell-customization-commandnotfound.adoc[] +** xref:using-shell-customization-singlecommand.adoc[] * xref:using-shell-execution.adoc[] * xref:using-shell-testing.adoc[] -* xref:using-shell-testing-basics.adoc[] -* xref:using-shell-testing-settings.adoc[] -* xref:appendices.adoc[] -* xref:appendices-techical-intro.adoc[] -* xref:appendices-techical-intro-registration.adoc[] -* xref:appendices-techical-intro-parser.adoc[] -* xref:appendices-techical-intro-execution.adoc[] -* xref:appendices-techical-intro-commandcontext.adoc[] -* xref:appendices-techical-intro-commandcatalog.adoc[] -* xref:appendices-techical-intro-theming.adoc[] -* xref:appendices-techical-intro-searchalgorithm.adoc[] -* xref:appendices-debugging.adoc[] -* xref:appendices-tui.adoc[] -* xref:appendices-tui-control.adoc[] -* xref:appendices-tui-view.adoc[] -* xref:appendices-tui-eventloop.adoc[] -* xref:appendices-tui-screen.adoc[] -* xref:appendices-tui-keyhandling.adoc[] -* xref:appendices-tui-mousehandling.adoc[] -* xref:appendices-tui-catalog.adoc[] +** xref:using-shell-testing-basics.adoc[] +** xref:using-shell-testing-settings.adoc[] +* Appendices +** xref:appendices-techical-intro.adoc[] +*** xref:appendices-techical-intro-registration.adoc[] +*** xref:appendices-techical-intro-parser.adoc[] +*** xref:appendices-techical-intro-execution.adoc[] +*** xref:appendices-techical-intro-commandcontext.adoc[] +*** xref:appendices-techical-intro-commandcatalog.adoc[] +*** xref:appendices-techical-intro-theming.adoc[] +*** xref:appendices-techical-intro-searchalgorithm.adoc[] +** xref:appendices-debugging.adoc[] +** xref:appendices-tui.adoc[] +*** xref:appendices-tui-control.adoc[] +*** xref:appendices-tui-view.adoc[] +*** xref:appendices-tui-eventloop.adoc[] +*** xref:appendices-tui-screen.adoc[] +*** xref:appendices-tui-keyhandling.adoc[] +*** xref:appendices-tui-mousehandling.adoc[] +*** xref:appendices-tui-catalog.adoc[] \ No newline at end of file diff --git a/spring-shell-docs/modules/ROOT/pages/appendices.adoc b/spring-shell-docs/modules/ROOT/pages/appendices.adoc deleted file mode 100644 index 139597f9..00000000 --- a/spring-shell-docs/modules/ROOT/pages/appendices.adoc +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/spring-shell-docs/modules/ROOT/pages/index.adoc b/spring-shell-docs/modules/ROOT/pages/index.adoc index ee56175c..2d44d57f 100644 --- a/spring-shell-docs/modules/ROOT/pages/index.adoc +++ b/spring-shell-docs/modules/ROOT/pages/index.adoc @@ -1,22 +1,18 @@ -[[spring-shell-reference-documentation]] -= Spring Shell Reference Documentation -:page-section-summary-toc: 1 += Spring Shell Eric Bottard; Janne Valkealahti; Jay Bryant; Corneil du Plessis -:doctype: book -:hide-uri-scheme: -:icons: font -:experimental: // For kbd: macro -:spring-shell-starter: spring-shell-starter +:page-section-summary-toc: 1 -*{project-version}* +**{project-version}** + +Not all applications need a fancy web user interface. Sometimes, interacting with an application through an interactive terminal is the most appropriate way to get things done. + +Spring Shell lets you create such a runnable application, where the user enters textual commands that are run until the program terminates. The Spring Shell project provides the infrastructure to create such a REPL (Read, Eval, Print Loop) application, letting you concentrate on implementing commands by using the familiar Spring programming model. + +Spring Shell includes advanced features (such as parsing, tab completion, colorization of output, fancy ASCII-art table display, input conversion, and validation), freeing you to focus on core command logic. (C) 2017 - 2023 VMware, Inc. _Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in -print or electronically._ - - - - +print or electronically._ \ No newline at end of file diff --git a/spring-shell-docs/modules/ROOT/pages/introduction.adoc b/spring-shell-docs/modules/ROOT/pages/introduction.adoc deleted file mode 100644 index 846323fc..00000000 --- a/spring-shell-docs/modules/ROOT/pages/introduction.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[[what-is-spring-shell?]] -= What is Spring Shell? -:page-section-summary-toc: 1 - -Not all applications need a fancy web user interface. -Sometimes, interacting with an application through an interactive terminal is -the most appropriate way to get things done. - -Spring Shell lets you create such a runnable application, where the -user enters textual commands that are run until the program terminates. -The Spring Shell project provides the infrastructure to create such a REPL (Read, Eval, -Print Loop) application, letting you concentrate on implementing commands by using -the familiar Spring programming model. - -Spring Shell includes advanced features (such as parsing, tab completion, colorization of -output, fancy ASCII-art table display, input conversion, and validation), freeing you -to focus on core command logic. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell.adoc deleted file mode 100644 index e3c0074c..00000000 --- a/spring-shell-docs/modules/ROOT/pages/using-shell.adoc +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - -