Update documentation from wiki

Add new documentation from the wiki. Add links to new documentation in the settings section of `package.json` Links between document pages are replaced during runtime so that they work property with vscode. Closes redhat-developer#328 Signed-off-by: David Thompson <[email protected]>
datho7561 · Oct 2, 2020 · b44ceb9 · b44ceb9
1 parent c24d888
commit b44ceb9
Show file tree

Hide file tree

Showing 18 changed files with 922 additions and 593 deletions.
diff --git a/README.md b/README.md
@@ -59,14 +59,14 @@ The following settings are supported:
 * `xml.format.enabled` : Enable/disable ability to format document. Default is `true`.
 * `xml.format.emptyElements` : Expand/collapse empty elements. Default is `ignore`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatemptyelements) for more information.
 * `xml.format.enforceQuoteStyle`: Enforce `preferred` quote style (set by `xml.preferences.quoteStyle`) or `ignore` quote style when formatting. Default is `ignore`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatenforcequotestyle) for more information.
-* `xml.format.joinCDATALines` : Set to `true` to join lines in CDATA content during formatting. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincdatalines-) for more information.
-* `xml.format.joinCommentLines` : Set to `true` to join lines in comments during formatting. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincommentlines-) for more information.
+* `xml.format.joinCDATALines` : Set to `true` to join lines in CDATA content during formatting. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincdatalines) for more information.
+* `xml.format.joinCommentLines` : Set to `true` to join lines in comments during formatting. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincommentlines) for more information.
 * `xml.format.joinContentLines` : Normalize the whitespace of content inside an element. Newlines and excess whitespace are removed. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincontentlines) for more information.
 * `xml.format.preserveAttributeLineBreaks`: Preserve line breaks that appear before and after attributes. This setting is overridden if `xml.format.splitAttributes` is set to `true`. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreserveattributelinebreaks) for more information.
-* `xml.format.preserveEmptyContent`: Preserve empty content/whitespace in a tag. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreserveemptycontent-) for more information.
+* `xml.format.preserveEmptyContent`: Preserve empty content/whitespace in a tag. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreserveemptycontent) for more information.
 * `xml.format.preservedNewLines`: Preserve new lines that separate tags. The value represents the maximum number of new lines per section. A value of 0 removes all new lines. Default is `2`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreservednewlines) for more information.
-* `xml.format.spaceBeforeEmptyCloseTag`: Insert space before end of self closing tag. \nExample:\n  ```<tag/> -> <tag />```. Default is `true`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatspacebeforeemptyclosetag-) for more information.
-* `xml.format.splitAttributes` : Split multiple attributes each onto a new line. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatsplitattributes-) for more information.
+* `xml.format.spaceBeforeEmptyCloseTag`: Insert space before end of self closing tag. \nExample:\n  ```<tag/> -> <tag />```. Default is `true`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatspacebeforeemptyclosetag) for more information.
+* `xml.format.splitAttributes` : Split multiple attributes each onto a new line. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatsplitattributes) for more information.
 * `xml.preferences.quoteStyle`: Preferred quote style to use for completion: `single` quotes, `double` quotes. Default is `double`.
 * `xml.autoCloseTags.enabled` : Enable/disable autoclosing of XML tags. Default is `true`. \n\nIMPORTANT: Turn off `#editor.autoClosingTags#` for this to work.
   **Note**: `editor.autoClosingBrackets` must be turned off to work.

diff --git a/docs/CodeLens.md b/docs/CodeLens.md
@@ -0,0 +1,56 @@
+
+## Code Lens
+
+### DTD features
+
+Code lens is provided in `.dtd` files to show where elements defined in the DTD are referenced.
+For instance, in the following code:
+
+```xml
+<!ELEMENT letter (to, from, title, body)>
+<!ELEMENT to (#PCDATA)>
+<!ELEMENT from (#PCDATA)>
+<!ELEMENT title (#PCDATA)>
+<!ELEMENT body (#PCDATA)>
+```
+
+There will be a code lens entry after the first line that points from the
+definition of the element `to` to where it is used in the definition of the
+element `letter`.
+
+Here is a demonstration of the above Code Lens:
+
+![A letter DTD element is declared, which consists of to, from title, and body elements. The definitions for these sub elements have a code lens above, which allows ofr navigating to the letter element declaration.](./images/CodeLens/DTDElementCodeLens.gif)
+
+### XSD Features
+
+Code lens is also provided in `.xsd` files. It shows where top level types
+and elements are referenced. For instance, in the following code:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema
+    xmlns:xs="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://example.org/my-example"
+    xmlns:NS="http://example.org/my-example">
+  <xs:element
+      name="root-element"
+      type="NS:yell" />
+  <xs:simpleType name='yell'>
+    <xs:restriction base='xs:string'>
+      <xs:pattern value='[A-Z]+!'></xs:pattern>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>
+```
+
+There will be a code lens above the line where the `yell` type is defined
+that points to where it is referenced when defining the `root-element` element.
+
+Here is a demonstration of the above Code Lens:
+
+![The code lens provides the number of references and links to references for an `xs:simpleType`.](./images/CodeLens/XSDTypeCodeLens.gif)
+
+Here is a demonstration of the code lens for `xs:element`:
+
+![An element root is declared that contains an element boot. Above the declaration of boot, there is a code lens that links to the reference in root.](./images/CodeLens/XSDElementCodeLens.gif)