diff --git a/README.make.txt b/BUILDING.rst similarity index 100% rename from README.make.txt rename to BUILDING.rst diff --git a/README.md b/README.md index ad19a057cb..ff549e0935 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,28 @@ * NeXus: http://www.nexusformat.org/ * documentation: http://download.nexusformat.org/doc/html/index.html +* Release Notes: https://github.com/nexusformat/definitions/wiki/Release-Notes * build server: http://build.nexusformat.org/ * travis-ci: syntax check of every NXDL file [![Build Status](https://travis-ci.org/nexusformat/definitions.svg)](https://travis-ci.org/nexusformat/definitions) These are the components that define the structure of NeXus data files in the development directory. -component | description -----------------------------|------------------------ -LGPL.txt | one proposed license model -NXDL_VERSION | the current NXDL version number -README.txt | README file -README.make.txt | how to build the documentation -release-notes.md | starting from v3.3 -applications/ | NXDL files for applications and instrument defs -base_classes/ | NXDL files for components -contributed_definitions/ | NXDL files from the community -impatient-guide/ | *NeXus for the Impatient* -jenkins_build | configuration for Jenkins continuous integration service -legacy_docs/ | legacy PDF copies of the NeXus definitions documentation -manual/ | Sphinx source files for the NeXus documentation -nxdl.xsd | XML Schema for NXDL files -nxdlTypes.xsd | called by nxdl.xsd -package/ | directory for packaging this content -utils/ | various tools used in the definitions tree -www/ | launch (home) page of NeXus WWW site -xslt/ | various XML stylesheet transformations - -* See [README.make.txt](README.make.txt) for how to build the documentation -* See [release-notes.md](release-notes.md) for what has changed since the previous release +component | description +-------------------------------|------------------------ +[BUILDING.rst](BUILDING.rst) | how to build the documentation +[LGPL.txt](LGPL.txt) | one proposed license model +NXDL_VERSION | the current NXDL version number +README.md | this file +applications/ | NXDL files for applications and instrument defs +base_classes/ | NXDL files for components +contributed_definitions/ | NXDL files from the community +impatient-guide/ | *NeXus for the Impatient* +jenkins_build | configuration for Jenkins continuous integration service +legacy_docs/ | legacy PDF copies of the NeXus definitions documentation +manual/ | Sphinx source files for the NeXus documentation +[nxdl.xsd](nxdl.xsd) | XML Schema for NXDL files +[nxdlTypes.xsd](nxdlTypes.xsd) | called by nxdl.xsd +package/ | directory for packaging this content +utils/ | various tools used in the definitions tree +www/ | launch (home) page of NeXus WWW site +xslt/ | various XML stylesheet transformations diff --git a/manual/source/installation.rst b/manual/source/installation.rst index cb2c18e3ab..1c13edd389 100644 --- a/manual/source/installation.rst +++ b/manual/source/installation.rst @@ -6,9 +6,8 @@ .. _Installation: -============ Installation -============ +############ .. index:: single: NAPI; installation; download location @@ -29,7 +28,7 @@ NeXus mailing list: http://lists.nexusformat.org/mailman/listinfo/nexus .. _Installation-Binary: Precompiled Binary Installation -############################### +******************************* .. _Installation-Linux: @@ -108,7 +107,7 @@ http://download.nexusformat.org/kits/macosx/ .. _Installation-Source: Source Installation -################### +******************* .. _Installation-Source-Generic: @@ -149,7 +148,17 @@ distribution. .. _Releases: Releases -######## +******** + +The NeXus definitions are expected to evolve. +The evolution is marked as a series of *releases* +which are snapshots of the repository (and current +state of the NeXus standard). +Each new *release* of the definitions +will be posted to the definitions GitHub repository +and announced to the community via the +NeXus mailing list: ``nexus@nexusformat.org`` +(http://download.nexusformat.org/doc/html/mailinglist.html#nexus-mailing-list) NeXus definitions ================= @@ -157,6 +166,36 @@ NeXus definitions Releases of the NeXus definitions are listed on the GitHub web site: https://github.com/nexusformat/definitions/releases +.. index:: release; notes + +Release Notes +------------- + +Detailed notes about each release (start with v3.3) are posted +to the definitions GitHub wiki: +https://github.com/nexusformat/definitions/wiki/Release-Notes + +.. index:: release; process + +Release Process +--------------- + +The process to make a new release of the NeXus definitions +repository is documented in the repository's GitHub wiki: +https://github.com/nexusformat/definitions/wiki/Release-Procedure. + +The release process starts by creating a GitHub +[Milestone](https://help.github.com/articles/tracking-the-progress-of-your-work-with-milestones/) +for the new release. +Milestones for the NeXus definitions repository are +available on the GitHub site: +https://github.com/nexusformat/definitions/milestones + +.. index:: release; versioning + +Versioning +---------- + 1. each NXDL file has a ``definitions/@version`` attribute that declares the version of this NXDL file 2. we will tag the definitions repository with new releases of the NeXus definitions @@ -176,7 +215,7 @@ https://github.com/nexusformat/definitions/releases *major.minor* tag to point to the newest commit hash. 3. changes in the NXDL language (such as new unit types) will become part of a new tag -4. the syntax of the NXDL language is currently 3.1 (2016-10-12) +4. the syntax of the NXDL language is currently 3.3 (2017-05-02) .. [#] *semantic versioning*: http://semver.org diff --git a/release-notes.md b/release-notes.md deleted file mode 100644 index 5116692582..0000000000 --- a/release-notes.md +++ /dev/null @@ -1,226 +0,0 @@ - -# Release History - -(starting from v3.3) - -**`#`** (prefix): issue or pull request - -**hash tag**: a specific set of changes, such as `abc1234` - -## NXDL 3.3 - -**milestone**: [NXDL 3.3](https://api.github.com/repos/nexusformat/definitions/milestones/4) - -section | number ------ | ----- -New Tags | 2 -Pull Requests | 15 -Issues | 21 -Commits | 148 - -### Tags - -* [4814b75](https://github.com/nexusformat/definitions/commit/4814b75207e06b891134af9d78eec7d14d49ab24) NXreflections-1.1 -* [4aa4215](https://github.com/nexusformat/definitions/commit/4aa421552297060fb9daa71dd8ec3d57713444df) Schema-3.3 - -### Pull Requests - -* [#540](https://github.com/nexusformat/definitions/pull/540) (merged) Issue 539 -* [#542](https://github.com/nexusformat/definitions/pull/542) (merged) NXmx multimodule and dectris changes -* [#549](https://github.com/nexusformat/definitions/pull/549) (closed) fixes #545 - units type AXISUNITS -* [#550](https://github.com/nexusformat/definitions/pull/550) (merged) Issue 546 minOccurs=0 to required=false -* [#551](https://github.com/nexusformat/definitions/pull/551) (merged) fixes #547: defines ``vector_units`` attribute for NXtransformations -* [#554](https://github.com/nexusformat/definitions/pull/554) (merged) Geometry docs #397 -* [#558](https://github.com/nexusformat/definitions/pull/558) (merged) Schema update 555 -* [#561](https://github.com/nexusformat/definitions/pull/561) (merged) fixes #560: changes to documentation only -* [#565](https://github.com/nexusformat/definitions/pull/565) (closed) Adds missing nComp dimensions -* [#566](https://github.com/nexusformat/definitions/pull/566) (closed) Remove NXcontainer duplicates -* [#568](https://github.com/nexusformat/definitions/pull/568) (merged) Updates from NIAC 2016 -* [#569](https://github.com/nexusformat/definitions/pull/569) (closed) NXstage contributed class -* [#578](https://github.com/nexusformat/definitions/pull/578) (merged) fixes #571 -* [#579](https://github.com/nexusformat/definitions/pull/579) (merged) Update NXdetector.nxdl.xml -* [#580](https://github.com/nexusformat/definitions/pull/580) (closed) NXexperiment and NXexperimentdata - -### Issues - -* [#177](https://github.com/nexusformat/definitions/issues/177) NXcharacterization needs proper documentation -* [#281](https://github.com/nexusformat/definitions/issues/281) allow string array content -* [#504](https://github.com/nexusformat/definitions/issues/504) NXreflections -* [#526](https://github.com/nexusformat/definitions/issues/526) defs_intro.rst needs to be updated -* [#535](https://github.com/nexusformat/definitions/issues/535) revise or remove the suggestion in NXpositioner -* [#536](https://github.com/nexusformat/definitions/issues/536) ensure index entries are comprehensive -* [#539](https://github.com/nexusformat/definitions/issues/539) recover commits from branch: www_page_486 -* [#543](https://github.com/nexusformat/definitions/issues/543) revise or remove the suggestion in NXlog -* [#545](https://github.com/nexusformat/definitions/issues/545) NXtransformations has invalid unit: AXISUNITS -* [#546](https://github.com/nexusformat/definitions/issues/546) NXmx uses minOccurs where it is not allowed -* [#547](https://github.com/nexusformat/definitions/issues/547) NXtransformations adds units attribute to vector attribute -* [#548](https://github.com/nexusformat/definitions/issues/548) NXtransformations has attributes that define dimensions -* [#560](https://github.com/nexusformat/definitions/issues/560) NXsas documentation wording is clumsy -* [#570](https://github.com/nexusformat/definitions/issues/570) HTML manual is not correct -* [#571](https://github.com/nexusformat/definitions/issues/571) XML Schema says NX_CHAR but should be NX_UINT? -* [#572](https://github.com/nexusformat/definitions/issues/572) NXDL syntax error in NXreflections -* [#581](https://github.com/nexusformat/definitions/issues/581) Document the structure of the NeXus link in HDF5 -* [#582](https://github.com/nexusformat/definitions/issues/582) Describe usage of NXsubentry -* [#584](https://github.com/nexusformat/definitions/issues/584) Document the `@napimount` attribute -* [#586](https://github.com/nexusformat/definitions/issues/586) generate release notes with consistent presentation -* [#588](https://github.com/nexusformat/definitions/issues/588) NXreflections needs a new version number & tag - -### Commits - -* [9f08221](https://github.com/nexusformat/definitions/commit/9f0822103aa0bd8b833db08c864817ed821a10d5) Draft changes for NIAC 2016 -* [ab9249c](https://github.com/nexusformat/definitions/commit/ab9249c2adcf077c9e0b5245c65d5a7537a769da) Clarify rank and units issues for NXmx and NXtransformations -* [5f56a8f](https://github.com/nexusformat/definitions/commit/5f56a8f023a48a2fb64a265781050bfc057ae21d) remove and ignore .DS_Store -* [2a64add](https://github.com/nexusformat/definitions/commit/2a64adda4c0a4e25862eccc3a05870c3378ba965) Merge branch 'master' into nxmx -* [2c3989a](https://github.com/nexusformat/definitions/commit/2c3989a1c5ba84be6128eb09a648adaf7dba7049) typo spotted by Peter Chang -* [92b607b](https://github.com/nexusformat/definitions/commit/92b607b6825709dd3601997ace5a83de8bf67eb0) Shrink coordinate system figures a little -* [f9ae4e6](https://github.com/nexusformat/definitions/commit/f9ae4e6725d23ff5a99bdd0b44950fa469eb6a41) Make section of coordinate transformation less repetitous and -* [97ce82e](https://github.com/nexusformat/definitions/commit/97ce82eaac1cd81f4413c372ced96797fc3df5cd) Emphasize relationship of depends_on and NXtransformations in NXsample -* [f320d38](https://github.com/nexusformat/definitions/commit/f320d383bbfb49d64d27f518872887f529d3a6c2) As per discussion in NIAC 13 Oct 14, remove redundant point-by-point -* [3e3a083](https://github.com/nexusformat/definitions/commit/3e3a083113c4530f9191fac12b223d62de75ea91) Remove prohibition of use of pixel units in beam centers -- HJB -* [85d31b4](https://github.com/nexusformat/definitions/commit/85d31b49e925e8579f7c440852ad84d685f7d35b) Merge with current version -- HJB -* [85a6952](https://github.com/nexusformat/definitions/commit/85a6952d616e70862bb825164617e569efe77509) Resolved conflicts -* [7bcfb8a](https://github.com/nexusformat/definitions/commit/7bcfb8a33618fd16234730cd5849db01770303b6) Clarify rank and units issues for NXmx and NXtransformations -* [3db824b](https://github.com/nexusformat/definitions/commit/3db824b5b1650bc5a339a534db2fa1820d5aedb3) remove and ignore .DS_Store -* [a014880](https://github.com/nexusformat/definitions/commit/a014880678b52d319acf7a19959532e953e08819) typo spotted by Peter Chang -* [876fb36](https://github.com/nexusformat/definitions/commit/876fb36f8bb7c2afa8521112509bf3096c42a98d) Emphasize relationship of depends_on and NXtransformations in NXsample -* [e9212d4](https://github.com/nexusformat/definitions/commit/e9212d49ddcaef70730ae868c111b6d965f3717e) Further merge -* [c617690](https://github.com/nexusformat/definitions/commit/c617690c4c9884c79ffaf198210539bab6ae0489) Rebase continued -* [5fa7910](https://github.com/nexusformat/definitions/commit/5fa79106fa131092e81f0d429b60b13040f0403d) Merge continued -* [12e3652](https://github.com/nexusformat/definitions/commit/12e36520cedea178bf9ee6455448eef6595de15b) fixes #177 -* [7a92f7b](https://github.com/nexusformat/definitions/commit/7a92f7b88f2b06bdf5960fafece242cd01e6cc08) fixes #536 -* [015eb0b](https://github.com/nexusformat/definitions/commit/015eb0ba15ff0fdd4eae22a5cbe979f84550e971) Clarified the beam_center_x,y documentation regarding length. As agreed upon at the -* [41b19a1](https://github.com/nexusformat/definitions/commit/41b19a1f6d46cb0bf5036ce009fef5d1b2bc2aa3) another index cross-reference -* [dd57eb4](https://github.com/nexusformat/definitions/commit/dd57eb45b56c660e1f0ada962894c99a5ab85339) refs #486 -* [1b4457d](https://github.com/nexusformat/definitions/commit/1b4457d27aeec0fef065538cee08d300086acee8) Merge branch 'master' of github.com:nexusformat/definitions -* [6819719](https://github.com/nexusformat/definitions/commit/6819719a8075ae899dfe15a0e7421fc34e6dfb00) refs #539, fixes #169 brief description of cnxvalidate and punx -* [fde3a65](https://github.com/nexusformat/definitions/commit/fde3a65a2068ee8f7ef6e91b58049f4c56842bfe) refs #539, note the recent 3.2 release tag -* [c5b9b75](https://github.com/nexusformat/definitions/commit/c5b9b75371dc33888c3ec0ca87823c6472cd1c58) refs #539, update URLS, reST autoformatting -* [35c8133](https://github.com/nexusformat/definitions/commit/35c8133f58b83eec9dcfb7b48d8090400147b6f4) refs #539: cross-references -* [7c21580](https://github.com/nexusformat/definitions/commit/7c215802e8401f083e22cdf522650db32d8ab1eb) refs #539: make WWW root directory an environment variable -* [2bc51db](https://github.com/nexusformat/definitions/commit/2bc51db25e499f46a65da4d83cc5595d8107a043) Merge pull request #540 from nexusformat/issue_539 -* [100cedd](https://github.com/nexusformat/definitions/commit/100ceddf7c6e49d2e21b7afed8d641d945a39953) remove statement advertising NXcollection -* [d9e7571](https://github.com/nexusformat/definitions/commit/d9e75710b809648e471f3c07667bdffe555d9043) preserve unpublished comment in version control -* [9b8777e](https://github.com/nexusformat/definitions/commit/9b8777e171736b470278e053a303802929a43c59) adapt to new web page -* [92dba80](https://github.com/nexusformat/definitions/commit/92dba800b1ed0ffc6fd295c7377ee709f3dc7d1d) revert changes to application definitions without agreement -* [45709d2](https://github.com/nexusformat/definitions/commit/45709d2a44d7d53bc827e42f30afe0e408bee994) Merge branch 'master' into nxmx -* [6cb9723](https://github.com/nexusformat/definitions/commit/6cb9723452a1b9b4e093317522734ddce29d5b64) really restore old versions -* [5a6164f](https://github.com/nexusformat/definitions/commit/5a6164f13afa8145da253a2ddeb1d0a4d9370ffd) remove adverising of NXcollection for official use -* [29d2ecc](https://github.com/nexusformat/definitions/commit/29d2ecce58d568d46ba03cc971528540a6e6ab88) spelling and formatting -* [433fb8f](https://github.com/nexusformat/definitions/commit/433fb8fc713c210d7b9d746a908bbbf2c16244bc) express documented time reference in iso8601 -* [a1b97e9](https://github.com/nexusformat/definitions/commit/a1b97e935e3dec0e163131f64c3f91e27335d5c7) Merge pull request #542 from nexusformat/NXmx_multimodule_and_dectris_changes -* [18fb184](https://github.com/nexusformat/definitions/commit/18fb184435b0b04459885e387c88e4f7526b7d43) fix indentation -* [5272154](https://github.com/nexusformat/definitions/commit/5272154f669b4d3502c51fa6709f4238571d6122) refs #546 -* [a156342](https://github.com/nexusformat/definitions/commit/a15634201c4386f8bbbed994e801d2aed569f6f0) fixes #546: change ``minOccurs`` to new ``required`` attribute -* [258b391](https://github.com/nexusformat/definitions/commit/258b39130f429758c9f3d1402713816602642d59) fixes #547: defines ``vector_units`` attribute -* [dcda144](https://github.com/nexusformat/definitions/commit/dcda1447772bac4293c0a681def52e8d06ede8f5) remove vector_units -* [2a7008e](https://github.com/nexusformat/definitions/commit/2a7008e0133c687f2907113078dfef085211167a) clarify documentation -* [485df90](https://github.com/nexusformat/definitions/commit/485df9045f1b9f2003e610f342853faec067c305) Merge pull request #551 from nexusformat/issue_547_vector_units_attribute -* [3280bce](https://github.com/nexusformat/definitions/commit/3280bce3fb68fe16bc07b0ad1f825d72f7e3cb7d) Merge pull request #550 from nexusformat/issue_546_minOccurs_not_allowed_here -* [10ae918](https://github.com/nexusformat/definitions/commit/10ae918249b3ad22beaa8d3ddfb3edf31b715a53) fixes #552 -* [3371002](https://github.com/nexusformat/definitions/commit/3371002944e421b9009f1f28011ba104e947f248) fixes #556 -* [5533323](https://github.com/nexusformat/definitions/commit/553332393aee04846e0d248ab45e6af223ede5f2) refs #555 XML Schema changed, python code needs to be updated -* [62abb9e](https://github.com/nexusformat/definitions/commit/62abb9e56233b4a12b3bd8e8d3d83db67a7039a9) fixes #545 -* [d1635e7](https://github.com/nexusformat/definitions/commit/d1635e7f05307de5a362e75ae19670b0b014e526) fixes #548 -* [0bd6729](https://github.com/nexusformat/definitions/commit/0bd6729fc7063aa546981846c909f6d45a22f17e) refs #555 : Sphinx -* [818324b](https://github.com/nexusformat/definitions/commit/818324b2de9967f82db6b9cad957fd413dc455b7) refs #555 Sphinx -* [84c8576](https://github.com/nexusformat/definitions/commit/84c8576cc999e1aef94b1d48cc04ce5a160e9c97) refs #555 : docs build with units described -* [07eb8db](https://github.com/nexusformat/definitions/commit/07eb8db186decff3949289d0ef341e2f9ca604e8) fixes #555 -* [2524540](https://github.com/nexusformat/definitions/commit/2524540839922d32c969a49c2a6ac308a9eac173) fixes #560 -* [cfc31ef](https://github.com/nexusformat/definitions/commit/cfc31efe44242144cc10319abd8dba1b2224c4fb) Added ub_matrix to NXsample as discussed on the 26.04.2017 NeXus teleconference -* [d5fdf77](https://github.com/nexusformat/definitions/commit/d5fdf77c50c5ff29b54941a2434edf32aad69f25) correct indentation -* [28ca93a](https://github.com/nexusformat/definitions/commit/28ca93a6d44394c8d5db237944718ded3a9cfe96) corrects: section title too short -* [264117c](https://github.com/nexusformat/definitions/commit/264117ce96659f42557eea9949b90ef5a15aa910) remove stray character -* [b459b66](https://github.com/nexusformat/definitions/commit/b459b6610847f26eb45483fdb23055c60ea57449) #555, #558: bumping NXDL version number to 3.3 -* [4aa4215](https://github.com/nexusformat/definitions/commit/4aa421552297060fb9daa71dd8ec3d57713444df) Merge pull request #558 from nexusformat/schema_update_555 -* [68abbc7](https://github.com/nexusformat/definitions/commit/68abbc7cda00c4012cf7f1c05a1562697342c151) remove artifacts from python's print() -* [18c727e](https://github.com/nexusformat/definitions/commit/18c727e45f1fd889d978081bdc847865b83687e5) Updates from NIAC 2016 -* [e1d87e8](https://github.com/nexusformat/definitions/commit/e1d87e88c3b0ac426c7e0989b311aa218a128ad3) NXreflections changes following Jun7 2017 Telco -* [aeb9816](https://github.com/nexusformat/definitions/commit/aeb9816ca3e59541dcdd1753736a7dc0c6cd5e60) Merge pull request #568 from nexusformat/nxreflections_niac2016 -* [685efde](https://github.com/nexusformat/definitions/commit/685efde4abbc1f35d08bd4edd0f425e8b849dd9e) #568 correct ReST indentation errors, split long doc lines -* [6b6e128](https://github.com/nexusformat/definitions/commit/6b6e12871f1891e38a855ab08bd463e038e0eb48) #568 add symbols table for bounding_box[n, 6] -* [f7fecce](https://github.com/nexusformat/definitions/commit/f7fecce1f04ce21ccf5f4ea92b20b15b1f581876) Add dimension n to most fields. Add new dimension m for the experiments field, as it links sets of reflections back to an NXmx entry. -* [bbaf17e](https://github.com/nexusformat/definitions/commit/bbaf17ed8d8dcc1c8635faa40e4061766b4da6b1) fixes #572: in NXDL, "dimensions" before "attribute" -* [79c22dd](https://github.com/nexusformat/definitions/commit/79c22dd87aa8e3addafe97a0836127ffc4c661dc) tests #573 -* [50487fd](https://github.com/nexusformat/definitions/commit/50487fd944ec74ed4c8c747bf35e620429a4de73) #573 restore to previous -* [f76479f](https://github.com/nexusformat/definitions/commit/f76479fee277b6f41df99e0278cba38bb8226076) test #573 -* [34360e7](https://github.com/nexusformat/definitions/commit/34360e7f8a306e677b9d70e6985e82f8869dd497) fixes #573 -* [99e45b4](https://github.com/nexusformat/definitions/commit/99e45b4dfd3bfabe01c26c26f7e62365211210e3) fixes #574 -* [449b403](https://github.com/nexusformat/definitions/commit/449b403c03e2bb8f4605828db78b9df26b3447ee) #570 turn off PDF manual for now -* [41b660f](https://github.com/nexusformat/definitions/commit/41b660fcc5a774ae5905cce91ee97f19b164e2ce) #574 -* [b1a052c](https://github.com/nexusformat/definitions/commit/b1a052c9a4175e5dba138a96dbe2616391c92c1b) #537 try *building* the manual if tests succeed -* [bc0860f](https://github.com/nexusformat/definitions/commit/bc0860f2351c093a6f9485bc80fb43784fc392a7) #537 pre-processing step worked, try Sphinx next -* [c683848](https://github.com/nexusformat/definitions/commit/c683848cfc3f49679ed8eaf6d4319b071672534f) #537 sphinx is now a dependency -* [edeaf53](https://github.com/nexusformat/definitions/commit/edeaf53665db16ebf8634384db3fa55ac1c2e063) #537 python3-ism -* [7e065a2](https://github.com/nexusformat/definitions/commit/7e065a2402838c8e02d202f223ecd3cd2b2cbf63) #537 prepare a tarball -* [093ec7e](https://github.com/nexusformat/definitions/commit/093ec7ef5102e699cdbafd44dd6fdc218d00d672) #537 need to study before proceeding with publishing -* [2de23e4](https://github.com/nexusformat/definitions/commit/2de23e4162c213bd78f90957d9678d720a4d1c1d) #537 try again with corrected path -* [3d47de2](https://github.com/nexusformat/definitions/commit/3d47de248912ab5367b5eb1180d611017ff4fc0f) #537 can we access the tarball? -* [fab9c64](https://github.com/nexusformat/definitions/commit/fab9c643e8701189ee919a93cb6f06bbebc0d9c8) #537 resolve py3 Sphinx warnings -* [7a9f596](https://github.com/nexusformat/definitions/commit/7a9f596bd2f57d69898976c0c3a0ae351584d0a7) #537 location -* [fb19c53](https://github.com/nexusformat/definitions/commit/fb19c531ec05979368e5e89ddb78d526e5627c37) #537 try PDF manual now -* [80c1052](https://github.com/nexusformat/definitions/commit/80c1052064a0a55300bb2eb0724eaeee45c8bc98) #537 skip PDF for now on travis-ci -* [02bf045](https://github.com/nexusformat/definitions/commit/02bf0453820e35c9acf606f8546678dcdf634b08) #537 diagnose extra footnote cited in NXentry -* [263a2a3](https://github.com/nexusformat/definitions/commit/263a2a30bd153b6cbfdb4fc7682f0085c0b1d480) #537 resolve footnote reference -* [d0c8920](https://github.com/nexusformat/definitions/commit/d0c892013bc59c03e75e0f17f0be836af46199e6) #537 indentation -* [7ee1609](https://github.com/nexusformat/definitions/commit/7ee1609b71f11267cfc7b8dabb6bd0d538941a4f) footnote format -* [a31e848](https://github.com/nexusformat/definitions/commit/a31e84892a7865767132a8486bb2393d2eba36a0) typo -* [4964082](https://github.com/nexusformat/definitions/commit/4964082cc081751580b45e43b3da4dfb886d2403) Merge branch 'master' into geometry_docs_397 -* [336e2bf](https://github.com/nexusformat/definitions/commit/336e2bf1849aa934c2d63826b84c377be43d5b44) some tlc -* [db55a5b](https://github.com/nexusformat/definitions/commit/db55a5b78899a9135c78cf40128e5036eac7aeff) float -> number as in nxdl -* [89c22fd](https://github.com/nexusformat/definitions/commit/89c22fde0946c935ea76c4dcfafb45ba006fc4fe) document about vairable length strings -* [edecbe2](https://github.com/nexusformat/definitions/commit/edecbe25882d3608803e0c19ce3623fb94b133d6) #567 restore build(s) of PDF manual -* [77e7133](https://github.com/nexusformat/definitions/commit/77e7133eef9b098845b294d8fc3bc44940d41c52) fixes #576 -* [da0bb75](https://github.com/nexusformat/definitions/commit/da0bb758d6e1f8707dcb8fca7e386bf187562d72) turn off travis-ci build of PDF for now -* [a279d6d](https://github.com/nexusformat/definitions/commit/a279d6dc96655c2a7464139023b2075d50ff0fce) #567 turn off the jenkins PDF build again -* [d5dc391](https://github.com/nexusformat/definitions/commit/d5dc391a5d4a54924c577c41e17217ca306cfdfa) testing #567 with Sphinx 1.6.3 -* [b79a976](https://github.com/nexusformat/definitions/commit/b79a976b08c364ce248ae07514d6a0a3d6617dd4) fixes #567 -* [7455d33](https://github.com/nexusformat/definitions/commit/7455d3346157056a659e2d661c1d8b68f6400060) Merge pull request #554 from nexusformat/geometry_docs_397 -* [7dfb0ac](https://github.com/nexusformat/definitions/commit/7dfb0ac3b03684a52ed5adc153ba2479bdaaafea) fixes #571 -* [e519bd3](https://github.com/nexusformat/definitions/commit/e519bd3a4bc5079490714b603eb768a8121bf12a) Merge pull request #578 from nexusformat/NX_UINT_571 -* [2e5bd7d](https://github.com/nexusformat/definitions/commit/2e5bd7d115c98c18bca80c24e1ccb6887a60266e) Update NXdetector.nxdl.xml -* [e1b33a1](https://github.com/nexusformat/definitions/commit/e1b33a1601bd725927e9778dbc12f6c0dc7472fe) #581 resolve TODO item -* [2a2c2bc](https://github.com/nexusformat/definitions/commit/2a2c2bcc01a01977a443ea655405c502b4fc7369) #581 improve example of NeXus link -* [33b59e2](https://github.com/nexusformat/definitions/commit/33b59e200d0e9a62ef907b6ce3db5d2019ab0a9a) fixes #581 highlight target attribute in index (refs #580), steps to -* [e21ea83](https://github.com/nexusformat/definitions/commit/e21ea8307aaa611e2b849928172890ebd8e92bdc) remove extra text -* [d7cf404](https://github.com/nexusformat/definitions/commit/d7cf404c0d681fdd7b08207e34ae98d6acefe6fa) copied from ``design.rst`` -* [8158833](https://github.com/nexusformat/definitions/commit/8158833f9ff115a31d78bcc76bdcdc0b13c68e3e) make new paragraph -* [024c509](https://github.com/nexusformat/definitions/commit/024c5091a15f1132516c00b03bcd70937e10f3cf) reST syntax -* [b719564](https://github.com/nexusformat/definitions/commit/b719564dbe46ecfaff147ca7c2fb42c38565271c) highlight with a subsection title -* [9e7162f](https://github.com/nexusformat/definitions/commit/9e7162fc663e1a843632f3d57f91e22df9df033f) fixes #388 -* [15a2eb3](https://github.com/nexusformat/definitions/commit/15a2eb3f4ed8bada8f3177cf4255889a62476226) fixes #388 - relocate these words -* [d68b35d](https://github.com/nexusformat/definitions/commit/d68b35d7c133068baca2f3a436be3d1a115e9567) #388 -* [9aa01a0](https://github.com/nexusformat/definitions/commit/9aa01a0e709f0f4c482f2acb26e9b5343bb922cf) fixes #582 -* [715b11a](https://github.com/nexusformat/definitions/commit/715b11a6b80015230c7e3ade5de587e250ce0122) #580 -* [ffb1654](https://github.com/nexusformat/definitions/commit/ffb1654ee5fbfcad727bb7d0b54161bf7b693365) #580 add URL to NX5nativeexternallink -* [6b8a348](https://github.com/nexusformat/definitions/commit/6b8a34884bd8cf73c90c5440e1b84dc910dad6f3) refs #580 -* [25e963b](https://github.com/nexusformat/definitions/commit/25e963ba03611560978a02c311edb8d9b425cc37) Merge pull request #579 from jacobfilik/detector_serial_number -* [fb03c27](https://github.com/nexusformat/definitions/commit/fb03c2758a4a0c795a6ec15e267040e9d0408552) Merge pull request #561 from nexusformat/NXsas-documentation -* [412b113](https://github.com/nexusformat/definitions/commit/412b113836999676ebe6f64436fdb6b400706259) fixes #584 -* [9b6a847](https://github.com/nexusformat/definitions/commit/9b6a847641c914e07435fd244e38fcecd1ed61f0) #526 one TODO remains -* [98f420d](https://github.com/nexusformat/definitions/commit/98f420d561aec681c96caccaad33e09c476d9a0c) #526 needs proofreading before closing issue -* [bcc37a5](https://github.com/nexusformat/definitions/commit/bcc37a5980a253d41242d6afc1b9abaa69cd9224) fixes #526 -* [d1ac987](https://github.com/nexusformat/definitions/commit/d1ac9876e106d93d324292c60f392615e005e0b5) #562 -* [115f939](https://github.com/nexusformat/definitions/commit/115f939364335b9b549726d8c0e9861adf593286) #577, #580 start a history file -* [ebdf2c9](https://github.com/nexusformat/definitions/commit/ebdf2c9ca7773c505833f59e8e59cea2496c8f71) #577, #580 link to main README -* [a683ba4](https://github.com/nexusformat/definitions/commit/a683ba467db2811a6abaf46ce2847e1c159b15a4) #586 more content -* [3bd31f1](https://github.com/nexusformat/definitions/commit/3bd31f11e280dd53fc74446f97be9d19baf20e3d) #586 too many commit details -* [9bf0962](https://github.com/nexusformat/definitions/commit/9bf0962cff295064776584a5d35a5ed6cdc57837) #586 still not quite ready -* [4814b75](https://github.com/nexusformat/definitions/commit/4814b75207e06b891134af9d78eec7d14d49ab24) fixes #588 -* [d3a9288](https://github.com/nexusformat/definitions/commit/d3a9288e536d3035b99e61342229756caf586dca) #577 update release notes with new tags -* [7487e8b](https://github.com/nexusformat/definitions/commit/7487e8bc1eda82e308b68a2fbe7cb67689042a64) #577 cross-reference -* [40df53f](https://github.com/nexusformat/definitions/commit/40df53fe62b1f6c3105ff14576ee99e36d221f55) keep up with new activity -* [8cd0037](https://github.com/nexusformat/definitions/commit/8cd003739e889a499cbcdd945b014c17cc67b7d6) fixes #586 -* [4dc8657](https://github.com/nexusformat/definitions/commit/4dc8657ba15b3f3877dea1635940b7a130d3687b) #577 release notes, prepared via #586 -* [6cdfeb1](https://github.com/nexusformat/definitions/commit/6cdfeb108baf7432c5459311209de5f438fa5203) #577 (manually) add URL to milestone reference -* [e35308c](https://github.com/nexusformat/definitions/commit/e35308c0b2fe2d3887c10949f75d388fa441d91d) #577 point to previous releases, no notes -* [1501a17](https://github.com/nexusformat/definitions/commit/1501a177ba30ef8b567235b9fc2edf185714c5f0) #577 report the milestone URL -* [bed843f](https://github.com/nexusformat/definitions/commit/bed843ff1895120dafd564bc82ae0dcc4b1f984e) fixes #281 - - -## [v3.2](https://github.com/nexusformat/definitions/releases/tag/v3.2) - -* no prepared notes - -## [v3.1.0](https://github.com/nexusformat/definitions/releases/tag/v3.1.0) - -* no prepared notes