diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-debugging.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-debugging.adoc index 17aecaaf..fa1356c2 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-debugging.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-debugging.adoc @@ -1,5 +1,6 @@ [appendix] [#appendix-debugging] = Debugging +:page-section-summary-toc: 1 Please find more info about debugging from https://github.com/spring-projects/spring-shell/wiki/Debugging[project wiki]. diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-commandcontext.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-commandcontext.adoc index 047d5d57..231d63fa 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-commandcontext.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-commandcontext.adoc @@ -1,5 +1,6 @@ [[command-context]] = Command Context +:page-section-summary-toc: 1 The `CommandContext` interface gives access to a currently running context. You can use it to get access to options: diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-execution.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-execution.adoc index 87196ee9..954f83ce 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-execution.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-execution.adoc @@ -1,5 +1,6 @@ [[command-execution]] = Command Execution +:page-section-summary-toc: 1 When command parsing has done its job and command registration has been resolved, command execution does the hard work of running the code. diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-parser.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-parser.adoc index c81b3879..6d785205 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-parser.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-parser.adoc @@ -1,5 +1,6 @@ [[command-parser]] = Command Parser +:page-section-summary-toc: 1 Before a command can be executed, we need to parse the command and whatever options the user may have provided. Parsing comes between command registration and command execution. diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro.adoc index 2b7291b3..4af2f9d7 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-techical-intro.adoc @@ -1,6 +1,7 @@ [appendix] [#appendix-tech-intro] = Techical Introduction +:page-section-summary-toc: 1 This appendix contains information for developers and others who would like to know more about how Spring Shell works internally and what its design decisions are. diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-catalog.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-catalog.adoc index 700d387f..ee541b64 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-catalog.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-catalog.adoc @@ -1,5 +1,6 @@ [#appendix-tui-catalog] = Catalog App +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc index 971648e8..2e58764b 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc @@ -1,5 +1,6 @@ [#appendix-tui-control] = Control +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc index e2cbb90a..0a48a8c1 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc @@ -1,5 +1,6 @@ [#appendix-tui-eventloop] = EventLoop +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc index 13ff643b..7d6aa22e 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc @@ -1,5 +1,6 @@ [#appendix-tui-keyhandling] = Key Handling +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc index 719356fd..14804df1 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc @@ -1,5 +1,6 @@ [#appendix-tui-mousehandling] = Mouse Handling +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc index 4f043cb6..f7d69725 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc @@ -1,5 +1,6 @@ [#appendix-tui-screen] = Screen +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc index cfad13e0..95858162 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc @@ -1,5 +1,6 @@ [#appendix-tui-view] = View +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/appendices-tui.adoc b/spring-shell-docs/modules/ROOT/pages/appendices-tui.adoc index 84dc6963..2c7b353e 100644 --- a/spring-shell-docs/modules/ROOT/pages/appendices-tui.adoc +++ b/spring-shell-docs/modules/ROOT/pages/appendices-tui.adoc @@ -1,6 +1,7 @@ [appendix] [#appendix-tech-intro-tui] = Terminal UI +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/index.adoc b/spring-shell-docs/modules/ROOT/pages/index.adoc index 9ee50e01..ee56175c 100644 --- a/spring-shell-docs/modules/ROOT/pages/index.adoc +++ b/spring-shell-docs/modules/ROOT/pages/index.adoc @@ -1,5 +1,6 @@ [[spring-shell-reference-documentation]] = Spring Shell Reference Documentation +:page-section-summary-toc: 1 Eric Bottard; Janne Valkealahti; Jay Bryant; Corneil du Plessis :doctype: book :hide-uri-scheme: diff --git a/spring-shell-docs/modules/ROOT/pages/introduction.adoc b/spring-shell-docs/modules/ROOT/pages/introduction.adoc index cee5b522..846323fc 100644 --- a/spring-shell-docs/modules/ROOT/pages/introduction.adoc +++ b/spring-shell-docs/modules/ROOT/pages/introduction.adoc @@ -1,5 +1,6 @@ [[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 diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-basics-reading.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-basics-reading.adoc index cf9f4528..14526045 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-basics-reading.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-basics-reading.adoc @@ -1,5 +1,6 @@ [[using-shell-basics-reading]] = Reading Docs +:page-section-summary-toc: 1 Throughout this documentation, we make references to configuring something by using annotations or programmatic examples. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-basics.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-basics.adoc index 23a3aa69..c54c90a2 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-basics.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-basics.adoc @@ -1,5 +1,6 @@ [[using-shell-basics]] = Basics +:page-section-summary-toc: 1 This section covers the basics of Spring Shell. Before going on to define actual commands and options, we need to go through some of the fundamental concepts of Spring Shell. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-clear.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-clear.adoc index 1ede6f0a..0d36f1bd 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-clear.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-clear.adoc @@ -1,5 +1,6 @@ [[built-in-commands-clear]] = Clear +:page-section-summary-toc: 1 The `clear` command does what you would expect and clears the screen, resetting the prompt in the top left corner. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-completion.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-completion.adoc index c0a31e1f..1e69a129 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-completion.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-completion.adoc @@ -1,5 +1,6 @@ [[built-in-commands-completion]] = Completion +:page-section-summary-toc: 1 The `completion` command set lets you create script files that can be used with am OS shell implementations to provide completion. This is very useful when diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-exit.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-exit.adoc index 90b262b5..5f8e05c2 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-exit.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-exit.adoc @@ -1,5 +1,6 @@ [[built-in-commands-exit]] = Exit +:page-section-summary-toc: 1 The `quit` command (also aliased as `exit`) requests the shell to quit, gracefully closing the Spring application context. If not overridden, a JLine `History` bean writes a history of all diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-history.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-history.adoc index edb2a715..3c2db2cb 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-history.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-history.adoc @@ -1,5 +1,6 @@ [[built-in-commands-history]] = History +:page-section-summary-toc: 1 The `history` command shows the history of commands that has been executed. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-script.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-script.adoc index da5c4c7f..2afe28fa 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-script.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-script.adoc @@ -1,5 +1,6 @@ [[built-in-commands-script]] = Script +:page-section-summary-toc: 1 The `script` command accepts a local file as an argument and replays commands found there, one at a time. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-stacktrace.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-stacktrace.adoc index 19e66079..f3183012 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-stacktrace.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-stacktrace.adoc @@ -1,5 +1,6 @@ [[built-in-commands-stacktrace]] = Stacktrace +:page-section-summary-toc: 1 When an exception occurs inside command code, it is caught by the shell and a simple, one-line message is displayed so as not to overflow the user with too much information. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin.adoc index 8616dbb8..521eb5ee 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin.adoc @@ -1,5 +1,6 @@ [[built-in-commands]] = Built-In Commands +:page-section-summary-toc: 1 diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-exceptionhandling.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-exceptionhandling.adoc index cf7cd2c7..041ba897 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-exceptionhandling.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-exceptionhandling.adoc @@ -1,5 +1,6 @@ [[dynamic-command-exitcode]] = Exception Handling +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-interactionmode.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-interactionmode.adoc index ec9a1786..4fd2114d 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-interactionmode.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-interactionmode.adoc @@ -1,5 +1,6 @@ [[commands-interactionmode]] = Interaction Mode +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration.adoc index 72cfa301..9efd25b0 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration.adoc @@ -1,5 +1,6 @@ [[registration]] = Registration +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-commands.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-commands.adoc index 692827ec..663af418 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-commands.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-commands.adoc @@ -1,5 +1,6 @@ [[commands]] = Commands +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc index a33c779f..dcbec06b 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc @@ -1,5 +1,6 @@ [[using-shell-components]] = Components +:page-section-summary-toc: 1 Components are a set of features which are either build-in or something you can re-use or extend for your own needs. Components in question are diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-customization-singlecommand.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-customization-singlecommand.adoc index f9b52111..7a4797d5 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-customization-singlecommand.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-customization-singlecommand.adoc @@ -1,5 +1,6 @@ [[using-shell-customization-singlecommand]] = Single Command +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-customization.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-customization.adoc index 59abca7b..41408675 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-customization.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-customization.adoc @@ -1,5 +1,6 @@ [[using-shell-customization]] = Customization +:page-section-summary-toc: 1 This section describes how you can customize the shell. diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-annotation.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-annotation.adoc index 4956ae5b..2287cf2f 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-annotation.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-annotation.adoc @@ -1,5 +1,6 @@ [[using-shell-options-basics-annotation]] = Annotation +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-programmatic.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-programmatic.adoc index 9b860de5..e869375c 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-programmatic.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-programmatic.adoc @@ -1,6 +1,7 @@ [[using-shell-options-basics-registration]] [[using-shell-options-basics-programmatic]] = Programmatic +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics.adoc index 6782c3ee..6a155c31 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-options-basics.adoc @@ -1,5 +1,6 @@ [[using-shell-options-basics]] = Basics +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-testing.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-testing.adoc index 8894cc3b..34e4d505 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-testing.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-testing.adoc @@ -1,5 +1,6 @@ [[using-shell-testing]] = Testing +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-intro.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-intro.adoc index 47cff1e5..aa703aef 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-intro.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-intro.adoc @@ -1,5 +1,6 @@ [[using-shell-tui-intro]] = Introduction +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc index 7ca3ef9b..1c6e664d 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc @@ -1,5 +1,6 @@ [[using-shell-tui-views-box]] = BoxView +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc index a7922d41..0cb9530c 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc @@ -1,5 +1,6 @@ [[using-shell-tui-views-list]] = ListView +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc index 6a036363..b4eb8151 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc @@ -1,5 +1,6 @@ [[using-shell-tui-views]] = Views +:page-section-summary-toc: 1 ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] diff --git a/spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc b/spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc index 76d38cd4..a8823bc6 100644 --- a/spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc +++ b/spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc @@ -1,5 +1,6 @@ [[using-shell-tui]] = Terminal UI +:page-section-summary-toc: 1 NOTE: Feature is experimental and subject to breaking changes until foundation and related concepts around framework are getting more stable.