pbcoreDescription is an element that uses free-form text or a narrative to report general notes, abstracts, or summaries about the intellectual content of an asset. The information may be in the form of an individual program description, anecdotal interpretations, or brief content reviews. The description may also consist of outlines, lists, bullet points, rundowns, edit decision lists, indexes, or tables of content.

Best practices: pbcoreDescription can be repeated, so that multiple descriptions can be provided. The attribute @descriptionType can be used to identify the type of description. The @source attribute can be used to identify the source of a description, e.g. @source=’NOVA website’.

pbcoreInstantiation can be contained within the elements pbcoreDescriptionDocument or pbcorePart.

Usage: required, repeatable.

Attributes

• descriptionType – optional. Use the attribute descriptionType to indicate the type of description being assigned to the element, such as ‘abstract,’ ‘summary,’ or ‘physical description.’
• descriptionTypeSource – optional. Attribute descriptionTypeSource provides the name of the authority used to declare data value of the attribute descriptionType. This might be the name of a controlled vocabulary, namespace or authority list, such as the official PBCore recommended vocabulary. We recommend a consistent and human readable use.
• descriptionTypeRef – optional. Use attribute descriptionTypeRef to supply a source’s URI for the value of the attribute descriptionType. Attribute descriptionTypeRef can be used to point to a term in a controlled vocabulary, or a URI associated with a source.
• descriptionTypeVersion – optional. Attribute descriptionTypeVersion identifies any version information about the authority or convention used to express data of the attribute descriptionType.
• descriptionTypeAnnotation – optional. Attribute descriptionTypeAnnotation includes narrative information intended to clarify the nature of data used in the element. Can be used as a notes field to include any additional information about the element or associated attributes
• segmentType – optional. Use the element segmentType to define the type of content contained in a segment. We recommend using description and descriptionType instead of segmentType.
• segmentTypeSource – optional. Attribute segmentTypeSource provides the name of the authority used to declare data value of the attribute segmentType. This might be the name of a controlled vocabulary, namespace or authority list, such as the official PBCore recommended vocabulary.
• segmentTypeRef – optional. Use attribute segmentTypeRef to supply a source’s URI for the value of the attribute segmentType. Attribute segmentTypeRef can be used to point to a term in a controlled vocabulary, or a URI associated with a source.
• segmentTypeVersion – optional. Attribute segmentTypeVersion identifies any version information about the authority or convention used to express data of the attribute segmentType.
• segmentTypeAnnotation – optional. Attribute segmentTypeAnnotation includes narrative information intended to clarify the nature of data used in the attribute segmentType. Can be used as a notes field to include any additional information about the element or associated attributes
• startTime – optional. Attribute startTime combines with the endTime attribute to define a specific media segment within a broader timeline of an asset and/or instantiation. This is a free text attribute and can be applied at the asset or instantiation level. When used at the asset level, it may be used to talk generally about the start/end time of a segment (e.g. “30 minutes”), or by providing a timestamp to a specific point in an instantiation. If you’re doing that for element at the asset level, we suggest referencing the instantiation ID you are referring to in timeAnnotation. One example would be if a six-hour long tape was broken into multiple programs, and each instantiation might have its start time labeled as when the instantiation began in the timeline of the broader tape. Another example for this usage might be a digital file created from a VHS tape that contains multiple segments. In the digital copy, color bars are removed from the beginning, and black from the end of the digital instantiation. Time references referring to the segments on the physical VHS are no longer relevant; therefore it’s important to tie start and end time references to a specific instantiation, e.g. use the asset ID and timestamp.
• endTime – optional. Attribute endTime combines with a similar value in the startTime attribute to define a specific media segment within a broader timeline of an asset and/or instantiation.
• timeAnnotation – optional. Attribute timeAnnotation includes narrative information intended to clarify information about the value of the startTime and endTime attributes.
• source – required only for the elements pbcoreIdentifier and instantiationIdentifier; for all other elements, optional. Attribute source provides the name of the authority used to declare the value of the element. Different elements will use the source attribute slightly differently. For example, identifier source (required) should be the name of the organization, institution, system or namespace that the identifier came from, such as “PBS NOLA Code” or an institutional database identifier. For other elements, this might be the name of a controlled vocabulary, namespace or authority list, such as Library of Congress Subject Headings. We recommend a consistent and human readable use.
• ref – optional. Use attribute ref to supply a source’s URI for the value of the element. Attribute ref can be used to point to a term in a controlled vocabulary, or a URI associated with a source.
• version – optional. Attribute version identifies any version information about the authority or convention used to express data of this element.
• annotation – optional. Attribute annotation includes narrative information intended to clarify the nature of data used in the element. Can be used as a notes field to include any additional information about the element or associated attributes.

Subelements

pbcoreDescription contains no subelements.

Examples

Submit any issues or suggested changes for future schema iterations by creating a ticket in our Github repository.