Enable Section Summary TOC for small pages
This commit is contained in:
Rob Winch
@@ -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].
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-catalog]
|
||||
= Catalog App
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-control]
|
||||
= Control
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-eventloop]
|
||||
= EventLoop
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-keyhandling]
|
||||
= Key Handling
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-mousehandling]
|
||||
= Mouse Handling
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-screen]
|
||||
= Screen
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[#appendix-tui-view]
|
||||
= View
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -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]
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[built-in-commands]]
|
||||
= Built-In Commands
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[dynamic-command-exitcode]]
|
||||
= Exception Handling
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[commands-interactionmode]]
|
||||
= Interaction Mode
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[registration]]
|
||||
= Registration
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[commands]]
|
||||
= Commands
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-customization-singlecommand]]
|
||||
= Single Command
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-customization]]
|
||||
= Customization
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
This section describes how you can customize the shell.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-options-basics-annotation]]
|
||||
= Annotation
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -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]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-options-basics]]
|
||||
= Basics
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-testing]]
|
||||
= Testing
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-tui-intro]]
|
||||
= Introduction
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-tui-views-box]]
|
||||
= BoxView
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-tui-views-list]]
|
||||
= ListView
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-shell-tui-views]]
|
||||
= Views
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user