Internal documentation only
This page has been marked as a draft.
Collapsibles/Accordions
Accordians are useful for hiding long or optional text, such as reference config files or information only relevent when using a proxy.
These have been set up in an extensible fashion similar to hint blocks so that multiple types can be supported and new types added in the future.
The design for these can be found in DES-437 and are also archived in \Tech Comms - Documents\UX & Design\Obcerv-figma-files
on sharepoint.
Block type Copied
This is the default if no type is specified.
To add a collapsible text box use the following shortcode:
{{< accordion title="Hello there" >}}
General Kenobi
{{< /accordion >}}
Which is rendered as:
Hello there
General Kenobi
List type Copied
We have a simplified list type for hiding sublists.
1. list begins
2. {{< accordion title="Hello there" type="list" >}}
- General
- Kenobi
{{< /accordion >}}
3. list ends
Which is rendered as:
- list begins
-
Hello there
- General
- Kenobi
- list ends
Including content inside blocks Copied
You can put a code example inside a block.
Quia quis distinctio sit voluptate sint eum cupiditate. Vel sed recusandae non et vel saepe. Cumque reprehenderit consectetur velit dolore et repudiandae vitae nostrum. Impedit consequatur voluptatem cum laborum ut et facere. Autem quos similique nobis. This page’s frontmatter looks like:Code example
title: "Collapsibles/Accordions"
draft: true
weight: -1200
This also works for images and tables:
Image example
In general, Obcerv works with other parts of the Geneos system to collect data. Metrics can be published to Obcerv as unmodified Collection Agent datapoints or in legacy Geneos formats. In either case, you must configure your Gateway to publish data to Obcerv. To do this, follow the instructions in the Gateway Obcerv Quickstart.
and a table for good measure:
Column A | Column B | Column C |
---|---|---|
A1 | B1 | C1 |
A2 | B2 | C2 |
A3 | B3 | C3 |
However, you cannot include hint blocks inside accordions since this triggers the indented codeblock problem.