Skip to main content

GLDF Templates

Overview

One way to get started with GLDF is to use predefined templates. Be it to learn the format or as a base for new GLDFs. Templates are GLDFs presets, and each represents a specific sub-area of the format.

However, please keep in mind that they should only serve as a starting point. Many templates focus on a specific part of the format and include only the mandatory elements for the rest. However, since most properties are optional and usually a lot of other data is missing, they should be used as an example only. The goal should be to combine the templates with the parts you need. And provide as many information about your product as possible.

tip

All templates can be found on Github. Under Releases you can find versioned packages for download, matching the respective GLDF XML Schema version.


How to get started

  • Choose the template you would like to start with...
  • ...or combine multiple templates for your XML as required
  • Replace the data inside the product.xml with yours
  • Replace all files like photometries or images
  • Zip the content and create the GLDF
    • The product.xml should be in the root directory
    • Images, photometries etc. should be in respective subdirectories
    • Finally, change the file extension of the zip archive to .gldf
    • See GLDF Container for further details
  • All templates have an example .gldf file created this way

The Templates

Templates

Mandatory fields

000_simple_luminaire

Template for the most basic luminaire without a photometry.

001_simple_luminaire_ldc

Template for the most basic luminaire including a ldc file and Photometry element.


Geometry possibilities

002_simple_geometry

Minimal luminaire with a SimpleGeometry element.

003_l3d_geometry

Minimal luminaire with a L3D geometry file and ModelGeometry element.


004_geometry_level_of_detail

A luminaire with multiple L3D level of detail (LoD) geometry file and ModelGeometry elements.

Header metadata

005_header

Minimal luminaire extended with a complete Header element containing all possible elements.


Sensor products

006_sensor

The most basic Sensor only product you can create.

007_sensor_and_lightemitter

A luminaire with a Sensor and ChangeableLightEmitter combined.


Photometries

008_photometry_complete

Minimal luminaire extended with a Photometry element containing all possible elements.


LightSources

009_lightsource_manadatory

Template with mandatory only elements of a ChangeableLightSource. As well as an Equipment, which is used to reference the ChangeableLightSource inside the luminaires Variant.

010_lightsource_complete

Template with a ChangeableLightSource element containing all possible elements. As well as an Equipment, which is used to reference the ChangeableLightSource inside the luminaires Variant.

011_lightsource_multichannel

Template with a MultiChannelLightSource element, referenced by a MultiChannelLightEmitter.


Spectrum

012_spectrum

Luminaire with a Spectrum element. Note in particular how the Spectrum is referenced inside a ChangeableLightSource. Which in turn is referenced through an Equipment element. And how it is possible to define a Spectrum as a file reference (spectrum1) and inside the XML itself (spectrum2).


ControlGears

013_control_gear

Luminaire with a complete ControlGear element containing all possible childs elements. As well as an Equipment referencing the ControlGear through ControlGearReference.


Product

014_product_metadata

Luminaire with a complete ProductMetaData element containing all possible child elements. ProductMetaData is intended for global properties of a product.


015_variant_simple_lightemitter

Luminaire with a complete Variant element.

016_variant_simple_sensoremitter

Luminaire with a complete Variant element containing a reference to a SensorEmitter.

017_variant_geometry_reference

Luminaire with a complete Variant element containing all possible elements, a l3d geometry and a Sensor.


DescriptiveAttributes

018_descriptive_attributes

Luminaire with a complete DescriptiveAttributes element inside ProductMetadata and Variant. DescriptiveAttributes values inside a Variant will override the global defined values in ProductMetadata.