-
Notifications
You must be signed in to change notification settings - Fork 56
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.
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
use consistent terms when names are flexible #562
Comments
Note that the procedures that publish the manual use the parenthesis style ( |
In
|
If we enclose the flexible part of the name within parentheses, this will require a change to the XML Schema and the regular expression. Suggest that we use all capital letters (in addition to the |
Pulling this out of the NXDL 3.3 milestone since a draft may take some review before acceptance. Will work that up in a branch. |
Discussed at the Telco today. Just UPPERCASE wasn't deemed obvious enough. The parentheses were not strongly favoured either, though. |
Might not make the next milestone (NXDLD 2018.3 planned) but will leave on the list for now. |
Also relevant for CHANGETHISAXISNAME_set for demand values as in #599 |
The table given above will change to:
|
In some NXDL files, the name for a group, field, or attribute is flexible (the exact name given by the NXDL specification is not required) and is set at the time the HDF file is written. Across the suite of NXDL files, different terms are used to mark a name as flexible. In some cases, there is no indication that a name may be substituted. In others, upper case is used, In some other cases, such as for groups that have not been given explicit names, a default is shown in parentheses. A few, select examples should describe the variations:
The documentation publishing process applies the parentheses for groups where the name is not specified in the NXDL file. Such as (from NXentry):
is documented as
It is proposed to choose either UPPER_CASE or (parentheses) to denote when a name is flexible and to apply this decision across all NXDL files. The proposed should not change the meaning of any definition, but just use consistent nomenclature.
The text was updated successfully, but these errors were encountered: