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.

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 section on relevant DC terms #46

Closed
kleihan opened this issue Nov 10, 2023 · 2 comments · Fixed by #65
Closed

Update section on relevant DC terms #46

kleihan opened this issue Nov 10, 2023 · 2 comments · Fixed by #65
Assignees
Labels
ERRATA Errors and omissions, inconsistencies

Comments

@kleihan
Copy link
Member

kleihan commented Nov 10, 2023

Section 3.2.1 Provenance contains a subset of DC terms that are relevant in the context of electronic interfaces. The proposal is to update this section to make a clear recommendation of DC terms to be used and their semantics. This is linked to the existing issue FIXTradingCommunity/fix-orchestra#186 about version attributes.

@kleihan
Copy link
Member Author

kleihan commented Oct 9, 2024

See also #39 Metadata usage guidelines

@martinswanson
Copy link

martinswanson commented Nov 1, 2024

As discussed at the previous Orchestra subcommittee meeting, here are our recommendations for the DC Terms.

Note: In general, we favour a permissive approach that avoids forcing users to specify lots of required fields, but being clear about the default behaviour if certain elements are not specified.

1. Change the recommended elements for an Orchestra spec from [title, publisher, date issued, and rights] to [title, creator, created, conformsTo, and source].

  • title: Should be a required element. If missing, should default to using the repository name.
  • creator: The recommended role should be creator not publisher, as not all specs are published (e.g. private specs)
  • created: The recommended date should be created not issued, as not all specs reach issuance in their lifecycle
  • conformsTo: Tools processing Orchestra files need to know which version of the technical spec the XML conforms to, hence conformsTo should be a recommended element. If missing, should default to the latest official version (currently Orchestra v1.0).
  • source: URL to another Orchestra file. Should be a recommended element if a reference file was used to create the specification. This helps to preserve provenance, and allows validation across specifications e.g. if a scenario variant in a derived spec is valid with respect the reference specification.

2. Additional elements recommended to support document generation (covers both PDF and EPUB formats)

  • alternative - Subtitle for the resource.
  • subject - List of keywords used for search and categorisation.
  • abstract - A summary of the resource.
  • issued - If missing, default to created date.
  • dateAccepted - if missing, default to issued date. If issued date is also missing, default to created date.
  • contributor - Secondary author, in addition to the creator.
  • publisher - Distributor of the Orchestra file or document. If missing, default to creator.

3. Additional recommended elements

  • rights - optional, identifies the copyright holder of the Orchestra file
  • licence - optional, URL to a licence file
  • isFormatOf - URL to original resource that the Orchestra spec is based on (e.g. a PDF spec published by an Exchange).

We have confirmed that the above is sufficient to correctly set all the relevant metadata attributes for both PDF and EBUP documentation formats.

kjrace pushed a commit to kjrace/fix-orchestra-spec that referenced this issue Nov 1, 2024
@kleihan kleihan linked a pull request Nov 1, 2024 that will close this issue
kjrace pushed a commit to kjrace/fix-orchestra-spec that referenced this issue Nov 4, 2024
kjrace pushed a commit to kjrace/fix-orchestra-spec that referenced this issue Nov 4, 2024
@kleihan kleihan moved this from Backlog to In progress in Orchestra v1.1 RC2 Nov 4, 2024
kleihan added a commit that referenced this issue Nov 4, 2024
[#46] update DC terms section
@kleihan kleihan moved this from In progress to Done in Orchestra v1.1 RC2 Dec 20, 2024
@kleihan kleihan closed this as completed by moving to Done in Orchestra v1.1 RC2 Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ERRATA Errors and omissions, inconsistencies
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants