Skip to content

Unclear whether examples are non-normative #958

@jelovirt

Description

@jelovirt

The spec says

All information in the specification is normative unless it is an example, a note, an appendix, or is explicitly labeled as non-normative.

For example the last paragraph of https://dita-lang.org/dita/archspec/base/sort-as-processing starts with

For example, if a processor uses the content of the <title> element as the base sort phrase...

Is that a non-normative example? It's not a <figure> or <example> that has a title that says it's an example. But the prose is clear that it's an example?

How about the the second paragraph that ends with

For elements that do not have titles, the base sort phrase might be literal content in the DITA source, or it might be generated or constructed based on the semantics of the element involved; for example, it could be constructed from various attribute or metadata values.

Is the last sentense that starts with "for example" an example that is non-normative? That is, is a single sentence inside a paragraph considered a non-normative example?

The style guide in the Wiki https://github.com/oasis-tcs/dita/wiki/Style-guidelines-for-the-DITA-specification#examples says examples paragraphs should use outputclass="example", but e.g. those linked paragraphs above don't use the@outputclass.

But the source like

<p otherprops="examples">For example, flagging can be used to highlight the fact that content
does use otherprops="examples".

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions