Skip to content

Add informal section about GDTF Name, ShortName, LongName #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
petrvanekrobe wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add informal section about GDTF Name, ShortName, LongName #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions gdtf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7906,3 +7906,24 @@ This attribute describes rotation of framing shutters or barndoors controlled
by the Blade(n)A attribute only. Rotation from negative to positive angle
values is counterclockwise when looking at the projection from the fixture's
point of view.

# Annex I. Name, ShortName, LongName (informative)

The [Name, ShortName, and LongName attributes](#table-3-fixture-type-node-attributes)
identify a fixture type and provide names for different uses.

The **Name** attribute is the basis for the GDTF file name. It uses the [Name
value type](#user-content-attrtype-name), so its value follows the character
restrictions defined in [Annex C](#user-content-table-c1). When deriving a file
name from this value, characters that are unsuitable for file names are
typically replaced with underscores (`_`). To maximize portability, it is
recommended to use only the POSIX "Fully Portable Filenames" character set:
`A–Z`, `a–z`, `0–9`, `_` (U+005F), `-` (U+002D), and at most one period (`.`
U+002E). For example: `My-Fixture_5.gdtf`.

The **LongName** attribute provides the detailed, complete name of the fixture
type. It may include any characters or symbols and is recommended for fixture
lists and search.

The **ShortName** attribute provides an abbreviated name for use in user
interfaces where space is limited.
Loading