Chapter Convention Discussion

USGCRP / gcis-conventions

Repository for the collection, management, and versioning of the GCIS data management conventions.

https://usgcrp.github.io/gcis-conventions/

1 stars 0 forks source link

Chapter Convention Discussion #15

Closed lomky closed 6 years ago

lomky commented 6 years ago

A ticket to discuss the conventions surrounding Chapters.

Current Chapter Conventions

Chapter Fields:

report_identifier
identifier
number
title
url
sort key
doi

Provenance Connections:

cito:isCitedBy
cito:cites

Relationships:

report
figures
findings
tables
gcmd_keywords
regions
Contributors
Files

lomky commented 6 years ago

report_identifier - the report this resource belongs to identifier - title of the chapter with dashes in place of the spaces number - the official published chapter ID, if any. (i.e. 1,2,3..., A,B,C). Likely blank for chapters like front matter and executive summary. title - official published chapter title. Does not include a subtitle unless needed for uniqueness. Doesn't include "Chapter 1:" prefix. Doesn't include the Report name. See CSSR as exemplar. url - The direct URL for the given chapter. Same as what the chapter DOI, if any, would resolve to. Blank if chapter does not have its own URL. Do not use the report URL. sort key - the internal number to make the chapters sort in order. doi - the DOI for the Chapter, if any. Blank if not. Do not use the report DOI.

lomky commented 6 years ago

Tangential discussion:

What to do for report chapters that are also available as separately published reports (i.e. CSSR ch Executive Summary & The CSSR Executive Summary PDF), that also specify distinct citaitons?
- should we have both publications (chapter version & report version) in gcis?
- should both have a DOI, and should they be distinct?

lomky commented 6 years ago

For external report that are being cited in GCIS a large number of times by GCIS reports, we will often fill out chapters for those reports (i.e. IPCC reports).

cito:isCitedBy
cito:cites

are used similarly to the way discussed in #13

lomky commented 6 years ago

report

must exist.

figures/findings/tables

only populate these for USGCRP reports
if a Federal agency is creating a report and collects metadata in GCIS-compliant processes, they may populate those records

gcmd_keywords - not to be used for the moment. To be determined. regions - not to be used.

Contributors

only populated for the USGCRP produced reports.
might not be populated if the authors are all linked to the report instead.
generally speaking, follow how the report links authors. If they are listed on the report as a whole, list on the report. If they have the authors specified by chapter, they should be on the chapter.

Files

should be the downloadable PDF of the chapter, usually hosted externally to GCIS. Populated for USGCRP produced reports. Maybe populated for external reports.

rasherman commented 6 years ago

Did a little copy-editing, this is looking good to me. Any open questions I forgot to address?

lomky commented 6 years ago

Looks good to me.