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.

Sign up for GitHub

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

Update Metadata Customization page to suggest how to implement booleans #11064

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Update Metadata Customization page to suggest how to implement booleans #11064

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8fda98c
#7961 - Update the guide to mention boolean possibility in the Metada…
luddaniel Dec 5, 2024
57d1dd5
added release note
luddaniel Dec 5, 2024
5bb6c00
reword #7961
pdurbin Dec 13, 2024
bc79949
Merge pull request #9 from IQSS/7961-tweaks
luddaniel Dec 14, 2024
649e2af
typo #7961
pdurbin Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/release-notes/11064-update-metadata-customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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))
13 changes: 9 additions & 4 deletions doc/sphinx-guides/source/admin/metadatacustomization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,8 @@ Each of the three main sections own sets of properties:
| | #metadataBlock) | | |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------+-----------------------+

.. _cvoc-props:

#controlledVocabulary (enumerated) properties
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -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 | |
Expand Down Expand Up @@ -293,6 +295,9 @@ FieldType definitions
+---------------+------------------------------------+
| text | Any text other than newlines may |
| | be entered into this field. |
| | The text fieldtype may used to |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@luddaniel There's just a missing "be" between may and used. Could you add that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jggautier whoops, that was my bad, part of my rewrite. I just fixed it in 649e2af.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool thanks. That was my only suggestion for the changes in the documentation. I'll remove myself from the Assignment list on this PR.

| | define a boolean (see "Value" |
| | under :ref:`cvoc-props`). |
+---------------+------------------------------------+
| textbox | Any text may be entered. For |
| | input, the Dataverse Software |
Expand Down
Loading