init

.gitattributes

@@ -1,4 +1,16 @@
 *.7z filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+**/data/img/*.txt filter=lfs diff=lfs merge=lfs -text
+src/WeChatOcrCpp/wco_data/**/* filter=lfs diff=lfs merge=lfs -text
+*.aps filter=lfs diff=lfs merge=lfs -text
+*.ico filter=lfs diff=lfs merge=lfs -text
+*.pgm filter=lfs diff=lfs merge=lfs -text
+# *.exe filter=lfs diff=lfs merge=lfs -text
+# *.dll filter=lfs diff=lfs merge=lfs -text
+# *.lib filter=lfs diff=lfs merge=lfs -text
+# *.exp filter=lfs diff=lfs merge=lfs -text
+data/img/*.txt filter=lfs diff=lfs merge=lfs -text
+*.ttf filter=lfs diff=lfs merge=lfs -text
 *.arrow filter=lfs diff=lfs merge=lfs -text
 *.bin filter=lfs diff=lfs merge=lfs -text
 *.bz2 filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,25 @@
+TestResults/
+.vs/
+
+[Oo]bj*/
+[Bb]in*/
+[Dd]ebug*/
+[Rr]elease*/
+*.exe
+*.dll
+*.lib
+*.exp
+
+*.[Cc]ache
+*.suo
+*.user
+*.ruleset
+*.cso
+*.autogenerated.cs
+*.autogenerated.wxi
+*.autogenerated.wxs
+*_wpftmp.csproj
+*.shfbproj_*
+/packages
+*.log
+/LediReader/Properties/launchSettings.json

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "HtmlToFlowDocument"]
+	path = HtmlToFlowDocument
+	url = https://github.com/lellid/HtmlToFlowDocument.git
+[submodule "EpubReader"]
+	path = EpubReader
+	url = https://github.com/vers-one/EpubReader.git

Clean-Temporary-Files.cmd

@@ -0,0 +1,11 @@
+rmdir /S /Q .\.vs
+rmdir /S /Q .\EpubReader\Source\VersOne.Epub\bin
+rmdir /S /Q .\EpubReader\Source\VersOne.Epub\obj
+rmdir /S /Q .\HtmlToFlowDocument\HtmlToFlowDocument\bin
+rmdir /S /Q .\HtmlToFlowDocument\HtmlToFlowDocument\obj
+rmdir /S /Q .\HtmlToFlowDocument\HtmlToFlowDocument.Wpf\bin
+rmdir /S /Q .\HtmlToFlowDocument\HtmlToFlowDocument.Wpf\obj
+rmdir /S /Q .\LediReader\bin
+rmdir /S /Q .\LediReader\obj
+rmdir /S /Q .\SlobViewer\bin
+rmdir /S /Q .\SlobViewer\obj

EpubReader/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+<!-- A clear and concise description of what the bug is. If this bug is related to an unexpected exception thrown by the library, please provide the call stack of the exception here. -->
+
+## Sample EPUB file
+<!-- Please provide a link to a sample EPUB file reproducing the bug (unless this EPUB file is under copyright restrictions). -->
+
+## EPUB specification link
+<!-- If you believe that the library violates some parts of the EPUB standard, provide a link to a relevant EPUB specification section. EPUB 2 specification can be found here: http://idpf.org/epub/201 and the latest version of EPUB 3 specification is located here: https://www.w3.org/TR/epub-33/ -->
+
+## Additional context
+<!-- Add any other context about the problem here. -->

EpubReader/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an enhancement for this library
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Description
+<!-- A clear and concise description of what the feature request is. If this request related to a problem, please describe the problem. -->
+
+## Proposed solution
+<!-- A clear and concise description of what you want to happen. Provide a code sample if applicable. -->
+
+## Additional context
+<!-- Add any other context about the feature request here. -->

EpubReader/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,10 @@
+---
+name: Question
+about: Ask a question about the library
+title: ''
+labels: question
+assignees: ''
+
+---
+
+<!-- Write your question here. Provide a code sample if applicable. If your question is related to a specific EPUB file, please add a link to that file. -->

EpubReader/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+# {Pull request title}
+
+<!-- Thank you for submitting a pull request! -->
+
+This is:
+- [ ] a bug fix
+- [ ] an enhancement
+
+<!-- If you'd like to propose a new feature or implement a bug fix, please open an issue to discuss the change or find an existing issue. -->
+
+Related issue: #{issue number}
+
+## Description
+
+<!-- Describe the implementation details. -->
+
+## Testing steps
+
+<!-- Describe how a reviewer can check if the bug is fixed or the feature is working properly. Provide the expected result at the end. -->

EpubReader/.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: windows-2022
+    env:
+      Configuration: Debug
+      Solution_Name: Source\EpubReader.sln
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9
+      - name: Setup MSBuild
+        uses: microsoft/setup-msbuild@v2
+      - name: Restore dependencies
+        run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true
+      - name: Build solution
+        run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration

EpubReader/.github/workflows/generate-docs.yml

@@ -0,0 +1,43 @@
+name: Generate documentation
+
+on: workflow_dispatch
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  generate-documentation:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: windows-2022
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9
+      - name: Restore dependencies
+        run: dotnet restore .\Source\VersOne.Epub\VersOne.Epub.csproj
+      - name: Install DocFX
+        run: dotnet tool install -g docfx
+      - name: Run DocFX
+        run: docfx Documentation\docfx.json
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './Documentation/docfx_output'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

EpubReader/.github/workflows/publish-to-nuget.yml

@@ -0,0 +1,29 @@
+name: Publish to Nuget
+
+on: workflow_dispatch
+
+jobs:
+  publish-to-nuget:
+    runs-on: windows-2022
+    env:
+      Configuration: Release
+      Solution_Name: Source\EpubReader.sln
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9
+      - name: Setup MSBuild
+        uses: microsoft/setup-msbuild@v2
+      - name: Restore dependencies
+        run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true
+      - name: Build solution
+        run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration
+      - name: Make Nuget package
+        run: nuget.exe pack Source\VersOne.Epub\VersOne.Epub.nuspec
+      - name: Publish Nuget package
+        run: nuget.exe push *.nupkg -Source https://api.nuget.org/v3/index.json -ApiKey ${{ secrets.NUGET_API_KEY }} -SkipDuplicate

EpubReader/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Create release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version for the release"
+        required: true 
+        type: string
+
+jobs:
+  create-release:
+    runs-on: windows-2022
+    env:
+      Configuration: Release
+      Solution_Name: Source\EpubReader.sln
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9
+      - name: Setup MSBuild
+        uses: microsoft/setup-msbuild@v2
+      - name: Restore dependencies
+        run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true
+      - name: Build solution
+        run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration
+      - name: Package release files
+        run: |
+          7z a VersOne.Epub.Net46.zip .\Source\VersOne.Epub\bin\Release\net46\VersOne.Epub.dll
+          7z a VersOne.Epub.NetStandard.zip .\Source\VersOne.Epub\bin\Release\netstandard1.3\VersOne.Epub.dll
+          7z a ConsoleDemo.zip .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\HtmlAgilityPack.dll .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\VersOne.Epub.dll .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\VersOne.Epub.ConsoleDemo.dll .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\VersOne.Epub.ConsoleDemo.exe .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\VersOne.Epub.ConsoleDemo.deps.json .\Source\VersOne.Epub.ConsoleDemo\bin\Release\net9.0\VersOne.Epub.ConsoleDemo.runtimeconfig.json
+          7z a WpfDemo.zip .\Source\VersOne.Epub.WpfDemo\bin\Release\HtmlRenderer.dll .\Source\VersOne.Epub.WpfDemo\bin\Release\HtmlRenderer.WPF.dll .\Source\VersOne.Epub.WpfDemo\bin\Release\System.IO.Compression.dll .\Source\VersOne.Epub.WpfDemo\bin\Release\VersOne.Epub.dll .\Source\VersOne.Epub.WpfDemo\bin\Release\VersOne.Epub.WpfDemo.exe
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: v${{ github.event.inputs.version }}
+          draft: true
+          files: |
+            VersOne.Epub.Net46.zip
+            VersOne.Epub.NetStandard.zip
+            ConsoleDemo.zip
+            WpfDemo.zip

EpubReader/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: windows-2022
+    env:
+      Configuration: Debug
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9
+      - name: Build test project and its dependencies
+        run: dotnet build Source\VersOne.Epub.Test -c $env:Configuration
+      - name: Run unit tests
+        run: dotnet test Source\VersOne.Epub.Test --filter Unit --no-restore --collect:"XPlat Code Coverage" --settings Source\VersOne.Epub.Test\coverlet.runsettings
+      - name: Upload code coverage result to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Run integration tests
+        run: dotnet test Source\VersOne.Epub.Test --filter Integration --no-restore

EpubReader/.github/workflows/update-versions.yml

@@ -0,0 +1,31 @@
+name: Update versions
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "New version for all projects"
+        required: true 
+        type: string
+
+jobs:
+  update-versions:
+    runs-on: ubuntu-latest
+    name: Update versions
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Update project versions
+        id: update
+        uses: vers-one/dotnet-project-version-updater@v1.6
+        with:
+          file: |
+            "Source/VersOne.Epub/VersOne.Epub.csproj", "Source/VersOne.Epub/VersOne.Epub.nuspec", "Source/VersOne.Epub.Test/VersOne.Epub.Test.csproj", "Source/VersOne.Epub.ConsoleDemo/VersOne.Epub.ConsoleDemo.csproj", "Source/VersOne.Epub.WpfDemo/Properties/AssemblyInfo.cs"
+          version: ${{ github.event.inputs.version }}
+      - run: |
+          git config user.name "vers-one"
+          git config user.email "vers-one@users.noreply.github.com"
+          git add .
+          git commit -m "Update project versions to ${{ steps.update.outputs.newVersion }}"
+          git tag v${{ steps.update.outputs.newVersion }}
+          git push --atomic origin master v${{ steps.update.outputs.newVersion }}

EpubReader/.gitignore

@@ -0,0 +1,10 @@
+.vs/
+packages/
+bin/
+obj/
+.misc/
+*.user
+Documentation/docfx_output/
+Documentation/reference/*.yml
+Documentation/reference/.*
+coverage.*.xml

EpubReader/Documentation/docfx.json

@@ -0,0 +1,62 @@
+{
+    "metadata": [
+        {
+            "src": [
+                {
+                    "src": "../Source/VersOne.Epub/",
+                    "files": [
+                        "*.csproj"
+                    ]
+                }
+            ],
+            "dest": "reference",
+            "disableGitFeatures": false,
+            "disableDefaultFilter": false,
+            "properties": {
+                "TargetFramework": "netstandard1.3"
+            }
+        }
+    ],
+    "build": {
+        "content": [
+            {
+                "files": [
+                    "*.md",
+                    "toc.yml",
+                    "getting-started/*.md",
+                    "reference/*.md",
+                    "reference/*.yml",
+                    "examples/*.md",
+                    "examples/toc.yml",
+                    "malformed-epub/*.md",
+                    "faq/*.md"
+                ]
+            }
+        ],
+        "resource": [
+            {
+                "files": [
+                    "images/**"
+                ]
+            }
+        ],
+        "globalMetadata": {
+            "_appLogoPath": "images/logo.svg",
+            "_appFaviconPath": "images/favicon.ico"
+        },
+        "dest": "docfx_output",
+        "template": [
+            "default",
+            "templates/default"
+        ],
+        "xref": [
+            "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json"
+        ],
+        "postProcessors": [],
+        "markdownEngineName": "markdig",
+        "noLangKeyword": false,
+        "keepFileLink": false,
+        "cleanupCacheHistory": false,
+        "disableGitFeatures": false
+    }
+}

EpubReader/Documentation/examples/example-1.md

@@ -0,0 +1,9 @@
+# How to extract the table of contents
+
+## Example
+
+[!code-csharp[Main](../../Source/VersOne.Epub.ConsoleDemo/PrintNavigation.cs)]
+
+## See it in action
+
+Download the [.NET console demo app](https://github.com/vers-one/EpubReader/releases/latest/download/ConsoleDemo.zip), run it, and select the **1. Print book navigation tree (table of contents)** option.

EpubReader/Documentation/examples/example-2.md

@@ -0,0 +1,12 @@
+# How to extract the plain text of the whole book
+
+## Example
+
+> [!Important]
+> In order to run this example, you need to install the [HtmlAgilityPack Nuget package](https://www.nuget.org/packages/HtmlAgilityPack).
+
+[!code-csharp[Main](../../Source/VersOne.Epub.ConsoleDemo/ExtractPlainText.cs)]
+
+## See it in action
+
+Download the [.NET console demo app](https://github.com/vers-one/EpubReader/releases/latest/download/ConsoleDemo.zip), run it, and select the **2. Extract plain text from the whole book** option.

EpubReader/Documentation/examples/example-3.md

@@ -0,0 +1,9 @@
+# How to iterate over all EPUB files in a directory and gather some stats
+
+## Example
+
+[!code-csharp[Main](../../Source/VersOne.Epub.ConsoleDemo/TestDirectory.cs)]
+
+## See it in action
+
+Download the [.NET console demo app](https://github.com/vers-one/EpubReader/releases/latest/download/ConsoleDemo.zip), run it, and select the **3. Test the library by reading all EPUB files from a directory** option.

EpubReader/Documentation/examples/toc.yml

@@ -0,0 +1,6 @@
+- name: How to extract the table of contents
+  href: example-1.md
+- name: How to extract the plain text of the whole book
+  href: example-2.md
+- name: How to iterate over all EPUB files in a directory and gather some stats
+  href: example-3.md

EpubReader/Documentation/faq/index.md

@@ -0,0 +1,32 @@
+# Frequently Asked Questions
+
+## How to write EPUB files?
+
+EpubReader is only for reading EPUB files. It doesn't have a support to write them.
+
+## How to display a EPUB book in my application?
+
+EpubReader allows to parse and extract the content of a EPUB book but it doesn't have any means to render the extracted content. Since a EPUB book is essentially just a collection of HTML files (along with CSS, images, fonts, etc), you need a way to render these HTML files in the same way a web browser does.
+
+[WPF demo app](https://github.com/vers-one/EpubReader/tree/master/Source/VersOne.Epub.WpfDemo/) contains an example of how to render a EPUB book in a WPF application but the third-party HTML renderer used in this demo app is far from perfect and may have difficulties while rendering the content if the HTML structure is too complicated.
+
+## How to convert EPUB to PDF?
+
+EPUB and PDF are two very different formats. EPUB is a flow-layout format which means that it usually doesn't have page breaks and can be easily scaled to occupy the whole screen of the device regardless of its size and aspect ratio. PDF on the other hand is a fixed-layout paged-based format, i.e. it determines how the whole page should look like. For example, if you increase the font size in your EPUB reader, you will be reducing the amount of text that can fit on the "page" of the reader and the number of "pages" will go up. If you scale the content of a PDF book, the number of pages will stay the same but the content of the current page may not fit into the screen of the reader.
+
+Due to all this, there is no straightforward way to convert a EPUB book to PDF. In order to do that, you'll need to [render the EPUB book first](#how-to-display-a-epub-book-in-my-application) (allowing the end user to customize the page size, styles, fonts, font sizes, margins, table of contents' rendering options and so on) and then write the rendered content as a PDF file.
+
+## What are the differences between `EpubBook` and `EpubBookRef` classes?
+
+[`EpubBook`](xref:VersOne.Epub.EpubBook) is returned by [`EpubReader.ReadBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_ReadBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) and [`EpubReader.ReadBookAsync`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_ReadBookAsync_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) methods. [`EpubBookRef`](xref:VersOne.Epub.EpubBookRef) is returned by [`EpubReader.OpenBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_OpenBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) and [`EpubReader.OpenBookAsync`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_OpenBookAsync_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) methods.
+
+Both `EpubBook` and `EpubBookRef` classes contain parsed metadata of the EPUB book. However there are two main differences between them:
+1. Book content:
+    * `EpubBook` has all the content of the book (HTML, CSS, images and other files) loaded into the memory.
+    * `EpubBookRef` doesn't have the content loaded. Instead it lets the consumer to load individual content files on demand.
+2. File handle:
+    * `EpubBook`, once it's created, doesn't keep the EPUB file open, which means that the file can be changed or even deleted.
+    * `EpubBookRef` contains a reference to the EPUB file (to be able to load content files on demand). Instances of this class need to be disposed (either by calling the `Dispose` method or by enclosing it into a `using()` block) to release the file handle.
+
+In the end, you should use `EpubBookRef` if you don't want the whole content of the file to be loaded into memory (for example, you are concerned about the memory consumption or the time it takes to load the whole content). Conversely, you should use `EpubBook` if you don't want the EPUB file to remain open for the whole lifetime of the `EpubBookRef` instance.
+

EpubReader/Documentation/getting-started/index.md

@@ -0,0 +1,134 @@
+# Getting Started
+
+## 1. Create an app
+
+In your command prompt, run the following command to create a .NET console app:
+
+```cmd
+dotnet new console -o MyApp
+```
+
+Then, navigate to the new directory created by the previous command:
+
+```cmd
+cd MyApp
+```
+
+## 2. Install Nuget packages
+
+Install EpubReader package:
+
+```cmd
+dotnet add package VersOne.Epub
+```
+
+Also install HtmlAgilityPack package:
+
+```cmd
+dotnet add package HtmlAgilityPack
+```
+
+HtmlAgilityPack will be used to extract the plain text from the HTML files of the book.
+
+## 3. Edit the code
+
+Open the *Program.cs* file in the editor of your choice and replace the content of the file with the following:
+
+```csharp
+using System.Text;
+using VersOne.Epub;
+using HtmlAgilityPack;
+
+// Load the book into memory
+EpubBook book = EpubReader.ReadBook("test.epub");
+
+// Print the title and the author of the book
+Console.WriteLine($"Title: {book.Title}");
+Console.WriteLine($"Author: {book.Author}");
+Console.WriteLine();
+
+// Print the table of contents
+Console.WriteLine("TABLE OF CONTENTS:");
+PrintTableOfContents();
+Console.WriteLine();
+
+// Print the text content of all chapters in the book
+Console.WriteLine("CHAPTERS:");
+PrintChapters();
+
+void PrintTableOfContents()
+{
+    foreach (EpubNavigationItem navigationItem in book.Navigation)
+    {
+        PrintNavigationItem(navigationItem, 0);
+    }
+}
+
+void PrintNavigationItem(EpubNavigationItem navigationItem, int identLevel)
+{
+    Console.Write(new string(' ', identLevel * 2));
+    Console.WriteLine(navigationItem.Title);
+    foreach (EpubNavigationItem nestedNavigationItem in navigationItem.NestedItems)
+    {
+        PrintNavigationItem(nestedNavigationItem, identLevel + 1);
+    }
+}
+
+void PrintChapters()
+{
+    foreach (EpubTextContentFile textContentFile in book.ReadingOrder)
+    {
+        PrintTextContentFile(textContentFile);
+    }
+}
+
+void PrintTextContentFile(EpubTextContentFile textContentFile)
+{
+    HtmlDocument htmlDocument = new();
+    htmlDocument.LoadHtml(textContentFile.Content);
+    StringBuilder sb = new();
+    foreach (HtmlNode node in htmlDocument.DocumentNode.SelectNodes("//text()"))
+    {
+        sb.AppendLine(node.InnerText.Trim());
+    }
+    string contentText = sb.ToString();
+    Console.WriteLine(contentText);
+    Console.WriteLine();
+}
+```
+
+## 4. Run the app
+
+Copy any EPUB file into the *MyApp* directory and rename the file to *test.epub*.
+
+Then, run the app using the following command in the command prompt:
+
+```cmd
+dotnet run
+```
+
+The output should look similar to this:
+```text
+Title: Alice's Adventures in Wonderland
+Author: Lewis Carroll
+
+TABLE OF CONTENTS:
+CHAPTER I. Down the Rabbit-Hole
+CHAPTER II. The Pool of Tears
+CHAPTER III. A Caucus-Race and a Long Tale
+CHAPTER IV. The Rabbit Sends in a Little Bill
+CHAPTER V. Advice from a Caterpillar
+CHAPTER VI. Pig and Pepper
+CHAPTER VII. A Mad Tea-Party
+CHAPTER VIII. The Queen's Croquet-Ground
+CHAPTER IX. The Mock Turtle's Story
+CHAPTER X. The Lobster Quadrille
+CHAPTER XI. Who Stole the Tarts?
+CHAPTER XII. Alice's Evidence
+
+CHAPTERS:
+CHAPTER I. Down the Rabbit-Hole
+
+Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice 'without pictures or conversations?'
+...
+```

EpubReader/Documentation/index.md

@@ -0,0 +1,131 @@
+---
+title: EpubReader — .NET library for reading EPUB files
+documentType: index
+---
+<style type="text/css">
+html
+{
+    height: auto;
+}
+body
+{
+    background: linear-gradient(219.46deg, #110036 27.63%, #170059 100%), linear-gradient(219.46deg, #FFFFFF 27.63%, #19004E 100%), radial-gradient(100% 246.94% at 100% 100%, #FFFFFF 0%, #000353 100%), linear-gradient(121.18deg, #1400FF 0.45%, #3A0000 100%), linear-gradient(337.69deg, #DC52FF 8.44%, #00BDBD 84.19%), linear-gradient(222.34deg, #FFFFFF 12.99%, #008171 87.21%), linear-gradient(150.76deg, #0015D5 15.35%, #000B6C 89.57%);
+    background-blend-mode: screen, overlay, overlay, difference, difference, difference, normal;
+    display: flex;
+    flex-direction: column;
+    min-height: 100vh;
+}
+header
+{
+    position: static;
+}
+.navbar-inverse
+{
+  background-color: #00000040;
+  border-color: #00000040;
+}
+.navbar-inverse .navbar-nav > li > a
+{
+    color: #ccc;
+}
+#wrapper
+{
+    flex-grow: 1;
+    display: flex;
+    flex-direction: column;
+}
+.main-page
+{
+    flex-grow: 1;
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+    align-items: center;
+    color: #fff;
+    font-size: 20px;
+    padding: 100px;
+}
+.left-column
+{
+    width: 100%;
+    max-width: 540px;
+    margin-right: 25px;
+}
+.left-column .svg
+{
+    display: block;
+    width: 100%;
+    height: auto;
+}
+.left-column p
+{
+    text-align: center;
+}
+.buttons
+{
+    text-align: center;
+    margin-top: 32px;
+}
+.buttons a
+{
+    font-size: 20px;
+    margin-bottom: 16px;
+}
+.buttons .glyphicon
+{
+    margin-right: 5px;
+    font-size: 17px;
+}
+.github-logo
+{
+    height: 22px;
+    vertical-align: top;
+    position: relative;
+    top: 2px;
+    margin-right: 4px;
+}
+.right-column
+{
+    margin-left: 25px;
+}
+.right-column img
+{
+    width: 100%;
+    max-width: 415px;
+    border: 10px solid #fff;
+    border-radius: 10px;
+    box-shadow: 0 0 40px #333;
+}
+
+@media only screen and (max-width: 768px)
+{
+    .main-page
+    {
+        flex-direction: column;
+        padding: 16px;
+    }
+    .left-column
+    {
+        margin: 0;
+    }
+    .right-column
+    {
+        margin: 0;
+    }
+}
+</style>
+
+<div class="main-page">
+    <div class="left-column">
+        <p><img class="svg" src="images/logo-with-title.svg"></p>
+        <p class="subtitle">.NET library for reading EPUB files</p>
+        <div class="buttons">
+            <a href="getting-started/index.md" class="btn btn-success btn-lg"><span class="glyphicon glyphicon-send"></span>Get Started</a>
+            <a href="https://github.com/vers-one/EpubReader#download-the-latest-stable-release" class="btn btn-primary btn-lg"><span class="glyphicon glyphicon-save"></span>Download</a>
+            <a href="https://github.com/vers-one/EpubReader" class="btn btn-default btn-lg"><img src="images/github-icon.svg" class="github-logo">View on GitHub</a>
+        </div>
+    </div>
+    <div class="right-column">
+        <img src="images/epubreader-in-a-nutshell.png">
+    </div>
+</div>

EpubReader/Documentation/malformed-epub/index.md

@@ -0,0 +1,127 @@
+# Handling Malformed EPUB files
+
+EpubReader has a few configuration options to handle the most common cases of malformed EPUB files (i.e. the files that deviate from the EPUB specification). This can be done by creating an instance of the [`EpubReaderOptions`](xref:VersOne.Epub.Options.EpubReaderOptions) class, setting the appropriate properties (see the sections below for examples), and passing it to one of the methods of the [`EpubReader`](xref:VersOne.Epub.EpubReader) class.
+
+## Missing TOC attribute in EPUB 2 spine
+
+The `spine` element of the EPUB manifest contains the `toc` attribute which is [not required](https://www.w3.org/TR/epub-33/#sec-pkg-spine) for EPUB 3 books but is [required](https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4) for EPUB 2 books. There are [some EPUB 2 books](https://github.com/vers-one/EpubReader/issues/41) that have the `toc` attribute missing which causes EpubReader to throw the *"Incorrect EPUB spine: TOC is missing"* exception.
+
+[`PackageReaderOptions.IgnoreMissingToc`](xref:VersOne.Epub.Options.PackageReaderOptions#VersOne_Epub_Options_PackageReaderOptions_IgnoreMissingToc) property can be used to instruct EpubReader to ignore this error:
+
+```csharp
+EpubReaderOptions options = new()
+{
+    PackageReaderOptions = new PackageReaderOptions()
+    {
+        IgnoreMissingToc = true
+    }
+};
+```
+
+## Invalid EPUB manifest items
+
+The [`item` element](https://www.w3.org/TR/epub-33/#sec-item-elem) within the EPUB manifest has three required attributes: `id`, `href`, and `media-type`. There are [some EPUB books](https://github.com/vers-one/EpubReader/issues/47) that have at least one of those three attributes missing which causes EpubReader to throw the *"Incorrect EPUB manifest: item ... is missing"* exception.
+
+[`PackageReaderOptions.SkipInvalidManifestItems`](xref:VersOne.Epub.Options.PackageReaderOptions#VersOne_Epub_Options_PackageReaderOptions_SkipInvalidManifestItems) property can be used to instruct EpubReader to ignore this error:
+
+```csharp
+EpubReaderOptions options = new()
+{
+    PackageReaderOptions = new PackageReaderOptions()
+    {
+        SkipInvalidManifestItems = true
+    }
+};
+```
+
+## Missing content files
+
+The [`item` element](https://www.w3.org/TR/epub-33/#sec-item-elem) within the EPUB manifest has a required `href` attribute which points to a content file in the EPUB archive. There are [some EPUB books](https://github.com/vers-one/EpubReader/issues/25) that declare content files in the EPUB manifest which do not exist in the actual EPUB archive. This causes EpubReader to throw the *"EPUB parsing error: file ... was not found in the EPUB file"* exception. Such exception is thrown immediately, if application uses [`EpubReader.ReadBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_ReadBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) / [`EpubReader.ReadBookAsync`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_ReadBookAsync_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) methods because they try to load the whole content of the book into memory. [`EpubReader.OpenBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_OpenBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) and [`EpubReader.OpenBookAsync`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_OpenBookAsync_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) methods don't load the content, so the exception will be thrown only during an attempt to call any of those methods for a missing file:
+* [`EpubLocalContentFileRef`](xref:VersOne.Epub.EpubLocalContentFileRef) class:
+  * [`GetContentStream`](xref:VersOne.Epub.EpubLocalContentFileRef#VersOne_Epub_EpubLocalContentFileRef_GetContentStream)
+  * [`ReadContentAsBytes`](xref:VersOne.Epub.EpubLocalContentFileRef#VersOne_Epub_EpubLocalContentFileRef_ReadContentAsBytes)
+  * [`ReadContentAsBytesAsync`](xref:VersOne.Epub.EpubLocalContentFileRef#VersOne_Epub_EpubLocalContentFileRef_ReadContentAsBytesAsync)
+  * [`ReadContentAsText`](xref:VersOne.Epub.EpubLocalContentFileRef#VersOne_Epub_EpubLocalContentFileRef_ReadContentAsText)
+  * [`ReadContentAsTextAsync`](xref:VersOne.Epub.EpubLocalContentFileRef#VersOne_Epub_EpubLocalContentFileRef_ReadContentAsTextAsync)
+* [`EpubLocalByteContentFileRef`](xref:VersOne.Epub.EpubLocalByteContentFileRef) class:
+  * [`ReadContent`](xref:VersOne.Epub.EpubLocalByteContentFileRef#VersOne_Epub_EpubLocalByteContentFileRef_ReadContent)
+  * [`ReadContentAsync`](xref:VersOne.Epub.EpubLocalByteContentFileRef#VersOne_Epub_EpubLocalByteContentFileRef_ReadContentAsync)
+* [`EpubLocalTextContentFileRef`](xref:VersOne.Epub.EpubLocalTextContentFileRef) class:
+  * [`ReadContent`](xref:VersOne.Epub.EpubLocalTextContentFileRef#VersOne_Epub_EpubLocalTextContentFileRef_ReadContent)
+  * [`ReadContentAsync`](xref:VersOne.Epub.EpubLocalTextContentFileRef#VersOne_Epub_EpubLocalTextContentFileRef_ReadContentAsync)
+
+[`ContentReaderOptions.ContentFileMissing`](xref:VersOne.Epub.Options.ContentReaderOptions#VersOne_Epub_Options_ContentReaderOptions_ContentFileMissing) event can be used to detect those issues and to instruct EpubReader how to handle missing content files. Application can choose one of the following options:
+
+### 1. Get notified about missing content files
+
+```csharp
+EpubReaderOptions options = new();
+options.ContentReaderOptions.ContentFileMissing += (sender, e) =>
+{
+    Console.WriteLine($"Content file is missing: content file name = '{e.FileName}', content file path in the EPUB archive = '{e.FilePathInEpubArchive}', content type = {e.ContentType}, MIME type = {e.ContentMimeType}.");
+};
+```
+
+This will let application to be notified about the missing content file but will not prevent the exception from being thrown by the EpubReader.
+
+### 2. Suppress exceptions
+
+```csharp
+EpubReaderOptions options = new();
+options.ContentReaderOptions.ContentFileMissing += (sender, e) =>
+{
+    e.SuppressException = true;
+};
+```
+
+This will suppress all missing content file exceptions from being thrown. The EpubReader will treat missing content files as existing but empty files.
+
+### 3. Provide a replacement content
+
+```csharp
+EpubReaderOptions options = new();
+options.ContentReaderOptions.ContentFileMissing += (sender, e) =>
+{
+    if (e.FileName == "chapter1.html")
+    {
+        e.ReplacementContentStream = new FileStream(@"C:\Temp\chapter1-replacement.html", FileMode.Open);
+    }
+};
+```
+
+This will let application to substitute the content of a missing file with another content. The value of the [`ReplacementContentStream`](xref:VersOne.Epub.Options.ContentFileMissingEventArgs#VersOne_Epub_Options_ContentFileMissingEventArgs_ReplacementContentStream) property can be any [`Stream`](xref:System.IO.Stream). The content of the stream is read only once, after which it will be cached in the EPUB content reader. The stream will be closed after its content is fully read.
+
+## Missing content attribute for EPUB 2 NCX navigation points
+
+The `navPoint` element within the [EPUB 2 NCX navigation document](https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX) must contain a nested `content` element pointing to a content file associated with this navigation item. There are some EPUB 2 books that have navigation points without a nested `content` element which causes EpubReader to throw the *"EPUB parsing error: navigation point X should contain content"* exception.
+
+[`Epub2NcxReaderOptions.IgnoreMissingContentForNavigationPoints`](xref:VersOne.Epub.Options.Epub2NcxReaderOptions#VersOne_Epub_Options_Epub2NcxReaderOptions_IgnoreMissingContentForNavigationPoints) property can be used to instruct EpubReader to skip such navigation points (as well as all their child navigation points):
+
+```csharp
+EpubReaderOptions options = new()
+{
+    Epub2NcxReaderOptions = new Epub2NcxReaderOptions()
+    {
+        IgnoreMissingContentForNavigationPoints = true
+    }
+};
+```
+
+## Handling XML 1.1 schema files
+
+.NET [doesn't have](https://stackoverflow.com/questions/17231675/does-net-4-5-support-xml-1-1-yet-for-characters-invalid-in-xml-1-0) a built-in support for XML 1.1 files (only XML 1.0 files are currently supported). There are [some EPUB books](https://github.com/vers-one/EpubReader/issues/34) that have at least one of their schema files (typically the OPF package file) saved in XML 1.1 format, even though they don't use any XML 1.1 features. This causes EpubReader to throw an `XmlException` with the *"Version number '1.1' is invalid"* message.
+
+[`XmlReaderOptions.SkipXmlHeaders`](xref:VersOne.Epub.Options.XmlReaderOptions#VersOne_Epub_Options_XmlReaderOptions_SkipXmlHeaders) property can be used to enable a workaround for handling XML 1.1 files in EpubReader:
+
+```csharp
+EpubReaderOptions options = new()
+{
+    XmlReaderOptions = new XmlReaderOptions()
+    {
+        SkipXmlHeaders = true
+    }
+};
+```
+
+> [!Important]
+> Keep in mind that enabling this workaround adds an additional overhead for processing all schema files within EPUB book. If this property is set to `true`, EpubReader will check if an XML file contains a declaration (`<?xml version="..." encoding="UTF-8"?>`) in which case the reader will skip it before passing the file to the underlying .NET `XDocument` class.

EpubReader/Documentation/reference/index.md

@@ -0,0 +1,21 @@
+# Class Reference
+
+## Core classes
+
+|Class Name                                                        |Description                                                               |
+|------------------------------------------------------------------|--------------------------------------------------------------------------|
+|[`EpubReader`](xref:VersOne.Epub.EpubReader)                      |The main static class that provides methods like [`OpenBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_OpenBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_) and [`ReadBook`](xref:VersOne.Epub.EpubReader#VersOne_Epub_EpubReader_ReadBook_System_IO_Stream_VersOne_Epub_Options_EpubReaderOptions_)|
+|[`EpubBook`](xref:VersOne.Epub.EpubBook)                          |Represents a EPUB book with all its content and metadata                  |
+|[`EpubBookRef`](xref:VersOne.Epub.EpubBookRef)                    |Represents a EPUB book with its metadata but with no content              |
+|[`EpubContent`](xref:VersOne.Epub.EpubContent)                    |A container for all content files within the EPUB book                    |
+|[`EpubSchema`](xref:VersOne.Epub.EpubSchema)                      |Parsed content of all EPUB schema files                                   |
+|[`EpubReaderOptions`](xref:VersOne.Epub.Options.EpubReaderOptions)|Various options to configure the behavior of the EPUB reader              |
+
+## Namespaces
+
+|Namespace                                                  |Description                                                                                            |
+|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
+|[`VersOne.Epub`](xref:VersOne.Epub)                        |The main namespace containing core classes like [`EpubReader`](xref:VersOne.Epub.EpubReader) and [`EpubBook`](xref:VersOne.Epub.EpubBook)|
+|[`VersOne.Epub.Options`](xref:VersOne.Epub.Options)        |Contains classes that configure the behavior of the EPUB reader                                        |
+|[`VersOne.Epub.Schema`](xref:VersOne.Epub.Schema)          |Contains classes representing the raw EPUB schema fields                                               |
+|[`VersOne.Epub.Environment`](xref:VersOne.Epub.Environment)|Contains interfaces that provide environment abstractions (e.g. file system) to facilitate unit testing|

EpubReader/Documentation/templates/default/index.html.tmpl

@@ -0,0 +1,18 @@
+{{!include(/^styles/.*/)}}
+{{!include(/^fonts/.*/)}}
+{{!include(favicon.ico)}}
+{{!include(logo.svg)}}
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html>
+  {{>partials/head}}
+  <body data-spy="scroll" data-target="#affix">
+    <div id="wrapper">
+      <header>
+        {{>partials/navbar}}
+      </header>
+      {{{conceptual}}}
+    </div>
+    {{>partials/scripts}}
+  </body>
+</html>

EpubReader/Documentation/templates/default/partials/affix.tmpl.partial

@@ -0,0 +1,28 @@
+{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
+
+<div class="hidden-sm col-md-2" role="complementary">
+  <div class="sideaffix">
+    {{^_disableContribution}}
+    <div class="contribution">
+      <ul class="nav">
+        {{^sourceurl}}
+          {{#docurl}}
+          <li>
+            <a href="{{docurl}}" class="contribution-link">{{__global.improveThisDoc}}</a>
+          </li>
+          {{/docurl}}
+        {{/sourceurl}}
+        {{#sourceurl}}
+        <li>
+          <a href="{{sourceurl}}" class="contribution-link">{{__global.viewSource}}</a>
+        </li>
+        {{/sourceurl}}
+      </ul>
+    </div>
+    {{/_disableContribution}}
+    <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
+      <h5>{{__global.inThisArticle}}</h5>
+      <div></div>
+    </nav>
+  </div>
+</div>

EpubReader/Documentation/templates/default/partials/class.tmpl.partial

@@ -0,0 +1,199 @@
+{{>partials/class.header}}
+{{#children}}
+<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
+{{#children}}
+{{^_disableContribution}}
+{{#sourceurl}}
+<span class="small pull-right mobile-hide">
+  <a href="{{sourceurl}}">{{__global.viewSource}}</a>
+</span>{{/sourceurl}}
+{{/_disableContribution}}
+{{#overload}}
+<a id="{{id}}" data-uid="{{uid}}"></a>
+{{/overload}}
+<h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
+<div class="markdown level1 summary">{{{summary}}}</div>
+<div class="markdown level1 conceptual">{{{conceptual}}}</div>
+<h5 class="decalaration">{{__global.declaration}}</h5>
+{{#syntax}}
+<div class="codewrapper">
+  <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
+</div>
+{{#parameters.0}}
+<h5 class="parameters">{{__global.parameters}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+  <thead>
+    <tr>
+      <th>{{__global.type}}</th>
+      <th>{{__global.name}}</th>
+      <th>{{__global.description}}</th>
+    </tr>
+  </thead>
+  <tbody>
+{{/parameters.0}}
+{{#parameters}}
+    <tr>
+      <td>{{{type.specName.0.value}}}</td>
+      <td><span class="parametername">{{{id}}}</span></td>
+      <td>{{{description}}}</td>
+    </tr>
+{{/parameters}}
+{{#parameters.0}}
+  </tbody>
+</table>
+{{/parameters.0}}
+{{#return}}
+<h5 class="returns">{{__global.returns}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+  <thead>
+    <tr>
+      <th>{{__global.type}}</th>
+      <th>{{__global.description}}</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>{{{type.specName.0.value}}}</td>
+      <td>{{{description}}}</td>
+    </tr>
+  </tbody>
+</table>
+{{/return}}
+{{#typeParameters.0}}
+<h5 class="typeParameters">{{__global.typeParameters}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+  <thead>
+    <tr>
+      <th>{{__global.name}}</th>
+      <th>{{__global.description}}</th>
+    </tr>
+  </thead>
+  <tbody>
+{{/typeParameters.0}}
+{{#typeParameters}}
+    <tr>
+      <td><span class="parametername">{{{id}}}</span></td>
+      <td>{{{description}}}</td>
+    </tr>
+{{/typeParameters}}
+{{#typeParameters.0}}
+  </tbody>
+</table>
+{{/typeParameters.0}}
+{{#fieldValue}}
+<h5 class="fieldValue">{{__global.fieldValue}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+  <thead>
+    <tr>
+      <th>{{__global.type}}</th>
+      <th>{{__global.description}}</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>{{{type.specName.0.value}}}</td>
+      <td>{{{description}}}</td>
+    </tr>
+  </tbody>
+</table>
+{{/fieldValue}}
+{{#propertyValue}}
+<h5 class="propertyValue">Property type: {{{type.specName.0.value}}}</h5>
+{{/propertyValue}}
+{{#eventType}}
+<h5 class="eventType">Event type: {{{type.specName.0.value}}}</h5>
+{{/eventType}}
+{{/syntax}}
+{{#overridden}}
+<h5 class="overrides">{{__global.overrides}}</h5>
+<div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
+{{/overridden}}
+{{#remarks}}
+<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
+<div class="markdown level1 remarks">{{{remarks}}}</div>
+{{/remarks}}
+{{#example.0}}
+<h5 id="{{id}}_examples">{{__global.examples}}</h5>
+{{/example.0}}
+{{#example}}
+{{{.}}}
+{{/example}}
+{{#exceptions.0}}
+<h5 class="exceptions">{{__global.exceptions}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+  <thead>
+    <tr>
+      <th>{{__global.type}}</th>
+      <th>{{__global.condition}}</th>
+    </tr>
+  </thead>
+  <tbody>
+{{/exceptions.0}}
+{{#exceptions}}
+    <tr>
+      <td>{{{type.specName.0.value}}}</td>
+      <td>{{{description}}}</td>
+    </tr>
+{{/exceptions}}
+{{#exceptions.0}}
+  </tbody>
+</table>
+{{/exceptions.0}}
+{{#seealso.0}}
+<h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
+<div class="seealso">
+{{/seealso.0}}
+{{#seealso}}
+  {{#isCref}}
+    <div>{{{type.specName.0.value}}}</div>
+  {{/isCref}}
+  {{^isCref}}
+    <div>{{{url}}}</div>
+  {{/isCref}}
+{{/seealso}}
+{{#seealso.0}}
+</div>
+{{/seealso.0}}
+{{/children}}
+{{/children}}
+{{#implements.0}}
+<h3 id="implements">{{__global.implements}}</h3>
+{{/implements.0}}
+{{#implements}}
+<div>
+  {{#definition}}
+    <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
+  {{/definition}}
+  {{^definition}}
+    <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
+  {{/definition}}
+</div>
+{{/implements}}
+{{#extensionMethods.0}}
+<h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
+{{/extensionMethods.0}}
+{{#extensionMethods}}
+<div>
+  {{#definition}}
+    <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
+  {{/definition}}
+  {{^definition}}
+    <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
+  {{/definition}}
+</div>
+{{/extensionMethods}}
+{{#seealso.0}}
+<h3 id="seealso">{{__global.seealso}}</h3>
+<div class="seealso">
+{{/seealso.0}}
+{{#seealso}}
+  {{#isCref}}
+    <div>{{{type.specName.0.value}}}</div>
+  {{/isCref}}
+  {{^isCref}}
+    <div>{{{url}}}</div>
+  {{/isCref}}
+{{/seealso}}
+{{#seealso.0}}
+</div>
+{{/seealso.0}}

EpubReader/Documentation/toc.yml

@@ -0,0 +1,11 @@
+- name: Getting Started
+  href: getting-started/index.md
+- name: Class Reference
+  href: reference/
+  homepage: reference/index.md
+- name: Examples
+  href: examples/
+- name: Malformed EPUB files
+  href: malformed-epub/index.md
+- name: FAQ
+  href: faq/index.md

EpubReader/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org>

EpubReader/README.md

@@ -0,0 +1,47 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="Documentation/images/logo-with-title-dark.svg">
+  <source media="(prefers-color-scheme: light)" srcset="Documentation/images/logo-with-title-light.svg">
+  <img alt="EpubReader logo with title" src="Documentation/images/logo-with-title-light.svg">
+</picture>
+
+.NET library for reading EPUB files.
+
+[![Build](https://github.com/vers-one/EpubReader/actions/workflows/build.yml/badge.svg)](https://github.com/vers-one/EpubReader/actions/workflows/build.yml)
+[![Tests](https://github.com/vers-one/EpubReader/actions/workflows/test.yml/badge.svg)](https://github.com/vers-one/EpubReader/actions/workflows/test.yml)
+[![Test coverage](https://codecov.io/gh/vers-one/EpubReader/branch/master/graph/badge.svg?token=19RoYjPa56)](https://codecov.io/gh/vers-one/EpubReader)
+[![NuGet](https://img.shields.io/nuget/v/VersOne.Epub.svg)](https://www.nuget.org/packages/VersOne.Epub)
+
+Supported EPUB standards:
+* EPUB 2 (2.0, 2.0.1)
+* EPUB 3 (3.0, 3.0.1, 3.1, 3.2, 3.3)
+
+Supported runtimes:
+* .NET Standard >= 1.3 (includes .NET Core >= 1.0 and .NET >= 5)
+* .NET Framework >= 4.6
+
+[Download](#download-the-latest-stable-release) | [Documentation](https://os.vers.one/EpubReader/) | [WPF & .NET 9 console demo apps](#demo-apps)
+
+## EpubReader in a nutshell
+![EpubReader in a nutshell](Documentation/images/epubreader-in-a-nutshell.png)
+
+## Demo apps
+* [Download WPF demo app](https://github.com/vers-one/EpubReader/releases/latest/download/WpfDemo.zip) (WpfDemo.zip)
+
+  This .NET Framework application demonstrates how to open EPUB books and extract their content using the library.
+
+  HTML renderer used in this demo app may have difficulties while rendering content for some of the books if the HTML structure is too complicated.
+
+* [Download .NET 9 console demo app](https://github.com/vers-one/EpubReader/releases/latest/download/ConsoleDemo.zip) (ConsoleDemo.zip)
+
+  This .NET 9 console application demonstrates how to open EPUB books and retrieve their text content.
+
+## Examples
+1. [How to extract the table of contents.](https://os.vers.one/EpubReader/examples/example-1.html)
+2. [How to extract the plain text of the whole book.](https://os.vers.one/EpubReader/examples/example-2.html)
+3. [How to iterate over all EPUB files in a directory and gather some stats.](https://os.vers.one/EpubReader/examples/example-3.html)
+
+## Download the latest stable release
+* [Download from nuget.org](https://www.nuget.org/packages/VersOne.Epub)
+* DLL file from GitHub:
+  * [for .NET Framework](https://github.com/vers-one/EpubReader/releases/latest/download/VersOne.Epub.Net46.zip)
+  * [for .NET Standard](https://github.com/vers-one/EpubReader/releases/latest/download/VersOne.Epub.NetStandard.zip)

EpubReader/Release checklist.md

@@ -0,0 +1,18 @@
+# Release checklist
+
+## Checks
+
+1. Release milestone doesn't have open issues.
+2. Documentation has been updated with the changes from the new release.
+3. README.md file is updated, if necessary.
+4. All CI checks are passing for the last commit.
+
+## Release procedure
+
+1. Prepare the change log markdown file for the GitHub release description.
+2. Run **Generate documentation** action.
+3. Run **Update versions** action with version = `<major>.<minor>.<patch>` format (without `v` prefix). If this is a pre-release version which requires `-alpha` or `-beta` postfixes, the versions need to be updated via a manual code change.
+4. Run **Publish to Nuget** action.
+5. Run **Create release** action with version = `<major>.<minor>.<patch>` format (without `v` prefix). This action can also be used for pre-release versions which require `-alpha` or `-beta` postfixes.
+6. Update the release description for the release draft generated at the previous step and publish the release.
+7. Make sure that Nuget package published at the step 5 is visible on the Nuget website and the Nuget badge on the Readme page is pointing to the new release.

EpubReader/Source/.editorconfig

@@ -0,0 +1,78 @@
+[*]
+
+# Visual Studio Spell Checker configuration
+spelling_languages = en-us
+spelling_error_severity = error
+spelling_exclusion_path = .\spell_exclusion.dic
+
+[*.cs]
+
+# IDE0005: Using directive is unnecessary.
+dotnet_diagnostic.IDE0005.severity = error
+
+# IDE0008: Use explicit type
+csharp_style_var_when_type_is_apparent = false
+csharp_style_var_for_built_in_types = false
+csharp_style_var_elsewhere = false
+dotnet_diagnostic.IDE0008.severity = error
+
+# IDE0017: Use object initializers
+dotnet_diagnostic.IDE0017.severity = none
+
+# IDE0018: Inline variable declaration
+dotnet_diagnostic.IDE0018.severity = error
+
+# IDE0060: Remove unused parameter
+dotnet_diagnostic.IDE0060.severity = error
+
+# IDE0090: Use 'new(...)'
+dotnet_diagnostic.IDE0090.severity = error
+
+# IDE0130: Namespace does not match folder structure
+dotnet_style_namespace_match_folder = false
+
+# S1168: Empty arrays and collections should be returned instead of null
+dotnet_diagnostic.S1168.severity = none
+
+# S3267: Loops should be simplified with "LINQ" expressions
+dotnet_diagnostic.S3267.severity = none
+
+# S3925: "ISerializable" should be implemented correctly
+# .NET Standard 1.3 doesn't have [Serializable] attribute
+dotnet_diagnostic.S3925.severity = none
+
+# S3963: "static" fields should be initialized inline
+dotnet_diagnostic.S3963.severity = none
+
+# SA1101: Prefix local calls with this
+dotnet_diagnostic.SA1101.severity = none
+
+# SA1117: Parameters should be on same line or separate lines
+dotnet_diagnostic.SA1117.severity = none
+
+# SA1121: Use built-in type alias
+dotnet_diagnostic.SA1121.severity = none
+
+# SA1200: Using directives should be placed correctly
+dotnet_diagnostic.SA1200.severity = none
+
+# SA1310: Field names should not contain underscore
+dotnet_diagnostic.SA1310.severity = none
+
+# SA1311: Static readonly fields should begin with upper-case letter
+dotnet_diagnostic.SA1311.severity = none
+
+# SA1413: Use trailing comma in multi-line initializers
+dotnet_diagnostic.SA1413.severity = none
+
+# SA1513: Closing brace should be followed by blank line
+dotnet_diagnostic.SA1513.severity = none
+
+# SA1633: File should have header
+dotnet_diagnostic.SA1633.severity = none
+
+# SA1516: Elements should be separated by blank line
+dotnet_diagnostic.SA1516.severity = none
+
+# xUnit1004: Test methods should not be skipped
+dotnet_diagnostic.xUnit1004.severity = none

EpubReader/Source/EpubReader.sln

@@ -0,0 +1,49 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32210.238
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VersOne.Epub", "VersOne.Epub\VersOne.Epub.csproj", "{313E44F0-4BC2-4A4F-B24B-C29D8FFB7C4E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VersOne.Epub.WpfDemo", "VersOne.Epub.WpfDemo\VersOne.Epub.WpfDemo.csproj", "{2C48D6FB-EC93-4B79-8E52-79B579B3C324}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VersOne.Epub.ConsoleDemo", "VersOne.Epub.ConsoleDemo\VersOne.Epub.ConsoleDemo.csproj", "{A6ED4735-3D37-4E44-BEE4-218C6BBAC1BD}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{60C29813-44AB-4FBF-B12C-81FF5968BFC8}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+		spell_exclusion.dic = spell_exclusion.dic
+	EndProjectSection
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VersOne.Epub.Test", "VersOne.Epub.Test\VersOne.Epub.Test.csproj", "{2FCDA010-24D2-43E4-B58C-07E88434A966}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{313E44F0-4BC2-4A4F-B24B-C29D8FFB7C4E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{313E44F0-4BC2-4A4F-B24B-C29D8FFB7C4E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{313E44F0-4BC2-4A4F-B24B-C29D8FFB7C4E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{313E44F0-4BC2-4A4F-B24B-C29D8FFB7C4E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2C48D6FB-EC93-4B79-8E52-79B579B3C324}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2C48D6FB-EC93-4B79-8E52-79B579B3C324}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2C48D6FB-EC93-4B79-8E52-79B579B3C324}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2C48D6FB-EC93-4B79-8E52-79B579B3C324}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A6ED4735-3D37-4E44-BEE4-218C6BBAC1BD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A6ED4735-3D37-4E44-BEE4-218C6BBAC1BD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A6ED4735-3D37-4E44-BEE4-218C6BBAC1BD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A6ED4735-3D37-4E44-BEE4-218C6BBAC1BD}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2FCDA010-24D2-43E4-B58C-07E88434A966}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2FCDA010-24D2-43E4-B58C-07E88434A966}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2FCDA010-24D2-43E4-B58C-07E88434A966}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2FCDA010-24D2-43E4-B58C-07E88434A966}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {8EEE6FCA-0A83-4845-805D-537EBCA647E1}
+	EndGlobalSection
+EndGlobal

EpubReader/Source/VersOne.Epub.ConsoleDemo/ExtractPlainText.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Text;
+using HtmlAgilityPack;
+
+namespace VersOne.Epub.ConsoleDemo
+{
+    internal static class ExtractPlainText
+    {
+        public static void Run(string filePath)
+        {
+            EpubBook book = EpubReader.ReadBook(filePath);
+            foreach (EpubLocalTextContentFile textContentFile in book.ReadingOrder)
+            {
+                PrintTextContentFile(textContentFile);
+            }
+        }
+
+        private static void PrintTextContentFile(EpubLocalTextContentFile textContentFile)
+        {
+            HtmlDocument htmlDocument = new();
+            htmlDocument.LoadHtml(textContentFile.Content);
+            StringBuilder sb = new();
+            foreach (HtmlNode node in htmlDocument.DocumentNode.SelectNodes("//text()"))
+            {
+                sb.AppendLine(node.InnerText.Trim());
+            }
+            string contentText = sb.ToString();
+            Console.WriteLine(contentText);
+            Console.WriteLine();
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.ConsoleDemo/PrintNavigation.cs

@@ -0,0 +1,30 @@
+using System;
+
+namespace VersOne.Epub.ConsoleDemo
+{
+    internal static class PrintNavigation
+    {
+        public static void Run(string filePath)
+        {
+            using (EpubBookRef bookRef = EpubReader.OpenBook(filePath))
+            {
+                Console.WriteLine("Navigation:");
+                foreach (EpubNavigationItemRef navigationItemRef in bookRef.GetNavigation())
+                {
+                    PrintNavigationItem(navigationItemRef, 0);
+                }
+            }
+            Console.WriteLine();
+        }
+
+        private static void PrintNavigationItem(EpubNavigationItemRef navigationItemRef, int identLevel)
+        {
+            Console.Write(new string(' ', identLevel * 2));
+            Console.WriteLine(navigationItemRef.Title);
+            foreach (EpubNavigationItemRef nestedNavigationItemRef in navigationItemRef.NestedItems)
+            {
+                PrintNavigationItem(nestedNavigationItemRef, identLevel + 1);
+            }
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.ConsoleDemo/Program.cs

@@ -0,0 +1,91 @@
+using System;
+using System.IO;
+
+namespace VersOne.Epub.ConsoleDemo
+{
+    internal static class Program
+    {
+        private static void Main()
+        {
+            char input = '\0';
+            while (input != 'Q')
+            {
+                Console.WriteLine("Select example:");
+                Console.WriteLine("1. Print book navigation tree (table of contents)");
+                Console.WriteLine("2. Extract plain text from the whole book");
+                Console.WriteLine("3. Test the library by reading all EPUB files from a directory");
+                Console.WriteLine("Q. Exit");
+                input = Char.ToUpper(Console.ReadKey(true).KeyChar);
+                Console.WriteLine();
+                switch (input)
+                {
+                    case '1':
+                        RunFileExample(PrintNavigation.Run);
+                        break;
+                    case '2':
+                        RunFileExample(ExtractPlainText.Run);
+                        break;
+                    case '3':
+                        RunDirectoryExample(TestDirectory.Run);
+                        break;
+                    case 'Q':
+                        break;
+                    default:
+                        Console.WriteLine("Input is not recognized. Please try again.");
+                        Console.WriteLine();
+                        break;
+                }
+            }
+        }
+
+        private static void RunFileExample(Action<string> example)
+        {
+            Console.Write("Enter the path to the EPUB file: ");
+            string filePath = Console.ReadLine();
+            Console.WriteLine();
+            if (File.Exists(filePath) && Path.GetExtension(filePath).ToLower() == ".epub")
+            {
+                try
+                {
+                    example(filePath);
+                }
+                catch (Exception ex)
+                {
+                    Console.WriteLine("Exception was thrown:");
+                    Console.WriteLine(ex.ToString());
+                    Console.WriteLine();
+                }
+            }
+            else
+            {
+                Console.WriteLine("File doesn't exist.");
+                Console.WriteLine();
+            }
+        }
+
+        private static void RunDirectoryExample(Action<string> example)
+        {
+            Console.Write("Enter the path to the directory with EPUB files: ");
+            string directoryPath = Console.ReadLine();
+            Console.WriteLine();
+            if (Directory.Exists(directoryPath))
+            {
+                try
+                {
+                    example(directoryPath);
+                }
+                catch (Exception ex)
+                {
+                    Console.WriteLine("Exception was thrown:");
+                    Console.WriteLine(ex.ToString());
+                    Console.WriteLine();
+                }
+            }
+            else
+            {
+                Console.WriteLine("Directory doesn't exist.");
+                Console.WriteLine();
+            }
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.ConsoleDemo/Properties/PublishProfiles/FolderProfile.pubxml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+https://go.microsoft.com/fwlink/?LinkID=208121.
+-->
+<Project>
+  <PropertyGroup>
+    <PublishProtocol>FileSystem</PublishProtocol>
+    <Configuration>Release</Configuration>
+    <Platform>Any CPU</Platform>
+    <TargetFramework>net9.0</TargetFramework>
+    <PublishDir>bin\Release\net9.0\publish\win-x64\</PublishDir>
+    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
+    <SelfContained>false</SelfContained>
+    <PublishSingleFile>true</PublishSingleFile>
+    <PublishReadyToRun>false</PublishReadyToRun>
+  </PropertyGroup>
+</Project>

EpubReader/Source/VersOne.Epub.ConsoleDemo/TestDirectory.cs

@@ -0,0 +1,116 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+
+namespace VersOne.Epub.ConsoleDemo
+{
+    internal static class TestDirectory
+    {
+        public static void Run(string directoryPath)
+        {
+            int totalFiles = 0;
+            Dictionary<string, int> filesByVersion = new();
+            List<string> filesWithErrors = new();
+            TestEpubDirectory(directoryPath, ref totalFiles, filesByVersion, filesWithErrors);
+            if (totalFiles == 0)
+            {
+                Console.WriteLine("No EPUB files found.");
+            }
+            else
+            {
+                if (filesByVersion.Any(version => version.Value > 0))
+                {
+                    Console.WriteLine("Statistics");
+                    Console.WriteLine("-----------------------------------");
+                    Console.Write("Versions: ");
+                    bool firstItem = true;
+                    foreach (string epubVersionString in filesByVersion.Keys.OrderBy(version => version))
+                    {
+                        if (firstItem)
+                        {
+                            firstItem = false;
+                        }
+                        else
+                        {
+                            Console.Write(", ");
+                        }
+                        Console.Write(epubVersionString + ": " + filesByVersion[epubVersionString]);
+                    }
+                    Console.WriteLine(".");
+                }
+                if (filesWithErrors.Any())
+                {
+                    Console.WriteLine("Files with errors:");
+                    foreach (string filePath in filesWithErrors)
+                    {
+                        Console.WriteLine(filePath);
+                    }
+                }
+                else
+                {
+                    Console.WriteLine("No errors.");
+                }
+                Console.WriteLine();
+            }
+        }
+
+        private static void TestEpubDirectory(string directoryPath, ref int totalFiles, Dictionary<string, int> filesByVersion, List<string> filesWithErrors)
+        {
+            foreach (string subdirectoryPath in Directory.EnumerateDirectories(directoryPath))
+            {
+                TestEpubDirectory(subdirectoryPath, ref totalFiles, filesByVersion, filesWithErrors);
+            }
+            foreach (string filePath in Directory.EnumerateFiles(directoryPath, "*.epub"))
+            {
+                TestEpubFile(filePath, filesByVersion, filesWithErrors);
+                totalFiles++;
+            }
+        }
+
+        private static void TestEpubFile(string epubFilePath, Dictionary<string, int> filesByVersion, List<string> filesWithErrors)
+        {
+            Console.WriteLine($"File: {epubFilePath}");
+            Console.WriteLine("-----------------------------------");
+            try
+            {
+                using EpubBookRef bookRef = EpubReader.OpenBook(epubFilePath);
+                string epubVersionString = bookRef.Schema.Package.GetVersionString();
+                if (filesByVersion.TryGetValue(epubVersionString, out int fileCount))
+                {
+                    fileCount++;
+                }
+                else
+                {
+                    fileCount = 1;
+                }
+                filesByVersion[epubVersionString] = fileCount;
+                Console.WriteLine($"EPUB version: {epubVersionString}");
+                Console.WriteLine($"Total files: {bookRef.Content.AllFiles.Local.Count}, HTML files: {bookRef.Content.Html.Local.Count}," +
+                    $" CSS files: {bookRef.Content.Css.Local.Count}, image files: {bookRef.Content.Images.Local.Count}, font files: {bookRef.Content.Fonts.Local.Count}.");
+                Console.WriteLine($"Reading order: {bookRef.GetReadingOrder().Count} file(s).");
+                Console.WriteLine("Navigation:");
+                foreach (EpubNavigationItemRef navigationItemRef in bookRef.GetNavigation())
+                {
+                    PrintNavigationItem(navigationItemRef, 0);
+                }
+            }
+            catch (Exception exception)
+            {
+                Console.WriteLine(exception.ToString());
+                filesWithErrors.Add(epubFilePath);
+            }
+            Console.WriteLine();
+        }
+
+        private static void PrintNavigationItem(EpubNavigationItemRef navigationItemRef, int identLevel)
+        {
+            Console.Write(new string(' ', identLevel * 2));
+            Console.WriteLine(navigationItemRef.Title);
+            foreach (EpubNavigationItemRef nestedNavigationItemRef in navigationItemRef.NestedItems)
+            {
+                PrintNavigationItem(nestedNavigationItemRef, identLevel + 1);
+            }
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.ConsoleDemo/VersOne.Epub.ConsoleDemo.csproj

@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFramework>net9.0</TargetFramework>
+		<Authors>vers</Authors>
+		<Copyright>vers, 2015-2024</Copyright>
+		<Version>3.3.4</Version>
+		<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
+		<DocumentationFile></DocumentationFile>
+		<GenerateDocumentationFile>True</GenerateDocumentationFile>
+		<TreatWarningsAsErrors>True</TreatWarningsAsErrors>
+	</PropertyGroup>
+	<ItemGroup>
+		<AdditionalFiles Include="stylecop.json" />
+	</ItemGroup>
+	<ItemGroup>
+		<PackageReference Include="HtmlAgilityPack" Version="1.11.61" />
+		<PackageReference Include="SonarAnalyzer.CSharp" Version="9.25.0.90414">
+			<PrivateAssets>all</PrivateAssets>
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.406">
+			<PrivateAssets>all</PrivateAssets>
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+	</ItemGroup>
+	<ItemGroup>
+		<ProjectReference Include="..\VersOne.Epub\VersOne.Epub.csproj" />
+	</ItemGroup>
+</Project>

EpubReader/Source/VersOne.Epub.ConsoleDemo/stylecop.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
+    "settings":
+    {
+        "documentationRules":
+        {
+            "documentInternalElements": false
+        },
+        "layoutRules":
+        {
+            "newlineAtEndOfFile": "require"
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.Test/Comparers/CollectionComparer.cs

@@ -0,0 +1,32 @@
+namespace VersOne.Epub.Test.Comparers
+{
+    internal static class CollectionComparer
+    {
+        public static void CompareCollections<T>(IList<T> expected, IList<T> actual, Action<T, T> elementComparer)
+        {
+            Assert.Equal(expected.Count, actual.Count);
+            for (int i = 0; i < expected.Count; i++)
+            {
+                elementComparer(expected[i], actual[i]);
+            }
+        }
+
+        public static void CompareDictionaries<TKey, TValue>(IDictionary<TKey, TValue> expected, IDictionary<TKey, TValue> actual, Action<TValue, TValue> elementValueComparer)
+        {
+            Assert.Equal(expected.Count, actual.Count);
+            foreach (KeyValuePair<TKey, TValue> expectedKeyValuePair in expected)
+            {
+                TKey expectedKey = expectedKeyValuePair.Key;
+                TValue expectedValue = expectedKeyValuePair.Value;
+                if (actual.TryGetValue(expectedKey, out TValue? actualValue))
+                {
+                    elementValueComparer(expectedValue, actualValue);
+                }
+                else
+                {
+                    Assert.Fail($"Key {expectedKey} was expected but not found in the dictionary.");
+                }
+            }
+        }
+    }
+}

EpubReader/Source/VersOne.Epub.Test/Comparers/Epub2NcxComparer.cs

@@ -0,0 +1,142 @@
+using VersOne.Epub.Schema;
+
+namespace VersOne.Epub.Test.Comparers
+{
+    internal static class Epub2NcxComparer
+    {
+        public static void CompareEpub2Ncxes(Epub2Ncx? expected, Epub2Ncx? actual)
+        {
+            if (expected == null)
+            {
+                Assert.Null(actual);
+            }
+            else
+            {
+                Assert.NotNull(actual);
+                CompareEpub2NcxHeads(expected.Head, actual.Head);
+                Assert.Equal(expected.DocTitle, actual.DocTitle);
+                Assert.Equal(expected.DocAuthors, actual.DocAuthors);
+                CompareEpub2NcxNavigationMaps(expected.NavMap, actual.NavMap);
+                CompareEpub2NcxPageLists(expected.PageList, actual.PageList);
+                CompareEpub2NcxNavigationListLists(expected.NavLists, actual.NavLists);
+            }
+        }
+
+        public static void CompareEpub2NcxHeads(Epub2NcxHead expected, Epub2NcxHead actual)
+        {
+            Assert.NotNull(actual);
+            CollectionComparer.CompareCollections(expected.Items, actual.Items, CompareEpub2NcxHeadMetas);
+        }
+
+        public static void CompareEpub2NcxNavigationMaps(Epub2NcxNavigationMap expected, Epub2NcxNavigationMap actual)
+        {
+            Assert.NotNull(actual);
+            CompareEpub2NcxNavigationPointLists(expected.Items, actual.Items);
+        }
+
+        public static void CompareEpub2NcxPageLists(Epub2NcxPageList? expected, Epub2NcxPageList? actual)
+        {
+            if (expected == null)
+            {
+                Assert.Null(actual);
+            }
+            else
+            {
+                Assert.NotNull(actual);
+                CompareEpub2NcxPageTargetLists(expected.Items, actual.Items);
+            }
+        }
+
+        public static void CompareEpub2NcxNavigationTargetLists(List<Epub2NcxNavigationTarget> expected, List<Epub2NcxNavigationTarget> actual)
+        {
+            CollectionComparer.CompareCollections(expected, actual, CompareEpub2NcxNavigationTargets);
+        }
+
+        public static void CompareEpub2NcxNavigationTargets(Epub2NcxNavigationTarget expected, Epub2NcxNavigationTarget actual)
+        {
+            Assert.Equal(expected.Id, actual.Id);
+            Assert.Equal(expected.Value, actual.Value);
+            Assert.Equal(expected.Class, actual.Class);
+            Assert.Equal(expected.PlayOrder, actual.PlayOrder);
+            CompareEpub2NcxNavigationLabelLists(expected.NavigationLabels, actual.NavigationLabels);
+            CompareEpub2NcxContents(expected.Content, actual.Content);
+        }
+
+        public static void CompareEpub2NcxPageTargetLists(List<Epub2NcxPageTarget> expected, List<Epub2NcxPageTarget> actual)
+        {
+            CollectionComparer.CompareCollections(expected, actual, CompareEpub2NcxPageTargets);
+        }
+
+        public static void CompareEpub2NcxPageTargets(Epub2NcxPageTarget expected, Epub2NcxPageTarget actual)
+        {
+            Assert.Equal(expected.Id, actual.Id);
+            Assert.Equal(expected.Value, actual.Value);
+            Assert.Equal(expected.Type, actual.Type);
+            Assert.Equal(expected.Class, actual.Class);
+            Assert.Equal(expected.PlayOrder, actual.PlayOrder);
+            CompareEpub2NcxNavigationLabelLists(expected.NavigationLabels, actual.NavigationLabels);
+            CompareEpub2NcxContents(expected.Content, actual.Content);
+        }
+
+        public static void CompareEpub2NcxHeadMetas(Epub2NcxHeadMeta expected, Epub2NcxHeadMeta actual)
+        {
+            Assert.Equal(expected.Name, actual.Name);
+            Assert.Equal(expected.Content, actual.Content);
+            Assert.Equal(expected.Scheme, actual.Scheme);
+        }
+
+        public static void CompareEpub2NcxNavigationListLists(List<Epub2NcxNavigationList> expected, List<Epub2NcxNavigationList> actual)
+        {
+            CollectionComparer.CompareCollections(expected, actual, CompareEpub2NcxNavigationLists);
+        }
+
+        public static void CompareEpub2NcxNavigationLists(Epub2NcxNavigationList expected, Epub2NcxNavigationList actual)
+        {
+            Assert.Equal(expected.Id, actual.Id);
+            Assert.Equal(expected.Class, actual.Class);
+            CompareEpub2NcxNavigationLabelLists(expected.NavigationLabels, actual.NavigationLabels);
+            CompareEpub2NcxNavigationTargetLists(expected.NavigationTargets, actual.NavigationTargets);
+        }
+
+        public static void CompareEpub2NcxNavigationLabelLists(List<Epub2NcxNavigationLabel> expected, List<Epub2NcxNavigationLabel> actual)
+        {
+            CollectionComparer.CompareCollections(expected, actual, CompareEpub2NcxNavigationLabels);
+        }
+
+        public static void CompareEpub2NcxNavigationLabels(Epub2NcxNavigationLabel expected, Epub2NcxNavigationLabel actual)
+        {
+            Assert.NotNull(actual);
+            Assert.Equal(expected.Text, actual.Text);
+        }
+
+        public static void CompareEpub2NcxNavigationPointLists(List<Epub2NcxNavigationPoint> expected, List<Epub2NcxNavigationPoint> actual)
+        {
+            CollectionComparer.CompareCollections(expected, actual, CompareEpub2NcxNavigationPoints);
+        }
+
+        public static void CompareEpub2NcxNavigationPoints(Epub2NcxNavigationPoint expected, Epub2NcxNavigationPoint actual)
+        {
+            Assert.NotNull(actual);
+            Assert.Equal(expected.Id, actual.Id);
+            Assert.Equal(expected.Class, actual.Class);
+            Assert.Equal(expected.PlayOrder, actual.PlayOrder);
+            CompareEpub2NcxNavigationLabelLists(expected.NavigationLabels, actual.NavigationLabels);
+            CompareEpub2NcxContents(expected.Content, actual.Content);
+            CompareEpub2NcxNavigationPointLists(expected.ChildNavigationPoints, actual.ChildNavigationPoints);
+        }
+
+        public static void CompareEpub2NcxContents(Epub2NcxContent? expected, Epub2NcxContent? actual)
+        {
+            if (expected == null)
+            {
+                Assert.Null(actual);
+            }
+            else
+            {
+                Assert.NotNull(actual);
+                Assert.Equal(expected.Id, actual.Id);
+                Assert.Equal(expected.Source, actual.Source);
+            }
+        }
+    }
+}