DOCSEARCHbyAlgolia
Submit Docs

ComicInfo.xml Metadata Standard

repository·main·Indexed 42 days ago

https://github.com/anansi-project/comicinfo

Documentation, schema definitions, and evolution tracking for the ComicInfo.xml metadata format used by comic book management applications. Includes specifications for core metadata, creator roles, story arcs, character tracking, and page-level information.

Tokens
1.1K
Snippets
0
Records
6
Agent score
4%

What's inside ComicInfo

  1. Access ComicInfo.xml schemas and drafts

    main

    The ComicInfo.xml format is a widely used metadata standard for comics. This project provides centralized documentation and schemas for the format.

    • Stable Schemas: To find documented versions of the schema and the accepted usage for each field, navigate to the schema/ directory. Each version is organized into its own subdirectory.
    • Draft Schemas: To view proposed or evolving versions of the schema, navigate to the drafts/ directory. Each draft version is also organized into its own subdirectory.

  2. Reference Character, Team, and Location metadata

    main

    Use these fields to categorize the content of the book. All these fields accept comma-separated values for multiple entries:

    • Characters: Characters present in the book.
    • Teams: Super-hero teams or other groups (e.g., Avengers).
    • Locations: Locations mentioned in the book.
    • MainCharacterOrTeam: The primary character or team. A single value should be present here.

  3. Use Creator fields for attribution

    main

    The schema provides specific fields for creators. According to the schema, each creator element can only appear once. To include multiple people for the same role, use comma-separated values.

    Supported Creator Roles

    • Writer: Scenario creator.
    • Penciller: Art drawer.
    • Inker: Inker.
    • Colorist: Colorist.
    • Letterer: Text and speech bubble artist.
    • CoverArtist: Cover artist.
    • Editor: Reviser or content contributor.
    • Translator: Text translator (includes "scanlators").

  4. Define Page and ComicPageInfo metadata

    main

    The Pages / ComicPageInfo section describes individual pages within a book using the following keys:

    • Image: The page number.
    • Type: The type of page. Valid values include:
      • FrontCover / BackCover / InnerCover (second cover inside)
      • Roundup (summary of previous issues)
      • Story
      • Advertisement
      • Editorial
      • Letters (fan letters)
      • Preview (sneak peek)
      • Other (unspecified)
      • Delete (indicates the page should not be shown to readers)
    • DoublePage: Indicates if the page is a double spread.
    • ImageSize: File size in bytes.
    • ImageWidth / ImageHeight: Dimensions in pixels.
    • Bookmark: Used by ComicRack for bookmarks.
    • Key: (Undefined in current schema documentation).

  5. Manage Story Arcs and Reading Orders

    main

    To track story arcs and specific reading orders, use the following fields:

    • StoryArc: The name of the story arc (e.g., Destiny). Supports comma-separated values for multiple arcs.
    • StoryArcNumber: Indicates the position of the book within a specific reading order. This is useful for books that belong to a reading order composed of multiple series. Supports comma-separated values.
    • SeriesGroup: A group or collection the series belongs to. Supports comma-separated values.

  6. Reference the ComicInfo.xml schema fields

    main

    The ComicInfo.xml schema defines various metadata fields for comic books. When implementing or consuming this schema, use the following field names and follow the specified formatting rules for multi-value fields.

    Core Metadata

    • Title: Title of the book.
    • Series: Title of the series.
    • Number: Number of the book in the series.
    • Count: Total number of books in the series. Note: Consuming applications should prefer the value from the latest book in a series.
    • Volume: Volume number (e.g., 1, 2) or year (e.g., 2018). Specific to US Comics.
    • AlternateSeries / AlternateNumber / AlternateCount: Used for crossover story arcs in US comics.
    • Summary: Description of the book.
    • Notes: Free text, often used for application-specific metadata.
    • Year / Month / Day: Release date components.
    • Publisher: The publishing organization.
    • Imprint: A group under a Publisher (e.g., Vertigo under DC Comics).
    • Genre: Genre (e.g., Science-Fiction). Use comma-separated values for multiple entries.
    • Tags: Descriptive tags (e.g., ninja). Use comma-separated values for multiple entries.
    • Web: Reference URLs. Use space-separated values. URLs containing spaces must be percent encoded.
    • PageCount: Total number of pages.
    • LanguageISO: Language code. It is recommended to use IETF BCP 47 language tags (e.g., to distinguish between zh-Hans and zh-Hant).
    • Format: Binding or presentation format (e.g., TBP, HC, Web, Digital).
    • BlackAndWhite: Boolean indicating if the book is B&W.
    • Manga: Indicates if the book is a manga. Setting this to YesAndRightToLeft defines the reading direction as right-to-left.
    • AgeRating: Age rating.
    • CommunityRating: Rating from 0.0 to 5.0.
    • Review: Text review of the book.
    • GTIN: Global Trade Item Number (includes ISBN, ISSN, EAN, or JAN).