Bug 8470 - UI labels aren't clear in documentation
Summary: UI labels aren't clear in documentation
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: ---
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-12-03 16:46 CET by Pierre Ossman
Modified: 2024-12-03 16:57 CET (History)
0 users

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2024-12-03 16:46:54 CET
We mark UI elements in the TAG with :guilabel:`` so that the reader can clearly see when we are referring to something in the product.

However, the only way these elements differ from other text is that they have a different font. This difference can be difficult to distinguish. Our custom fonts might also not always be respected.

We should consider adding some more clear styling to make it easier to see what are direct references to the UI, and what is normal descriptive text.
Comment 1 Pierre Ossman cendio 2024-12-03 16:57:02 CET
As an example, this is what Canonical does:

https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide/

So something similar for us could be:

> .guilabel {
>   background: #eee;
>   font-size: 0.9em;
>   border-radius: 4px;
>   padding: 2px 6px;
>   margin: auto 2px;
> }

Note You need to log in before you can comment on or make changes to this bug.