Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Epub doc 3.1 #159

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
5e154ac
initial metadata for th doc as epub 3.0.1
gautierchomel Dec 17, 2024
db8684a
fixes image links with errors
gautierchomel Dec 17, 2024
ad9be7c
Include handcrafted toc
gautierchomel Dec 17, 2024
cc4e922
include handcrafted TOC for EN
gautierchomel Dec 17, 2024
e3b30b9
Introduction now lives in the foreword chapter
gautierchomel Dec 18, 2024
37dc345
Reorganise NAV
gautierchomel Dec 18, 2024
35e3f5b
COmplete missing informations about Reading navigation and setting pa…
gautierchomel Dec 18, 2024
32cbcd3
Update 240_annotations.md
gautierchomel Dec 19, 2024
f1c1b02
user friendlier title
gautierchomel Dec 19, 2024
ee84239
Additional features of the General settings panel
gautierchomel Dec 19, 2024
4434a8c
adds annotations toc entries
gautierchomel Dec 19, 2024
46e1153
Update 102_windows_views_panels.md
gautierchomel Dec 19, 2024
c032d9f
Adds explanations for new annotations funcionalities
gautierchomel Dec 19, 2024
65e4e28
Update 240_annotations.md
gautierchomel Dec 20, 2024
ba68d72
Update metadata.json
gautierchomel Dec 20, 2024
90baa7a
Ignoring builds while debugging
gautierchomel Dec 23, 2024
2cc36a8
more consistant css
gautierchomel Dec 23, 2024
eed284e
deactivate template called css
gautierchomel Dec 23, 2024
7c9f002
update css refs in ressources
gautierchomel Dec 23, 2024
2cd4462
metadata.json does not accepts comments for building
gautierchomel Dec 23, 2024
4d74210
relative urls errors
gautierchomel Dec 23, 2024
2dfe8bb
adds toc to the spine
gautierchomel Dec 23, 2024
5896dfd
Update toc.md
gautierchomel Dec 23, 2024
5837846
Create 000_title.md
gautierchomel Dec 23, 2024
5735c4d
fix the tag subsection that was considered as code
gautierchomel Dec 23, 2024
92eb78b
typos
gautierchomel Dec 23, 2024
f8e89ee
fix missing alt text
gautierchomel Dec 23, 2024
5263e0b
fix epub-type-has-matching-role
gautierchomel Dec 23, 2024
fb0103f
format toc
gautierchomel Dec 26, 2024
c7453f8
Add zen mode localisation keys
gautierchomel Dec 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ node_modules/
.hugo_build.lock
W/
.vscode/
epub-doc/en/build/*
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,8 @@ toc: false
| reader.navigation.currentPageTotal| Current page: {{- current}}/{{- total}} | | |
| reader.navigation.detachWindowTitle| show library / bookshelf window | | |
| reader.navigation.fullscreenTitle| go fullscreen | | |
| reader.navigation.ZenModeTitle| Zen mode | | |
| reader.navigation.ZenModeExit| Exit Zen mode | | |
| reader.navigation.goTo| Go to | | |
| reader.navigation.goToError| Page break does not exist | | |
| reader.navigation.goToPlaceHolder| Enter page number | | |
Expand Down
10 changes: 4 additions & 6 deletions epub-doc/en/src/_data/metadata.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"dc": {
"title": "Thorium Reader Documentation in English",
"title": "Thorium reader user's guide (English, 3.1)",
"creator": "EDRLab",
"publisher": "EDRLab",
"description": "Get to know better Thorium Reader",
"identifier": "com.github.edrlab.thorium-reader-doc-epub.0.0.2",
"description": "This is the official Thorium 3.1 documentation. It offers guidance to help you get to know and make better use of Thorium Reader. Quick support references are not included here and are available online from the Thorium Support webpages.",
"identifier": "com.github.edrlab.thorium-reader-doc-epub.3.0.1",
"language": "en",
"rights": "Creative Commons Attribution-Share Alike (CC BY-SA) license."
},
Expand All @@ -15,10 +15,8 @@
}
],
"properties": {
"dcterms:modified": "2024-10-01T00:00:00Z",
"dcterms:modified": "2024-12-31T00: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"]
Expand Down
2 changes: 1 addition & 1 deletion epub-doc/en/src/_data/resources.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["resources/css/edrlabpublications.css","resources/css/page.css","resources/css/style.css","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"]
["resources/css/blitz-lite.min.css","resources/css/edrlabpublications.css","resources/css/thdoc.css","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"]
2 changes: 1 addition & 1 deletion epub-doc/en/src/_includes/base.njk
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<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"/>
{# <link rel="stylesheet" type="text/css" href="{{EPUBRoot}}/resources/css/style.css"/> #}
{% block head %}{% endblock %}
</head>
<body>
Expand Down
1 change: 1 addition & 0 deletions epub-doc/en/src/_includes/package.njk
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,6 @@
<itemref idref="page{{loop.index}}"/>
{%- endfor %}
{%- endif %}
<itemref idref="toc"/>
</spine>
</package>
2 changes: 1 addition & 1 deletion epub-doc/en/src/_includes/page.njk
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% block head %}
<title>{% if title %}{{ title }}{% else %}{{metadata.dc.title}}{% endif %}</title>
<link rel="stylesheet" type="text/css" href="{{EPUBRoot}}/resources/css/page.css"/>
{# <link rel="stylesheet" type="text/css" href="{{EPUBRoot}}/resources/css/page.css"/> #}
{% endblock %}

{% block content %}
Expand Down
6 changes: 6 additions & 0 deletions epub-doc/en/src/pages/000_title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Title
role: doc-title
draft: false
weight: 100
---
4 changes: 1 addition & 3 deletions epub-doc/en/src/pages/100_forewords.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
title: Forewords
role: doc-foreword
draft: false
weight: 100
---


# Forewords

Thorium is a digital book reader, it is also a library where you can
store your books and access to online catalogs.

Expand Down
Loading