Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Model
Properties
Source
Used by
Included schema schemaFigure.xsd
Namespace http://www.legislation.gov.uk/namespaces/legislation
Annotations
Describes display images
Properties
attribute form default unqualified
element form default qualified
version 2.0
Element Image
Namespace http://www.legislation.gov.uk/namespaces/legislation
Annotations

A single image. An image may be inline, or alternatively display as a block when it is contained in a <Figure> element or in a <Signee> element in a signature.

An image does not link directly to a file, but instead to a resource represented by a <Resource> element. The reason for this is that the resource may be external (i.e. a file) or it may be internal (i.e. the image data is held within the document).

The resource is referenced with a ResourceRef attribute. It is perfectly acceptable for more than one Image element to reference the same resource.

Each Image element must have Width and Height attributes. The values held are expected to reflect the size of the original image as printed (not necessarily the actual native size of the image) if absolute values are held (for example, 580pt). The values can be in points or ems. Ems are expected mainly to be used inline (where it would be likely that the image would be less than 1em high to avoid problems with line spacing). Obviously for display images ems may not have a defined value, in which case it would be down to the implementation to define what an em is.

It it is possible to use relative values. These have been created with authoring of legislation in mind and are explained below:

  • auto (default value) - This indicates that the image should be scaled automatically for the output format. This is generally used in conjunction with ‘scale-to-fit’ on the other attribute to maintain the aspect ratio of the image. If the image will not fit on the output then it should be cropped. If both attributes are auto then the image should be output at its native size.
  • scale-to-fit - This should enlarge the image for either the width or height (whichever attribute this is on) to fit the output format. For printed output this would generally be the page width or height. It would be down to implementations as to how to treat this value for, say, web output.
  • fit-page-to-image - This is designed for use with oversize images where it is desirable to enlarge the page size to fit the image. For other output formats it would be down to implementation as to how to treat this value
  • spread - This is also designed for use with oversize images but in this instance it indicates that for printed documents the output should be put on a page spread.
  • % - For values defined as percent this should be a percentage of the containing area. For printed output this will be the printable section of the page.
Diagram
DiagramschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_Image_DescriptionschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_Image_ResourceRefschemaLegislationCommonAttributes_xsd.tmp#CommonSubAttributesschemaFigure_xsd.tmp#FigureElementIDattributesschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_Image_HeightschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_Image_Width
Properties
content complex
Used by
Element Group InlineBasic
Elements Figure, Signee
Attributes
QName Type Default Use Annotation
AltVersionRefs RefsLinkType optional
Links to alternate versions of the content by referencing the version's id attribute, e.g. perhaps a Welsh version or an image (Figure) of a Formula
Description xsd:string optional
Height FigureSizeType auto optional
The height of the image
ResourceRef xsd:string required
Width FigureSizeType auto optional
The width of the image
id restriction of xsd:ID optional
A unique identifier for the figure in the format g00000
xml:base xs:anyURI optional
Is used to change the base from which relative URLs are calculated. See http://www.w3.org/TR/xmlbase/ for information about this attribute.
xml:lang xs:language optional
Should be used to indicate the main language of the content contained by the element upon which the attribute is appearing. Values should be taken from the ISO 639 standard. This attribute should be used where the language is different from the main language of the document.
xml:space restriction of xs:NCName optional
Is used to indicate whether white space is significant in the contained content and can contain the value ‘default’ or ‘preserve’. For a value of ‘default’, it is left to an application as to how to treat white space.
Source
<xsd:element name="Image">
  <xsd:annotation>
    <xsd:documentation>
      <h:p>A single image. An image may be inline, or alternatively display as a block when it is contained in a
        <h:code><Figure></h:code>element or in a
        <h:code><Signee></h:code>element in a signature.</h:p>
      <h:p>An image does not link directly to a file, but instead to a resource represented by a
        <h:code><Resource></h:code>element. The reason for this is that the resource may be external (i.e. a file) or it may be internal (i.e. the image data is held within the document).</h:p>
      <h:p>The resource is referenced with a ResourceRef attribute. It is perfectly acceptable for more than one Image element to reference the same resource.</h:p>
      <h:p>Each Image element must have Width and Height attributes. The values held are expected to reflect the size of the original image as printed (not necessarily the actual native size of the image) if absolute values are held (for example, 580pt). The values can be in points or ems. Ems are expected mainly to be used inline (where it would be likely that the image would be less than 1em high to avoid problems with line spacing). Obviously for display images ems may not have a defined value, in which case it would be down to the implementation to define what an em is.</h:p>
      <h:p>It it is possible to use relative values. These have been created with authoring of legislation in mind and are explained below:</h:p>
      <h:ul>
        <h:li>auto (default value) - This indicates that the image should be scaled automatically for the output format. This is generally used in conjunction with ‘scale-to-fit’ on the other attribute to maintain the aspect ratio of the image. If the image will not fit on the output then it should be cropped. If both attributes are auto then the image should be output at its native size.</h:li>
        <h:li>scale-to-fit - This should enlarge the image for either the width or height (whichever attribute this is on) to fit the output format. For printed output this would generally be the page width or height. It would be down to implementations as to how to treat this value for, say, web output.</h:li>
        <h:li>fit-page-to-image - This is designed for use with oversize images where it is desirable to enlarge the page size to fit the image. For other output formats it would be down to implementation as to how to treat this value</h:li>
        <h:li>spread - This is also designed for use with oversize images but in this instance it indicates that for printed documents the output should be put on a page spread.</h:li>
        <h:li>% - For values defined as percent this should be a percentage of the containing area. For printed output this will be the printable section of the page.</h:li>
      </h:ul>
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:attribute name="Description" type="xsd:string" use="optional"/>
    <xsd:attribute name="ResourceRef" type="xsd:string" use="required"/>
    <xsd:attributeGroup ref="CommonSubAttributes"/>
    <xsd:attributeGroup ref="FigureElementIDattributes"/>
    <!-- issue ID #156763855
			<xsd:attribute name="Height" type="FigureSizeType" use="required"/>
			<xsd:attribute name="Width" type="FigureSizeType" use="required"/>  -->
    <xsd:attribute name="Height" type="FigureSizeType" use="optional" default="auto">
      <xsd:annotation>
        <xsd:documentation>The height of the image</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="Width" type="FigureSizeType" use="optional" default="auto">
      <xsd:annotation>
        <xsd:documentation>The width of the image</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>
</xsd:element>
Element Figure
Namespace http://www.legislation.gov.uk/namespaces/legislation
Annotations

A container for graphic(s) material. There may also be a number, caption, associated text and notes to accompany the images

Diagram
DiagramschemaLegislationCommonAttributes_xsd.tmp#CommonSubAttributesschemaFigure_xsd.tmp#FigureElementIDattributesschemaFigure_xsd.tmp#Figure_OrientationschemaFigure_xsd.tmp#Figure_ImageLayoutschemaCommonElements_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_NumberschemaCommonElements_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_TitleschemaCommonElements_xsd.tmp#ParaschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_ImageschemaFigure_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_Notes
Properties
content complex
Used by
Model
Children Image, Notes, Number, Para, Title
Attributes
QName Type Default Use Annotation
AltVersionRefs RefsLinkType optional
Links to alternate versions of the content by referencing the version's id attribute, e.g. perhaps a Welsh version or an image (Figure) of a Formula
ImageLayout restriction of xsd:string vertical optional

Defines the layout of the images. This mainly applies when there is more than one image in a figure. They may be laid vertically (normal), horizontally, e.g. across the page, or when there are many images, in a matrix format up to 5 images wide.

There is the possibility that this option may cause a conflict on image widths and page size. It it left to individual implementations as to how this should be resolved.

Orientation restriction of xsd:string portrait optional
Defines the orientation of the figure, including any title, text and images
id restriction of xsd:ID optional
A unique identifier for the figure in the format g00000
xml:base xs:anyURI optional
Is used to change the base from which relative URLs are calculated. See http://www.w3.org/TR/xmlbase/ for information about this attribute.
xml:lang xs:language optional
Should be used to indicate the main language of the content contained by the element upon which the attribute is appearing. Values should be taken from the ISO 639 standard. This attribute should be used where the language is different from the main language of the document.
xml:space restriction of xs:NCName optional
Is used to indicate whether white space is significant in the contained content and can contain the value ‘default’ or ‘preserve’. For a value of ‘default’, it is left to an application as to how to treat white space.
Instance
<Figure AltVersionRefs="" xml:base="" id="" ImageLayout="vertical" xml:lang="" Orientation="portrait" xml:space="" xmlns="http://www.legislation.gov.uk/namespaces/legislation">
  <Number Align="" AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{0,1}</Number>
  <Title Align="" AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{0,1}</Title>
  <Para Align="" AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{0,unbounded}</Para>
  <Image AltVersionRefs="" xml:base="" Description="" Height="auto" id="" xml:lang="" ResourceRef="" xml:space="" Width="auto">{1,unbounded}</Image>
  <Notes AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{0,1}</Notes>
</Figure>
Source
<xsd:element name="Figure">
  <xsd:annotation>
    <xsd:documentation>
      <h:p>A container for graphic(s) material. There may also be a number, caption, associated text and notes to accompany the images</h:p>
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="Number" minOccurs="0"/>
      <xsd:element ref="Title" minOccurs="0"/>
      <xsd:element ref="Para" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element ref="Image" maxOccurs="unbounded"/>
      <xsd:element ref="Notes" minOccurs="0"/>
    </xsd:sequence>
    <xsd:attributeGroup ref="CommonSubAttributes"/>
    <xsd:attributeGroup ref="FigureElementIDattributes"/>
    <xsd:attribute name="Orientation" default="portrait">
      <xsd:annotation>
        <xsd:documentation>Defines the orientation of the figure, including any title, text and images</xsd:documentation>
      </xsd:annotation>
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:enumeration value="portrait"/>
          <xsd:enumeration value="landscape"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:attribute>
    <xsd:attribute name="ImageLayout" default="vertical">
      <xsd:annotation>
        <xsd:documentation>
          <h:p>Defines the layout of the images. This mainly applies when there is more than one image in a figure. They may be laid vertically (normal), horizontally, e.g. across the page, or when there are many images, in a matrix format up to 5 images wide.</h:p>
          <h:p>There is the possibility that this option may cause a conflict on image widths and page size. It it left to individual implementations as to how this should be resolved.</h:p>
        </xsd:documentation>
      </xsd:annotation>
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:enumeration value="vertical">
            <xsd:annotation>
              <xsd:documentation>Images will be laid below each other on the page</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
          <xsd:enumeration value="horizontal">
            <xsd:annotation>
              <xsd:documentation>Images will be placed beside each other on the page</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
          <xsd:enumeration value="matrix-2-wide">
            <xsd:annotation>
              <xsd:documentation>Images will be placed two to a line, using enough lines as needed to place all the images</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
          <xsd:enumeration value="matrix-3-wide">
            <xsd:annotation>
              <xsd:documentation>Images will be placed three to a line, using enough lines as needed to place all the images</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
          <xsd:enumeration value="matrix-4-wide">
            <xsd:annotation>
              <xsd:documentation>Images will be placed four to a line, using enough lines as needed to place all the images</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
          <xsd:enumeration value="matrix-5-wide">
            <xsd:annotation>
              <xsd:documentation>Images will be placed five to a line, using enough lines as needed to place all the images</xsd:documentation>
            </xsd:annotation>
          </xsd:enumeration>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:attribute>
  </xsd:complexType>
</xsd:element>
Element Notes
Namespace http://www.legislation.gov.uk/namespaces/legislation
Annotations
A placeholder for footnotes to the figure
Diagram
DiagramschemaLegislationCommonAttributes_xsd.tmp#CommonAttributesschemaCommonElements_xsd.tmp#http___www.legislation.gov.uk_namespaces_legislation_TitleschemaFootnote_xsd.tmp#Footnote
Properties
content complex
Used by
Element Figure
Model
Children Footnote, Title
Attributes
QName Type Use Annotation
AltVersionRefs RefsLinkType optional
Links to alternate versions of the content by referencing the version's id attribute, e.g. perhaps a Welsh version or an image (Figure) of a Formula
id restriction of xsd:NCName optional

A unique identifier for the element.

The format of this identifier is yxxxxx where y is a letter and xxxxx is a number, padded to five digits.

Note that most elements that normally have identifiers have a separate, element-specific definition of the id attribute in the schema.

xml:base xs:anyURI optional
Is used to change the base from which relative URLs are calculated. See http://www.w3.org/TR/xmlbase/ for information about this attribute.
xml:lang xs:language optional
Should be used to indicate the main language of the content contained by the element upon which the attribute is appearing. Values should be taken from the ISO 639 standard. This attribute should be used where the language is different from the main language of the document.
xml:space restriction of xs:NCName optional
Is used to indicate whether white space is significant in the contained content and can contain the value ‘default’ or ‘preserve’. For a value of ‘default’, it is left to an application as to how to treat white space.
Instance
<Notes AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="" xmlns="http://www.legislation.gov.uk/namespaces/legislation">
  <Title Align="" AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{0,1}</Title>
  <Footnote AltVersionRefs="" xml:base="" id="" xml:lang="" xml:space="">{1,unbounded}</Footnote>
</Notes>
Source
<xsd:element name="Notes">
  <xsd:annotation>
    <xsd:documentation>A placeholder for footnotes to the figure</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="Title" minOccurs="0"/>
      <xsd:element ref="Footnote" maxOccurs="unbounded"/>
    </xsd:sequence>
    <xsd:attributeGroup ref="CommonAttributes"/>
  </xsd:complexType>
</xsd:element>
Simple Type FigureSizeType
Namespace http://www.legislation.gov.uk/namespaces/legislation
Annotations
Defines a size in either pixels, points or ems; alternatively the value can be auto (inherent, but cropped if larger than the page size), scale-to-fit (i.e. image is scaled to fit the page), spread (as in a two-page spread), or fit-page-to-image (where the page grows to fit around the image).
Diagram
Diagram
Facets
pattern (auto|scale-to-fit|fit-page-to-image|spread|\d{1,}\.?\d{0,3}%|\d{1,}\.?\d{0,3}pt|\d{1,}\.?\d{0,3}em)
Used by
Source
<xsd:simpleType name="FigureSizeType">
  <xsd:annotation>
    <xsd:documentation>Defines a size in either pixels, points or ems; alternatively the value can be auto (inherent, but cropped if larger than the page size), scale-to-fit (i.e. image is scaled to fit the page), spread (as in a two-page spread), or fit-page-to-image (where the page grows to fit around the image).</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:pattern value="(auto|scale-to-fit|fit-page-to-image|spread|\d{1,}\.?\d{0,3}%|\d{1,}\.?\d{0,3}pt|\d{1,}\.?\d{0,3}em)"/>
  </xsd:restriction>
</xsd:simpleType>
Attribute Image / @Description
Namespace No namespace
Properties
use optional
Used by
Element Image
Source
<xsd:attribute name="Description" type="xsd:string" use="optional"/>
Attribute Image / @ResourceRef
Namespace No namespace
Properties
use required
Used by
Element Image
Source
<xsd:attribute name="ResourceRef" type="xsd:string" use="required"/>
Attribute FigureElementIDattributes / @id
Namespace No namespace
Annotations
A unique identifier for the figure in the format g00000
Properties
content simple
Facets
pattern (\i\c*) & ([\i-[:]][\c-[:]]*) & (g[0-9]{5})
Used by
Attribute Group FigureElementIDattributes
Source
<xsd:attribute name="id">
  <xsd:annotation>
    <xsd:documentation>A unique identifier for the figure in the format g00000</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:ID">
      <xsd:pattern value="g[0-9]{5}"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:attribute>
Attribute Image / @Height
Namespace No namespace
Annotations
The height of the image
Properties
use optional
default auto
Facets
pattern (auto|scale-to-fit|fit-page-to-image|spread|\d{1,}\.?\d{0,3}%|\d{1,}\.?\d{0,3}pt|\d{1,}\.?\d{0,3}em)
Used by
Element Image
Source
<xsd:attribute name="Height" type="FigureSizeType" use="optional" default="auto">
  <xsd:annotation>
    <xsd:documentation>The height of the image</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
Attribute Image / @Width
Namespace No namespace
Annotations
The width of the image
Properties
use optional
default auto
Facets
pattern (auto|scale-to-fit|fit-page-to-image|spread|\d{1,}\.?\d{0,3}%|\d{1,}\.?\d{0,3}pt|\d{1,}\.?\d{0,3}em)
Used by
Element Image
Source
<xsd:attribute name="Width" type="FigureSizeType" use="optional" default="auto">
  <xsd:annotation>
    <xsd:documentation>The width of the image</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
Attribute Figure / @Orientation
Namespace No namespace
Annotations
Defines the orientation of the figure, including any title, text and images
Properties
default portrait
Facets
enumeration portrait
enumeration landscape
Used by
Element Figure
Source
<xsd:attribute name="Orientation" default="portrait">
  <xsd:annotation>
    <xsd:documentation>Defines the orientation of the figure, including any title, text and images</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:enumeration value="portrait"/>
      <xsd:enumeration value="landscape"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:attribute>
Attribute Figure / @ImageLayout
Namespace No namespace
Annotations

Defines the layout of the images. This mainly applies when there is more than one image in a figure. They may be laid vertically (normal), horizontally, e.g. across the page, or when there are many images, in a matrix format up to 5 images wide.

There is the possibility that this option may cause a conflict on image widths and page size. It it left to individual implementations as to how this should be resolved.

Properties
default vertical
Facets
enumeration vertical
Images will be laid below each other on the page
enumeration horizontal
Images will be placed beside each other on the page
enumeration matrix-2-wide
Images will be placed two to a line, using enough lines as needed to place all the images
enumeration matrix-3-wide
Images will be placed three to a line, using enough lines as needed to place all the images
enumeration matrix-4-wide
Images will be placed four to a line, using enough lines as needed to place all the images
enumeration matrix-5-wide
Images will be placed five to a line, using enough lines as needed to place all the images
Used by
Element Figure
Source
<xsd:attribute name="ImageLayout" default="vertical">
  <xsd:annotation>
    <xsd:documentation>
      <h:p>Defines the layout of the images. This mainly applies when there is more than one image in a figure. They may be laid vertically (normal), horizontally, e.g. across the page, or when there are many images, in a matrix format up to 5 images wide.</h:p>
      <h:p>There is the possibility that this option may cause a conflict on image widths and page size. It it left to individual implementations as to how this should be resolved.</h:p>
    </xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:enumeration value="vertical">
        <xsd:annotation>
          <xsd:documentation>Images will be laid below each other on the page</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="horizontal">
        <xsd:annotation>
          <xsd:documentation>Images will be placed beside each other on the page</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="matrix-2-wide">
        <xsd:annotation>
          <xsd:documentation>Images will be placed two to a line, using enough lines as needed to place all the images</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="matrix-3-wide">
        <xsd:annotation>
          <xsd:documentation>Images will be placed three to a line, using enough lines as needed to place all the images</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="matrix-4-wide">
        <xsd:annotation>
          <xsd:documentation>Images will be placed four to a line, using enough lines as needed to place all the images</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="matrix-5-wide">
        <xsd:annotation>
          <xsd:documentation>Images will be placed five to a line, using enough lines as needed to place all the images</xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:attribute>
Attribute Group FigureElementIDattributes
Namespace http://www.legislation.gov.uk/namespaces/legislation
Diagram
DiagramschemaFigure_xsd.tmp#FigureElementIDattributes_id
Used by
Elements Figure, Image
Attributes
QName Type Use Annotation
id restriction of xsd:ID optional
A unique identifier for the figure in the format g00000
Source
<xsd:attributeGroup name="FigureElementIDattributes">
  <xsd:attribute name="id">
    <xsd:annotation>
      <xsd:documentation>A unique identifier for the figure in the format g00000</xsd:documentation>
    </xsd:annotation>
    <xsd:simpleType>
      <xsd:restriction base="xsd:ID">
        <xsd:pattern value="g[0-9]{5}"/>
      </xsd:restriction>
    </xsd:simpleType>
  </xsd:attribute>
</xsd:attributeGroup>