From 98acdca83a6772f7a04bacd2a117ef40cb2edc78 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Tue, 17 May 2022 16:36:32 -0400 Subject: [PATCH 1/8] 8127 citation field improvements Closes #8127 Changes the labels, tooltips and watermarks of fields shown in the Citation metadatablock to improve readability --- .../source/admin/metadatacustomization.rst | 2 + doc/sphinx-guides/source/style/index.rst | 1 + doc/sphinx-guides/source/style/text.rst | 14 + scripts/api/data/metadatablocks/citation.tsv | 160 +++++------ src/main/java/propertyFiles/Bundle.properties | 14 +- .../java/propertyFiles/citation.properties | 250 +++++++++--------- 6 files changed, 229 insertions(+), 212 deletions(-) create mode 100644 doc/sphinx-guides/source/style/text.rst diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst index e59d3d4bc3b..026053f3c09 100644 --- a/doc/sphinx-guides/source/admin/metadatacustomization.rst +++ b/doc/sphinx-guides/source/admin/metadatacustomization.rst @@ -574,6 +574,8 @@ The scripts required can be hosted locally or retrieved dynamically from https:/ Tips from the Dataverse Community --------------------------------- +When creating new metadatablocks, please review the :doc:`/style/text` section of the Style Guide, which includes guidance about naming metadata fields and writing text for metadata tooltips. + If there are tips that you feel are omitted from this document, please open an issue at https://github.com/IQSS/dataverse/issues and consider making a pull request to make improvements. You can find this document at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/admin/metadatacustomization.rst Alternatively, you are welcome to request "edit" access to this "Tips for Dataverse Software metadata blocks from the community" Google doc: https://docs.google.com/document/d/1XpblRw0v0SvV-Bq6njlN96WyHJ7tqG0WWejqBdl7hE0/edit?usp=sharing diff --git a/doc/sphinx-guides/source/style/index.rst b/doc/sphinx-guides/source/style/index.rst index ba6995e1b53..0e93716e146 100755 --- a/doc/sphinx-guides/source/style/index.rst +++ b/doc/sphinx-guides/source/style/index.rst @@ -14,3 +14,4 @@ This style guide is meant to help developers implement clear and appropriate UI foundations patterns + text diff --git a/doc/sphinx-guides/source/style/text.rst b/doc/sphinx-guides/source/style/text.rst new file mode 100644 index 00000000000..635eb5228c7 --- /dev/null +++ b/doc/sphinx-guides/source/style/text.rst @@ -0,0 +1,14 @@ +Text +++++ + +Here we describe the guidelines that help us provide helpful, clear and consistent textual information to users. + +.. contents:: |toctitle| + :local: + +Metadata Text Guidelines +======================= + +`Bootstrap `__ provides a responsive, fluid, 12-column grid system that we use to organize our page layouts. + +These guidelines are maintained in `a Google Doc `__ as we expect to make frequent changes to them. We welcome comments in the Google Doc. \ No newline at end of file diff --git a/scripts/api/data/metadatablocks/citation.tsv b/scripts/api/data/metadatablocks/citation.tsv index 375a8c67cec..1764b95b14b 100644 --- a/scripts/api/data/metadatablocks/citation.tsv +++ b/scripts/api/data/metadatablocks/citation.tsv @@ -1,84 +1,84 @@ -#metadataBlock name dataverseAlias displayName blockURI - citation Citation Metadata https://dataverse.org/schema/citation/ +#metadataBlock name dataverseAlias displayName blockURI + citation Citation Metadata https://dataverse.org/schema/citation/ #datasetField name title description watermark fieldType displayOrder displayFormat advancedSearchField allowControlledVocabulary allowmultiples facetable displayoncreate required parent metadatablock_id termURI - title Title Full title by which the Dataset is known. Enter title... text 0 TRUE FALSE FALSE FALSE TRUE TRUE citation http://purl.org/dc/terms/title - subtitle Subtitle A secondary title used to amplify or state certain limitations on the main title. text 1 FALSE FALSE FALSE FALSE FALSE FALSE citation - alternativeTitle Alternative Title A title by which the work is commonly referred, or an abbreviation of the title. text 2 FALSE FALSE FALSE FALSE FALSE FALSE citation http://purl.org/dc/terms/alternative - alternativeURL Alternative URL A URL where the dataset can be viewed, such as a personal or project website. Enter full URL, starting with http:// url 3 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE citation https://schema.org/distribution - otherId Other ID Another unique identifier that identifies this Dataset (e.g., producer's or another repository's number). none 4 : FALSE FALSE TRUE FALSE FALSE FALSE citation - otherIdAgency Agency Name of agency which generated this identifier. text 5 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE otherId citation - otherIdValue Identifier Other identifier that corresponds to this Dataset. text 6 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE otherId citation - author Author The person(s), corporate body(ies), or agency(ies) responsible for creating the work. none 7 FALSE FALSE TRUE FALSE TRUE TRUE citation http://purl.org/dc/terms/creator - authorName Name The author's Family Name, Given Name or the name of the organization responsible for this Dataset. FamilyName, GivenName or Organization text 8 #VALUE TRUE FALSE FALSE TRUE TRUE TRUE author citation - authorAffiliation Affiliation The organization with which the author is affiliated. text 9 (#VALUE) TRUE FALSE FALSE TRUE TRUE FALSE author citation - authorIdentifierScheme Identifier Scheme Name of the identifier scheme (ORCID, ISNI). text 10 - #VALUE: FALSE TRUE FALSE FALSE TRUE FALSE author citation http://purl.org/spar/datacite/AgentIdentifierScheme - authorIdentifier Identifier Uniquely identifies an individual author or organization, according to various schemes. text 11 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE author citation http://purl.org/spar/datacite/AgentIdentifier - datasetContact Contact The contact(s) for this Dataset. none 12 FALSE FALSE TRUE FALSE TRUE TRUE citation - datasetContactName Name The contact's Family Name, Given Name or the name of the organization. FamilyName, GivenName or Organization text 13 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE datasetContact citation - datasetContactAffiliation Affiliation The organization with which the contact is affiliated. text 14 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE datasetContact citation - datasetContactEmail E-mail The e-mail address(es) of the contact(s) for the Dataset. This will not be displayed. email 15 #EMAIL FALSE FALSE FALSE FALSE TRUE TRUE datasetContact citation - dsDescription Description A summary describing the purpose, nature, and scope of the Dataset. none 16 FALSE FALSE TRUE FALSE TRUE TRUE citation - dsDescriptionValue Text A summary describing the purpose, nature, and scope of the Dataset. textbox 17 #VALUE TRUE FALSE FALSE FALSE TRUE TRUE dsDescription citation - dsDescriptionDate Date In cases where a Dataset contains more than one description (for example, one might be supplied by the data producer and another prepared by the data repository where the data are deposited), the date attribute is used to distinguish between the two descriptions. The date attribute follows the ISO convention of YYYY-MM-DD. YYYY-MM-DD date 18 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE dsDescription citation - subject Subject Domain-specific Subject Categories that are topically relevant to the Dataset. text 19 TRUE TRUE TRUE TRUE TRUE TRUE citation http://purl.org/dc/terms/subject - keyword Keyword Key terms that describe important aspects of the Dataset. none 20 FALSE FALSE TRUE FALSE TRUE FALSE citation - keywordValue Term Key terms that describe important aspects of the Dataset. Can be used for building keyword indexes and for classification and retrieval purposes. A controlled vocabulary can be employed. The vocab attribute is provided for specification of the controlled vocabulary in use, such as LCSH, MeSH, or others. The vocabURI attribute specifies the location for the full controlled vocabulary. text 21 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE keyword citation - keywordVocabulary Vocabulary For the specification of the keyword controlled vocabulary in use, such as LCSH, MeSH, or others. text 22 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE keyword citation - keywordVocabularyURI Vocabulary URL Keyword vocabulary URL points to the web presence that describes the keyword vocabulary, if appropriate. Enter an absolute URL where the keyword vocabulary web site is found, such as http://www.my.org. Enter full URL, starting with http:// url 23 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE keyword citation - topicClassification Topic Classification The classification field indicates the broad important topic(s) and subjects that the data cover. Library of Congress subject terms may be used here. none 24 FALSE FALSE TRUE FALSE FALSE FALSE citation - topicClassValue Term Topic or Subject term that is relevant to this Dataset. text 25 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE topicClassification citation - topicClassVocab Vocabulary Provided for specification of the controlled vocabulary in use, e.g., LCSH, MeSH, etc. text 26 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE topicClassification citation - topicClassVocabURI Vocabulary URL Specifies the URL location for the full controlled vocabulary. Enter full URL, starting with http:// url 27 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE topicClassification citation - publication Related Publication Publications that use the data from this Dataset. The full list of Related Publications will be displayed on the metadata tab. none 28 FALSE FALSE TRUE FALSE TRUE FALSE citation http://purl.org/dc/terms/isReferencedBy - publicationCitation Citation The full bibliographic citation for this related publication. textbox 29 #VALUE TRUE FALSE FALSE FALSE TRUE FALSE publication citation http://purl.org/dc/terms/bibliographicCitation - publicationIDType ID Type The type of digital identifier used for this publication (e.g., Digital Object Identifier (DOI)). text 30 #VALUE: TRUE TRUE FALSE FALSE TRUE FALSE publication citation http://purl.org/spar/datacite/ResourceIdentifierScheme - publicationIDNumber ID Number The identifier for the selected ID type. text 31 #VALUE TRUE FALSE FALSE FALSE TRUE FALSE publication citation http://purl.org/spar/datacite/ResourceIdentifier - publicationURL URL Link to the publication web page (e.g., journal article page, archive record page, or other). Enter full URL, starting with http:// url 32 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE publication citation https://schema.org/distribution - notesText Notes Additional important information about the Dataset. textbox 33 FALSE FALSE FALSE FALSE TRUE FALSE citation - language Language Language of the Dataset text 34 TRUE TRUE TRUE TRUE FALSE FALSE citation http://purl.org/dc/terms/language - producer Producer Person or organization with the financial or administrative responsibility over this Dataset none 35 FALSE FALSE TRUE FALSE FALSE FALSE citation - producerName Name Producer name FamilyName, GivenName or Organization text 36 #VALUE TRUE FALSE FALSE TRUE FALSE TRUE producer citation - producerAffiliation Affiliation The organization with which the producer is affiliated. text 37 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE producer citation - producerAbbreviation Abbreviation The abbreviation by which the producer is commonly known. (ex. IQSS, ICPSR) text 38 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE producer citation - producerURL URL Producer URL points to the producer's web presence, if appropriate. Enter an absolute URL where the producer's web site is found, such as http://www.my.org. Enter full URL, starting with http:// url 39 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE producer citation - producerLogoURL Logo URL URL for the producer's logo, which points to this producer's web-accessible logo image. Enter an absolute URL where the producer's logo image is found, such as http://www.my.org/images/logo.gif. Enter full URL for image, starting with http:// url 40
FALSE FALSE FALSE FALSE FALSE FALSE producer citation - productionDate Production Date Date when the data collection or other materials were produced (not distributed, published or archived). YYYY-MM-DD date 41 TRUE FALSE FALSE TRUE FALSE FALSE citation - productionPlace Production Place The location where the data collection and any other related materials were produced. text 42 FALSE FALSE FALSE FALSE FALSE FALSE citation - contributor Contributor The organization or person responsible for either collecting, managing, or otherwise contributing in some form to the development of the resource. none 43 : FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/contributor - contributorType Type The type of contributor of the resource. text 44 #VALUE TRUE TRUE FALSE TRUE FALSE FALSE contributor citation - contributorName Name The Family Name, Given Name or organization name of the contributor. FamilyName, GivenName or Organization text 45 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE contributor citation - grantNumber Grant Information Grant Information none 46 : FALSE FALSE TRUE FALSE FALSE FALSE citation https://schema.org/sponsor - grantNumberAgency Grant Agency Grant Number Agency text 47 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation - grantNumberValue Grant Number The grant or contract number of the project that sponsored the effort. text 48 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation - distributor Distributor The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. none 49 FALSE FALSE TRUE FALSE FALSE FALSE citation - distributorName Name Distributor name FamilyName, GivenName or Organization text 50 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE distributor citation - distributorAffiliation Affiliation The organization with which the distributor contact is affiliated. text 51 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE distributor citation - distributorAbbreviation Abbreviation The abbreviation by which this distributor is commonly known (e.g., IQSS, ICPSR). text 52 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE distributor citation - distributorURL URL Distributor URL points to the distributor's web presence, if appropriate. Enter an absolute URL where the distributor's web site is found, such as http://www.my.org. Enter full URL, starting with http:// url 53 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE distributor citation - distributorLogoURL Logo URL URL of the distributor's logo, which points to this distributor's web-accessible logo image. Enter an absolute URL where the distributor's logo image is found, such as http://www.my.org/images/logo.gif. Enter full URL for image, starting with http:// url 54
FALSE FALSE FALSE FALSE FALSE FALSE distributor citation - distributionDate Distribution Date Date that the work was made available for distribution/presentation. YYYY-MM-DD date 55 TRUE FALSE FALSE TRUE FALSE FALSE citation - depositor Depositor The person (Family Name, Given Name) or the name of the organization that deposited this Dataset to the repository. text 56 FALSE FALSE FALSE FALSE FALSE FALSE citation - dateOfDeposit Deposit Date Date that the Dataset was deposited into the repository. YYYY-MM-DD date 57 FALSE FALSE FALSE TRUE FALSE FALSE citation http://purl.org/dc/terms/dateSubmitted - timePeriodCovered Time Period Covered Time period to which the data refer. This item reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. Also known as span. none 58 ; FALSE FALSE TRUE FALSE FALSE FALSE citation https://schema.org/temporalCoverage - timePeriodCoveredStart Start Start date which reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. YYYY-MM-DD date 59 #NAME: #VALUE TRUE FALSE FALSE TRUE FALSE FALSE timePeriodCovered citation - timePeriodCoveredEnd End End date which reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. YYYY-MM-DD date 60 #NAME: #VALUE TRUE FALSE FALSE TRUE FALSE FALSE timePeriodCovered citation - dateOfCollection Date of Collection Contains the date(s) when the data were collected. none 61 ; FALSE FALSE TRUE FALSE FALSE FALSE citation - dateOfCollectionStart Start Date when the data collection started. YYYY-MM-DD date 62 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE dateOfCollection citation - dateOfCollectionEnd End Date when the data collection ended. YYYY-MM-DD date 63 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE dateOfCollection citation - kindOfData Kind of Data Type of data included in the file: survey data, census/enumeration data, aggregate data, clinical data, event/transaction data, program source code, machine-readable text, administrative records data, experimental data, psychological test, textual data, coded textual, coded documents, time budget diaries, observation data/ratings, process-produced data, or other. text 64 TRUE FALSE TRUE TRUE FALSE FALSE citation http://rdf-vocabulary.ddialliance.org/discovery#kindOfData - series Series Information about the Dataset series. none 65 : FALSE FALSE FALSE FALSE FALSE FALSE citation - seriesName Name Name of the dataset series to which the Dataset belongs. text 66 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE series citation - seriesInformation Information History of the series and summary of those features that apply to the series as a whole. textbox 67 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE series citation - software Software Information about the software used to generate the Dataset. none 68 , FALSE FALSE TRUE FALSE FALSE FALSE citation https://www.w3.org/TR/prov-o/#wasGeneratedBy - softwareName Name Name of software used to generate the Dataset. text 69 #VALUE FALSE TRUE FALSE FALSE FALSE FALSE software citation - softwareVersion Version Version of the software used to generate the Dataset. text 70 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE software citation - relatedMaterial Related Material Any material related to this Dataset. textbox 71 FALSE FALSE TRUE FALSE FALSE FALSE citation - relatedDatasets Related Datasets Any Datasets that are related to this Dataset, such as previous research on this subject. textbox 72 FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/relation - otherReferences Other References Any references that would serve as background or supporting material to this Dataset. text 73 FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/references - dataSources Data Sources List of books, articles, serials, or machine-readable data files that served as the sources of the data collection. textbox 74 FALSE FALSE TRUE FALSE FALSE FALSE citation https://www.w3.org/TR/prov-o/#wasDerivedFrom - originOfSources Origin of Sources For historical materials, information about the origin of the sources and the rules followed in establishing the sources should be specified. textbox 75 FALSE FALSE FALSE FALSE FALSE FALSE citation - characteristicOfSources Characteristic of Sources Noted Assessment of characteristics and source material. textbox 76 FALSE FALSE FALSE FALSE FALSE FALSE citation - accessToSources Documentation and Access to Sources Level of documentation of the original sources. textbox 77 FALSE FALSE FALSE FALSE FALSE FALSE citation + title Title The main title of the Dataset text 0 TRUE FALSE FALSE FALSE TRUE TRUE citation http://purl.org/dc/terms/title + subtitle Subtitle A secondary title that amplifies or states certain limitations on the main title text 1 FALSE FALSE FALSE FALSE FALSE FALSE citation + alternativeTitle Alternative Title Either 1) a title commonly used to refer to the Dataset or 2) an abbreviation of the main title text 2 FALSE FALSE FALSE FALSE FALSE FALSE citation http://purl.org/dc/terms/alternative + alternativeURL Alternative URL Another URL where one can view or access the data in the Dataset, e.g. a project or personal webpage https:// url 3 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE citation https://schema.org/distribution + otherId Other Identifier Another unique identifier for the Dataset (e.g. producer's or another repository's identifier) none 4 : FALSE FALSE TRUE FALSE FALSE FALSE citation + otherIdAgency Agency The name of the agency that generated the other identifier text 5 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE otherId citation + otherIdValue Identifier Another identifier uniquely identifies the Dataset text 6 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE otherId citation + author Author The entity, e.g. a person or organization, that created the Dataset none 7 FALSE FALSE TRUE FALSE TRUE TRUE citation http://purl.org/dc/terms/creator + authorName Name The name of the author, such as the person's name or the name of an organization 1) Family Name, Given Name or 2) Organization XYZ text 8 #VALUE TRUE FALSE FALSE TRUE TRUE TRUE author citation + authorAffiliation Affiliation The name of the entity affiliated with the author, e.g. an organization's name Organization XYZ text 9 (#VALUE) TRUE FALSE FALSE TRUE TRUE FALSE author citation + authorIdentifierScheme Identifier Type The type of identifier that uniquely identifies the author (e.g. ORCID, ISNI) text 10 - #VALUE: FALSE TRUE FALSE FALSE TRUE FALSE author citation http://purl.org/spar/datacite/AgentIdentifierScheme + authorIdentifier Identifier Uniquely identifies the author when paired with an identifier type text 11 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE author citation http://purl.org/spar/datacite/AgentIdentifier + datasetContact Point of Contact The entity, e.g. a person or organization, that users of the Dataset can contact with questions none 12 FALSE FALSE TRUE FALSE TRUE TRUE citation + datasetContactName Name The name of the point of contact, e.g. the person's name or the name of an organization 1) FamilyName, GivenName or 2) Organization text 13 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE datasetContact citation + datasetContactAffiliation Affiliation The name of the entity affiliated with the point of contact, e.g. an organization's name Organization XYZ text 14 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE datasetContact citation + datasetContactEmail E-mail The point of contact's email address name@email.xyz email 15 #EMAIL FALSE FALSE FALSE FALSE TRUE TRUE datasetContact citation + dsDescription Description A summary describing the purpose, nature, and scope of the Dataset none 16 FALSE FALSE TRUE FALSE TRUE TRUE citation + dsDescriptionValue Text A summary describing the purpose, nature, and scope of the Dataset textbox 17 #VALUE TRUE FALSE FALSE FALSE TRUE TRUE dsDescription citation + dsDescriptionDate Date The date when the description was added to the Dataset. If the Dataset contains more than one description, e.g. the data producer supplied one description and the data repository supplied another, this date is used to distinguish between the descriptions YYYY-MM-DD date 18 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE dsDescription citation + subject Subject The area of study relevant to the Dataset text 19 TRUE TRUE TRUE TRUE TRUE TRUE citation http://purl.org/dc/terms/subject + keyword Keyword A key term that describes an important aspect of the Dataset and information about any controlled vocabulary used none 20 FALSE FALSE TRUE FALSE TRUE FALSE citation + keywordValue Term A key term that describes important aspects of the Dataset text 21 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE keyword citation + keywordVocabulary Controlled Vocabulary Name The controlled vocabulary used for the keyword term (e.g. LCSH, MeSH) text 22 (#VALUE) FALSE FALSE FALSE FALSE TRUE FALSE keyword citation + keywordVocabularyURI Controlled Vocabulary URL The URL where one can access information about the term's controlled vocabulary https:// url 23 #VALUE FALSE FALSE FALSE FALSE TRUE FALSE keyword citation + topicClassification Topic Classification Indicates a broad, important topic or subject that the Dataset covers and information about any controlled vocabulary used none 24 FALSE FALSE TRUE FALSE FALSE FALSE citation + topicClassValue Term A topic or subject term text 25 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE topicClassification citation + topicClassVocab Controlled Vocabulary Name The controlled vocabulary used for the keyword term (e.g. LCSH, MeSH) text 26 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE topicClassification citation + topicClassVocabURI Controlled Vocabulary URL The URL where one can access information about the term's controlled vocabulary https:// url 27 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE topicClassification citation + publication Related Publication The article or report that uses the data in the Dataset. The full list of related publications will be displayed on the metadata tab none 28 FALSE FALSE TRUE FALSE TRUE FALSE citation http://purl.org/dc/terms/isReferencedBy + publicationCitation Citation The full bibliographic citation for the related publication textbox 29 #VALUE TRUE FALSE FALSE FALSE TRUE FALSE publication citation http://purl.org/dc/terms/bibliographicCitation + publicationIDType Identifier Type The type of identifier that uniquely identifies a related publication text 30 #VALUE: TRUE TRUE FALSE FALSE TRUE FALSE publication citation http://purl.org/spar/datacite/ResourceIdentifierScheme + publicationIDNumber Identifier The identifier for a related publication text 31 #VALUE TRUE FALSE FALSE FALSE TRUE FALSE publication citation http://purl.org/spar/datacite/ResourceIdentifier + publicationURL URL The URL form of the identifier entered in the Identifier field, e.g. the DOI URL if a DOI was entered in the Identifier field. Used to display what was entered in the ID Type and ID Number fields as a link. If what was entered in the Identifier field has no URL form, the URL of the publication webpage is used, e.g. a journal article webpage https:// url 32 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE publication citation https://schema.org/distribution + notesText Notes Additional information about the Dataset textbox 33 FALSE FALSE FALSE FALSE TRUE FALSE citation + language Language A language that the Dataset's files is written in text 34 TRUE TRUE TRUE TRUE FALSE FALSE citation http://purl.org/dc/terms/language + producer Producer The entity, such a person or organization, managing the finances or other administrative processes involved in the creation of the Dataset none 35 FALSE FALSE TRUE FALSE FALSE FALSE citation + producerName Name The name of the entity, e.g. the person's name or the name of an organization 1) FamilyName, GivenName or 2) Organization text 36 #VALUE TRUE FALSE FALSE TRUE FALSE TRUE producer citation + producerAffiliation Affiliation The name of the entity affiliated with the producer, e.g. an organization's name Organization XYZ text 37 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE producer citation + producerAbbreviation Abbreviated Name The producer's abbreviated name (e.g. IQSS, ICPSR) text 38 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE producer citation + producerURL URL The URL of the producer's website https:// url 39 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE producer citation + producerLogoURL Logo URL The URL of the producer's logo https:// url 40
FALSE FALSE FALSE FALSE FALSE FALSE producer citation + productionDate Production Date The date when the data were produced (not distributed, published, or archived) YYYY-MM-DD date 41 TRUE FALSE FALSE TRUE FALSE FALSE citation + productionPlace Production Location The location where the data and any related materials were produced or collected text 42 FALSE FALSE FALSE FALSE FALSE FALSE citation + contributor Contributor The entity, such as a person or organization, responsible for collecting, managing, or otherwise contributing to the development of the Dataset none 43 : FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/contributor + contributorType Type Indicates the type of contribution made to the dataset text 44 #VALUE TRUE TRUE FALSE TRUE FALSE FALSE contributor citation + contributorName Name The name of the contributor, e.g. the person's name or the name of an organization 1) FamilyName, GivenName or 2) Organization text 45 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE contributor citation + grantNumber Funding Information Information about the Dataset's financial support none 46 : FALSE FALSE TRUE FALSE FALSE FALSE citation https://schema.org/sponsor + grantNumberAgency Agency The agency that provided financial support for the Dataset Organization XYZ text 47 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation + grantNumberValue Identifier The grant identifier or contract identifier of the agency that provided financial support for the Dataset text 48 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation + distributor Distributor The entity, such as a person or organization, designated to generate copies of the Dataset, including any editions or revisions none 49 FALSE FALSE TRUE FALSE FALSE FALSE citation + distributorName Name The name of the entity, e.g. the person's name or the name of an organization 1) FamilyName, GivenName or 2) Organization text 50 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE distributor citation + distributorAffiliation Affiliation The name of the entity affiliated with the distributor, e.g. an organization's name Organization XYZ text 51 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE distributor citation + distributorAbbreviation Abbreviated Name The distributor's abbreviated name (e.g. IQSS, ICPSR) text 52 (#VALUE) FALSE FALSE FALSE FALSE FALSE FALSE distributor citation + distributorURL URL The URL of the distributor's webpage https:// url 53 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE distributor citation + distributorLogoURL Logo URL The URL of the distributor's logo image, used to show the image on the Dataset's page https:// url 54
FALSE FALSE FALSE FALSE FALSE FALSE distributor citation + distributionDate Distribution Date The date when the Dataset was made available for distribution/presentation YYYY-MM-DD date 55 TRUE FALSE FALSE TRUE FALSE FALSE citation + depositor Depositor The entity, such as a person or organization, that deposited the Dataset in the repository 1) FamilyName, GivenName or 2) Organization text 56 FALSE FALSE FALSE FALSE FALSE FALSE citation + dateOfDeposit Deposit Date The date when the Dataset was deposited into the repository YYYY-MM-DD date 57 FALSE FALSE FALSE TRUE FALSE FALSE citation http://purl.org/dc/terms/dateSubmitted + timePeriodCovered Time Period The time period that the data refer to. Also known as span. This is the time period covered by the data, not the dates of coding, collecting data, or making documents machine-readable none 58 ; FALSE FALSE TRUE FALSE FALSE FALSE citation https://schema.org/temporalCoverage + timePeriodCoveredStart Start Date The start date of the time period that the data refer to YYYY-MM-DD date 59 #NAME: #VALUE TRUE FALSE FALSE TRUE FALSE FALSE timePeriodCovered citation + timePeriodCoveredEnd End Date The end date of the time period that the data refer to YYYY-MM-DD date 60 #NAME: #VALUE TRUE FALSE FALSE TRUE FALSE FALSE timePeriodCovered citation + dateOfCollection Date of Collection The dates when the data were collected or generated none 61 ; FALSE FALSE TRUE FALSE FALSE FALSE citation + dateOfCollectionStart Start Date The date when the data collection started YYYY-MM-DD date 62 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE dateOfCollection citation + dateOfCollectionEnd End Date The date when the data collection ended YYYY-MM-DD date 63 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE dateOfCollection citation + kindOfData Data Type The type of data included in the files (e.g. survey data, clinical data, or machine-readable text) text 64 TRUE FALSE TRUE TRUE FALSE FALSE citation http://rdf-vocabulary.ddialliance.org/discovery#kindOfData + series Series Information about the dataset series to which the Dataset belong none 65 : FALSE FALSE FALSE FALSE FALSE FALSE citation + seriesName Name The name of the dataset series text 66 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE series citation + seriesInformation Information Can include 1) a history of the series and 2) a summary of features that apply to the series textbox 67 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE series citation + software Software Information about the software used to generate the Dataset none 68 , FALSE FALSE TRUE FALSE FALSE FALSE citation https://www.w3.org/TR/prov-o/#wasGeneratedBy + softwareName Name The name of software used to generate the Dataset text 69 #VALUE FALSE TRUE FALSE FALSE FALSE FALSE software citation + softwareVersion Version The version of the software used to generate the Dataset, e.g. 4.11 text 70 #NAME: #VALUE FALSE FALSE FALSE FALSE FALSE FALSE software citation + relatedMaterial Related Material Information, such as a persistent ID or citation, about the material related to the Dataset, such as appendices or sampling information available outside of the Dataset textbox 71 FALSE FALSE TRUE FALSE FALSE FALSE citation + relatedDatasets Related Dataset Information, such as a persistent ID or citation, about a related dataset, such as previous research on the Dataset's subject textbox 72 FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/relation + otherReferences Other Reference Information, such as a persistent ID or citation, about another type of resource that provides background or supporting material to the Dataset text 73 FALSE FALSE TRUE FALSE FALSE FALSE citation http://purl.org/dc/terms/references + dataSources Data Source Information, such as a persistent ID or citation, about sources of the Dataset (e.g. a book, article, serial, or machine-readable data file) textbox 74 FALSE FALSE TRUE FALSE FALSE FALSE citation https://www.w3.org/TR/prov-o/#wasDerivedFrom + originOfSources Origin of Historical Sources For historical sources, the origin and any rules followed in establishing them as sources textbox 75 FALSE FALSE FALSE FALSE FALSE FALSE citation + characteristicOfSources Characteristic of Sources Characteristics not already noted elsewhere textbox 76 FALSE FALSE FALSE FALSE FALSE FALSE citation + accessToSources Documentation and Access to Sources 1) Methods or procedures for accessing data sources and 2) any special permissions needed for access textbox 77 FALSE FALSE FALSE FALSE FALSE FALSE citation #controlledVocabulary DatasetField Value identifier displayOrder subject Agricultural Sciences D01 0 subject Arts and Humanities D0 1 diff --git a/src/main/java/propertyFiles/Bundle.properties b/src/main/java/propertyFiles/Bundle.properties index 4245f8a45fc..1f39ed9533e 100644 --- a/src/main/java/propertyFiles/Bundle.properties +++ b/src/main/java/propertyFiles/Bundle.properties @@ -883,9 +883,9 @@ advanced.search.files.variableName=Variable Name advanced.search.files.variableName.tip=The name of the variable's column in the data frame. advanced.search.files.variableLabel=Variable Label advanced.search.files.variableLabel.tip=A short description of the variable. -advanced.search.datasets.persistentId.tip=The persistent identifier for the dataset. -advanced.search.datasets.persistentId=Dataset Persistent ID -advanced.search.datasets.persistentId.tip=The unique persistent identifier for a dataset, which can be a Handle or DOI in Dataverse. +advanced.search.datasets.persistentId.tip=The persistent identifier for the Dataset. +advanced.search.datasets.persistentId=Persistent Identifier +advanced.search.datasets.persistentId.tip=The Dataset's unique persistent identifier, either a DOI or Handle advanced.search.files.fileTags=File Tags advanced.search.files.fileTags.tip=Terms such "Documentation", "Data", or "Code" that have been applied to files. @@ -1524,15 +1524,15 @@ dataset.message.termsFailure=The dataset terms could not be updated. dataset.message.label.fileAccess=File Access dataset.message.publicInstall=Files are stored on a publicly accessible storage server. dataset.metadata.publicationDate=Publication Date -dataset.metadata.publicationDate.tip=The publication date of a dataset. +dataset.metadata.publicationDate.tip=The publication date of a Dataset. dataset.metadata.citationDate=Citation Date dataset.metadata.citationDate.tip=The citation date of a dataset, determined by the longest embargo on any file in version 1.0. dataset.metadata.publicationYear=Publication Year dataset.metadata.publicationYear.tip=The publication year of a dataset. -dataset.metadata.persistentId=Dataset Persistent ID -dataset.metadata.persistentId.tip=The unique persistent identifier for a dataset, which can be a Handle or DOI in Dataverse. +dataset.metadata.persistentId=Persistent Identifier +dataset.metadata.persistentId.tip=The Dataset's unique persistent identifier, either a DOI or Handle dataset.metadata.alternativePersistentId=Previous Dataset Persistent ID -dataset.metadata.alternativePersistentId.tip=A previously used persistent identifier for a dataset, which can be a Handle or DOI in Dataverse. +dataset.metadata.alternativePersistentId.tip=A previously used persistent identifier for the Dataset, either a DOI or Handle file.metadata.preview=Preview file.metadata.filetags=File Tags file.metadata.persistentId=File Persistent ID diff --git a/src/main/java/propertyFiles/citation.properties b/src/main/java/propertyFiles/citation.properties index 70cb98a98e4..bdcc48b5bf1 100644 --- a/src/main/java/propertyFiles/citation.properties +++ b/src/main/java/propertyFiles/citation.properties @@ -4,15 +4,15 @@ datasetfieldtype.title.title=Title datasetfieldtype.subtitle.title=Subtitle datasetfieldtype.alternativeTitle.title=Alternative Title datasetfieldtype.alternativeURL.title=Alternative URL -datasetfieldtype.otherId.title=Other ID +datasetfieldtype.otherId.title=Other Identifier datasetfieldtype.otherIdAgency.title=Agency datasetfieldtype.otherIdValue.title=Identifier datasetfieldtype.author.title=Author datasetfieldtype.authorName.title=Name datasetfieldtype.authorAffiliation.title=Affiliation -datasetfieldtype.authorIdentifierScheme.title=Identifier Scheme +datasetfieldtype.authorIdentifierScheme.title=Identifier Type datasetfieldtype.authorIdentifier.title=Identifier -datasetfieldtype.datasetContact.title=Contact +datasetfieldtype.datasetContact.title=Point of Contact datasetfieldtype.datasetContactName.title=Name datasetfieldtype.datasetContactAffiliation.title=Affiliation datasetfieldtype.datasetContactEmail.title=E-mail @@ -22,49 +22,49 @@ datasetfieldtype.dsDescriptionDate.title=Date datasetfieldtype.subject.title=Subject datasetfieldtype.keyword.title=Keyword datasetfieldtype.keywordValue.title=Term -datasetfieldtype.keywordVocabulary.title=Vocabulary -datasetfieldtype.keywordVocabularyURI.title=Vocabulary URL +datasetfieldtype.keywordVocabulary.title=Controlled Vocabulary Name +datasetfieldtype.keywordVocabularyURI.title=Controlled Vocabulary URL datasetfieldtype.topicClassification.title=Topic Classification datasetfieldtype.topicClassValue.title=Term -datasetfieldtype.topicClassVocab.title=Vocabulary -datasetfieldtype.topicClassVocabURI.title=Vocabulary URL +datasetfieldtype.topicClassVocab.title=Controlled Vocabulary Name +datasetfieldtype.topicClassVocabURI.title=Controlled Vocabulary URL datasetfieldtype.publication.title=Related Publication datasetfieldtype.publicationCitation.title=Citation -datasetfieldtype.publicationIDType.title=ID Type -datasetfieldtype.publicationIDNumber.title=ID Number +datasetfieldtype.publicationIDType.title=Identifier Type +datasetfieldtype.publicationIDNumber.title=Identifier datasetfieldtype.publicationURL.title=URL datasetfieldtype.notesText.title=Notes datasetfieldtype.language.title=Language datasetfieldtype.producer.title=Producer datasetfieldtype.producerName.title=Name datasetfieldtype.producerAffiliation.title=Affiliation -datasetfieldtype.producerAbbreviation.title=Abbreviation +datasetfieldtype.producerAbbreviation.title=Abbreviated Name datasetfieldtype.producerURL.title=URL datasetfieldtype.producerLogoURL.title=Logo URL datasetfieldtype.productionDate.title=Production Date -datasetfieldtype.productionPlace.title=Production Place +datasetfieldtype.productionPlace.title=Production Location datasetfieldtype.contributor.title=Contributor datasetfieldtype.contributorType.title=Type datasetfieldtype.contributorName.title=Name -datasetfieldtype.grantNumber.title=Grant Information -datasetfieldtype.grantNumberAgency.title=Grant Agency -datasetfieldtype.grantNumberValue.title=Grant Number +datasetfieldtype.grantNumber.title=Funding Information +datasetfieldtype.grantNumberAgency.title=Agency +datasetfieldtype.grantNumberValue.title=Identifier datasetfieldtype.distributor.title=Distributor datasetfieldtype.distributorName.title=Name datasetfieldtype.distributorAffiliation.title=Affiliation -datasetfieldtype.distributorAbbreviation.title=Abbreviation +datasetfieldtype.distributorAbbreviation.title=Abbreviated Name datasetfieldtype.distributorURL.title=URL datasetfieldtype.distributorLogoURL.title=Logo URL datasetfieldtype.distributionDate.title=Distribution Date datasetfieldtype.depositor.title=Depositor datasetfieldtype.dateOfDeposit.title=Deposit Date -datasetfieldtype.timePeriodCovered.title=Time Period Covered -datasetfieldtype.timePeriodCoveredStart.title=Start -datasetfieldtype.timePeriodCoveredEnd.title=End +datasetfieldtype.timePeriodCovered.title=Time Period +datasetfieldtype.timePeriodCoveredStart.title=Start Date +datasetfieldtype.timePeriodCoveredEnd.title=End Date datasetfieldtype.dateOfCollection.title=Date of Collection -datasetfieldtype.dateOfCollectionStart.title=Start -datasetfieldtype.dateOfCollectionEnd.title=End -datasetfieldtype.kindOfData.title=Kind of Data +datasetfieldtype.dateOfCollectionStart.title=Start Date +datasetfieldtype.dateOfCollectionEnd.title=End Date +datasetfieldtype.kindOfData.title=Data Type datasetfieldtype.series.title=Series datasetfieldtype.seriesName.title=Name datasetfieldtype.seriesInformation.title=Information @@ -72,106 +72,106 @@ datasetfieldtype.software.title=Software datasetfieldtype.softwareName.title=Name datasetfieldtype.softwareVersion.title=Version datasetfieldtype.relatedMaterial.title=Related Material -datasetfieldtype.relatedDatasets.title=Related Datasets -datasetfieldtype.otherReferences.title=Other References -datasetfieldtype.dataSources.title=Data Sources -datasetfieldtype.originOfSources.title=Origin of Sources -datasetfieldtype.characteristicOfSources.title=Characteristic of Sources Noted +datasetfieldtype.relatedDatasets.title=Related Dataset +datasetfieldtype.otherReferences.title=Other Reference +datasetfieldtype.dataSources.title=Data Source +datasetfieldtype.originOfSources.title=Origin of Historical Sources +datasetfieldtype.characteristicOfSources.title=Characteristic of Sources datasetfieldtype.accessToSources.title=Documentation and Access to Sources -datasetfieldtype.title.description=Full title by which the Dataset is known. -datasetfieldtype.subtitle.description=A secondary title used to amplify or state certain limitations on the main title. -datasetfieldtype.alternativeTitle.description=A title by which the work is commonly referred, or an abbreviation of the title. -datasetfieldtype.alternativeURL.description=A URL where the dataset can be viewed, such as a personal or project website. -datasetfieldtype.otherId.description=Another unique identifier that identifies this Dataset (e.g., producer's or another repository's number). -datasetfieldtype.otherIdAgency.description=Name of agency which generated this identifier. -datasetfieldtype.otherIdValue.description=Other identifier that corresponds to this Dataset. -datasetfieldtype.author.description=The person(s), corporate body(ies), or agency(ies) responsible for creating the work. -datasetfieldtype.authorName.description=The author's Family Name, Given Name or the name of the organization responsible for this Dataset. -datasetfieldtype.authorAffiliation.description=The organization with which the author is affiliated. -datasetfieldtype.authorIdentifierScheme.description=Name of the identifier scheme (ORCID, ISNI). -datasetfieldtype.authorIdentifier.description=Uniquely identifies an individual author or organization, according to various schemes. -datasetfieldtype.datasetContact.description=The contact(s) for this Dataset. -datasetfieldtype.datasetContactName.description=The contact's Family Name, Given Name or the name of the organization. -datasetfieldtype.datasetContactAffiliation.description=The organization with which the contact is affiliated. -datasetfieldtype.datasetContactEmail.description=The e-mail address(es) of the contact(s) for the Dataset. This will not be displayed. -datasetfieldtype.dsDescription.description=A summary describing the purpose, nature, and scope of the Dataset. -datasetfieldtype.dsDescriptionValue.description=A summary describing the purpose, nature, and scope of the Dataset. -datasetfieldtype.dsDescriptionDate.description=In cases where a Dataset contains more than one description (for example, one might be supplied by the data producer and another prepared by the data repository where the data are deposited), the date attribute is used to distinguish between the two descriptions. The date attribute follows the ISO convention of YYYY-MM-DD. -datasetfieldtype.subject.description=Domain-specific Subject Categories that are topically relevant to the Dataset. -datasetfieldtype.keyword.description=Key terms that describe important aspects of the Dataset. -datasetfieldtype.keywordValue.description=Key terms that describe important aspects of the Dataset. Can be used for building keyword indexes and for classification and retrieval purposes. A controlled vocabulary can be employed. The vocab attribute is provided for specification of the controlled vocabulary in use, such as LCSH, MeSH, or others. The vocabURI attribute specifies the location for the full controlled vocabulary. -datasetfieldtype.keywordVocabulary.description=For the specification of the keyword controlled vocabulary in use, such as LCSH, MeSH, or others. -datasetfieldtype.keywordVocabularyURI.description=Keyword vocabulary URL points to the web presence that describes the keyword vocabulary, if appropriate. Enter an absolute URL where the keyword vocabulary web site is found, such as http://www.my.org. -datasetfieldtype.topicClassification.description=The classification field indicates the broad important topic(s) and subjects that the data cover. Library of Congress subject terms may be used here. -datasetfieldtype.topicClassValue.description=Topic or Subject term that is relevant to this Dataset. -datasetfieldtype.topicClassVocab.description=Provided for specification of the controlled vocabulary in use, e.g., LCSH, MeSH, etc. -datasetfieldtype.topicClassVocabURI.description=Specifies the URL location for the full controlled vocabulary. -datasetfieldtype.publication.description=Publications that use the data from this Dataset. The full list of Related Publications will be displayed on the metadata tab. -datasetfieldtype.publicationCitation.description=The full bibliographic citation for this related publication. -datasetfieldtype.publicationIDType.description=The type of digital identifier used for this publication (e.g., Digital Object Identifier (DOI)). -datasetfieldtype.publicationIDNumber.description=The identifier for the selected ID type. -datasetfieldtype.publicationURL.description=Link to the publication web page (e.g., journal article page, archive record page, or other). -datasetfieldtype.notesText.description=Additional important information about the Dataset. -datasetfieldtype.language.description=Language of the Dataset -datasetfieldtype.producer.description=Person or organization with the financial or administrative responsibility over this Dataset -datasetfieldtype.producerName.description=Producer name -datasetfieldtype.producerAffiliation.description=The organization with which the producer is affiliated. -datasetfieldtype.producerAbbreviation.description=The abbreviation by which the producer is commonly known. (ex. IQSS, ICPSR) -datasetfieldtype.producerURL.description=Producer URL points to the producer's web presence, if appropriate. Enter an absolute URL where the producer's web site is found, such as http://www.my.org. -datasetfieldtype.producerLogoURL.description=URL for the producer's logo, which points to this producer's web-accessible logo image. Enter an absolute URL where the producer's logo image is found, such as http://www.my.org/images/logo.gif. -datasetfieldtype.productionDate.description=Date when the data collection or other materials were produced (not distributed, published or archived). -datasetfieldtype.productionPlace.description=The location where the data collection and any other related materials were produced. -datasetfieldtype.contributor.description=The organization or person responsible for either collecting, managing, or otherwise contributing in some form to the development of the resource. -datasetfieldtype.contributorType.description=The type of contributor of the resource. -datasetfieldtype.contributorName.description=The Family Name, Given Name or organization name of the contributor. -datasetfieldtype.grantNumber.description=Grant Information -datasetfieldtype.grantNumberAgency.description=Grant Number Agency -datasetfieldtype.grantNumberValue.description=The grant or contract number of the project that sponsored the effort. -datasetfieldtype.distributor.description=The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. -datasetfieldtype.distributorName.description=Distributor name -datasetfieldtype.distributorAffiliation.description=The organization with which the distributor contact is affiliated. -datasetfieldtype.distributorAbbreviation.description=The abbreviation by which this distributor is commonly known (e.g., IQSS, ICPSR). -datasetfieldtype.distributorURL.description=Distributor URL points to the distributor's web presence, if appropriate. Enter an absolute URL where the distributor's web site is found, such as http://www.my.org. -datasetfieldtype.distributorLogoURL.description=URL of the distributor's logo, which points to this distributor's web-accessible logo image. Enter an absolute URL where the distributor's logo image is found, such as http://www.my.org/images/logo.gif. -datasetfieldtype.distributionDate.description=Date that the work was made available for distribution/presentation. -datasetfieldtype.depositor.description=The person (Family Name, Given Name) or the name of the organization that deposited this Dataset to the repository. -datasetfieldtype.dateOfDeposit.description=Date that the Dataset was deposited into the repository. -datasetfieldtype.timePeriodCovered.description=Time period to which the data refer. This item reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. Also known as span. -datasetfieldtype.timePeriodCoveredStart.description=Start date which reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. -datasetfieldtype.timePeriodCoveredEnd.description=End date which reflects the time period covered by the data, not the dates of coding or making documents machine-readable or the dates the data were collected. -datasetfieldtype.dateOfCollection.description=Contains the date(s) when the data were collected. -datasetfieldtype.dateOfCollectionStart.description=Date when the data collection started. -datasetfieldtype.dateOfCollectionEnd.description=Date when the data collection ended. -datasetfieldtype.kindOfData.description=Type of data included in the file: survey data, census/enumeration data, aggregate data, clinical data, event/transaction data, program source code, machine-readable text, administrative records data, experimental data, psychological test, textual data, coded textual, coded documents, time budget diaries, observation data/ratings, process-produced data, or other. -datasetfieldtype.series.description=Information about the Dataset series. -datasetfieldtype.seriesName.description=Name of the dataset series to which the Dataset belongs. -datasetfieldtype.seriesInformation.description=History of the series and summary of those features that apply to the series as a whole. -datasetfieldtype.software.description=Information about the software used to generate the Dataset. -datasetfieldtype.softwareName.description=Name of software used to generate the Dataset. -datasetfieldtype.softwareVersion.description=Version of the software used to generate the Dataset. -datasetfieldtype.relatedMaterial.description=Any material related to this Dataset. -datasetfieldtype.relatedDatasets.description=Any Datasets that are related to this Dataset, such as previous research on this subject. -datasetfieldtype.otherReferences.description=Any references that would serve as background or supporting material to this Dataset. -datasetfieldtype.dataSources.description=List of books, articles, serials, or machine-readable data files that served as the sources of the data collection. -datasetfieldtype.originOfSources.description=For historical materials, information about the origin of the sources and the rules followed in establishing the sources should be specified. -datasetfieldtype.characteristicOfSources.description=Assessment of characteristics and source material. -datasetfieldtype.accessToSources.description=Level of documentation of the original sources. -datasetfieldtype.title.watermark=Enter title... +datasetfieldtype.title.description=The main title of the Dataset +datasetfieldtype.subtitle.description=A secondary title that amplifies or states certain limitations on the main title +datasetfieldtype.alternativeTitle.description=Either 1) a title commonly used to refer to the Dataset or 2) an abbreviation of the main title +datasetfieldtype.alternativeURL.description=Another URL where one can view or access the data in the Dataset, e.g. a project or personal webpage +datasetfieldtype.otherId.description=Another unique identifier for the Dataset (e.g. producer's or another repository's identifier) +datasetfieldtype.otherIdAgency.description=The name of the agency that generated the other identifier +datasetfieldtype.otherIdValue.description=Another identifier uniquely identifies the Dataset +datasetfieldtype.author.description=The entity, e.g. a person or organization, that created the Dataset +datasetfieldtype.authorName.description=The name of the author, such as the person's name or the name of an organization +datasetfieldtype.authorAffiliation.description=The name of the entity affiliated with the author, e.g. an organization's name +datasetfieldtype.authorIdentifierScheme.description=The type of identifier that uniquely identifies the author (e.g. ORCID, ISNI) +datasetfieldtype.authorIdentifier.description=Uniquely identifies the author when paired with an identifier type +datasetfieldtype.datasetContact.description=The entity, e.g. a person or organization, that users of the Dataset can contact with questions +datasetfieldtype.datasetContactName.description=The name of the point of contact, e.g. the person's name or the name of an organization +datasetfieldtype.datasetContactAffiliation.description=The name of the entity affiliated with the point of contact, e.g. an organization's name +datasetfieldtype.datasetContactEmail.description=The point of contact's email address +datasetfieldtype.dsDescription.description=A summary describing the purpose, nature, and scope of the Dataset +datasetfieldtype.dsDescriptionValue.description=A summary describing the purpose, nature, and scope of the Dataset +datasetfieldtype.dsDescriptionDate.description=The date when the description was added to the Dataset. If the Dataset contains more than one description, e.g. the data producer supplied one description and the data repository supplied another, this date is used to distinguish between the descriptions +datasetfieldtype.subject.description=The area of study relevant to the Dataset +datasetfieldtype.keyword.description=A key term that describes an important aspect of the Dataset and information about any controlled vocabulary used +datasetfieldtype.keywordValue.description=A key term that describes important aspects of the Dataset +datasetfieldtype.keywordVocabulary.description=The controlled vocabulary used for the keyword term (e.g. LCSH, MeSH) +datasetfieldtype.keywordVocabularyURI.description=The URL where one can access information about the term's controlled vocabulary +datasetfieldtype.topicClassification.description=Indicates a broad, important topic or subject that the Dataset covers and information about any controlled vocabulary used +datasetfieldtype.topicClassValue.description=A topic or subject term +datasetfieldtype.topicClassVocab.description=The controlled vocabulary used for the keyword term (e.g. LCSH, MeSH) +datasetfieldtype.topicClassVocabURI.description=The URL where one can access information about the term's controlled vocabulary +datasetfieldtype.publication.description=The article or report that uses the data in the Dataset. The full list of related publications will be displayed on the metadata tab +datasetfieldtype.publicationCitation.description=The full bibliographic citation for the related publication +datasetfieldtype.publicationIDType.description=The type of identifier that uniquely identifies a related publication +datasetfieldtype.publicationIDNumber.description=The identifier for a related publication +datasetfieldtype.publicationURL.description=The URL form of the identifier entered in the Identifier field, e.g. the DOI URL if a DOI was entered in the Identifier field. Used to display what was entered in the ID Type and ID Number fields as a link. If what was entered in the Identifier field has no URL form, the URL of the publication webpage is used, e.g. a journal article webpage +datasetfieldtype.notesText.description=Additional information about the Dataset +datasetfieldtype.language.description=A language that the Dataset's files is written in +datasetfieldtype.producer.description=The entity, such a person or organization, managing the finances or other administrative processes involved in the creation of the Dataset +datasetfieldtype.producerName.description=The name of the entity, e.g. the person's name or the name of an organization +datasetfieldtype.producerAffiliation.description=The name of the entity affiliated with the producer, e.g. an organization's name +datasetfieldtype.producerAbbreviation.description=The producer's abbreviated name (e.g. IQSS, ICPSR) +datasetfieldtype.producerURL.description=The URL of the producer's website +datasetfieldtype.producerLogoURL.description=The URL of the producer's logo +datasetfieldtype.productionDate.description=The date when the data were produced (not distributed, published, or archived) +datasetfieldtype.productionPlace.description=The location where the data and any related materials were produced or collected +datasetfieldtype.contributor.description=The entity, such as a person or organization, responsible for collecting, managing, or otherwise contributing to the development of the Dataset +datasetfieldtype.contributorType.description=Indicates the type of contribution made to the dataset +datasetfieldtype.contributorName.description=The name of the contributor, e.g. the person's name or the name of an organization +datasetfieldtype.grantNumber.description=Information about the Dataset's financial support +datasetfieldtype.grantNumberAgency.description=The agency that provided financial support for the Dataset +datasetfieldtype.grantNumberValue.description=The grant identifier or contract identifier of the agency that provided financial support for the Dataset +datasetfieldtype.distributor.description=The entity, such as a person or organization, designated to generate copies of the Dataset, including any editions or revisions +datasetfieldtype.distributorName.description=The name of the entity, e.g. the person's name or the name of an organization +datasetfieldtype.distributorAffiliation.description=The name of the entity affiliated with the distributor, e.g. an organization's name +datasetfieldtype.distributorAbbreviation.description=The distributor's abbreviated name (e.g. IQSS, ICPSR) +datasetfieldtype.distributorURL.description=The URL of the distributor's webpage +datasetfieldtype.distributorLogoURL.description=The URL of the distributor's logo image, used to show the image on the Dataset's page +datasetfieldtype.distributionDate.description=The date when the Dataset was made available for distribution/presentation +datasetfieldtype.depositor.description=The entity, such as a person or organization, that deposited the Dataset in the repository +datasetfieldtype.dateOfDeposit.description=The date when the Dataset was deposited into the repository +datasetfieldtype.timePeriodCovered.description=The time period that the data refer to. Also known as span. This is the time period covered by the data, not the dates of coding, collecting data, or making documents machine-readable +datasetfieldtype.timePeriodCoveredStart.description=The start date of the time period that the data refer to +datasetfieldtype.timePeriodCoveredEnd.description=The end date of the time period that the data refer to +datasetfieldtype.dateOfCollection.description=The dates when the data were collected or generated +datasetfieldtype.dateOfCollectionStart.description=The date when the data collection started +datasetfieldtype.dateOfCollectionEnd.description=The date when the data collection ended +datasetfieldtype.kindOfData.description=The type of data included in the files (e.g. survey data, clinical data, or machine-readable text) +datasetfieldtype.series.description=Information about the dataset series to which the Dataset belong +datasetfieldtype.seriesName.description=The name of the dataset series +datasetfieldtype.seriesInformation.description=Can include 1) a history of the series and 2) a summary of features that apply to the series +datasetfieldtype.software.description=Information about the software used to generate the Dataset +datasetfieldtype.softwareName.description=The name of software used to generate the Dataset +datasetfieldtype.softwareVersion.description=The version of the software used to generate the Dataset, e.g. 4.11 +datasetfieldtype.relatedMaterial.description=Information, such as a persistent ID or citation, about the material related to the Dataset, such as appendices or sampling information available outside of the Dataset +datasetfieldtype.relatedDatasets.description=Information, such as a persistent ID or citation, about a related dataset, such as previous research on the Dataset's subject +datasetfieldtype.otherReferences.description=Information, such as a persistent ID or citation, about another type of resource that provides background or supporting material to the Dataset +datasetfieldtype.dataSources.description=Information, such as a persistent ID or citation, about sources of the Dataset (e.g. a book, article, serial, or machine-readable data file) +datasetfieldtype.originOfSources.description=For historical sources, the origin and any rules followed in establishing them as sources +datasetfieldtype.characteristicOfSources.description=Characteristics not already noted elsewhere +datasetfieldtype.accessToSources.description=1) Methods or procedures for accessing data sources and 2) any special permissions needed for access +datasetfieldtype.title.watermark= datasetfieldtype.subtitle.watermark= datasetfieldtype.alternativeTitle.watermark= -datasetfieldtype.alternativeURL.watermark=Enter full URL, starting with http:// +datasetfieldtype.alternativeURL.watermark=https:// datasetfieldtype.otherId.watermark= datasetfieldtype.otherIdAgency.watermark= datasetfieldtype.otherIdValue.watermark= datasetfieldtype.author.watermark= -datasetfieldtype.authorName.watermark=FamilyName, GivenName or Organization -datasetfieldtype.authorAffiliation.watermark= +datasetfieldtype.authorName.watermark=1) Family Name, Given Name or 2) Organization XYZ +datasetfieldtype.authorAffiliation.watermark=Organization XYZ datasetfieldtype.authorIdentifierScheme.watermark= datasetfieldtype.authorIdentifier.watermark= datasetfieldtype.datasetContact.watermark= -datasetfieldtype.datasetContactName.watermark=FamilyName, GivenName or Organization -datasetfieldtype.datasetContactAffiliation.watermark= -datasetfieldtype.datasetContactEmail.watermark= +datasetfieldtype.datasetContactName.watermark=1) FamilyName, GivenName or 2) Organization +datasetfieldtype.datasetContactAffiliation.watermark=Organization XYZ +datasetfieldtype.datasetContactEmail.watermark=name@email.xyz datasetfieldtype.dsDescription.watermark= datasetfieldtype.dsDescriptionValue.watermark= datasetfieldtype.dsDescriptionDate.watermark=YYYY-MM-DD @@ -179,40 +179,40 @@ datasetfieldtype.subject.watermark= datasetfieldtype.keyword.watermark= datasetfieldtype.keywordValue.watermark= datasetfieldtype.keywordVocabulary.watermark= -datasetfieldtype.keywordVocabularyURI.watermark=Enter full URL, starting with http:// +datasetfieldtype.keywordVocabularyURI.watermark=https:// datasetfieldtype.topicClassification.watermark= datasetfieldtype.topicClassValue.watermark= datasetfieldtype.topicClassVocab.watermark= -datasetfieldtype.topicClassVocabURI.watermark=Enter full URL, starting with http:// +datasetfieldtype.topicClassVocabURI.watermark=https:// datasetfieldtype.publication.watermark= datasetfieldtype.publicationCitation.watermark= datasetfieldtype.publicationIDType.watermark= datasetfieldtype.publicationIDNumber.watermark= -datasetfieldtype.publicationURL.watermark=Enter full URL, starting with http:// +datasetfieldtype.publicationURL.watermark=https:// datasetfieldtype.notesText.watermark= datasetfieldtype.language.watermark= datasetfieldtype.producer.watermark= -datasetfieldtype.producerName.watermark=FamilyName, GivenName or Organization -datasetfieldtype.producerAffiliation.watermark= +datasetfieldtype.producerName.watermark=1) FamilyName, GivenName or 2) Organization +datasetfieldtype.producerAffiliation.watermark=Organization XYZ datasetfieldtype.producerAbbreviation.watermark= -datasetfieldtype.producerURL.watermark=Enter full URL, starting with http:// -datasetfieldtype.producerLogoURL.watermark=Enter full URL for image, starting with http:// +datasetfieldtype.producerURL.watermark=https:// +datasetfieldtype.producerLogoURL.watermark=https:// datasetfieldtype.productionDate.watermark=YYYY-MM-DD datasetfieldtype.productionPlace.watermark= datasetfieldtype.contributor.watermark= datasetfieldtype.contributorType.watermark= -datasetfieldtype.contributorName.watermark=FamilyName, GivenName or Organization +datasetfieldtype.contributorName.watermark=1) FamilyName, GivenName or 2) Organization datasetfieldtype.grantNumber.watermark= -datasetfieldtype.grantNumberAgency.watermark= +datasetfieldtype.grantNumberAgency.watermark=Organization XYZ datasetfieldtype.grantNumberValue.watermark= datasetfieldtype.distributor.watermark= -datasetfieldtype.distributorName.watermark=FamilyName, GivenName or Organization -datasetfieldtype.distributorAffiliation.watermark= +datasetfieldtype.distributorName.watermark=1) FamilyName, GivenName or 2) Organization +datasetfieldtype.distributorAffiliation.watermark=Organization XYZ datasetfieldtype.distributorAbbreviation.watermark= -datasetfieldtype.distributorURL.watermark=Enter full URL, starting with http:// -datasetfieldtype.distributorLogoURL.watermark=Enter full URL for image, starting with http:// +datasetfieldtype.distributorURL.watermark=https:// +datasetfieldtype.distributorLogoURL.watermark=https:// datasetfieldtype.distributionDate.watermark=YYYY-MM-DD -datasetfieldtype.depositor.watermark= +datasetfieldtype.depositor.watermark=1) FamilyName, GivenName or 2) Organization datasetfieldtype.dateOfDeposit.watermark=YYYY-MM-DD datasetfieldtype.timePeriodCovered.watermark= datasetfieldtype.timePeriodCoveredStart.watermark=YYYY-MM-DD From 1572f3048f92eb3f3fd821ddf0d6ae97136af3a5 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Tue, 17 May 2022 16:43:55 -0400 Subject: [PATCH 2/8] Create 8127-citation-field-improvements.md --- .../8127-citation-field-improvements.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/release-notes/8127-citation-field-improvements.md diff --git a/doc/release-notes/8127-citation-field-improvements.md b/doc/release-notes/8127-citation-field-improvements.md new file mode 100644 index 00000000000..c589145d01b --- /dev/null +++ b/doc/release-notes/8127-citation-field-improvements.md @@ -0,0 +1,16 @@ +### Improvements to fields that appear in the Citation metadata block + +Grammar, style and consistency improvements have been made to the titles, tooltip description text, and watermarks of metadata fields that appear in the Citation metadata block. + +This includes fields that dataset depositors can edit in the Citation Metadata accordion (i.e. fields controlled by the citation.tsv and citation.properties files) and fields whose values are system-generated, such as the Dataset Persistent ID, Previous Dataset Persistent ID, and Publication Date fields whose titles and tooltips are configured in the bundles.properties file. + +The changes should provide clearer information to curators, depositors, and people looking for data about what the fields are for. + +A new page in the Style Guides called "Text" has also been added. The new page includes a section called "Metadata Text Guidelines" with a link to a Google Doc where the guidelines are being maintained for now since we expect them to be revised frequently. + +### Additional Upgrade Steps + +Update the Citation metadata block: + +- `wget https://github.com/IQSS/dataverse/releases/download/v#.##/citation.tsv` +- `curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @citation.tsv -H "Content-type: text/tab-separated-values"` \ No newline at end of file From 19d05fea57dacb992d867595af5ba35612e6df1b Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Tue, 17 May 2022 16:51:38 -0400 Subject: [PATCH 3/8] Update text.rst --- doc/sphinx-guides/source/style/text.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/style/text.rst b/doc/sphinx-guides/source/style/text.rst index 635eb5228c7..4794db3453a 100644 --- a/doc/sphinx-guides/source/style/text.rst +++ b/doc/sphinx-guides/source/style/text.rst @@ -7,7 +7,7 @@ Here we describe the guidelines that help us provide helpful, clear and consiste :local: Metadata Text Guidelines -======================= +======================== `Bootstrap `__ provides a responsive, fluid, 12-column grid system that we use to organize our page layouts. From e28a6f2abbd0902d3b341596c690a29d1b127bc0 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Tue, 24 May 2022 18:46:23 -0400 Subject: [PATCH 4/8] Update metadatacustomization.rst --- doc/sphinx-guides/source/admin/metadatacustomization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst index 026053f3c09..c4aa57a4efe 100644 --- a/doc/sphinx-guides/source/admin/metadatacustomization.rst +++ b/doc/sphinx-guides/source/admin/metadatacustomization.rst @@ -574,7 +574,7 @@ The scripts required can be hosted locally or retrieved dynamically from https:/ Tips from the Dataverse Community --------------------------------- -When creating new metadatablocks, please review the :doc:`/style/text` section of the Style Guide, which includes guidance about naming metadata fields and writing text for metadata tooltips. +When creating new metadatablocks, please review the :doc:`/style/text` section of the Style Guide, which includes guidance about naming metadata fields and writing text for metadata tooltips and watermarks. If there are tips that you feel are omitted from this document, please open an issue at https://github.com/IQSS/dataverse/issues and consider making a pull request to make improvements. You can find this document at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/admin/metadatacustomization.rst From fa7d72f8d5ed0f1aba88977d7d155f84bfdf9c14 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 9 Jun 2022 16:36:20 -0400 Subject: [PATCH 5/8] Update doc/sphinx-guides/source/admin/metadatacustomization.rst Changing metadatablocks to metadata blocks since metadata blocks (with a space is used everywhere else in the guides). Co-authored-by: Philip Durbin --- doc/sphinx-guides/source/admin/metadatacustomization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst index c4aa57a4efe..094f310a156 100644 --- a/doc/sphinx-guides/source/admin/metadatacustomization.rst +++ b/doc/sphinx-guides/source/admin/metadatacustomization.rst @@ -574,7 +574,7 @@ The scripts required can be hosted locally or retrieved dynamically from https:/ Tips from the Dataverse Community --------------------------------- -When creating new metadatablocks, please review the :doc:`/style/text` section of the Style Guide, which includes guidance about naming metadata fields and writing text for metadata tooltips and watermarks. +When creating new metadata blocks, please review the :doc:`/style/text` section of the Style Guide, which includes guidance about naming metadata fields and writing text for metadata tooltips and watermarks. If there are tips that you feel are omitted from this document, please open an issue at https://github.com/IQSS/dataverse/issues and consider making a pull request to make improvements. You can find this document at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/admin/metadatacustomization.rst From deb9ec319c0b1aee968ae2ef71408c899202b168 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 9 Jun 2022 16:39:14 -0400 Subject: [PATCH 6/8] Update doc/sphinx-guides/source/style/text.rst Removing line about bootstrap. Co-authored-by: Philip Durbin --- doc/sphinx-guides/source/style/text.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/sphinx-guides/source/style/text.rst b/doc/sphinx-guides/source/style/text.rst index 4794db3453a..4fb2352300c 100644 --- a/doc/sphinx-guides/source/style/text.rst +++ b/doc/sphinx-guides/source/style/text.rst @@ -9,6 +9,4 @@ Here we describe the guidelines that help us provide helpful, clear and consiste Metadata Text Guidelines ======================== -`Bootstrap `__ provides a responsive, fluid, 12-column grid system that we use to organize our page layouts. - These guidelines are maintained in `a Google Doc `__ as we expect to make frequent changes to them. We welcome comments in the Google Doc. \ No newline at end of file From 1c9d6e36f918624b92e863f5bcbddb9d24ba6414 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 9 Jun 2022 16:58:26 -0400 Subject: [PATCH 7/8] Updating name of required Point of Contact Email field --- doc/sphinx-guides/source/user/dataset-management.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/user/dataset-management.rst b/doc/sphinx-guides/source/user/dataset-management.rst index 10b770bd09b..f30658b7a49 100755 --- a/doc/sphinx-guides/source/user/dataset-management.rst +++ b/doc/sphinx-guides/source/user/dataset-management.rst @@ -44,7 +44,7 @@ Adding a New Dataset #. Navigate to the Dataverse collection in which you want to add a dataset. #. Click on the "Add Data" button and select "New Dataset" in the dropdown menu. **Note:** If you are on the root Dataverse collection, your My Data page or click the "Add Data" link in the navbar, the dataset you create will be hosted in the root Dataverse collection. You can change this by selecting another Dataverse collection you have proper permissions to create datasets in, from the Host Dataverse collection dropdown in the create dataset form. This option to choose will not be available after you create the dataset. #. To quickly get started, enter at minimum all the required fields with an asterisk (e.g., the Dataset Title, Author, - Description, Contact Email and Subject) to get a Data Citation with a DOI. + Description, Point of Contact Email and Subject) to get a Data Citation with a DOI. #. Scroll down to the "Files" section and click on "Select Files to Add" to add all the relevant files to your Dataset. You can also upload your files directly from your Dropbox. **Tip:** You can drag and drop or select multiple files at a time from your desktop directly into the upload widget. Your files will appear below the "Select Files to Add" button where you can add a From 6681855b9e7bbc3bd91d8000eb64d428a195c8dd Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 9 Jun 2022 17:01:47 -0400 Subject: [PATCH 8/8] Using more specific field names for the required fields --- doc/sphinx-guides/source/api/native-api.rst | 6 +++--- doc/sphinx-guides/source/user/dataset-management.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/sphinx-guides/source/api/native-api.rst b/doc/sphinx-guides/source/api/native-api.rst index 5cf90359001..17e6b7e0f6f 100644 --- a/doc/sphinx-guides/source/api/native-api.rst +++ b/doc/sphinx-guides/source/api/native-api.rst @@ -454,9 +454,9 @@ A dataset is a container for files as explained in the :doc:`/user/dataset-manag To create a dataset, you must supply a JSON file that contains at least the following required metadata fields: - Title -- Author -- Contact -- Description +- Author Name +- Point of Contact Email +- Description Text - Subject As a starting point, you can download :download:`dataset-finch1.json <../../../../scripts/search/tests/data/dataset-finch1.json>` and modify it to meet your needs. (:download:`dataset-create-new-all-default-fields.json <../../../../scripts/api/data/dataset-finch1_fr.json>` is a variant of this file that includes setting the metadata language (see :ref:`:MetadataLanguages`) to French (fr). In addition to this minimal example, you can download :download:`dataset-create-new-all-default-fields.json <../../../../scripts/api/data/dataset-create-new-all-default-fields.json>` which populates all of the metadata fields that ship with a Dataverse installation.) diff --git a/doc/sphinx-guides/source/user/dataset-management.rst b/doc/sphinx-guides/source/user/dataset-management.rst index f30658b7a49..e9b69eb8573 100755 --- a/doc/sphinx-guides/source/user/dataset-management.rst +++ b/doc/sphinx-guides/source/user/dataset-management.rst @@ -43,8 +43,8 @@ Adding a New Dataset #. Navigate to the Dataverse collection in which you want to add a dataset. #. Click on the "Add Data" button and select "New Dataset" in the dropdown menu. **Note:** If you are on the root Dataverse collection, your My Data page or click the "Add Data" link in the navbar, the dataset you create will be hosted in the root Dataverse collection. You can change this by selecting another Dataverse collection you have proper permissions to create datasets in, from the Host Dataverse collection dropdown in the create dataset form. This option to choose will not be available after you create the dataset. -#. To quickly get started, enter at minimum all the required fields with an asterisk (e.g., the Dataset Title, Author, - Description, Point of Contact Email and Subject) to get a Data Citation with a DOI. +#. To quickly get started, enter at minimum all the required fields with an asterisk (e.g., the Dataset Title, Author Name, + Description Text, Point of Contact Email, and Subject) to get a Data Citation with a DOI. #. Scroll down to the "Files" section and click on "Select Files to Add" to add all the relevant files to your Dataset. You can also upload your files directly from your Dropbox. **Tip:** You can drag and drop or select multiple files at a time from your desktop directly into the upload widget. Your files will appear below the "Select Files to Add" button where you can add a