[NeXus-definitions-tickets] [NeXusDefinitions] #35: ADD svnid attribute to NXDL definition element
NeXus Base Classes and Instrument Definitions
noreply at nexusformat.org
Thu Jan 15 17:52:03 GMT 2009
#35: ADD svnid attribute to NXDL definition element
------------------------+---------------------------------------------------
Reporter: Pete Jemian | Owner: Pete Jemian
Type: enhancement | Status: new
Priority: major | Keywords:
------------------------+---------------------------------------------------
When developing the documentation (#30) for NeXus base classes (as defined
by the NXDL), it seems valuable to identify a specific revision of the
NXDL instance in the DocBook documentation for each base class.
One way to do this is to add the SVN Id or Revision keyword as an
attribute to the definition element. An existing definition element
(example from NXaperture)
{{{
<definition xmlns="http://definition.nexusformat.org/schema/3.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://definition.nexusformat.org/schema/3.1
../nxdl.xsd"
name="NXaperture"
type="group" extends="../nxdl">
}}}
would change to
{{{
<definition xmlns="http://definition.nexusformat.org/schema/3.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://definition.nexusformat.org/schema/3.1
../nxdl.xsd"
name="NXaperture"
svnid="$Id: NXaperture.nxdl.xml 218 2008-12-17 20:41:06Z Pete Jemian
$"
type="group" extends="../nxdl">
}}}
With this change, the {{{definition/@svnid}}} could be added to the
DocBook documentation to indicate which revision of the NXDL instance was
used to generate the documentation presented.
--
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/35>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions
More information about the NeXus-definitions-tickets
mailing list