From 6f7eac435abaabd82d9e771b02fdad62a6c7433d Mon Sep 17 00:00:00 2001 From: Janne Valkealahti Date: Fri, 6 Oct 2023 17:07:16 +0100 Subject: [PATCH] Update docs --- spring-shell-docs/modules/ROOT/nav.adoc | 20 +++++++++---------- .../flow/index.adoc} | 2 +- .../index.adoc} | 0 .../ui/confirmation.adoc} | 2 +- .../ui/index.adoc} | 2 +- .../ui/multiselect.adoc} | 2 +- .../ui/pathinput.adoc} | 2 +- .../ui/pathsearch.adoc} | 2 +- .../ui/render.adoc} | 0 .../ui/singleselect.adoc} | 2 +- .../ui/stringinput.adoc} | 2 +- 11 files changed, 18 insertions(+), 18 deletions(-) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-flow.adoc => components/flow/index.adoc} (91%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components.adoc => components/index.adoc} (100%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-confirmation.adoc => components/ui/confirmation.adoc} (82%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui.adoc => components/ui/index.adoc} (88%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-multiselect.adoc => components/ui/multiselect.adoc} (83%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-pathinput.adoc => components/ui/pathinput.adoc} (80%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-pathsearch.adoc => components/ui/pathsearch.adoc} (86%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-render.adoc => components/ui/render.adoc} (100%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-singleselect.adoc => components/ui/singleselect.adoc} (87%) rename spring-shell-docs/modules/ROOT/pages/{using-shell-components-ui-stringinput.adoc => components/ui/stringinput.adoc} (86%) diff --git a/spring-shell-docs/modules/ROOT/nav.adoc b/spring-shell-docs/modules/ROOT/nav.adoc index 289a8e208..5812b07a7 100644 --- a/spring-shell-docs/modules/ROOT/nav.adoc +++ b/spring-shell-docs/modules/ROOT/nav.adoc @@ -42,16 +42,16 @@ ** xref: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:components/index.adoc[] +** xref:components/flow/index.adoc[] +** xref:components/ui/index.adoc[] +*** xref:components/ui/render.adoc[] +*** xref:components/ui/stringinput.adoc[] +*** xref:components/ui/pathinput.adoc[] +*** xref:components/ui/pathsearch.adoc[] +*** xref:components/ui/confirmation.adoc[] +*** xref:components/ui/singleselect.adoc[] +*** xref:components/ui/multiselect.adoc[] * xref:tui/index.adoc[] ** xref:tui/intro/index.adoc[] ** xref:tui/views/index.adoc[] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-flow.adoc b/spring-shell-docs/modules/ROOT/pages/components/flow/index.adoc similarity index 91% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-flow.adoc rename to spring-shell-docs/modules/ROOT/pages/components/flow/index.adoc index d7f03e913..e994c344c 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-flow.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/flow/index.adoc @@ -3,7 +3,7 @@ ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] -When you use xref:using-shell-components-ui.adoc[Flow Components] to build something that involves +When you use xref:components/ui/index.adoc[Flow Components] to build something that involves use of a multiple components, your implementation may become a bit cluttered. To ease these use cases, we added a `ComponentFlow` that can hook multiple component executions together diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc b/spring-shell-docs/modules/ROOT/pages/components/index.adoc similarity index 100% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc rename to spring-shell-docs/modules/ROOT/pages/components/index.adoc diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-confirmation.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/confirmation.adoc similarity index 82% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-confirmation.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/confirmation.adoc index c7bf861cd..2c1046fd4 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-confirmation.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/confirmation.adoc @@ -26,5 +26,5 @@ The context object is `ConfirmationInputContext`. The following table describes |The default value -- either `true` or `false`. |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). +|The parent context variables (see xref:components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). |=== diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/index.adoc similarity index 88% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/index.adoc index dddb73011..b9124fb24 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/index.adoc @@ -19,7 +19,7 @@ Built-in components generally follow this logic: . Exit. . Render the final status of a component state. -NOTE: xref:using-shell-components-flow.adoc[Flow] gives better interface for defining the flow of +NOTE: xref:components/flow/index.adoc[Flow] gives better interface for defining the flow of components that are better suited for defining interactive command flows. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-multiselect.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/multiselect.adoc similarity index 83% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-multiselect.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/multiselect.adoc index 4ba79df2f..7e09f7384 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-multiselect.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/multiselect.adoc @@ -29,5 +29,5 @@ The context object is `MultiItemSelectorContext`. The following table describes |The visible items, where rows contain maps of name, selected, on-row, and enabled items. |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]). +|The parent context variables (see xref:components/ui/render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]). |=== diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathinput.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/pathinput.adoc similarity index 80% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathinput.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/pathinput.adoc index 1c9772e3c..3e274dbd8 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathinput.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/pathinput.adoc @@ -22,5 +22,5 @@ The context object is `PathInputContext`. The following table describes its cont |Key |Description |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). +|The parent context variables (see xref:components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). |=== diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathsearch.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/pathsearch.adoc similarity index 86% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathsearch.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/pathsearch.adoc index 886acd36d..8b4782f4a 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathsearch.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/pathsearch.adoc @@ -30,5 +30,5 @@ The context object is `PathSearchContext`. The following table describes its con |The items available for rendering search results. |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). +|The parent context variables (see xref:/components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). |=== diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-render.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/render.adoc similarity index 100% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-render.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/render.adoc diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-singleselect.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/singleselect.adoc similarity index 87% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-singleselect.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/singleselect.adoc index 993c4e4c3..502d92659 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-singleselect.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/singleselect.adoc @@ -29,7 +29,7 @@ The context object is `SingleItemSelectorContext`. The following table describes |The visible items, where rows contains maps of name and selected items. |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]). +|The parent context variables (see xref:/components/ui/render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]). |=== You can pre-select an item by defining it to get exposed. This is diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-stringinput.adoc b/spring-shell-docs/modules/ROOT/pages/components/ui/stringinput.adoc similarity index 86% rename from spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-stringinput.adoc rename to spring-shell-docs/modules/ROOT/pages/components/ui/stringinput.adoc index d2130a340..c0db1f2b1 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-stringinput.adoc +++ b/spring-shell-docs/modules/ROOT/pages/components/ui/stringinput.adoc @@ -38,5 +38,5 @@ The context object is `StringInputContext`. The following table lists its contex |`true` if a mask character is set. Otherwise, false. |`model` -|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). +|The parent context variables (see xref:/components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]). |===