diff --git a/doc/release-notes/11064-update-metadata-customization.md b/doc/release-notes/11064-update-metadata-customization.md new file mode 100644 index 00000000000..bcead3497f8 --- /dev/null +++ b/doc/release-notes/11064-update-metadata-customization.md @@ -0,0 +1 @@ +Metadata Customization guide has been updated to explain how to implement a kind of boolean fieldtype (see [Metadata Customization Guide](https://guides.dataverse.org/en/latest/admin/metadatacustomization.html#controlledvocabulary-enumerated-properties)) \ No newline at end of file diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst index e5326efebef..4c9dc693a0d 100644 --- a/doc/sphinx-guides/source/admin/metadatacustomization.rst +++ b/doc/sphinx-guides/source/admin/metadatacustomization.rst @@ -244,6 +244,8 @@ Each of the three main sections own sets of properties: | | #metadataBlock) | | | +---------------------------+--------------------------------------------------------+----------------------------------------------------------+-----------------------+ +.. _cvoc-props: + #controlledVocabulary (enumerated) properties ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -259,10 +261,10 @@ Each of the three main sections own sets of properties: | | | an existing #datasetField from | | | | another metadata block.) | +--------------+--------------------------------------------+-----------------------------------------+ -| Value | A short display string, representing | Free text | -| | an enumerated value for this field. If | | -| | the identifier property is empty, | | -| | this value is used as the identifier. | | +| Value | A short display string, representing | Free text. When defining a boolean, the | +| | an enumerated value for this field. If | values "True" and "False" are | +| | the identifier property is empty, | recommended and "Unknown" can be added | +| | this value is used as the identifier. | if needed. | +--------------+--------------------------------------------+-----------------------------------------+ | identifier | A string used to encode the selected | Free text | | | enumerated value of a field. If this | | @@ -293,6 +295,9 @@ FieldType definitions +---------------+------------------------------------+ | text | Any text other than newlines may | | | be entered into this field. | +| | The text fieldtype may be used to | +| | define a boolean (see "Value" | +| | under :ref:`cvoc-props`). | +---------------+------------------------------------+ | textbox | Any text may be entered. For | | | input, the Dataverse Software |