Use specific style for textrole "guilabel"

TYPO3-Documentation / t3SphinxThemeRtd

Please report only issues that concern the rendering of the official TYPO3 docs here. For help and support on TYPO3, please see: https://typo3.org/help/

MIT License

11 stars 7 forks source link

Use specific style for textrole "guilabel" #96

Closed sypets closed 5 years ago

sypets commented 5 years ago

In our docs, it is recommended to use default sphinx textrole guilabel, see also textroles.

But the text is currently not styled differently, if you use textrole guilabel. I think it would be better for readability to have a specific style.

I have also seen other places in the docs that use bold for describing gui elements, so I think bold would be a good style.

Examples:

"using the WEB > List module" (uses bold) , see Getting Started

My proposal is to use

:guilabel:`WEB > List`.

sypets commented 5 years ago

Using guilabel is already documented:

:guilabel:`WEB > List`.

https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/CodingGuidelines.html#referring-to-gui-elements

A PR #97 already exists.

sypets commented 5 years ago

Implemented with https://github.com/TYPO3-Documentation/t3SphinxThemeRtd/commit/1f644b7e9c2cca758afc5a6b55772bcc28b80039