Markdown


Tooltips

Tooltips display a short definition of an item. There are two ways to create tooltips:

  • Automatic from the Glossary
  • Via Link Override

Automatic Tooltips

Automatic tooltips reference Glossary entries. If a Glossary article by the name of “Tooltips” exists, a tooltip will be available for the following item:

TooltipsThis is an example of a Glossary entry linked to from here.
{{< tooltip "Tooltips" >}}`

You can use an internal article as the source of a tooltip. Presidium will use the first 100 words of the article to construct the tooltip, so you should make sure the text will work as a tooltip. Note that the text used for the demarcation of a tooltip does not need to match the article title, like this,Before you write any content, spend some time anticipating what tasks you need to perform and make sure you have the time and resources to achieve your goals. The following steps work for both small and large projects: Design the site structure Inventory existing content Plan the conversion of existing content into articles Map the planned articles to your structure Identify required new articles Repurpose existing content into articles Write new articles Proofread and edit Publish Discussion The most important planning task is identifying the scope of your documentation efforts and understanding the needs of your audience. Presidium is pre-configured with a set of standard sections that are commonly used in software documentation. You can use this framework when starting to scope your project. which links to an article on plan content development.

{{< tooltip "this," "best-practices/plan-content-development.md" >}}

© Copyright 2024 SPAN Digital

Generated on Jan 17, 2024