Writerside Help

Tooltips

Use the <tooltip> element to mark words as terms that your reader can hover to see a tooltip with a description.

Add tooltips

  1. If your project doesn't 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>
  2. 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.

Last modified: 23 May 2024