Writerside Help

Summary elements

Use the link-summary element in the target topic to display its summary in the link popup.

<topic xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" title="Links" id="Links"> <link-summary>This information is displayed in the link popup</link-summary> ...

Card summary

Use it to specify the topic summary and display it on the card on the starting page, so that a user can evaluate what the target topic is about before clicking. Otherwise, you can write the summary using the summary attribute.

<topic xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" title="Links" id="Links"> <card-summary>This information is displayed in the card on the starting page.</card-summary> ...

Web summary

Use it to specify the short topic summary for external search engines.

When this element is specified, Writerside adds a meta tag with a name="description" attribute and content="your web-summary here" attribute to the generated HTML page.

This doesn't mean that this description will appear in the snippet on the search results page, but search engines take it into account. Also it is used a text preview when someone shares the link in a messenger or a social media.

When it is not specified, we don't provide any default value. A search engine will display a summary that it has generated automatically while crawling the page, it can be any other fragment from the page it considers relevant.

<topic xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" title="Links" id="Links"> <web-summary>This is information for the search engines.</web-summary> ...

For each of these elements, you can either write the text fragment or specify the rel attribute with the element ID to use it as a summary. It can be any element that contains text, Writerside will extract the text from it.

<topic xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" title="Links" id="Links"> <link-summary rel="my-paragraph"/> ... <p id="my-paragraph"> This is the text to use as a link summary. </p>
Last modified: 05 October 2023