Manual: Introduction of :guilabel: #48384

New Issue

Tobias Heinke · 2016-05-09T02:16:13+02:00

Tobias Heinke commented

2016-05-09 02:16:13 +02:00

Rise the semantic level with the :guilabel:
http://www.sphinx-doc.org/en/stable/markup/inline.html#other-semantic-markup

Styling isn't in the theme yet.
https://github.com/snide/sphinx_rtd_theme/pull/279

Auto replace italic by :guilabel: with regex
80% of the unique items are actually UI
50% of all emphasized items

i.e modes
Locally and temporally wrap the modes in other chars: Edit Mode

Preparation:
manually remove emphasis:
full sentences, numbers, modes stumps (Edit without mode)

How to treat the editors - are the UI?
or as an anonymous literal

Rise the semantic level with the :guilabel: http://www.sphinx-doc.org/en/stable/markup/inline.html#other-semantic-markup Styling isn't in the theme yet. https://github.com/snide/sphinx_rtd_theme/pull/279 Auto replace *italic* by :guilabel: with regex 80% of the unique items are actually UI 50% of all emphasized items i.e modes Locally and temporally wrap the modes in other chars: $Edit Mode$ Preparation: manually remove emphasis: full sentences, numbers, modes stumps (Edit without mode) How to treat the editors - are the UI? or as an anonymous ``literal``

Tobias Heinke commented

2016-05-09 02:16:13 +02:00

Changed status to: 'Open'

Tobias Heinke self-assigned this 2016-05-09 02:16:13 +02:00

Tobias Heinke commented

2016-05-09 02:16:13 +02:00

Added subscriber: @Tobias

Tobias Heinke commented

2016-05-09 02:19:44 +02:00

Added subscriber: @Blendify

Campbell Barton commented

2016-05-09 07:38:49 +02:00

Added subscriber: @ideasman42

Campbell Barton commented

2016-05-09 07:38:49 +02:00

We were aware of the possibility to use :guilabel: when moving to Sphinx,
and while its nice to semantic markup, the manual references buttons often, so having to write :guilabel: everywhere is a bit of a hassle.

If our theme supports showing these labels with some nice indication its a button - it does make it seem more worthwhile...
even so, not sure its worth doing.

We were aware of the possibility to use `:guilabel:` when moving to Sphinx, and while its nice to semantic markup, the manual references buttons often, so having to write :guilabel: everywhere is a bit of a hassle. If our theme supports showing these labels with some nice indication its a button - it does make it seem more worthwhile... even so, not sure its worth doing.

Aaron Carlisle commented

2016-05-09 21:24:40 +02:00

There is a patch to make this italics here (D1980). The advantage here is being able to easily search for things that are UI instead of all text that is italics.
We could also do something else in italics.

There is a patch to make this italics here ([D1980](https://archive.blender.org/developer/D1980)). The advantage here is being able to easily search for things that are UI instead of all text that is italics. We could also do something else in italics.

Aaron Carlisle commented

2016-07-03 20:58:10 +02:00

Changed status from 'Open' to: 'Archived'

Aaron Carlisle closed this issue

2016-07-03 20:58:10 +02:00

Sign in to join this conversation.