Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enable Section Summary TOC for small pages

Browse Source
This commit is contained in:
Rob Winch
2023-08-03 11:11:14 -05:00
parent d1105f5b8e
commit 2ee3fff367
40 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-shell-docs/modules/ROOT/pages/appendices-debugging.adoc
View File

@@ -1,5 +1,6 @@
[appendix] [appendix]
[#appendix-debugging] [#appendix-debugging]
= 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]. Please find more info about debugging from https://github.com/spring-projects/spring-shell/wiki/Debugging[project wiki].

1
spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-commandcontext.adoc
View File

@@ -1,5 +1,6 @@
[[command-context]] [[command-context]]
= Command Context = Command Context
:page-section-summary-toc: 1
The `CommandContext` interface gives access to a currently running The `CommandContext` interface gives access to a currently running
context. You can use it to get access to options: context. You can use it to get access to options:

1
spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-execution.adoc
View File

@@ -1,5 +1,6 @@
[[command-execution]] [[command-execution]]
= Command Execution = Command Execution
:page-section-summary-toc: 1
When command parsing has done its job and command registration has been resolved, command execution When command parsing has done its job and command registration has been resolved, command execution
does the hard work of running the code. does the hard work of running the code.

1
spring-shell-docs/modules/ROOT/pages/appendices-techical-intro-parser.adoc
View File

@@ -1,5 +1,6 @@
[[command-parser]] [[command-parser]]
= 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 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. comes between command registration and command execution.

1
spring-shell-docs/modules/ROOT/pages/appendices-techical-intro.adoc
View File

@@ -1,6 +1,7 @@
[appendix] [appendix]
[#appendix-tech-intro] [#appendix-tech-intro]
= Techical Introduction = 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 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. works internally and what its design decisions are.

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-catalog.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-catalog] [#appendix-tui-catalog]
= Catalog App = Catalog App
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-control] [#appendix-tui-control]
= Control = Control
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-eventloop] [#appendix-tui-eventloop]
= EventLoop = EventLoop
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-keyhandling] [#appendix-tui-keyhandling]
= Key Handling = Key Handling
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-mousehandling] [#appendix-tui-mousehandling]
= Mouse Handling = Mouse Handling
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-screen] [#appendix-tui-screen]
= Screen = Screen
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc
View File

@@ -1,5 +1,6 @@
[#appendix-tui-view] [#appendix-tui-view]
= View = View
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/appendices-tui.adoc
View File

@@ -1,6 +1,7 @@
[appendix] [appendix]
[#appendix-tech-intro-tui] [#appendix-tech-intro-tui]
= Terminal UI = Terminal UI
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/index.adoc
View File

@@ -1,5 +1,6 @@
[[spring-shell-reference-documentation]] [[spring-shell-reference-documentation]]
= Spring Shell Reference Documentation = Spring Shell Reference Documentation
:page-section-summary-toc: 1
Eric Bottard; Janne Valkealahti; Jay Bryant; Corneil du Plessis Eric Bottard; Janne Valkealahti; Jay Bryant; Corneil du Plessis
:doctype: book :doctype: book
:hide-uri-scheme: :hide-uri-scheme:

1
spring-shell-docs/modules/ROOT/pages/introduction.adoc
View File

@@ -1,5 +1,6 @@
[[what-is-spring-shell?]] [[what-is-spring-shell?]]
= What is Spring Shell? = What is Spring Shell?
:page-section-summary-toc: 1
Not all applications need a fancy web user interface. Not all applications need a fancy web user interface.
Sometimes, interacting with an application through an interactive terminal is Sometimes, interacting with an application through an interactive terminal is

1
spring-shell-docs/modules/ROOT/pages/using-shell-basics-reading.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-basics-reading]] [[using-shell-basics-reading]]
= Reading Docs = Reading Docs
:page-section-summary-toc: 1
Throughout this documentation, we make references to configuring something by using Throughout this documentation, we make references to configuring something by using
annotations or programmatic examples. annotations or programmatic examples.

1
spring-shell-docs/modules/ROOT/pages/using-shell-basics.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-basics]] [[using-shell-basics]]
= Basics = Basics
:page-section-summary-toc: 1
This section covers the basics of Spring Shell. Before going on to define actual commands and options, 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. we need to go through some of the fundamental concepts of Spring Shell.

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-clear.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-clear]] [[built-in-commands-clear]]
= Clear = Clear
:page-section-summary-toc: 1
The `clear` command does what you would expect and clears the screen, resetting the prompt The `clear` command does what you would expect and clears the screen, resetting the prompt
in the top left corner. in the top left corner.

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-completion.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-completion]] [[built-in-commands-completion]]
= Completion = Completion
:page-section-summary-toc: 1
The `completion` command set lets you create script files that can be used 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 with am OS shell implementations to provide completion. This is very useful when

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-exit.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-exit]] [[built-in-commands-exit]]
= Exit = Exit
:page-section-summary-toc: 1
The `quit` command (also aliased as `exit`) requests the shell to quit, gracefully 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 closing the Spring application context. If not overridden, a JLine `History` bean writes a history of all

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-history.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-history]] [[built-in-commands-history]]
= History = History
:page-section-summary-toc: 1
The `history` command shows the history of commands that has been executed. The `history` command shows the history of commands that has been executed.

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-script.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-script]] [[built-in-commands-script]]
= 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. The `script` command accepts a local file as an argument and replays commands found there, one at a time.

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-stacktrace.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands-stacktrace]] [[built-in-commands-stacktrace]]
= 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 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. so as not to overflow the user with too much information.

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin.adoc
View File

@@ -1,5 +1,6 @@
[[built-in-commands]] [[built-in-commands]]
= Built-In Commands = Built-In Commands
:page-section-summary-toc: 1

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-exceptionhandling.adoc
View File

@@ -1,5 +1,6 @@
[[dynamic-command-exitcode]] [[dynamic-command-exitcode]]
= Exception Handling = Exception Handling
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-interactionmode.adoc
View File

@@ -1,5 +1,6 @@
[[commands-interactionmode]] [[commands-interactionmode]]
= Interaction Mode = Interaction Mode
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration.adoc
View File

@@ -1,5 +1,6 @@
[[registration]] [[registration]]
= Registration = Registration
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-commands.adoc
View File

@@ -1,5 +1,6 @@
[[commands]] [[commands]]
= Commands = Commands
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-components.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-components]] [[using-shell-components]]
= Components = Components
:page-section-summary-toc: 1
Components are a set of features which are either build-in or something 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 you can re-use or extend for your own needs. Components in question are

1
spring-shell-docs/modules/ROOT/pages/using-shell-customization-singlecommand.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-customization-singlecommand]] [[using-shell-customization-singlecommand]]
= Single Command = Single Command
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-customization.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-customization]] [[using-shell-customization]]
= Customization = Customization
:page-section-summary-toc: 1
This section describes how you can customize the shell. This section describes how you can customize the shell.

1
spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-annotation.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-options-basics-annotation]] [[using-shell-options-basics-annotation]]
= Annotation = Annotation
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-options-basics-programmatic.adoc
View File

@@ -1,6 +1,7 @@
[[using-shell-options-basics-registration]] [[using-shell-options-basics-registration]]
[[using-shell-options-basics-programmatic]] [[using-shell-options-basics-programmatic]]
= Programmatic = Programmatic
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-options-basics.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-options-basics]] [[using-shell-options-basics]]
= Basics = Basics
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-testing.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-testing]] [[using-shell-testing]]
= Testing = Testing
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-tui-intro.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-tui-intro]] [[using-shell-tui-intro]]
= Introduction = Introduction
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-tui-views-box]] [[using-shell-tui-views-box]]
= BoxView = BoxView
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-tui-views-list]] [[using-shell-tui-views-list]]
= ListView = ListView
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-tui-views]] [[using-shell-tui-views]]
= Views = Views
:page-section-summary-toc: 1
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs] ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]

1
spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc
View File

@@ -1,5 +1,6 @@
[[using-shell-tui]] [[using-shell-tui]]
= Terminal UI = Terminal UI
:page-section-summary-toc: 1
NOTE: Feature is experimental and subject to breaking changes until foundation NOTE: Feature is experimental and subject to breaking changes until foundation
and related concepts around framework are getting more stable. and related concepts around framework are getting more stable.