Changeset 3480740
- Timestamp:
- 03/12/2026 01:28:57 AM (2 weeks ago)
- Location:
- simple-ebook-viewer
- Files:
-
- 2 edited
-
tags/1.0.0/readme.txt (modified) (3 diffs)
-
trunk/readme.txt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
simple-ebook-viewer/tags/1.0.0/readme.txt
r3480737 r3480740 79 79 - accepted values: "**auto**", "**sepia**", "**light**", "**dark**" (default: **auto**) 80 80 81 `Layout`, `max-pages`, `default-font-size` and `page-margins` are only available for reflowable ebooks, while `zoom`is only available for fixed layout ones.81 **Layout**, **max-pages**, **default-font-size** and **page-margins** are only available for reflowable ebooks, while **zoom** is only available for fixed layout ones. 82 82 83 `Max-pages`is the maximum number of pages (in the "paginated" layout) that the user will be able to see in a single view (if there is enough screen space).83 **Max-pages** is the maximum number of pages (in the "paginated" layout) that the user will be able to see in a single view (if there is enough screen space). 84 84 85 `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).85 **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). 86 86 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 in their device or browser (light or dark). 88 88 89 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..."). … … 102 102 - accepted values: a valid CSS hex color code (default: **#FFFFFF**) 103 103 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`.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**. 105 105 106 `Bg-transparent-filter` and `bg-color-filter`are available for reflowable ebooks only.106 **Bg-transparent-filter** and **bg-color-filter** are available for reflowable ebooks only. 107 107 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, the white will become black and the black will become white. 109 109 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 in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white). 111 111 112 112 There are some other settings that the users won't be able to change by themselves. These are: … … 129 129 - accepted values: "**true**", "**false**" (default: **true**) 130 130 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).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). 132 132 133 If `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.133 If **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. 134 134 135 `Allow-js`: normally, the plugin forbids, as far as possible, script execution from inside the ebooks. If you set `allow-js`to true, this restriction is relaxed, and scripts within the ebook can be executed.135 **Allow-js**: normally, the plugin forbids, as far as possible, script execution from inside the ebooks. If you set **allow-js** to true, this restriction is relaxed, and scripts within the ebook can be executed. 136 136 **Caveat 1**: you need to be absolutely certain that the code inside the ebook is not malicious, since it can harm your entire webpage. 137 137 **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. 138 138 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.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 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. 141 141 142 `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.142 **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. 143 143 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 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). 145 145 146 146 == Warning == -
simple-ebook-viewer/trunk/readme.txt
r3480737 r3480740 79 79 - accepted values: "**auto**", "**sepia**", "**light**", "**dark**" (default: **auto**) 80 80 81 `Layout`, `max-pages`, `default-font-size` and `page-margins` are only available for reflowable ebooks, while `zoom`is only available for fixed layout ones.81 **Layout**, **max-pages**, **default-font-size** and **page-margins** are only available for reflowable ebooks, while **zoom** is only available for fixed layout ones. 82 82 83 `Max-pages`is the maximum number of pages (in the "paginated" layout) that the user will be able to see in a single view (if there is enough screen space).83 **Max-pages** is the maximum number of pages (in the "paginated" layout) that the user will be able to see in a single view (if there is enough screen space). 84 84 85 `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).85 **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). 86 86 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 in their device or browser (light or dark). 88 88 89 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..."). … … 102 102 - accepted values: a valid CSS hex color code (default: **#FFFFFF**) 103 103 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`.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**. 105 105 106 `Bg-transparent-filter` and `bg-color-filter`are available for reflowable ebooks only.106 **Bg-transparent-filter** and **bg-color-filter** are available for reflowable ebooks only. 107 107 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, the white will become black and the black will become white. 109 109 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 in a [Color Wheel](https://developer.mozilla.org/en-US/docs/Glossary/Color_wheel) (so, no effect on black and white). 111 111 112 112 There are some other settings that the users won't be able to change by themselves. These are: … … 129 129 - accepted values: "**true**", "**false**" (default: **true**) 130 130 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).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). 132 132 133 If `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.133 If **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. 134 134 135 `Allow-js`: normally, the plugin forbids, as far as possible, script execution from inside the ebooks. If you set `allow-js`to true, this restriction is relaxed, and scripts within the ebook can be executed.135 **Allow-js**: normally, the plugin forbids, as far as possible, script execution from inside the ebooks. If you set **allow-js** to true, this restriction is relaxed, and scripts within the ebook can be executed. 136 136 **Caveat 1**: you need to be absolutely certain that the code inside the ebook is not malicious, since it can harm your entire webpage. 137 137 **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. 138 138 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.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 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. 141 141 142 `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.142 **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. 143 143 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 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). 145 145 146 146 == Warning ==
Note: See TracChangeset
for help on using the changeset viewer.