Skip to content
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

Document how to associate name of NXDL with requirements in the XML file. #914

Closed
prjemian opened this issue Mar 29, 2021 · 5 comments · Fixed by #1100
Closed

Document how to associate name of NXDL with requirements in the XML file. #914

prjemian opened this issue Mar 29, 2021 · 5 comments · Fixed by #1100

Comments

@prjemian
Copy link
Contributor

prjemian commented Mar 29, 2021

The manual must make clear how to properly construct an NXDL file that connects the NXDL file name with the definition@name=".." attribute in the top-most element and the required enumeration element in the definition field below. This same name (and spelling, and upper/lower case representation) should match the file name. Consider putting this into the manual as a sidebar.

And, any content referenced by the NXDL (such as images) be placed in a subdirectory with the name chosen by stripping off the NX. (as in: NXDL for NXthing would be in file NXthing.nxdl.xml)

file: NXthing.nxdl.xml
resources: thing/image1.png

In the NXDL file:

<definition name="NXthing" ... />

<!-- later -->

        <field name="definition">
            <doc>Official NeXus NXDL schema to which this file conforms.</doc>
            <enumeration>
                <item value="NXthing"/>                
            </enumeration>
        </field>

Originally posted by @prjemian in #910 (comment)

@prjemian
Copy link
Contributor Author

@RussBerg Didn't you work on a PR similar to this issue?

@prjemian
Copy link
Contributor Author

PR #1089 and issue #1001

@prjemian
Copy link
Contributor Author

Looks like additional work, advising how to create an NXDL file.

@benajamin
Copy link
Contributor

I was just looking at it and thinking about picking it up.

@benajamin benajamin assigned benajamin and unassigned prjemian Jun 15, 2022
@prjemian
Copy link
Contributor Author

@benajamin #1046 is related

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants