LediReader / EpubReader /Source /VersOne.Epub /Schema /Opf /Metadata /EpubMetadataContributor.cs
fasdfsa's picture
init
fab29d7
using System;
namespace VersOne.Epub.Schema
{
/// <summary>
/// <para>Contributor of the book. Represents the name of a person, organization, etc. that played a secondary role in the creation of the content of the EPUB book.</para>
/// <para>
/// See <see href="https://www.w3.org/TR/epub-33/#sec-opf-dccontributor" />,
/// <see href="https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6" />,
/// and <see href="http://purl.org/dc/elements/1.1/contributor" /> for more information.
/// </para>
/// </summary>
public class EpubMetadataContributor
{
/// <summary>
/// Initializes a new instance of the <see cref="EpubMetadataContributor" /> class.
/// </summary>
/// <param name="contributor">The name of the contributor as the author intends it to be displayed to a user.</param>
/// <param name="id">The unique ID of this EPUB metadata contributor item.</param>
/// <param name="fileAs">The normalized form of the name of the contributor for sorting.</param>
/// <param name="role">The contributor's role which describes the nature of work performed by the contributor.</param>
/// <param name="textDirection">The text direction for the name of this contributor or <c>null</c> if the contributor doesn't specify a text direction.</param>
/// <param name="language">The language for the name of this contributor or <c>null</c> if the contributor doesn't specify the language.</param>
/// <exception cref="ArgumentNullException">The <paramref name="contributor" /> parameter is <c>null</c>.</exception>
public EpubMetadataContributor(string contributor, string? id = null, string? fileAs = null, string? role = null, EpubTextDirection? textDirection = null,
string? language = null)
{
Contributor = contributor ?? throw new ArgumentNullException(nameof(contributor));
Id = id;
FileAs = fileAs;
Role = role;
TextDirection = textDirection;
Language = language;
}
/// <summary>
/// <para>Gets the name of the contributor as the author intends it to be displayed to a user.</para>
/// <para>See <see href="https://www.w3.org/TR/epub-33/#sec-opf-dccontributor" /> for more information.</para>
/// </summary>
public string Contributor { get; }
/// <summary>
/// <para>Gets the unique ID of this EPUB metadata contributor item.</para>
/// <para>See <see href="https://www.w3.org/TR/epub-33/#attrdef-id" /> for more information.</para>
/// </summary>
public string? Id { get; }
/// <summary>
/// <para>Gets the normalized form of the name of the contributor for sorting.</para>
/// <para>
/// See <see href="https://www.w3.org/TR/epub-33/#file-as" />
/// and <see href="https://www.w3.org/TR/epub-33/#sec-opf-dccontributor" /> for more information.
/// </para>
/// </summary>
public string? FileAs { get; }
/// <summary>
/// <para>Gets the contributor's role which describes the nature of work performed by the contributor.</para>
/// <para>
/// See <see href="https://www.w3.org/TR/epub-33/#role" />
/// and <see href="https://www.w3.org/TR/epub-33/#sec-opf-dccontributor" /> for more information.
/// </para>
/// </summary>
public string? Role { get; }
/// <summary>
/// <para>Gets the text direction for the name of this contributor or <c>null</c> if the contributor doesn't specify a text direction.</para>
/// <para>See <see href="https://www.w3.org/TR/epub-33/#attrdef-dir" /> for more information.</para>
/// </summary>
public EpubTextDirection? TextDirection { get; }
/// <summary>
/// <para>Gets the language for the name of this contributor or <c>null</c> if the contributor doesn't specify the language.</para>
/// <para>See <see href="https://www.w3.org/TR/epub-33/#attrdef-xml-lang" /> for more information.</para>
/// </summary>
public string? Language { get; }
}
}