marking of normative and non-normative sections

[philipwindecker]

Normative vs. non-normative sections need to be identifiable. This is true for both Antora and Asciidoctor. Currently, there is not default solution specified yet. There, also, is no specification for how it should look exactly.

The goal of this issue is to

• define the expected look and features of non-normative sections
• optionally: specifiy the expected look and features of (explicitly marked) normative sections
• implement those specifications in css for Antora and for Asciidoctor
• document using these section markers in the Project Guide

Suggested marking: use [.non-normative] block

[philipwindecker]

Option	Image
Use admonition blocks and (temporarily) replace the caption
Use admontion blocks with tiles
Add custom definitions for css classes

Limitation foir the custom css definition: It is using open blocks. These cannot be nested.
Currently, we see no reason for nesting another open block inside the non-normative block. But this limitation should be kept in mind.

css example:

.openblock.non-normative {
    border: 0.15rem solid #5d5d5d;
    background: #F2F4F4;
    border-radius: 0.5rem;
    padding: 0.75rem;
}

...

.doc .admonitionblock .title, .doc .exampleblock .title, .doc .imageblock .title, .doc .listingblock .title, .doc .literalblock .title, .doc .openblock .title, .doc .tableblock caption, .doc .videoblock .title {
    color: #5d5d5d;
    font-size: 0.88889rem;
    font-weight: 600;
    font-style: italic;
    -webkit-hyphens: none;
    -ms-hyphens: none;
    hyphens: none;
    letter-spacing: 0.01em;
    padding-bottom: 0.075rem;
    text-align: left;
}

Target title look:

[philipwindecker]

Update:

CSS:

.openblock.non-normative {
    border: 0.15rem solid #5d5d5d;
    background: #F2F4F4;
    border-radius: 0.5rem;
    padding: 0.75rem;
}

.doc .openblock.non-normative .title{
    text-transform: uppercase;
    background: #217ee7;
    color: #fff;
    top: 0;
    font-size: 0.83333rem;
    padding: 0 0.5rem;
    height: 1.25rem;
    display: -webkit-inline-box;
    display: -ms-inline-flexbox;
    display: inline-flex;
}

.doc div.non-normative div.content div:nth-child(1){
    margin-top: 0;
}

.doc .openblock.non-normative .title,
.doc .admonitionblock .icon {
    border-radius: 1rem;
    left: 10px;
}

.doc .openblock.non-normative .title::before,
i.fa[class^='icon-'],
i.fa[class*=' icon-']::before {
    content: "";
    height: 1.25rem;
    width: 1.25rem;
    margin-right: 0.25rem;
    margin-left: -0.5rem;
}

.doc .openblock.non-normative .title::after {
    content="NON-NORMATIVE";
} 

.doc .openblock.non-normative .title::before,
i.fa.icon-note::before {
    background: no-repeat url("../img/note.svg");
}

[christiangoedert]

Add a rule to the ASAM Editorial guide that contains information about normative and non-normative sections:

Rule: Include statement about normative and informative content

=== Normative and informative content

Content in this standard can be normative or informative.
The sections listed in <<tab-normative-informative-content>> are normative or informative per definition.

[#tab-normative-informative-content]
.Normative and informative sections
[%header, cols=2*]
|===
|Section               |Indication
|Foreword              |Informative
|Introduction          |Informative
|Scope                 |Normative
|Normative references  |Informative
|Terms and definitions |Normative
|Abbreviations         |Normative
|Annexes               |Annexes can be normative or informative. The annex heading contains the indication "(normative)" or "(informative)".
|Bibliography          |Informative
|===

All other sections in this standard are normative as long as not explicitly stated otherwise.
Informative sections are highlighted using the non-normative tag:

include::ROOT:partial$fragments/admonition_non_normative_chapter.adoc[]

The non-normative tag is valid for the section and all of its sub-sections.

@jmdska Let us discuss the implementation in our issue planning meetings.

[christiangoedert]

:important-caption: NON-NORMATIVE
[IMPORTANT]
====
Please note that the following section and its sub-sections are non-normative.
====
:important-caption: IMPORTANT

[jmdska]

Added rule ASM-91 in commit https://github.com/asam-ev/asam-project-guide-content/commit/5fb17dc5634e95763d12adf2bd5a073a05ce02c0