Merge pull request #104 from edrlab/epub-doc-sources-en

Isolated markdown english content for epub doc

epub-doc/en/src/_data/metadata.json

@@ -0,0 +1,26 @@
+{
+  "dc": {
+    "title": "Thorium Reader Documentation English",
+    "creator": "EDRLab",
+    "publisher": "EDRLab",
+    "description": "Get to know better Thorium Reader",
+    "identifier": "com.github.edrlab.thorium-reader-doc-epub.0.0.1",
+    "language": "en",
+    "rights": "Creative Commons Attribution-Share Alike (CC BY-SA) license."
+  },
+  "links": [
+    {
+      "rel": "cc:license",
+      "href": "http://creativecommons.org/licenses/by-sa/3.0/"
+    }
+  ],
+  "properties": {
+    "dcterms:modified": "2023-10-01T00:00:00Z",
+    "schema:accessibilityFeature": ["alternativeText", "readingOrder","structuralNavigation", "tableOfContents"],
+    "schema:accessibilitySummary": "The publication has been evaluated for accessibility.",
+    "schema:accessibilityHazard": "none",
+    "schema:accessMode": ["textual","visual"],
+    "schema:accessModeSufficient": "textual",
+    "schema:accessibilityControl": ["fullKeyboardControl", "fullMouseControl"]
+  }
+}

epub-doc/en/src/_data/pub.json

@@ -0,0 +1,13 @@
+{
+  "cover": {
+    "page": "cover/index.xhtml",
+    "src": "resources/images/cover.png",
+    "alt": "Cartoon bear with construction tools"
+  },
+  "toc": {
+    "page": "toc/index.xhtml"
+  },
+  "readingOrder": [
+    "_index", "000_todo", "100_quickStart", "110_notes", "210_reading", "211_moving", "212_ImageZoom", "212_whereAmI", "213_search", "214_bookmarks", "215_ReadingParameters", "220_organizing", "221_libraries", "221_maths", "222_catalogs", "223_search", "223_tags", "230_TTS", "300_accessibility", "301_A11yInfos", "310_natives", "310_screenReaders", "391_epubTest", "400_ressources", "401_functions", "402_Keyboard-shortcuts", "403_gesture", "406_formats", "420_glossary", "430_faq", "900_about", "902_credits", "903_support", "904_issues", "905_contribute", "912_accessibility_declaration", "913_licence"
+  ]
+}

epub-doc/en/src/_data/resources.json

@@ -0,0 +1 @@
+["resources/css/edrlabpublications.css","resources/css/page.css","resources/css/style.css","resources/fonts/TruenoBd.otf","resources/fonts/TruenoLt.otf","resources/fonts/TruenoLtIt.otf","resources/images/asterism.svg","resources/images/cover.png","resources/images/icons3/2cols-icon.svg","resources/images/icons3/BookmarkRemove-icon.svg","resources/images/icons3/Minus-Bold.svg","resources/images/icons3/Plus-bold.svg","resources/images/icons3/SaveAs-icon.svg","resources/images/icons3/TextOutline-icon.svg","resources/images/icons3/TextStrikethrough-icon.svg","resources/images/icons3/add-alone.svg","resources/images/icons3/addTag-icon.svg","resources/images/icons3/align-auto-icon.svg","resources/images/icons3/align-justify-icon.svg","resources/images/icons3/align-right-icon.svg","resources/images/icons3/alignleft-icon.svg","resources/images/icons3/annotation-icon.svg","resources/images/icons3/annotations-icon.svg","resources/images/icons3/arrow-right.svg","resources/images/icons3/arrowFirst-icon.svg","resources/images/icons3/arrowLast-icon.svg","resources/images/icons3/aspect_ratio-black-18dp.svg","resources/images/icons3/audio-next-icon.svg","resources/images/icons3/audio-pause-icon.svg","resources/images/icons3/audio-play-icon.svg","resources/images/icons3/audio-previous-icon.svg","resources/images/icons3/audio-stop-icon.svg","resources/images/icons3/available-icon.svg","resources/images/icons3/avatar.svg","resources/images/icons3/backward-icon.svg","resources/images/icons3/baseline-add-24px.svg","resources/images/icons3/baseline-arrow_forward_ios-24px.svg","resources/images/icons3/baseline-arrow_left_ios-24px.svg","resources/images/icons3/baseline-close-24px.svg","resources/images/icons3/baseline-mute-24px.svg","resources/images/icons3/baseline-search-24px-grey.svg","resources/images/icons3/bin-icon.svg","resources/images/icons3/bookOpen-icon.svg","resources/images/icons3/bookmarkMultiple-icon.svg","resources/images/icons3/bookmarkSingle-icon.svg","resources/images/icons3/borrow-icon.svg","resources/images/icons3/breadcrumbsNav-icon.svg","resources/images/icons3/calendar-icon.svg","resources/images/icons3/calendar2-icon.svg","resources/images/icons3/calendarExpired-icon.svg","resources/images/icons3/cart-fill.svg","resources/images/icons3/cart-icon.svg","resources/images/icons3/catalogs-icon.svg","resources/images/icons3/chevron-down.svg","resources/images/icons3/chevron-right.svg","resources/images/icons3/chevron-up.svg","resources/images/icons3/clock-reverse-icon.svg","resources/images/icons3/close-icon.svg","resources/images/icons3/cog-icon.svg","resources/images/icons3/comment-icon.svg","resources/images/icons3/defaultPage-icon.svg","resources/images/icons3/deleteFilter-icon.svg","resources/images/icons3/dockleft-icon.svg","resources/images/icons3/dockmodal-icon.svg","resources/images/icons3/dockright-icon.svg","resources/images/icons3/documents-icon.svg","resources/images/icons3/done.svg","resources/images/icons3/doubleCheck-icon.svg","resources/images/icons3/double_arrow_down_black_24dp.svg","resources/images/icons3/double_arrow_left_black_24dp.svg","resources/images/icons3/double_arrow_right_black_24dp.svg","resources/images/icons3/double_arrow_up_black_24dp.svg","resources/images/icons3/download.svg","resources/images/icons3/duplicate-icon.svg","resources/images/icons3/emptylibrary-background-icon.svg","resources/images/icons3/emptylibrary-icon.svg","resources/images/icons3/filter-icon.svg","resources/images/icons3/floppydisk-icon.svg","resources/images/icons3/followLink-icon.svg","resources/images/icons3/forbidden-icon.svg","resources/images/icons3/forward-icon.svg","resources/images/icons3/fullscreen-corners-icon.svg","resources/images/icons3/fullscreen-icon.svg","resources/images/icons3/fullscreenExit-icon.svg","resources/images/icons3/gear-icon.svg","resources/images/icons3/globe-icon-bold.svg","resources/images/icons3/globe-icon.svg","resources/images/icons3/grid-icon.svg","resources/images/icons3/headphone-icon.svg","resources/images/icons3/highlight-icon.svg","resources/images/icons3/home-icon.svg","resources/images/icons3/import.svg","resources/images/icons3/info-icon.svg","resources/images/icons3/key-icon.svg","resources/images/icons3/keyreturn-icon.svg","resources/images/icons3/landmark-icon.svg","resources/images/icons3/language.svg","resources/images/icons3/layout-icon.svg","resources/images/icons3/library-icon.svg","resources/images/icons3/lightbulb-icon.svg","resources/images/icons3/link-icon.svg","resources/images/icons3/list-icon.svg","resources/images/icons3/loader.svg","resources/images/icons3/logo_edrlab.svg","resources/images/icons3/loop.svg","resources/images/icons3/magnifying_glass.svg","resources/images/icons3/menu.svg","resources/images/icons3/ongoingBook-icon.svg","resources/images/icons3/open_book.svg","resources/images/icons3/outline-exit_to_app-24px.svg","resources/images/icons3/outline-flip_to_front-24px.svg","resources/images/icons3/outline-info-24px.svg","resources/images/icons3/page-icon.svg","resources/images/icons3/paintbrush-icon.svg","resources/images/icons3/palette-icon.svg","resources/images/icons3/password-icon.svg","resources/images/icons3/pen-icon.svg","resources/images/icons3/person-fill.svg","resources/images/icons3/readBook-icon.svg","resources/images/icons3/refresh-icon.svg","resources/images/icons3/scroll-icon.svg","resources/images/icons3/search-icon.svg","resources/images/icons3/shelf-icon.svg","resources/images/icons3/singlecheck-icon.svg","resources/images/icons3/speaker-icon.svg","resources/images/icons3/stop-icon.svg","resources/images/icons3/swatches-icon.svg","resources/images/icons3/table-icon.svg","resources/images/icons3/tag-icon.svg","resources/images/icons3/target-icon.svg","resources/images/icons3/textarea-icon.svg","resources/images/icons3/toc-icon.svg","resources/images/icons3/trash-icon.svg","resources/images/icons3/underline-icon.svg","resources/images/icons3/unsvg.svg","resources/images/icons3/validated-icon.svg","resources/images/icons3/volume-icon.svg","resources/images/local-fr/thorium-NVDA-liste-boutons-bibli.png","resources/images/local-fr/thorium-TDM-light.png","resources/images/local-fr/thorium-TDM-night.png","resources/images/local-fr/thorium-bookinfo-a11ysummary.png","resources/images/local-fr/thorium-fullscreen.png","resources/images/local-fr/thorium-gotopage.png","resources/images/local-fr/thorium-luciole.png","resources/images/local-fr/thorium-marquePages.png","resources/images/local-fr/thorium-mathjax-menu.png","resources/images/local-fr/thorium-mathjax.png","resources/images/local-fr/thorium-opds-add.png","resources/images/local-fr/thorium-opds-gallica-1.png","resources/images/local-fr/thorium-progression.png","resources/images/local-fr/thorium-reperes.png","resources/images/local-fr/thorium-search-navpanel.png","resources/images/local-fr/thorium-signet.png","resources/images/local-fr/thorium-tags.png","resources/images/local-fr/thorium-verdana.png","resources/images/local-fr/thorium-whereami-ctrlK.png","resources/images/local-fr/thorium-whereami-tdmfocus.png","resources/images/local_en/th3_anotation_pop_up.png","resources/images/local_en/th3_library_grid_actions.png","resources/images/local_en/th3_library_pages.png","resources/images/local_en/th3_library_table_actions.png","resources/images/local_en/th3_main_settings_keys_context.png","resources/images/local_en/th3_main_window_home.png"]

epub-doc/en/src/_includes/base.njk

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" lang="en" xml:lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <link rel="stylesheet" type="text/css" href="{{EPUBRoot}}/resources/css/style.css"/>
+    {% block head %}{% endblock %}
+  </head>
+  <body>
+    {% block content %}{% endblock %}
+  </body>
+</html>

epub-doc/en/src/_includes/details.liquid

@@ -0,0 +1 @@
+<details></details>

epub-doc/en/src/_includes/package.njk

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="uid" prefix="cc: http://creativecommons.org/ns#">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+    {% for name, value in metadata.dc -%}
+    {% if name == "identifier" %}
+      <dc:{{name}} id="uid">{{value}}</dc:{{name}}>
+    {% else %}
+      <dc:{{name}}>{{value}}</dc:{{name}}>
+    {% endif %}
+    {%- endfor %}
+
+    {% for rel, href in links -%}
+    <link rel="{{rel}}" href="{{href}}"/>
+    {%- endfor %}
+
+    {% for property, value in metadata.properties -%}
+      {# metadata could be an array of values #}
+      {% if value | isArray %}
+        {% for v in value %}
+        <meta property="{{property}}">{{v}}</meta>
+        {% endfor %}  
+      {% else %}
+      <meta property="{{property}}">{{value}}</meta>
+      {% endif %}
+    {%- endfor %}
+  </metadata>
+  <manifest>
+    {% for resource in resources -%}
+    <item id="rsc{{loop.index}}"
+      href="{{resource}}"
+      media-type="{{resource | mediaType}}"
+    {% if resource == pub.cover.src %}
+      properties="cover-image"
+    {% endif %}
+    />
+    {%- endfor %}
+
+    <item id="cover" href="{{pub.cover.page}}" media-type="application/xhtml+xml"/>
+    <item id="toc" properties="nav" href="{{pub.toc.page}}" media-type="application/xhtml+xml"/>
+
+    {% for page in collections.pages -%}
+    <item id="page{{loop.index}}" href=".{{page.url}}index.xhtml" media-type="application/xhtml+xml"
+    {% if  page.data.scripted -%}properties="scripted"{%- endif -%} />
+    {%- endfor %}
+  </manifest>
+  <spine>
+    <itemref idref="cover"/>
+    {% if pub.readingOrder -%}
+      {% for item in pub.readingOrder -%}
+        {% for page in collections.pages -%}
+          {% if page.fileSlug == item -%}
+            <itemref idref="page{{loop.index}}"/>
+          {%- endif %}
+        {%- endfor %}
+      {%- endfor %}
+    {% else %}
+      {% for page in collections.pages -%}
+      <itemref idref="page{{loop.index}}"/>
+      {%- endfor %}
+    {%- endif %}
+  </spine>
+</package>

epub-doc/en/src/_includes/page.njk

@@ -0,0 +1,10 @@
+{% extends 'base.njk' %}
+
+{% block head %}
+<title>{% if title %}{{ title }}{% else %}{{metadata.dc.title}}{% endif %}</title>
+<link rel="stylesheet" type="text/css" href="{{EPUBRoot}}/resources/css/page.css"/>
+{% endblock %}
+
+{% block content %}
+{{ content | safe}}
+{% endblock %}

epub-doc/en/src/_includes/toc.njk

@@ -0,0 +1,34 @@
+{% extends 'base.njk' %}
+
+{% block head %}
+<title>{{ title }}</title>
+{% endblock %}
+
+{% block content %}
+<section id="toc">
+   <h1>{{title}}</h1>
+   <nav epub:type="toc">
+      {% if auto == false %}
+        {{ content | safe}}
+      {% else -%}
+      <ol>
+        {# use the reading order, if specified #}
+        {% if pub.readingOrder -%}
+          {% for item in pub.readingOrder -%}
+            {% for page in collections.pages -%}
+              {% if page.fileSlug == item -%}
+                <li><a href="{{EPUBRoot}}{{page.url}}index.xhtml">{{page.data.title}}</a></li>
+              {%- endif %}
+            {%- endfor %}
+          {%- endfor %}
+        {% else -%}
+          {% for page in collections.pages -%}
+            <li><a href="{{EPUBRoot}}{{page.url}}index.xhtml">{{page.data.title}}</a></li>
+          {%- endfor %}
+        {%- endif %}
+      </ol>
+      {%- endif %}
+
+   </nav>
+</section>
+{% endblock %}

epub-doc/en/src/cover.md

@@ -0,0 +1,9 @@
+---
+layout: page.njk
+EPUBRoot: ".."
+---
+# {{metadata.dc.title}}
+
+{% if pub.cover.src %}
+![{{pub.cover.alt}}]({{EPUBRoot}}/{{pub.cover.src}})
+{% endif %}

epub-doc/en/src/index.md

@@ -0,0 +1,3 @@
+---
+layout: package.njk
+---

epub-doc/en/src/pages/100_forewords.md

@@ -0,0 +1,49 @@
+---
+title: Forewords
+role: doc-foreword
+draft: false
+---
+
+
+::: {.section role="doc-foreword" aria-labelledby="forewords"}
+# Forewords
+
+Thorium is a digital book reader, it is also a library where you can
+store your books and access to online catalogs.
+
+Thorium allows to read ebooks in different [formats](../406_formats/index.xhtml),
+each of them having strengths and limitations. This documentation is
+provided as an EPUB, the format with the larger number of
+functionalities.
+
+------------------------------------------------------------------------
+
+This software is free, open-source and as such, its development is only
+possible because it is funded by different organizations. Among these,
+members of EDRLab, private or public grants and small recurring
+donations from happy users (individuals or companies). If you rely on
+this application, consider [support!](../903_support/index.xhtml)
+
+::: section
+## This is the documentation for Thorium 3, and it is a work in progress! {#th3}
+
+Thorium 3 introduces numerous changes and, we hope, a friction less
+reading experience. This documentation is a work in progress trying to
+support new users discovering the software as well as providing the
+missing links for the experimented readers.
+:::
+
+::: section
+## Additional material available online {#th3add}
+
+To complete this documentation, the [thorium
+website](https://thorium.edrlab.org) proposes a frequently asked
+questions section as well as a list of ressources including place to
+find ebooks online.
+
+[Github Thorium Issue
+tracker](https://github.com/edrlab/thorium-reader/issues) can also be
+browsed to find answers to specific use cases and give us feedback about
+any difficulty or bug affecting your reading experience.
+:::
+:::

epub-doc/en/src/pages/101_opening_thorium.md

@@ -0,0 +1,26 @@
+---
+title: Opening Thorium Reader
+role:
+draft: false
+---
+
+::: section
+# Opening Thorium Reader {#getabook}
+
+Once Thorium reader is installed on your system, severals ways are
+possible to open it.
+
+-   Thorium can be launched from the application menu or from any
+    shortcut created. This action will open the [library home
+    view]() and will allow you to choose a book or to add
+    one but also to access to [catalogs]() and organize your
+    collection. To read a book just click on it or validate with
+    [Enter]{.kbd} when selected.
+-   Select the book you want to read, use the `contextual menu` (right
+    click), select `open with` and then select `Thorium`.
+-   You can set the default application for certain file types through
+    the Windows settings. Select a file, open the context menu, select
+    `Open with`, in the pop-up window select `Thorium`, check the box
+    `Always open with`. This operation must be repeated for each file
+    format you wish to read with Thorium.
+:::