Skip to content

Commit d1105f5

Browse files
committed
Fix cross references
1 parent 17d0b3b commit d1105f5

23 files changed

+32
-32
lines changed

spring-shell-docs/modules/ROOT/pages/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Or in non-interactive mode:
9393
----
9494
====
9595

96-
TIP: Check out <<using-shell-customization-logging>> making logging to work
96+
TIP: Check out xref:using-shell-customization-logging.adoc[Logging] making logging to work
9797
better with shell apps.
9898

9999
[[using-spring-shell-your-first-command]]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Throughout this documentation, we make references to configuring something by using
55
annotations or programmatic examples.
66

7-
NOTE: There are two annotation models, <<commands-registration-annotation, annotations>>
8-
referred to new annotation model, <<commands-registration-legacyannotation, legacy annotations>>
7+
NOTE: There are two annotation models, xref:using-shell-commands-registration-annotation.adoc[annotations]
8+
referred to new annotation model, xref:using-shell-commands-registration-legacyannotation.adoc[legacy annotations]
99
referred to old legacy annotation model.
1010

1111
Old legacy annotation model mostly relates to use of `@ShellMethod` and `@ShellOption` and

spring-shell-docs/modules/ROOT/pages/using-shell-commands-availability.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Details of the error have been omitted. You can use the stacktrace command to pr
5757
----
5858
====
5959

60-
Information about currently unavailable commands is also used in the integrated help. See <<built-in-commands-help>>.
60+
Information about currently unavailable commands is also used in the integrated help. See xref:using-shell-commands-builtin-help.adoc[Help].
6161

6262
[TIP]
6363
====

spring-shell-docs/modules/ROOT/pages/using-shell-commands-builtin-help.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ accessing a web browser or any other rich UI application (such as a PDF viewer)
77
be possible. This is why it is important that the shell commands are correctly self-documented, and this is where the `help`
88
command comes in.
99

10-
Typing `help` + `ENTER` lists all the commands known to the shell (including <<dynamic-command-availability,unavailable>> commands)
10+
Typing `help` + `ENTER` lists all the commands known to the shell (including xref:using-shell-commands-availability.adoc[unavailable] commands)
1111
and a short description of what they do, similar to the following:
1212

1313
====
@@ -96,10 +96,10 @@ as a model.
9696
|`true` if showing groups is enabled. Otherwise, false.
9797

9898
|`groups`
99-
|The commands variables (see <<groupcommandinfomodel-variables>>).
99+
|The commands variables (see xref:using-shell-commands-builtin-help.adoc#groupcommandinfomodel-variables[GroupCommandInfoModel Variables]).
100100

101101
|`commands`
102-
|The commands variables (see <<commandinfomodel-variables>>).
102+
|The commands variables (see xref:using-shell-commands-builtin-help.adoc#commandinfomodel-variables[CommandInfoModel Variables]).
103103

104104
|`hasUnavailableCommands`
105105
|`true` if there is unavailable commands. Otherwise, false.
@@ -114,7 +114,7 @@ as a model.
114114
|The name of a group, if set. Otherwise, empty.
115115

116116
|`commands`
117-
|The commands, if set. Otherwise, empty. Type is a multi value, see <<commandinfomodel-variables>>.
117+
|The commands, if set. Otherwise, empty. Type is a multi value, see xref:using-shell-commands-builtin-help.adoc#commandinfomodel-variables[CommandInfoModel Variables].
118118
|===
119119

120120
[[commandinfomodel-variables]]
@@ -135,10 +135,10 @@ as a model.
135135
|The description of a command, if set. Otherwise, null.
136136

137137
|`parameters`
138-
|The parameters variables, if set. Otherwise empty. Type is a multi value, see <<commandparameterinfomodel-variables>>.
138+
|The parameters variables, if set. Otherwise empty. Type is a multi value, see xref:using-shell-commands-builtin-help.adoc#commandparameterinfomodel-variables[CommandParameterInfoModel Variables].
139139

140140
|`availability`
141-
|The availability variables (see <<commandavailabilityinfomodel-variables>>).
141+
|The availability variables (see xref:using-shell-commands-builtin-help.adoc#commandavailabilityinfomodel-variables[CommandAvailabilityInfoModel Variables]).
142142
|===
143143

144144
[[commandparameterinfomodel-variables]]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
55

66
Command registration can define `InteractionMode` which is used to hide commands
7-
depending which mode shell is executing. More about that in <<using-shell-execution-interactionmode>>.
7+
depending which mode shell is executing. More about that in xref:using-shell-execution.adoc#using-shell-execution-interactionmode[Interaction Mode].
88

99
You can define it with `CommandRegisration`.
1010

spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration-legacyannotation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::{snippets}/AnnotationRegistrationSnippets.java[tag=snippet1]
2626

2727
The only required attribute of the `@ShellMethod` annotation is its `value` attribute, which should have
2828
a short, one-sentence, description of what the command does. This lets your users
29-
get consistent help about your commands without having to leave the shell (see <<built-in-commands-help>>).
29+
get consistent help about your commands without having to leave the shell (see xref:using-shell-commands-builtin-help.adoc[Help]).
3030

3131
NOTE: The description of your command should be short -- no more than one or two sentences. For better
3232
consistency, it should start with a capital letter and end with a period.

spring-shell-docs/modules/ROOT/pages/using-shell-commands-registration-programmatic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ be autowired. Default implementation of this supplier returns
1919
a new builder so you don't need to worry about its internal state.
2020

2121
IMPORTANT: Commands registered programmatically automatically
22-
add _help options_ mentioned in <<commands-helpoptions>>.
22+
add _help options_ mentioned in xref:using-shell-commands-helpoptions.adoc[Help Options].
2323

2424
If bean of this supplier type is defined then auto-configuration
2525
will back off giving you an option to redefine default functionality.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ In the programmatic model, you use a more low level approach, defining command
1010
registrations (either as beans or by dynamically registering with a command catalog).
1111

1212
Starting from _3.1.x_ a better support for defining commands using
13-
<<commands-registration-annotation, annotations>> were added. Firstly because eventually standard
14-
package providing <<commands-registration-legacyannotation, legacy annotations>> will get deprecated
13+
xref:using-shell-commands-registration-annotation.adoc[annotations] were added. Firstly because eventually standard
14+
package providing xref:using-shell-commands-registration-legacyannotation.adoc[legacy annotations] will get deprecated
1515
and removed. Secondly so that we're able to provide same set of features than using underlying
1616
`CommandRegistration`. Creating new a annotation model allows us to rethink and modernise that
1717
part without breaking existing applications.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
55

66
In this section, we go through an actual command registration and leave command options
77
and execution for later in a documentation. You can find more detailed info in
8-
<<appendix-tech-intro-registration>>.
8+
xref:appendices-techical-intro-registration.adoc[Command Registration].
99

1010

1111

spring-shell-docs/modules/ROOT/pages/using-shell-completion.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ include::{snippets}/CompletionSnippets.java[tag=anno-method]
6565
== Command-Line
6666

6767
Command-line completion currently only support _bash_ and is documented
68-
in a built-in `completion` command <<built-in-commands-completion>>.
68+
in a built-in `completion` command xref:using-shell-commands-builtin-completion.adoc[Completion].

spring-shell-docs/modules/ROOT/pages/using-shell-components-flow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
55

6-
When you use <<using-shell-components-ui>> to build something that involves
6+
When you use xref:using-shell-components-ui.adoc[Flow Components] to build something that involves
77
use of a multiple components, your implementation may become a bit cluttered.
88
To ease these use cases, we added a
99
`ComponentFlow` that can hook multiple component executions together

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-confirmation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ The context object is `ConfirmationInputContext`. The following table describes
2828
|The default value -- either `true` or `false`.
2929

3030
|`model`
31-
|The parent context variables (see <<textcomponentcontext-template-variables>>).
31+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
3232
|===

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-multiselect.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ The context object is `MultiItemSelectorContext`. The following table describes
3131
|The visible items, where rows contain maps of name, selected, on-row, and enabled items.
3232

3333
|`model`
34-
|The parent context variables (see <<selectorcomponentcontext-template-variables>>).
34+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
3535
|===

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathinput.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ The context object is `PathInputContext`. The following table describes its cont
2424
|Key |Description
2525

2626
|`model`
27-
|The parent context variables (see <<textcomponentcontext-template-variables>>).
27+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
2828
|===

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathsearch.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ include::{snippets}/UiComponentSnippets.java[tag=snippet9]
1515
====
1616

1717
NOTE: Logic for search is passed as is into algorithms documented
18-
in <<appendix-tech-intro-searchalgorithm>>.
18+
in xref:appendices-techical-intro-searchalgorithm.adoc[Search Algorithms].
1919

2020
The following image shows typical output from a path search component:
2121

@@ -32,5 +32,5 @@ The context object is `PathSearchContext`. The following table describes its con
3232
|The items available for rendering search results.
3333

3434
|`model`
35-
|The parent context variables (see <<textcomponentcontext-template-variables>>).
35+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
3636
|===

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-singleselect.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The context object is `SingleItemSelectorContext`. The following table describes
3131
|The visible items, where rows contains maps of name and selected items.
3232

3333
|`model`
34-
|The parent context variables (see <<selectorcomponentcontext-template-variables>>).
34+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
3535
|===
3636

3737
You can pre-select an item by defining it to get exposed. This is

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-stringinput.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ The context object is `StringInputContext`. The following table lists its contex
4040
|`true` if a mask character is set. Otherwise, false.
4141

4242
|`model`
43-
|The parent context variables (see <<textcomponentcontext-template-variables>>).
43+
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
4444
|===

spring-shell-docs/modules/ROOT/pages/using-shell-components-ui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Built-in components generally follow this logic:
1919
. Exit.
2020
. Render the final status of a component state.
2121

22-
NOTE: <<using-shell-components-flow>> gives better interface for defining the flow of
22+
NOTE: xref:using-shell-components-flow.adoc[Flow] gives better interface for defining the flow of
2323
components that are better suited for defining interactive command flows.
2424

2525

spring-shell-docs/modules/ROOT/pages/using-shell-customization-styling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Spring Shell supports these via it's theming framework which contains two parts,
1313
firstly _styling_ can be used to change text type and secondly _figures_ how
1414
some characters are shown. These two are then combined together as a _theme_.
1515

16-
More about _theming_ internals, see <<appendix-tech-intro-theming>>.
16+
More about _theming_ internals, see xref:appendices-techical-intro-theming.adoc[Theming].
1717

1818
NOTE: Default theme is named `default` but can be change using property
1919
`spring.shell.theme.name`. Other built-in theme named `dump` uses

spring-shell-docs/modules/ROOT/pages/using-shell-execution.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ simple command-line tool without requiring customization.
1414

1515
Currently, interactive mode is entered if any command line options are passed when starting
1616
or running a shell from a command line. This works especially well when a shell application
17-
is compiled with <<native>>.
17+
is compiled with xref:using-shell-building.adoc#native[Native Support].
1818

1919
Some commands may not have any useful meanings when they run in interactive mode
2020
or (conversely) in non-interactive mode. For example, a built-in `exit` command would

spring-shell-docs/modules/ROOT/pages/using-shell-options-default.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
55

66
Having a default value for an option is somewhat related to
7-
<<using-shell-options-optional>>, as there are cases where you
7+
xref:using-shell-options-optional.adoc[Optional Value], as there are cases where you
88
may want to know if the user defined an option and change behavior
99
based on a default value:
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
55

66
Framework provides a build-in views which are documented below.
77

8-
TIP: To learn more about views, see <<appendix-tui-view>>.
8+
TIP: To learn more about views, see xref:appendices-tui-view.adoc[View].
99

1010

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ NOTE: Feature is experimental and subject to breaking changes until foundation
66

77
_Terminal UI Framework_ is a toolkit to build rich console apps. This section is
88
for those using existing features as is. If you're planning to go deeper possibly
9-
creating your own components <<appendix-tech-intro-tui>> provides more detailed
9+
creating your own components xref:appendices-tui.adoc[Terminal UI] provides more detailed
1010
documentation.
1111

12-
TIP: Catalog sample is a good place to study a real application <<appendix-tui-catalog>>.
12+
TIP: Catalog sample is a good place to study a real application xref:appendices-tui-catalog.adoc[Catalog App].
1313

1414

0 commit comments

Comments
 (0)