WordPress.org
Get WordPress

Plugin Directory

Changeset 3483350


Ignore:
Timestamp:
03/16/2026 01:03:55 AM (12 days ago)
Author:
wrcisco
Message:

Update readme and remove useless zip file from previous version.

Location:
simple-ebook-viewer
Files:
1 deleted
4 edited

Legend:

Unmodified
Added
Removed

  • simple-ebook-viewer/tags/1.0.0/README.md

    r3480712 r3483350  
    11# Simple Ebook Viewer for WordPress
    22
    3 Simple plugin for WordPress that enables you to upload various ebook formats as normal media files and to display them in your site using a shortcode.
     3Simple plugin for WordPress that enables you to upload various ebook formats as normal media files and to display them on your site using a shortcode.
    44
    5 Every ebook uploaded in your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
     5Every ebook uploaded on your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
    66
    77The plugin uses the library [foliate-js](https://github.com/johnfactotum/foliate-js) by John Factotum to display ebooks in the browser.
    … …  
    8484`Show-annotations` and `show-page-delimiters` let the user see on the pages the Calibre annotations (as highlighted text, if there are Calibre annotations in the ebook) and the page delimiters (as short vertical bars, if the ebook contains a page list).
    8585
    86 `Color-scheme`: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user in their device or browser (light or dark).
     86`Color-scheme`: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user on their device or browser (light or dark).
    8787
    88 For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
     88For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users also have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
    8989
    9090You can set the default values for these filters with the following shortcode's attributes:
    … …  
    100100  - accepted values: a valid CSS hex color code (default: **#FFFFFF**)
    101101
    102 Set `activate-color-filter` to "true" is necessary to enable all the other filters, and set `bg-transparent-filter` to false is necessary to enable `bg-color-filter`.
     102Setting `activate-color-filter` to "true" is necessary to enable all the other filters, and setting `bg-transparent-filter` to false is necessary to enable `bg-color-filter`.
    103103
    104104`Bg-transparent-filter` and `bg-color-filter` are available for reflowable ebooks only.
    105105
    106 `Invert-color-filter` inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, the white will become black and the black will become white.
     106`Invert-color-filter` inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, white become black and black become white.
    107107
    108 `Rotate-color-filter` rotates the hues of all the colors in the ebook, like in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
     108`Rotate-color-filter` rotates the hues of all the colors in the ebook, like on a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
    109109
    110110There are some other settings that the users won't be able to change by themselves. These are:
    … …  
    112112  - accepted values: "**true**", "**false**" (default: **false**. If **true**, **return-to-url** is also required)
    113113* **`return-to-url`**
    114   - accepted values: a URL with the same hostname than the page that contains the ebook viewer (default: '')
     114  - accepted values: a URL with the same hostname as the page that contains the ebook viewer (default: '')
    115115* **`real-fullscreen`**
    116116  - accepted values: "**true**", "**false**" (default: **false**)
    … …  
    126126  - accepted values: "**true**", "**false**" (default: **true**)
    127127
    128 With `always-full-viewport` set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. `always-full-viewport="true"` requires that also `return-to-url` is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative, like "/" or "/books-gallery", or it can be absolute, but it needs to have the same hostname of the webpage that contains the ebook viewer (e.g. if the ebook viewer is opened in https://www.example.com/ebook-viewer, the URL in `return-to-url` needs to start with https://www.example.com).
     128With `always-full-viewport` set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. `always-full-viewport="true"` requires that also `return-to-url` is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative (e.g., "/" or "/books-gallery") or absolute. In either case, it must have the same hostname as the webpage containing the ebook viewer (e.g. if the viewer is at https://www.example.com/ebook-viewer, the absolute URL must start with https://www.example.com).
    129129
    130130If `real-fullscreen` is set to "true", the ebook viewer will cover the entire screen instead of only the viewport of the webpage when the user clicks on the "full screen" icon. With `real-fullscreen` set to true, `always-full-viewport` is ignored, since the full screen requires an explicit action by the user.
    … …  
    134134**Caveat 2**: the ebook viewer is not strongly equipped to deal with dynamic content created or removed after the ebook opening, so you might encounter errors or inaccuracies when jumping from one ebook location to another in such a circumstance.
    135135
    136 `Math-styles`: in recent years all the major browser have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expression without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
    137 Another shortcoming in the current support of MathML, is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
     136`Math-styles`: in recent years all the major browsers have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expressions without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
     137Another shortcoming in the current support of MathML is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
    138138
    139139`Ebook-author` and `ebook-title`: you can use these optional values to override the ones that the ebook viewer retrieves from the ebook metadata in order to display them to the users.
    140140
    141 `Popup-notes`: show footnotes and endnotes as popup instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
     141`Popup-notes`: show footnotes and endnotes as popups instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
    142142
    143143### Development
    … …  
    179179which is distributed under the MIT license.
    180180
    181 As secondary dependencies of the foliate-js library, the plugin embeds other three libraries:
     181As secondary dependencies of the foliate-js library, the plugin embeds three other libraries:
    182182* zip.js (https://github.com/gildas-lormeau/zip.js), licensed under the BSD-3-Clause;
    183183* fflate (https://github.com/101arrowz/fflate), MIT licensed.
    … …  
    197197* Latin Modern (https://www.gust.org.pl/projects/e-foundry) by the Polish TeX Users Group, licensed under the GUST Font License.
    198198
    199 OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, at the best of my knowledge, modifying their internal parameters and metadata.
     199OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, to the best of my knowledge, modifying their internal parameters and metadata.

  • simple-ebook-viewer/tags/1.0.0/readme.txt

    r3480740 r3483350  
    1212
    1313== Description ==
    14 After installing this plugin, you will be able to upload various ebook formats as normal media files and to display them in your site using a shortcode.
     14After installing this plugin, you will be able to upload various ebook formats as normal media files and to display them on your site using a shortcode.
    1515
    16 Every ebook uploaded in your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
     16Every ebook uploaded on your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
    1717
    1818The full source code of the plugin is hosted on [GitHub](https://github.com/wrCisco/simple-ebook-viewer-for-wp).
    … …  
    8585**Show-annotations** and **show-page-delimiters** let the user see on the pages the Calibre annotations (as highlighted text, if there are Calibre annotations in the ebook) and the page delimiters (as short vertical bars, if the ebook contains a page list).
    8686
    87 **Color-scheme**: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user in their device or browser (light or dark).
     87**Color-scheme**: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user on their device or browser (light or dark).
    8888
    89 For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
     89For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users also have the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
    9090
    9191You can set the default values for these filters with the following shortcode's attributes:
    … …  
    102102  - accepted values: a valid CSS hex color code (default: **#FFFFFF**)
    103103
    104 Set **activate-color-filter** to "true" is necessary to enable all the other filters, and set **bg-transparent-filter** to false is necessary to enable **bg-color-filter**.
     104Setting **activate-color-filter** to "true" is necessary to enable all the other filters, and setting **bg-transparent-filter** to false is necessary to enable **bg-color-filter**.
    105105
    106106**Bg-transparent-filter** and **bg-color-filter** are available for reflowable ebooks only.
    107107
    108 **Invert-color-filter** inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, the white will become black and the black will become white.
     108**Invert-color-filter** inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, white become black and black become white.
    109109
    110 **Rotate-color-filter** rotates the hues of all the colors in the ebook, like in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
     110**Rotate-color-filter** rotates the hues of all the colors in the ebook, like on a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
    111111
    112112There are some other settings that the users won't be able to change by themselves. These are:
    … …  
    115115  - accepted values: "**true**", "**false**" (default: **false**. If **true**, **return-to-url** is also required)
    116116* **`return-to-url`**
    117   - accepted values: a URL with the same hostname than the page that contains the ebook viewer (default: '')
     117  - accepted values: a URL with the same hostname as the page that contains the ebook viewer (default: '')
    118118* **`real-fullscreen`**
    119119  - accepted values: "**true**", "**false**" (default: **false**)
    … …  
    129129  - accepted values: "**true**", "**false**" (default: **true**)
    130130
    131 With **always-full-viewport** set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. **always-full-viewport="true"** requires that also **return-to-url** is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative, like "/" or "/books-gallery", or it can be absolute, but it needs to have the same hostname of the webpage that contains the ebook viewer (e.g. if the ebook viewer is opened in https://www.example.com/ebook-viewer, the URL in **return-to-url** needs to start with https://www.example.com).
     131With **always-full-viewport** set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. **always-full-viewport="true"** requires that also **return-to-url** is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative (e.g., "/" or "/books-gallery") or absolute. In either case, it must have the same hostname as the webpage containing the ebook viewer (e.g. if the viewer is at https://www.example.com/ebook-viewer, the absolute URL must start with https://www.example.com).
    132132
    133133If **real-fullscreen** is set to "true", the ebook viewer will cover the entire screen instead of only the viewport of the webpage when the user clicks on the "full screen" icon. With **real-fullscreen** set to true, **always-full-viewport** is ignored, since the full screen requires an explicit action by the user.
    … …  
    137137**Caveat 2**: the ebook viewer is not strongly equipped to deal with dynamic content created or removed after the ebook opening, so you might encounter errors or inaccuracies when jumping from one ebook location to another in such a circumstance.
    138138
    139 **Math-styles**: in recent years all the major browser have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expression without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
    140 Another shortcoming in the current support of MathML, is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
     139**Math-styles**: in recent years all the major browsers have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expressions without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
     140Another shortcoming in the current support of MathML is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
    141141
    142142**Ebook-author** and **ebook-title**: you can use these optional values to override the ones that the ebook viewer retrieves from the ebook metadata in order to display them to the users.
    143143
    144 **Popup-notes**: show footnotes and endnotes as popup instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
     144**Popup-notes**: show footnotes and endnotes as popups instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
    145145
    146146== Warning ==
    … …  
    154154which is distributed under the MIT license.
    155155
    156 As secondary dependencies of the foliate-js library, the plugin embeds other three libraries:
     156As secondary dependencies of the foliate-js library, the plugin embeds three other libraries:
    157157
    158158* zip.js (https://github.com/gildas-lormeau/zip.js), licensed under the BSD-3-Clause;
    … …  
    175175* Latin Modern (https://www.gust.org.pl/projects/e-foundry) by the Polish TeX Users Group, licensed under the GUST Font License.
    176176
    177 OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, at the best of my knowledge, modifying their internal parameters and metadata.
     177OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, to the best of my knowledge, modifying their internal parameters and metadata.

  • simple-ebook-viewer/trunk/README.md

    r3480712 r3483350  
    11# Simple Ebook Viewer for WordPress
    22
    3 Simple plugin for WordPress that enables you to upload various ebook formats as normal media files and to display them in your site using a shortcode.
     3Simple plugin for WordPress that enables you to upload various ebook formats as normal media files and to display them on your site using a shortcode.
    44
    5 Every ebook uploaded in your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
     5Every ebook uploaded on your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
    66
    77The plugin uses the library [foliate-js](https://github.com/johnfactotum/foliate-js) by John Factotum to display ebooks in the browser.
    … …  
    8484`Show-annotations` and `show-page-delimiters` let the user see on the pages the Calibre annotations (as highlighted text, if there are Calibre annotations in the ebook) and the page delimiters (as short vertical bars, if the ebook contains a page list).
    8585
    86 `Color-scheme`: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user in their device or browser (light or dark).
     86`Color-scheme`: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user on their device or browser (light or dark).
    8787
    88 For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
     88For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users also have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
    8989
    9090You can set the default values for these filters with the following shortcode's attributes:
    … …  
    100100  - accepted values: a valid CSS hex color code (default: **#FFFFFF**)
    101101
    102 Set `activate-color-filter` to "true" is necessary to enable all the other filters, and set `bg-transparent-filter` to false is necessary to enable `bg-color-filter`.
     102Setting `activate-color-filter` to "true" is necessary to enable all the other filters, and setting `bg-transparent-filter` to false is necessary to enable `bg-color-filter`.
    103103
    104104`Bg-transparent-filter` and `bg-color-filter` are available for reflowable ebooks only.
    105105
    106 `Invert-color-filter` inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, the white will become black and the black will become white.
     106`Invert-color-filter` inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, white become black and black become white.
    107107
    108 `Rotate-color-filter` rotates the hues of all the colors in the ebook, like in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
     108`Rotate-color-filter` rotates the hues of all the colors in the ebook, like on a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
    109109
    110110There are some other settings that the users won't be able to change by themselves. These are:
    … …  
    112112  - accepted values: "**true**", "**false**" (default: **false**. If **true**, **return-to-url** is also required)
    113113* **`return-to-url`**
    114   - accepted values: a URL with the same hostname than the page that contains the ebook viewer (default: '')
     114  - accepted values: a URL with the same hostname as the page that contains the ebook viewer (default: '')
    115115* **`real-fullscreen`**
    116116  - accepted values: "**true**", "**false**" (default: **false**)
    … …  
    126126  - accepted values: "**true**", "**false**" (default: **true**)
    127127
    128 With `always-full-viewport` set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. `always-full-viewport="true"` requires that also `return-to-url` is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative, like "/" or "/books-gallery", or it can be absolute, but it needs to have the same hostname of the webpage that contains the ebook viewer (e.g. if the ebook viewer is opened in https://www.example.com/ebook-viewer, the URL in `return-to-url` needs to start with https://www.example.com).
     128With `always-full-viewport` set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. `always-full-viewport="true"` requires that also `return-to-url` is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative (e.g., "/" or "/books-gallery") or absolute. In either case, it must have the same hostname as the webpage containing the ebook viewer (e.g. if the viewer is at https://www.example.com/ebook-viewer, the absolute URL must start with https://www.example.com).
    129129
    130130If `real-fullscreen` is set to "true", the ebook viewer will cover the entire screen instead of only the viewport of the webpage when the user clicks on the "full screen" icon. With `real-fullscreen` set to true, `always-full-viewport` is ignored, since the full screen requires an explicit action by the user.
    … …  
    134134**Caveat 2**: the ebook viewer is not strongly equipped to deal with dynamic content created or removed after the ebook opening, so you might encounter errors or inaccuracies when jumping from one ebook location to another in such a circumstance.
    135135
    136 `Math-styles`: in recent years all the major browser have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expression without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
    137 Another shortcoming in the current support of MathML, is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
     136`Math-styles`: in recent years all the major browsers have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expressions without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
     137Another shortcoming in the current support of MathML is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
    138138
    139139`Ebook-author` and `ebook-title`: you can use these optional values to override the ones that the ebook viewer retrieves from the ebook metadata in order to display them to the users.
    140140
    141 `Popup-notes`: show footnotes and endnotes as popup instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
     141`Popup-notes`: show footnotes and endnotes as popups instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
    142142
    143143### Development
    … …  
    179179which is distributed under the MIT license.
    180180
    181 As secondary dependencies of the foliate-js library, the plugin embeds other three libraries:
     181As secondary dependencies of the foliate-js library, the plugin embeds three other libraries:
    182182* zip.js (https://github.com/gildas-lormeau/zip.js), licensed under the BSD-3-Clause;
    183183* fflate (https://github.com/101arrowz/fflate), MIT licensed.
    … …  
    197197* Latin Modern (https://www.gust.org.pl/projects/e-foundry) by the Polish TeX Users Group, licensed under the GUST Font License.
    198198
    199 OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, at the best of my knowledge, modifying their internal parameters and metadata.
     199OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, to the best of my knowledge, modifying their internal parameters and metadata.

  • simple-ebook-viewer/trunk/readme.txt

    r3480740 r3483350  
    1212
    1313== Description ==
    14 After installing this plugin, you will be able to upload various ebook formats as normal media files and to display them in your site using a shortcode.
     14After installing this plugin, you will be able to upload various ebook formats as normal media files and to display them on your site using a shortcode.
    1515
    16 Every ebook uploaded in your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
     16Every ebook uploaded on your site will have an "ebook slug" (by default it will be the ebook name) that you can view and edit in the Edit Media page of the Admin Panel.
    1717
    1818The full source code of the plugin is hosted on [GitHub](https://github.com/wrCisco/simple-ebook-viewer-for-wp).
    … …  
    8585**Show-annotations** and **show-page-delimiters** let the user see on the pages the Calibre annotations (as highlighted text, if there are Calibre annotations in the ebook) and the page delimiters (as short vertical bars, if the ebook contains a page list).
    8686
    87 **Color-scheme**: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user in their device or browser (light or dark).
     87**Color-scheme**: "auto" means that the Viewer will adapt to the preferred color-scheme set by the user on their device or browser (light or dark).
    8888
    89 For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users have also the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
     89For most ebooks these preferences should be enough, but sometimes there are ebooks with style rules that don't play well with the styles set by the Viewer, so the users also have the option to apply some filters to the Viewer's colors (with the menu entry "Color filter...").
    9090
    9191You can set the default values for these filters with the following shortcode's attributes:
    … …  
    102102  - accepted values: a valid CSS hex color code (default: **#FFFFFF**)
    103103
    104 Set **activate-color-filter** to "true" is necessary to enable all the other filters, and set **bg-transparent-filter** to false is necessary to enable **bg-color-filter**.
     104Setting **activate-color-filter** to "true" is necessary to enable all the other filters, and setting **bg-transparent-filter** to false is necessary to enable **bg-color-filter**.
    105105
    106106**Bg-transparent-filter** and **bg-color-filter** are available for reflowable ebooks only.
    107107
    108 **Invert-color-filter** inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, the white will become black and the black will become white.
     108**Invert-color-filter** inverts the lightness of the colors. With a value of 0 it has no effect, with a value of 1, white become black and black become white.
    109109
    110 **Rotate-color-filter** rotates the hues of all the colors in the ebook, like in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
     110**Rotate-color-filter** rotates the hues of all the colors in the ebook, like on a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white).
    111111
    112112There are some other settings that the users won't be able to change by themselves. These are:
    … …  
    115115  - accepted values: "**true**", "**false**" (default: **false**. If **true**, **return-to-url** is also required)
    116116* **`return-to-url`**
    117   - accepted values: a URL with the same hostname than the page that contains the ebook viewer (default: '')
     117  - accepted values: a URL with the same hostname as the page that contains the ebook viewer (default: '')
    118118* **`real-fullscreen`**
    119119  - accepted values: "**true**", "**false**" (default: **false**)
    … …  
    129129  - accepted values: "**true**", "**false**" (default: **true**)
    130130
    131 With **always-full-viewport** set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. **always-full-viewport="true"** requires that also **return-to-url** is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative, like "/" or "/books-gallery", or it can be absolute, but it needs to have the same hostname of the webpage that contains the ebook viewer (e.g. if the ebook viewer is opened in https://www.example.com/ebook-viewer, the URL in **return-to-url** needs to start with https://www.example.com).
     131With **always-full-viewport** set to "true", the ebook viewer will automatically cover the entire webpage when it is opened, and the "full screen" icon will be replaced by a "close viewer" icon. **always-full-viewport="true"** requires that also **return-to-url** is present, with a valid URL that indicates the destination of the user when they choose to close the viewer. The URL can be relative (e.g., "/" or "/books-gallery") or absolute. In either case, it must have the same hostname as the webpage containing the ebook viewer (e.g. if the viewer is at https://www.example.com/ebook-viewer, the absolute URL must start with https://www.example.com).
    132132
    133133If **real-fullscreen** is set to "true", the ebook viewer will cover the entire screen instead of only the viewport of the webpage when the user clicks on the "full screen" icon. With **real-fullscreen** set to true, **always-full-viewport** is ignored, since the full screen requires an explicit action by the user.
    … …  
    137137**Caveat 2**: the ebook viewer is not strongly equipped to deal with dynamic content created or removed after the ebook opening, so you might encounter errors or inaccuracies when jumping from one ebook location to another in such a circumstance.
    138138
    139 **Math-styles**: in recent years all the major browser have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expression without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
    140 Another shortcoming in the current support of MathML, is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
     139**Math-styles**: in recent years all the major browsers have implemented a good deal of the MathML Core specification, so it is now possible to represent natively many mathematical expressions without the use of third party libraries. However, not all browsers and systems load automatically appropriate fonts. With math-styles set to "fonts" or "all", all the contents of MathML expression will use the Latin Modern font.
     140Another shortcoming in the current support of MathML is that only Gecko based browsers (i.e. Firefox) implement a breaking lines algorithm, so long math expressions within small screens usually don't fit entirely. With math-styles set to "styles" or "all", the plugin will use some html+css tricks to try to allow either line breaks or horizontal scrolling.
    141141
    142142**Ebook-author** and **ebook-title**: you can use these optional values to override the ones that the ebook viewer retrieves from the ebook metadata in order to display them to the users.
    143143
    144 **Popup-notes**: show footnotes and endnotes as popup instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
     144**Popup-notes**: show footnotes and endnotes as popups instead of just links. The notes (and their references) need to be marked with the appropriate epub:type attributes to ensure that they are displayed as popups (the ebook viewer will try to recognize them anyway, but without guarantees).
    145145
    146146== Warning ==
    … …  
    154154which is distributed under the MIT license.
    155155
    156 As secondary dependencies of the foliate-js library, the plugin embeds other three libraries:
     156As secondary dependencies of the foliate-js library, the plugin embeds three other libraries:
    157157
    158158* zip.js (https://github.com/gildas-lormeau/zip.js), licensed under the BSD-3-Clause;
    … …  
    175175* Latin Modern (https://www.gust.org.pl/projects/e-foundry) by the Polish TeX Users Group, licensed under the GUST Font License.
    176176
    177 OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, at the best of my knowledge, modifying their internal parameters and metadata.
     177OpenDyslexic and Latin Modern fonts have been converted from their original OpenType format to the woff2 format for use on the web, without, to the best of my knowledge, modifying their internal parameters and metadata.
Note: See TracChangeset for help on using the changeset viewer.