Skip to content

Commit

Permalink
Merge pull request #199 from edrlab/3.1-doc-as-epub
Browse files Browse the repository at this point in the history
3.1 doc as epub
  • Loading branch information
gautierchomel authored Feb 14, 2025
2 parents 8844a1f + bacd846 commit 3827bff
Show file tree
Hide file tree
Showing 169 changed files with 6,129 additions and 5,700 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ node_modules/
.hugo_build.lock
W/
.vscode/
epub-doc/en/build/*
epub-doc/en/build/
11 changes: 7 additions & 4 deletions epub-doc/en/build/epub/EPUB/cover/index.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@
<title>Thorium reader user&#39;s guide (English, 3.1)</title>
</head>
<body>
<h1>Thorium reader user's guide (English, 3.1)</h1>
<p>
<img src="../resources/images/cover.jpeg" alt="" />
</p>
<section class="colbreak" >
<hr class="asterism" aria-hidden="true"></hr>
<h1>Thorium reader user's guide (English, 3.1)</h1>
<p>
<img src="../resources/images/cover.jpeg" alt="" />
</p>
</section>
</body>
</html>
54 changes: 24 additions & 30 deletions epub-doc/en/build/epub/EPUB/package.opf
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
<metadata
xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:title>Thorium reader user&#39;s guide (English, 3.1)</dc:title>
<dc:creator>EDRLab</dc:creator>
<dc:publisher>EDRLab</dc:publisher>
<dc:creator>The European Digital Reading Lab</dc:creator>
<dc:publisher>The European Digital Reading Lab</dc:publisher>
<dc: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.</dc:description>
<dc:identifier id="uid">com.github.edrlab.thorium-reader-doc-epub.3.0.1</dc:identifier>
<dc:identifier id="uid">com.github.edrlab.thorium-reader-doc-epub-en.3.1.0</dc:identifier>
<dc:language>en</dc:language>
<dc:rights>Creative Commons Attribution-Share Alike (CC BY-SA) license.</dc:rights>
<meta property="dcterms:modified">2024-12-31T00:00:00Z</meta>
<meta property="dcterms:modified">2025-01-30T00:00:00Z</meta>
<meta property="schema:accessibilityFeature">alternativeText</meta>
<meta property="schema:accessibilityFeature">readingOrder</meta>
<meta property="schema:accessibilityFeature">structuralNavigation</meta>
Expand Down Expand Up @@ -843,57 +843,51 @@
/>
<item id="page6" href="./pages/214_reading_pdfs/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page7" href="./pages/300_accessibility/index.xhtml" media-type="application/xhtml+xml"
<item id="page7" href="./pages/402_keys_functions/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page8" href="./pages/311_screenReaders/index.xhtml" media-type="application/xhtml+xml"
<item id="page8" href="./pages/403_gesture/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page9" href="./pages/400_ressources/index.xhtml" media-type="application/xhtml+xml"
<item id="page9" href="./pages/406_formats/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page10" href="./pages/402_keys_functions/index.xhtml" media-type="application/xhtml+xml"
<item id="page10" href="./pages/102_windows_views_panels/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page11" href="./pages/403_gesture/index.xhtml" media-type="application/xhtml+xml"
<item id="page11" href="./pages/110_libraries_actions/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page12" href="./pages/406_formats/index.xhtml" media-type="application/xhtml+xml"
<item id="page12" href="./pages/211_reading_textuals/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page13" href="./pages/900_about/index.xhtml" media-type="application/xhtml+xml"
<item id="page13" href="./pages/220_reading_actions/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page14" href="./pages/000_title/index.xhtml" media-type="application/xhtml+xml"
<item id="page14" href="./pages/240_annotations/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page15" href="./pages/100_forewords/index.xhtml" media-type="application/xhtml+xml"
<item id="page15" href="./pages/000_title/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page16" href="./pages/102_windows_views_panels/index.xhtml" media-type="application/xhtml+xml"
<item id="page16" href="./pages/100_forewords/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page17" href="./pages/110_libraries_actions/index.xhtml" media-type="application/xhtml+xml"
<item id="page17" href="./pages/300_accessibility/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page18" href="./pages/211_reading_textuals/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page19" href="./pages/220_reading_actions/index.xhtml" media-type="application/xhtml+xml"
/>
<item id="page20" href="./pages/240_annotations/index.xhtml" media-type="application/xhtml+xml"
<item id="page18" href="./pages/900_about/index.xhtml" media-type="application/xhtml+xml"
/>
</manifest>
<spine>
<itemref idref="cover"/>
<itemref idref="page14"/>
<itemref idref="page15"/>
<itemref idref="page1"/>
<itemref idref="page16"/>
<itemref idref="page17"/>
<itemref idref="page1"/>
<itemref idref="page10"/>
<itemref idref="page11"/>
<itemref idref="page2"/>
<itemref idref="page3"/>
<itemref idref="page18"/>
<itemref idref="page12"/>
<itemref idref="page4"/>
<itemref idref="page5"/>
<itemref idref="page6"/>
<itemref idref="page19"/>
<itemref idref="page20"/>
<itemref idref="page13"/>
<itemref idref="page14"/>
<itemref idref="page17"/>
<itemref idref="page7"/>
<itemref idref="page8"/>
<itemref idref="page9"/>
<itemref idref="page10"/>
<itemref idref="page11"/>
<itemref idref="page12"/>
<itemref idref="page13"/>
<itemref idref="page18"/>
<itemref idref="toc"/>
</spine>
</package>
37 changes: 20 additions & 17 deletions epub-doc/en/build/epub/EPUB/pages/100_forewords/index.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,42 @@
<title>Forewords</title>
</head>
<body>
<p>Thorium is a digital book reader, it is also a library where you can
<section class="colbreak" role="doc-foreword" >
<hr class="asterism" aria-hidden="true"></hr>
<p>Thorium is a digital book reader, it is also a library where you can
store your books and access to online catalogs.</p>
<p>Thorium allows to read ebooks in different
<a href="../406_formats/index.xhtml">formats</a>,
<p>Thorium allows to read ebooks in different
<a href="../406_formats/index.xhtml">formats</a>,
each of them having strengths and limitations. This documentation is
provided as an EPUB, the format with the larger number of
functionalities.
</p>
<hr />
<p>This software is free, open-source and as such, its development is only
</p>
<hr />
<p>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
<a href="https://thorium.edrlab.org/en/th3/800_collaborating/903_support/">support!</a>
</p>
<h2 id="th3">This is the documentation for Thorium 3, and it is a work in progress!</h2>
<p>Thorium 3 introduces numerous changes and, we hope, a friction less
<a href="https://thorium.edrlab.org/en/th3/900_about_thorium/901_thorium-sponsorship/">support thru funding and sponsorhip</a>
</p>
<h2 id="th3">This is the documentation for Thorium 3, and it is a work in progress!</h2>
<p>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.</p>
<h2 id="th3add">Additional material available online</h2>
<p>To complete this documentation, the
<a href="https://thorium.edrlab.org">thorium
<h2 id="th3add">Additional material available online</h2>
<p>To complete this documentation, the
<a href="https://thorium.edrlab.org">thorium
website</a> proposes a frequently asked
questions section as well as a list of ressources including place to
find ebooks online.
</p>
<p>
<a href="https://github.com/edrlab/thorium-reader/issues">Github Thorium Issue
</p>
<p>
<a href="https://github.com/edrlab/thorium-reader/issues">Github Thorium Issue
tracker</a> can also be
browsed to find answers to specific use cases and give us feedback about
any difficulty or bug affecting your reading experience.
</p>
</p>
</section>
</body>
</html>
41 changes: 22 additions & 19 deletions epub-doc/en/build/epub/EPUB/pages/101_opening_thorium/index.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,38 @@
<title>Opening Thorium Reader</title>
</head>
<body>
<h1 id="getabook">Opening Thorium Reader</h1>
<p>Once Thorium reader is installed on your system, severals ways are
<section class="colbreak" role="doc-chapter" >
<hr class="asterism" aria-hidden="true"></hr>
<h1 id="getabook">Opening Thorium Reader</h1>
<p>Once Thorium reader is installed on your system, severals ways are
possible to open it.</p>
<ul>
<li>Thorium can be launched from the application menu or from any
<ul>
<li>Thorium can be launched from the application menu or from any
shortcut created. This action will open the
<a href="">library home
<a href="">library home
view</a> and will allow you to choose a book or to add
one but also to access to
<a href="">catalogs</a> and organize your
<a href="">catalogs</a> and organize your
collection. To read a book just click on it or validate with

<kbd>Enter</kbd> when selected.
</li>
<li>Select the book you want to read, use the
<code>contextual menu</code> (right
<kbd>Enter</kbd> when selected.
</li>
<li>Select the book you want to read, use the
<code>contextual menu</code> (right
click), select
<code>open with</code> and then select
<code>Thorium</code>.
</li>
<li>You can set the default application for certain file types through
<code>open with</code> and then select
<code>Thorium</code>.
</li>
<li>You can set the default application for certain file types through
the Windows settings. Select a file, open the context menu, select

<code>Open with</code>, in the pop-up window select
<code>Thorium</code>, check the box
<code>Open with</code>, in the pop-up window select
<code>Thorium</code>, check the box

<code>Always open with</code>. This operation must be repeated for each file
<code>Always open with</code>. This operation must be repeated for each file
format you wish to read with Thorium.
</li>
</ul>
</li>
</ul>
</section>
</body>
</html>
Loading

0 comments on commit 3827bff

Please sign in to comment.