Skip to content

Commit

Permalink
Merge pull request #110 from edrlab/clean-epub-doc
Browse files Browse the repository at this point in the history
Clean epub doc
  • Loading branch information
gautierchomel authored Sep 23, 2024
2 parents ea82668 + a901504 commit a6f707f
Show file tree
Hide file tree
Showing 143 changed files with 9,680 additions and 345 deletions.
40 changes: 39 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,42 @@ resources/
node_modules/
.hugo_build.lock
W/
.vscode/
.vscode/

epub-doc/en/extra/*
epub-doc/en/lib/*
epub-doc/en/node_modules/*
epub-doc/en/src
epub-doc/en/.eleventy.js
epub-doc/en/.gitattributes
epub-doc/en/.gitignore
epub-doc/en/.stylelintrc
epub-doc/en/gulpfile.js
epub-doc/en/LICENSE
epub-doc/en/package-lock.json
epub-doc/en/package.json
epub-doc/en/postbuild.js
epub-doc/en/prebuild.js
epub-doc/en/README.md
epub-doc/en/rename.js
epub-doc/en/utils.js
epub-doc/en/watch.json

epub-doc/fr/extra/*
epub-doc/fr/lib/*
epub-doc/fr/node_modules/*
epub-doc/fr/src
epub-doc/fr/.eleventy.js
epub-doc/fr/.gitattributes
epub-doc/fr/.gitignore
epub-doc/fr/.stylelintrc
epub-doc/fr/gulpfile.js
epub-doc/fr/LICENSE
epub-doc/fr/package-lock.json
epub-doc/fr/package.json
epub-doc/fr/postbuild.js
epub-doc/fr/prebuild.js
epub-doc/fr/README.md
epub-doc/fr/rename.js
epub-doc/fr/utils.js
epub-doc/fr/watch.json
32 changes: 16 additions & 16 deletions content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<div class="col hero">
<div style="flex: 1; max-width: 50dvw;">
<div class="indexHeading">
<img src="/images/free-label.png" class="freeLabelIcon" alt="" role="presentation" />
<img src="/images/free-label.png" class="freeLabelIcon" alt="" role="presentation" //>
<p class="freeLabelText">COMPLETELY <br /> FREE</p>
<p class="exergue1">Read, Select, Annotate, Classify</p>
<p class="exergue2">Perfect for heavy readers, library-goers, and students alike!</p>
Expand All @@ -22,7 +22,7 @@
<section class="downloadPanel">

<div class="downloadPanel_title">
<img class="left" src="https://www.edrlab.org/wp-content/uploads/2018/10/Miniature_blue.png" alt="" role="presentation">
<img class="left" src="https://www.edrlab.org/wp-content/uploads/2018/10/Miniature_blue.png" alt="" role="presentation"/>
<h1>Download links</h1>
</div>

Expand All @@ -35,14 +35,14 @@ <h2>
</h2>
<span>
<a class="download_button" href="https://bit.ly/thoriumreader-en">Windows Store
<img src="/images/icons/download-icon.svg" alt="access"/>
<img src="/images/icons/download-icon.svg" alt="access"//>
</a>
</span>
<span>
<a class="download_button"
href="https://github.com/edrlab/thorium-reader/releases/download/v3.0.0/Thorium.Setup.3.0.0.exe">
Direct Install
<img src="/images/icons/download-icon.svg" alt="download"/>
<img src="/images/icons/download-icon.svg" alt="download"//>
</a>
</span>
</div>
Expand All @@ -56,14 +56,14 @@ <h2>
<a class="download_button"
href="https://github.com/edrlab/thorium-reader/releases/download/v3.0.0/Thorium-3.0.0-arm64.dmg">
Apple Silicon
<img src="/images/icons/download-icon.svg" alt="download"/>
<img src="/images/icons/download-icon.svg" alt="download"//>
</a>
</span>
<span>
<a class="download_button"
href="https://github.com/edrlab/thorium-reader/releases/download/v3.0.0/Thorium-3.0.0.dmg">
Intel
<img src="/images/icons/download-icon.svg" alt="download"/>
<img src="/images/icons/download-icon.svg" alt="download"//>
</a>
</span>
</div>
Expand All @@ -77,14 +77,14 @@ <h2>
<a class="download_button"
href="https://github.com/edrlab/thorium-reader/releases/download/v3.0.0/Thorium-3.0.0.AppImage">
AppImage
<img src="/images/icons/download-icon.svg" alt="download"/>
<img src="/images/icons/download-icon.svg" alt="download"//>
</a>
</span>
<span>
<a class="download_button"
href="https://github.com/edrlab/thorium-reader/releases/download/v3.0.0/EDRLab.ThoriumReader_3.0.0_amd64.deb">
Debian
<img src="/images/icons/download-icon.svg" alt="download"/>
<img src="/images/icons/download-icon.svg" alt="download"//>
</a>
</span>
</div>
Expand All @@ -104,14 +104,14 @@ <h1>Thorium 3</h1>
documentation catalogue in Thorium Reader.</p>
<button
onclick="location.href='opds://rawcdn.githack.com/edrlab/publications/main/feeds/thorium3_documentation.json'">
<img src="/images/icons/documentation-icon.svg" alt="" role="presentation"/>
<img src="/images/icons/documentation-icon.svg" alt="" role="presentation"//>
<h2>Documentation</h2>
<img src="/images/icons/doc-arrow-icon.svg" alt="" role="presentation"/>
<img src="/images/icons/doc-arrow-icon.svg" alt="" role="presentation"//>
</button>
</div>
<div class="banner-element">
<!-- <i class="fa-solid fa-book-open-reader"></i> -->
<img src="/images/ReaderFirst-ILLU.png" alt="" role="presentation"/>
<img src="/images/ReaderFirst-ILLU.png" alt="" role="presentation"//>
<h3 class="h3">Reader first</h3>
<div class="mb-0">
<ul>
Expand All @@ -127,7 +127,7 @@ <h3 class="h3">Reader first</h3>
<!-- <p><a href="https://github.com/edrlab/thorium-reader/releases/tag/v3.0.0">Read more …</a></p> -->
</div>
<div class="banner-element">
<img src="/images/Annotations-ILLU.png" alt="" role="presentation"/>
<img src="/images/Annotations-ILLU.png" alt="" role="presentation"//>
<h3 class="h3">Annotations</h3>
<div class="mb-0">
<ul>
Expand All @@ -141,7 +141,7 @@ <h3 class="h3">Annotations</h3>
<!-- <p><a href="https://github.com/edrlab/thorium-reader/releases/tag/v3.0.0">Read more …</a></p> -->
</div>
<div class="banner-element">
<img src="/images/Features-ILLU.png" alt="" role="presentation"/>
<img src="/images/Features-ILLU.png" alt="" role="presentation"//>
<h3 class="h3">3.0 new features</h3>
<div class="mb-0">
<ul>
Expand All @@ -157,16 +157,16 @@ <h3 class="h3">3.0 new features</h3>
</div>
</section>
<section class="donation_section">
<img src="/images/computer-ILLU.png" alt="" role="presentation"/>
<img src="/images/computer-ILLU.png" alt="" role="presentation"//>
<div class="donation_container">
<img src="/images/heart-ILLU.png" alt="" role="presentation"/>
<img src="/images/heart-ILLU.png" alt="" role="presentation"//>
<h2>Help us develop Thorium Reader</h2>
<p>This software is free & open-source. As such, its maintenance and evolution is only possible because of public
grants completed by donations from private organisations and end-users. If you like this reading application,
become a sponsor.</p>
<button onclick="location.href='https://github.com/sponsors/edrlab'">
Donate!
<img src="/images/icons/doc-arrow-icon.svg" alt="" role="presentation"/>
<img src="/images/icons/doc-arrow-icon.svg" alt="" role="presentation"//>
</button>
</div>
</section>
Expand Down
8 changes: 4 additions & 4 deletions content/en/about/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h2>The reading application<br /> for all readers</h2>

<a href="https://www.youtube.com/watch?v=QYu_DJBpJkE" target="_blank" class="big_button_orange">Thorium Reader Presentation</a>
</div>
<img style="flex: 1; width: 400px; height: 100%; padding-top: 50px;" src="/images/about-ILLU.png" alt="" role="presentation"/>
<img style="flex: 1; width: 400px; height: 100%; padding-top: 50px;" src="/images/about-ILLU.png" alt="" role="presentation"//>

{{< /blocks/section>}}

Expand Down Expand Up @@ -80,7 +80,7 @@ <h2>Credits</h2>
<div class="credits_leftside">
<p>This documentation site is designed and maintained by EDRLab as part of the development of the
Thorium-Reader application.</p>
<img src="/images/credits-ILLU.png" alt="" role="presentation"/>
<img src="/images/credits-ILLU.png" alt="" role="presentation"//>
</div>
<div class="credits_rightside">
<div class="credits_contributors">
Expand Down Expand Up @@ -117,8 +117,8 @@ <h3>Who has developed this app</h3>
<section class="financers_section">

<div>
<img src="/images/ministere.png" alt="" role="presentation"/>
<img src="/images/cnl.png" alt="" role="presentation"/>
<img src="/images/ministere.png" alt="" role="presentation"//>
<img src="/images/cnl.png" alt="" role="presentation"//>
</div>

<div>
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/000_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is a template for new files including some shortcodes that can be used.
<!--
Shift+click to zoom in.
<img src="/images/local-fr/..." alt=""/>
<img src="/images/local-fr/..." alt=""//>
Shortcodes
* {{< alert info >}}{{< /alert>}}
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/210_reading/211_moving.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ History Navigation takes into account user interactions, including clicks on bot
To navigate forward and backward in the content of the book you can
use the arrows on your keyboard or click on the navigation arrows
located at the bottom right of the reading interface
(<img class="icons" src="/images/icons/baseline-arrow_left_ios-24px.svg" alt="Previous content button" width="15px"><img class="icons" src="/images/icons/baseline-arrow_forward_ios-24px.svg" alt="Next content button" width="15px">).
(<img class="icons" src="/images/icons/baseline-arrow_left_ios-24px.svg" alt="Previous content button" width="15px"/><img class="icons" src="/images/icons/baseline-arrow_forward_ios-24px.svg" alt="Next content button" width="15px"/>).

It is possible to move between chapters using
<kbd>Ctrl</kbd> + <kbd>Previous page (Page Up)</kbd> (previous chapter) and
Expand Down Expand Up @@ -68,7 +68,7 @@ to explore and move through the table of contents.



<img src="/images/local-fr/thorium-TDM-light.png" alt="Screenshot, table of contents: Titles Level 1 Cover, Title, Copyright, Dedicae, Exergue, Introduction, The Mark of Four; Title Level 2 Deduction elevated to a science."/>
<img src="/images/local-fr/thorium-TDM-light.png" alt="Screenshot, table of contents: Titles Level 1 Cover, Title, Copyright, Dedicae, Exergue, Introduction, The Mark of Four; Title Level 2 Deduction elevated to a science."//>



Expand Down Expand Up @@ -101,7 +101,7 @@ is available on the W3C website.



<img src="/images/local-fr/thorium-reperes.png" alt="Screenshot, Go to page. Current page: 3. A drop-down menu indicates 3, an editable field indicates Enter page number, a button indicates Go to."/>
<img src="/images/local-fr/thorium-reperes.png" alt="Screenshot, Go to page. Current page: 3. A drop-down menu indicates 3, an editable field indicates Enter page number, a button indicates Go to."//>



Expand Down Expand Up @@ -133,7 +133,7 @@ changing the value using the `Go to page` box.



<img src="/images/local-fr/thorium-gotopage.png" alt="Screenshot, Go to page. Current page: 3. A drop-down menu indicates 3, an editable field indicates Enter page number, a button indicates Go to."/>
<img src="/images/local-fr/thorium-gotopage.png" alt="Screenshot, Go to page. Current page: 3. A drop-down menu indicates 3, an editable field indicates Enter page number, a button indicates Go to."//>



Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/210_reading/212_whereAmI.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This [screenreader page location issue](https://github.com/edrlab/thorium-reader
However NVDA will announce the page break as a separator if it has a title attribute (exemple: ` <span epub:type="pagebreak" role="doc-pagebreak" id="page_2" class="page" title="2"/>` will cause NVDA to anounce "Two, separator").
{{< /details >}}

<img src="/images/local-fr/thorium-whereami-ctrlK.png" alt="Screenshot, notification area, current page 103 - progress = 14/25 (barrel incident) [32%] H1 VII / H2 Barrel incident."/>
<img src="/images/local-fr/thorium-whereami-ctrlK.png" alt="Screenshot, notification area, current page 103 - progress = 14/25 (barrel incident) [32%] H1 VII / H2 Barrel incident."//>



Expand All @@ -28,7 +28,7 @@ The keyboard shortcut <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>n</kbd> will
When you look at the `Navigation` menu, Thorium shows the current chapter
in the `table of contents` and the current page in the `Go to page` menu.

<img src="/images/local-fr/thorium-whereami-tdmfocus.png" alt="Screenshot, reading a book with title VII Barrel Incident. The navigation pane is open, the table of contents shows the title Barrel Incident in a square which indicates that this is the chapter being read."/>
<img src="/images/local-fr/thorium-whereami-tdmfocus.png" alt="Screenshot, reading a book with title VII Barrel Incident. The navigation pane is open, the table of contents shows the title Barrel Incident in a square which indicates that this is the chapter being read."//>

# Access more informations

Expand All @@ -50,7 +50,7 @@ and return to the text.



<img src="/images/local-fr/thorium-progression.png" alt="Screenshot, progress: 14/25 (barrel incident) [1%] h1: VII"/>
<img src="/images/local-fr/thorium-progression.png" alt="Screenshot, progress: 14/25 (barrel incident) [1%] h1: VII"//>



Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/210_reading/213_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Just place a Bookmark to make sure you find your way back.
{{< /alert>}}


<img src="/images/local-fr/thorium-search-navpanel.png" alt="Screenshot, the search bar is present above the text, the corresponding text highlighted in green and the Search panel indicates a match"/>
<img src="/images/local-fr/thorium-search-navpanel.png" alt="Screenshot, the search bar is present above the text, the corresponding text highlighted in green and the Search panel indicates a match"//>
4 changes: 2 additions & 2 deletions content/en/docs/210_reading/214_bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ after this action.

Select the text you want to mark.
Press the `bookmark` button
(<img class="icons" src="/images/icons/outline-bookmark-24px-grey.svg" alt="" width="20px">)
(<img class="icons" src="/images/icons/outline-bookmark-24px-grey.svg" alt="" width="20px"/>)
or the key combination <kbd>Ctrl</kbd> + <kbd>B</kbd>.

If no text is selected so the full page will be marked.
Expand Down Expand Up @@ -58,7 +58,7 @@ copied. When you have several bookmarks, this renaming of the bookmarks allows
you to use them easily.

<figure>
<img src="/images/local-fr/thorium-marquePages.png" alt="">
<img src="/images/local-fr/thorium-marquePages.png" alt=""/>
<figcaption class="icon">
</figcaption>
</figure>
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/210_reading/215_ReadingParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 216
toc: false
---

In the reading interface use the `Preferences` button (<img class="icons" src="/images/icons/font-size.svg" alt="" width="20px">): the options are revealed.
In the reading interface use the `Preferences` button (<img class="icons" src="/images/icons/font-size.svg" alt="" width="20px"/>): the options are revealed.

{{< alert info >}}
Reading settings can be saved or reset by using buttons `Save` and `Reset` located in the menu `Settings`, submenu `Configuration` of the Reading window.
Expand Down Expand Up @@ -41,7 +41,7 @@ the operating system.
3. Write the word *Verdana* in the empty field that appears next to the drop-down list.
4. Confirm with <kbd>Enter</kbd>.

<img class="icons" src="/images/local-fr/thorium-verdana.png" alt="Screenshot showing the Text settings Pannel with verdana set up as reading font">
<img class="icons" src="/images/local-fr/thorium-verdana.png" alt="Screenshot showing the Text settings Pannel with verdana set up as reading font"/>



Expand All @@ -56,7 +56,7 @@ the operating system.



<img class="icons" src="/images/local-fr/thorium-luciole.png" alt="Screenshot showing the Text settings Pannel with Luciole set up as reading font"/>
<img class="icons" src="/images/local-fr/thorium-luciole.png" alt="Screenshot showing the Text settings Pannel with Luciole set up as reading font"//>



Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/210_reading/221_maths.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ To activate it when reading a book, go to the
menu `Reading settings`, at the bottom of the `Display` tab you will find
a checkbox `MathJax`.

<img src="/images/local-fr/thorium-mathjax.png" alt="Screenshot of a complex mathematical formula correctly displayed with the MathJax option checked."/>
<img src="/images/local-fr/thorium-mathjax.png" alt="Screenshot of a complex mathematical formula correctly displayed with the MathJax option checked."//>

Once MathJax is activated, you can use the `contextual menu` (right click)
on a mathematical formula inserted in MathML format and use the many
options proposed such as reading aloud (speech), viewing the semantic marking
or copy the formula with its semantic attributes to use it in a
compatible editor.

<img src="/images/local-fr/thorium-mathjax-menu.png" alt="Screenshot of the MathJax context menu showing the Accessibility sub-menu with the Activate option checked."/>
<img src="/images/local-fr/thorium-mathjax-menu.png" alt="Screenshot of the MathJax context menu showing the Accessibility sub-menu with the Activate option checked."//>

{{< details "Read **mathematics** with NVDA">}}
You can read mathematical expressions tagged with MathML using
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/220_organizing/221_libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ It offers a quick access view organized into two sections:
`Recently added` and `Resume reading`. The `All Books`
button will display all the books imported into Thorium.

The default view is the grid view (<img class="icons" src="/images/icons/baseline-view_module-24px.svg" alt="Icon grid" width="20px">), it shows the book covers, title and author.
The default view is the grid view (<img class="icons" src="/images/icons/baseline-view_module-24px.svg" alt="Icon grid" width="20px"/>), it shows the book covers, title and author.
Clicking on any of these items will open the book in a new
window. A menu for each book allows you to access the `Book File`,
`Delete` or `Export` the book.

It is possible to choose display as a `list view` (<img class="icons" src="/images/icons/baseline-view_list-24px.svg" alt="Icon list" width="20px">), in this view the cover is no longer
It is possible to choose display as a `list view` (<img class="icons" src="/images/icons/baseline-view_list-24px.svg" alt="Icon list" width="20px"/>), in this view the cover is no longer
displayed but the year of publication and the publisher are shown.

## All Books
Expand All @@ -52,7 +52,7 @@ books in English displayed.

The column headers allow you to sort the books in ascending or descending order.
The `magnifying glass` icon
(<img class="icons" src="/images/icons/magnifying_glass.svg" alt="" width="20px">)
(<img class="icons" src="/images/icons/magnifying_glass.svg" alt="" width="20px"/>)
in the header of the first column activates a search field by column
allowing for example to search for an expression only among the titles
of the works.
2 changes: 1 addition & 1 deletion content/en/docs/220_organizing/222_catalogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Since Thorium 2.2, OPDS feeds can be edited so you can change the name or retrie
{{< /alert>}}

<figure>
<img src="/images/local-fr/thorium-opds-add.png" alt="">
<img src="/images/local-fr/thorium-opds-add.png" alt=""/>
<figcaption class="icon">
</figcaption>
</figure>
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/220_organizing/223_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ The tag is added in a blue box, you can remove it by clicking on
the cross.
{{< /alert>}}

<img src="/images/local-fr/thorium-tags.png" alt="Screenshot, the search bar is present above the text, the corresponding text is highlighted in green and the Search panel shows 1 match"/>
<img src="/images/local-fr/thorium-tags.png" alt="Screenshot, the search bar is present above the text, the corresponding text is highlighted in green and the Search panel shows 1 match"//>
2 changes: 1 addition & 1 deletion content/en/docs/300_accessibility/301_A11yInfos.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Currently Thorium displays in the
under the heading `Description` the content of the accessibility summary metadata
(<span lang="en">accessibilitySummary</span>).

<img src="/images/local-fr/thorium-bookinfo-a11ysummary.png" alt="Screenshot, the book The Mark of Four indicates: This publication complies with the SNE Charter - natively accessible textual EPUBs »."/>
<img src="/images/local-fr/thorium-bookinfo-a11ysummary.png" alt="Screenshot, the book The Mark of Four indicates: This publication complies with the SNE Charter - natively accessible textual EPUBs »."//>

{{< alert warning >}}

Expand Down
Loading

0 comments on commit a6f707f

Please sign in to comment.