Skip to content

mnml smpl #24

@tim-weis

Description

@tim-weis

This repository sports a wide range of interesting samples. The one sample I came here looking for is missing, though: The most minimal set of assets and structure that can be bundled into a valid EPUB publication (EPUB 3.3 at the time of writing).

Here is a rough sketch of what I had in mind:

file structure

.
├── META-INF
│   └── container.xml
├── mimetype
├── intro.xhtml
├── nav.xhtml
└── package.opf

META-INF/container.xml

<?xml version="1.0"?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
    <rootfiles>
        <rootfile
            full-path="package.opf"
            media-type="application/oebps-package+xml" />
    </rootfiles>
</container>

mimetype

application/epub+zip

intro.xhtml

<?xml version="1.0"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
    <title>Intro</title>
</head>

<body>
</body>

</html>

nav.xhtml

<?xml version="1.0"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">

<head>
    <title>Navigation</title>
</head>

<body>
    <nav epub:type="toc">
        <ol>
            <li><a href="intro.xhtml">Intro</a></li>
        </ol>
    </nav>
</body>

</html>

package.opf

<?xml version="1.0"?>
<package unique-identifier="pub_id" version="3.0" xmlns="http://www.idpf.org/2007/opf"
    xmlns:dc="http://purl.org/dc/elements/1.1/">
    <metadata>
        <dc:identifier id="pub_id">urn:uuid:172D8817-BBD6-471B-AB53-04D86C6248DF</dc:identifier>
        <dc:title>mnml</dc:title>
        <dc:language>en</dc:language>
        <meta property="dcterms:modified">2025-11-11T00:00:00Z</meta>
    </metadata>
    <manifest>
        <item href="nav.xhtml" media-type="application/xhtml+xml" id="nav" properties="nav" />
        <item href="intro.xhtml" media-type="application/xhtml+xml" id="intro" />
    </manifest>
    <spine>
        <itemref idref="nav" />
        <itemref idref="intro" />
    </spine>
</package>

This sample is useful for several reasons, such as:

  • Providing a cleanroom publication for folks new to EPUB 3 (like me), for purposes of education and exploration.
  • Serving as a template for EPUB authoring systems.
  • Test material for EPUB reading systems, exercising several edge cases.

I don't know whether this repository is still the right place to file issues, as the EPUB 3 CG closed earlier this year. Feel free to transfer this issue to the respective successor.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions