Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

Hierarchy

  • Configuration

Index

Constructors

Accessors

  • get TOCpath(): string
  • get YAML(): any
  • get bookMetaSourceID(): any
  • set bookMetaSourceID(newID: any): void
  • get bookMetaSourceType(): any
  • set bookMetaSourceType(newType: any): void
  • get bookOPF(): any
  • set bookOPF(newBookOPF: any): void
  • get bookOPFFullPath(): string
  • Compute the full pathname to the OPF file. In the config file bookOPF is relative to the location of the config file. However some callers will require the full pathname.

    Returns string

  • get configDirPath(): string
  • get configFileName(): string
  • set configFileName(FN: string): void
  • File name for configuration file. Appears this is to be the full path name?

    Returns string

  • File name for configuration file. Appears this is to be the full path name?

    Parameters

    • FN: string

    Returns void

  • get containerRootfiles(): any
  • set containerRootfiles(newOPFs: any): void
  • get doGenerateNCX(): boolean
  • get epubFileName(): any
  • set epubFileName(newEPUBFN: any): void
  • Pathname where the packaged EPUB will land, relative to the location of the configuration file.

    Returns any

  • Pathname where the packaged EPUB will land, relative to the location of the configuration file.

    Parameters

    • newEPUBFN: any

    Returns void

  • get epubPathOPF(): any
  • Compute the path within the EPUB file for the OPF. Assume that renderedFullPath is something like accessible_epub_3 While bookOPF is something like accessible_epub_3/EPUB/package.opf

    Returns any

  • get opfContributors(): any
  • set opfContributors(newContributors: any): void
  • get opfCoverage(): any
  • set opfCoverage(newBookCoverage: any): void
  • get opfCreators(): any
  • set opfCreators(newCreators: any): void
  • get opfDescription(): any
  • set opfDescription(newBookDescription: any): void
  • get opfFormat(): any
  • set opfFormat(newBookFormat: any): void
  • get opfIdentifiers(): any
  • set opfIdentifiers(newIdentifiers: any): void
  • get opfLanguages(): any
  • set opfLanguages(newBookPubLanguage: any): void
  • get opfManifest(): any
  • set opfManifest(newManifest: any): void
  • get opfModifiedDate(): any
  • set opfModifiedDate(newBookModifiedDate: any): void
  • get opfPublicationDate(): any
  • set opfPublicationDate(newBookPublicationDate: any): void
  • get opfPublisher(): any
  • set opfPublisher(newBookPublisher: any): void
  • get opfRelation(): any
  • set opfRelation(newBookRelation: any): void
  • get opfRights(): any
  • set opfRights(newBookRights: any): void
  • get opfSubjects(): any
  • set opfSubjects(newSubjects: any): void
  • get opfTitles(): any
  • set opfTitles(newBookTitles: any): void
  • This is an array of objects containing: id: ID value title: "The title to use" type: is a code which is one of the following main The title that reading systems should normally display, for example in a user’s library or bookshelf. If no values for the title-type property are provided, it is assumed that the first or only dc:title should be considered the “main title.”

             subtitle
    A secondary title that augments the main title but
    is separate from it.

    short
    A shortened version of the main title, often used when
    referring to a book with a long title (for example,
    Huck Finnfor The Adventures of Huckleberry Finn) or
    a brief expression by which a book is known (for example,
    Strunk and Whitefor The Elements of Style orFowler
    for A Dictionary of Modern English Usage).

    collection
    A title given to a set (either finite or ongoing) to
    which the given publication is a member. This can be a
    series title,” when the publications are in a specific
    sequence (e.g., The Lord of the Rings), or one in which
    the members are not necessarily in a particular order
    (e.g., “Columbia Studies in South Asian Art”).

    edition
    A designation that indicates substantive changes from
    one to the next.

    extended
    A fully expressed title that may be a combination of
    some of the other title types, for example: The Great
    Cookbooks of the World: Mon premier guide de caisson,
    un Mémoire. The New French Cuisine Masters, Volume Two.
    Special Anniversary Edition.

    Returns any

  • This is an array of objects containing: id: ID value title: "The title to use" type: is a code which is one of the following main The title that reading systems should normally display, for example in a user’s library or bookshelf. If no values for the title-type property are provided, it is assumed that the first or only dc:title should be considered the “main title.”

             subtitle
    A secondary title that augments the main title but
    is separate from it.

    short
    A shortened version of the main title, often used when
    referring to a book with a long title (for example,
    Huck Finnfor The Adventures of Huckleberry Finn) or
    a brief expression by which a book is known (for example,
    Strunk and Whitefor The Elements of Style orFowler
    for A Dictionary of Modern English Usage).

    collection
    A title given to a set (either finite or ongoing) to
    which the given publication is a member. This can be a
    series title,” when the publications are in a specific
    sequence (e.g., The Lord of the Rings), or one in which
    the members are not necessarily in a particular order
    (e.g., “Columbia Studies in South Asian Art”).

    edition
    A designation that indicates substantive changes from
    one to the next.

    extended
    A fully expressed title that may be a combination of
    some of the other title types, for example: The Great
    Cookbooks of the World: Mon premier guide de caisson,
    un Mémoire. The New French Cuisine Masters, Volume Two.
    Special Anniversary Edition.

    Parameters

    • newBookTitles: any

    Returns void

  • get projectName(): any
  • set projectName(newName: any): void
  • Human-friendly text string describing this project. It is not used anywhere else, e.g. it is not the book title.

    Returns any

  • Human-friendly text string describing this project. It is not used anywhere else, e.g. it is not the book title.

    Parameters

    • newName: any

    Returns void

  • get renderedFullPath(): string
  • get renderedPath(): any
  • set renderedPath(newPath: any): void
  • The directory path where the rendered files are stored. In akasharender-epub an additional YAML location is supported, this.YAML.akashaepub.bookdest, but it would be a mistake for epubtools to support that data, and it would be better for akasharender-epub to use the rendered field.

    Returns any

  • The directory path where the rendered files are stored. In akasharender-epub an additional YAML location is supported, this.YAML.akashaepub.bookdest, but it would be a mistake for epubtools to support that data, and it would be better for akasharender-epub to use the rendered field.

    Parameters

    • newPath: any

    Returns void

  • get sourceBookCoverHREF(): any
  • set sourceBookCoverHREF(newCoverHREF: any): void
  • get sourceBookCoverHTMLHREF(): any
  • set sourceBookCoverHTMLHREF(newCoverHREF: any): void
  • get sourceBookCoverHTMLID(): any
  • set sourceBookCoverHTMLID(newCoverID: any): void
  • get sourceBookCoverID(): any
  • set sourceBookCoverID(newCoverID: any): void
  • get sourceBookNCXHREF(): any
  • set sourceBookNCXHREF(newNCXHREF: any): void
  • get sourceBookNCXID(): any
  • set sourceBookNCXID(newNCXID: any): void
  • get sourceBookTOCHREF(): any
  • set sourceBookTOCHREF(newTOCHREF: any): void
  • get sourceBookTOCID(): any
  • set sourceBookTOCID(newTOCID: any): void
  • get tocdata(): any

Methods

  • check(): Promise<void>
  • readTOCData(): Promise<void>
  • save(): Promise<void>

Generated using TypeDoc