Skip to content
This repository has been archived by the owner on Jan 5, 2021. It is now read-only.

Documentation and other text styles

Rene Beckmann edited this page Jul 5, 2016 · 1 revision

What is this?

An attempt to write down proposals for consistent styles for certain elements in the documentation.

Why?

Because I found myself to be in doubt often how to mark down text that refers to Yakindu specialities, like a state, a transition's expressions, a region, whatever. A consistent style with the right amount of applied text styles eases the reading flow and enables the reader to distinguish and locate elements quickly.

What if I do it differently?

Take part in the discussion.

Proposal

This is a first version and open for discussion.

Element css class name style
State sct_state bold
transition code_inline / code mono, grey bg: i'm code
big code blocks code mono, grey bg, indented
product name - upper case: YAKINDU SCT