Home

MS Concept

  • prefix: msc:
  • schema: b:

Categories:

documentation:

  • c:manual
 
 

Schema element "c:manual"

The payload of a Unit which is specialized in documentation texts.

Definitions

<element name="manual" type="c:Manual"
   substitutionGroup="b:payload" />

<complexType name="Manual">
  <complexContent>
    <extension base="b:Native">
      <sequence>
        <element ref="b:documentation" [0..∞] />
      </sequence>
      <attribute name="documents" type="b:UnitRef" />
    </extension>
  </complexContent>
</complexType>

Description

Documentation MAY be contained in any Unit. However, its size may become too large to distribute efficiently and it hinders translations (think about the access rights of translators). Therefore, the documentation of the Units (for instance, about a ms:Constant or a released product) is often grouped into separate "Manual" Units in helper Collections.

attribute documents

The documents attribute can be used to set a default for the unit references in the b:doc-selector. Of course, this defaults to the current Collection.


mark@overmeer.net      Web-pages generated on 2023-12-19