Skip to content

Add documentation for hover tooltip HTML rendering #1182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
angelozerr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for hover tooltip HTML rendering #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/Features/XMLFeatures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ When XML file is associated with a DTD file, hover documentation based on tags,

![Hover Based On DTD](../images/Features/HoverBasedOnDTD.gif)

### Writing documentation for hover

The documentation content in XSD (`xs:documentation`) and DTD (comments) supports HTML formatting that is automatically rendered as Markdown in the hover tooltip. This includes inline formatting (`<b>`, `<i>`, `<code>`), links, tables, lists, code blocks, and more.

See [Writing Documentation for Hover Tooltips](../HoverDocumentation.md) for the full list of supported HTML elements and how to write documentation that renders well.

## Validation Support

### Syntax validation
Expand Down
Loading
Loading