Schema element "`b:prefix`"

Declares additional prefixes used in the context.

Definitions

<element name="prefix" type="b:Prefix" />

<complexType name="Prefix">
  <complexContent>
    <extension base="b:Reusable">
      <sequence>
        <element name="endpoint"  type="anyURI" [0..∞] />
      </sequence>
      <attribute name="namespace" type="anyURI" />
    </extension>
  </complexContent>
</complexType>

Description

Units and data which is distributed in a Namespace may use other namespaces, and refer to those via prefixes. Some data formats (like XML) are very careful with prefixes, where other data formats do not support them in a clean way.

These prefix specifications are commonly found in the ms:Role/Namespace and msc:Role/Collection Units, but may appear in any Unit.

It is permitted to use more than one prefix for the same namespace, but using the same prefix twice in one Subspace for different namespaces is an error.

You SHOULD avoid using prefixes of popular protocols, like http, https, ftp, and s3, where this will probably create confusion to less experienced readers.

attribute `name`

Prefix names are restricted to \w[\w-]* in ASCII space.

attribute `namespace`

The URI which is the root of the Meshy Space server instance.

When the namespace attribute is missing, the prefix is used as alternative for the current Namespace. Therefore, top level Namespace REQUIRE such element.

element `endpoint`

Explains where to contact the namespace. When this element is missing, the endpoint is the same as the namespace.

The namespace looks like an endpoint of service but may also bee shown to users. The real endpoint may also change over time. You may need to add transport parameters like authorization or a port number to help users to reach the server. To avoid unclean namespace, you can add a endpoint elements. You MAY also give alternative endpoints for the same namespace.

Discussion

This is not XML!

Warning: Where elements of type b:UnitRef (may) use a prefix, they are not XML QName typed entities: the data itself may not contain the prefix declarations.

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

Schema element "b:prefix"