.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXcite.nxdl.xml

.. index::
    ! NXcite (base class)
    ! cite (base class)
    see: cite (base class); NXcite

.. _NXcite:

======
NXcite
======

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  A literature reference

  Definition to include references for example for detectors,
  manuals, instruments, acquisition or analysis software used.

  The idea would be to include this in the relevant NeXus object:
  :ref:`NXdetector` for detectors, :ref:`NXinstrument` for instruments, etc.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    This should describe the reason for including this reference.
    For example: The dataset in this group was normalised using the method 
    which is described in detail in this reference.

  .. index:: url (field)

  **url**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    URL referencing the document or data.

  .. index:: doi (field)

  **doi**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    DOI referencing the document or data.

  .. index:: endnote (field)

  **endnote**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Bibliographic reference data in EndNote format.

  .. index:: bibtex (field)

  **bibtex**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Bibliographic reference data in BibTeX format.

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/base_classes/NXcite.nxdl.xml