Skip to content

Commit 027c492

Browse files
datho7561angelozerr
authored andcommitted
Document xml.symbols.showReferencedGrammars
Closes #335 Signed-off-by: David Thompson <davthomp@redhat.com>
1 parent af429c2 commit 027c492

File tree

5 files changed

+18
-1
lines changed

5 files changed

+18
-1
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ As [vscode-xml](https://github.com/redhat-developer/vscode-xml) consumes the [Le
1010
* [Preferences](Preferences.md#preferences): More info on available [vscode-xml](https://github.com/redhat-developer/vscode-xml) preferences.
1111
* [Formatting](Formatting.md#formatting): More info on the available formatting preferences.
1212
* [XML Commands](Commands.md#commands): More info on the available XML vscode commands.
13+
* [Symbols](Symbols.md#symbols): More info on the available settings for the document symbols (outline).
1314
* [Troubleshooting](Troubleshooting.md#troubleshooting): Info on troubleshooting and fixes to issues.
1415

1516
## Developer Guide

docs/Symbols.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Symbols
2+
3+
## Show Referenced Grammars
4+
5+
If `xml.symbols.showReferencedGrammars` is enabled, the referenced grammars will be listed in the document outline.
6+
The following are also listed:
7+
* The association method for each grammar
8+
* If the grammar is in the cache. Remote grammars are cached by default. Please refer to the [server cache path documentation](Preferences.md#server-cache-path) for more information.
9+
10+
![An XML document that references two grammars. The referenced grammars are listed in the outline](./images/Symbols/ShowReferencedGrammars.png)
11+
12+
This option has no effect if symbols are disabled through `xml.symbols.enabled`.
13+
The displayed symbols are affected by `xml.symbols.maxItemsComputed`

docs/Validation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ You can `validate your XML with a grammar` (XSD, DTD). In order to do so, you mu
1818
* XML `completion` based on the grammar.
1919
* XML `hover` based on the grammar in order to show the documentation.
2020

21+
If the `xml.symbols.showReferencedGrammars` setting is enabled, the method used to associate each grammar is listed in the document symbols.
22+
Please see the [Show Referenced Grammars documentation](Symbols.md#show-referenced-grammars) for more information.
23+
2124
## Validation with XSD grammar
2225

2326
In the following sections, we would like to validate the XML `foo.xml` file:
92.2 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@
356356
"xml.symbols.showReferencedGrammars": {
357357
"type": "boolean",
358358
"default": true,
359-
"markdownDescription": "Show referenced grammars in the Outline. Default is `true`.",
359+
"markdownDescription": "Show referenced grammars in the Outline. Default is `true`. Please see [here](command:xml.open.docs?%5B%7B%22page%22%3A%22Symbols%22%2C%22section%22%3A%22show-referenced-grammars%22%7D%5D) for more information.",
360360
"scope": "window"
361361
},
362362
"xml.extension.jars": {

0 commit comments

Comments
 (0)