Tooltips
Last modified: 18 July 2024Use the <tooltip>
element to mark words as terms that your reader can hover to see a tooltip with a description.
Add tooltips
If your project does not already have one, create glossary.xml in the cfg directory and define the terms and descriptions in it. For example:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd"> <terms> <term name="GUI">Graphical User Interface</term> <term name="HTTP">Hypertext Transfer Protocol</term> </terms>
tip
To create the glossary.xml file, you can right-click the build configuration directory (cfg by default) in the Project tool window, select New, and then click glossary.xml.
In a topic file, wrap the text you want to explain with
<tooltip>
and specify the name in the term attribute. For example:Send an <tooltip term="HTTP">HTTP</tooltip> request.
Here is how it will render:
Send an HTTP request.