Tranquility Release Notes

Version 3.0.22

• Provide option to include/exclude header/footer when printing the page as PDF document
• Increase the margins of printed PDF to 1.0" (default 0.5"). At this time, margin is not user customizable
• Remove font size hardcoding of certain custom elements and make sure they also use the user specified font settings (certain element dimensions are now scaled based on user specified font size)
• Attempt to fix issue with scrolling to top of page after processing the page
• Fix regression where some of the related/supporting links were not showing up (for easy navigation in continuous browsing mode) See github issue #27 for more details
• Attempt to remove menu like elements on some pages

Version 3.0.21

• Preserve the original zoom setting (scale the font size instead)
• Clone the document instead of the body (attempt to remove more event listeners)
• Auto-hide the UI controls (toggle display on clicking on the body of the page)
• Reorganize code to separate out UI related functionality into a separate file

Version 3.0.20

• Update PRIVACY.md to reflect removal of "tabs" permission
• Handle corner case where pages with content in the "main" tag have content flowing outside the reading width
• Fix bug where the page up/down scroll buttons do not work in offline/saved pages
• Refine regexp to remove additional ad related elements
• Ignore CDATA nodes when measuring amount of text in an element

Version 3.0.19

• Adding missing heading/title if it has been removed during processing
• Move logic to hide/remove spurious elements from css to javascript code for better control; added additional filtering logic
• Add scroll buttons (for page-up/page-down) for people who prefer mouse to keyboard (and for mobile users)
• Always scroll back to the top of the page/article after transforming a page
• Try to retain images within an article/main tag
• Minor bug fixes and code restructuring/simplification
• Removed unnecessary "tabs" permission request since we are not using it

Version 3.0.18

• Bug fix for regression on some pages. The computed height and width property were used to identify hidden elements, but the logic used was incorrect. Undoing this change.
• Minor change to try and remove more unnecessary images that get restored even though their parent elements were removed

Version 3.0.17

• Allow users to configure A4/Letter paper size in extension preferences when saving the transformed page as a PDF
• Add the original/source link to the top of the transformed page. This is useful when the page is saved as a PDF or offline reading and the users have forgotten and need to refer to the original source.
• Bug fix so that we identify computed CSS style properties correctly

Version 3.0.16

• Enable keyboard shortcut available with legacy version (Ctrl+Alt+T)
• New keyboard option to launch preferences page (Ctrl+Alt+J)
• New keyboard option to launch saved/offline pages (Ctrl+Alt+K)
• Keyboard shortcuts are user customizable. Refer to the webpage: https://support.mozilla.org/en-US/kb/manage-extension-shortcuts-firefox
• Fix progress bar visibility bug when saving transformed page as PDF
• Fix bug in not reverting to original page when clicking on browser action icon (when the URL has a "#" reference
• Ability to view offline pages from the preferences page. This avoids the need to first run the extension on some page before a user can access the saved/offline pages
• Removed "Save as PDF" functionality from Android version. Android already has such an option on the Firefox-Page menu which works just fine. The icon only clutters up the usually smaller screen in Android phones/devices
• Added user friendly privacy policy statement and explanation of permissions used by the extension

Version 3.0.15

• Ability to save a PDF document of the Tranquility Reader view for offline reading or sharing with others (not supported on MacOS)
• Improve handling of images (fix cases where image width was larger than the reading width setting)
• Use CSS settings to identify some extraneous elements so that they can be removed from the page during processing
• Updated copyright message

Version 3.0.14

• Added an option to change browser action icon to a grayscale version

Version 3.0.13

• Fixed problem with TITLE/HEAD elements being removed because their default css property of display is "none". This causes a problem when saving a link for offline reading -- saved article shows up with a blank name
• Fixed logic for replacing using the contents of the ARTICLE tag as proxy for the entire content of the page. The original solution of replacing just the parent was not sufficient to remove a lot of other crud. Now, we replace the entire body of the page with the article tag contents

Version 3.0.12

• Attempt to remove all event handlers in the original page to prevent them from modifying the processed page
• Fix to handle pages that have windows-1252 encoding
• Ignore links like "mail:" that need not be processed by the addon and which caused the addon to freeze while processing pages with such links
• More aggressive removal of hidden elements this can cause more images to be removed in the processed view
• Removal of links with onclick events/javascript since they are often associated with social media forwarding links/images and clutter the processed page
• Minor changes to make code consistent (tag names are now all in uppercase)

Version 3.0.11

• When a reader click on a link in the tranquility mode, the page updates to show the clicked URL contents in the tranquility mode. However, the address bar is not updated.
• An icon is provided on the top right corner of the page with a link to the URL of the page that is currently processed/displayed.
• Updated copyright message

Version 3.0.10

• Fix to scale images better
• Remove hidden images (based on the computedStyle properties)
• Allow smaller length text content to show more information. This can have the side effect of unnecessary material getting into the tranquilized view. So, this is currently experimental.
• Updated copyright message

Version 3.0.9

• Add support to handle #links; Tranquility currently tries to reload the entire page and reprocess instead of moving to the #link.
• Experimental support to handle images better. Most images were being removed. Added support for images. Currently, more images than necessary are retained (including some pesky icons) but the changes are ready for publishing to a wider audience to receive feedback.

Version 3.0.8

• Default font size for Android preset was changed to 15 (a typo had set it to 25 instead).

Version 3.0.7

• Ability to highlight a portion of a web page and run Tranquility to process and display only the selected text. Right click and select "Tranquilize Selection!" from the context menu.
• Gives users additional control on the content they wish to read. Not supported on Android.

Version 3.0.6

• Create and manage user defined presets for tranquility preferences
• Changes made to the preferences are instantly reflected on all tabs in the Tranquility Reader view. This allows for fast iterations in customizing user preferences.

Version 3.0.5

• Limited support for Firefox on AndroidOS (version 55 and later)
• Only the browserAction (running Tranquility by selecting the browser toolbar menu option) is available on AndroidOS
• No command shortcuts or right click context menus provided on AndroidOS
• Currently no ability to to import/export the offline pages on AndroidOS
• Changes to css/default options for AndroidOS/smaller screen devices.

Version 3.0.4

• Removed popup menu for the browser action; now, clicking on the Tranquility icon will make the page readable. For the other actions provided through the popup menu, users will have to go to the options page or use the Read Later button after running tranquility.
• Added a few "preset" configurations (color schemes and font colors) rather than having to customize each option manually. This is experimental at this time; will explore the option of allowing users to import a configuration file for this in the future.
• Changed the background page to "about:blank" (instead of mozilla.org) when loading offline pages from the options window.
• Minor bug fix to remove the progress bar which was not being removed in some corner cases.
• Bug fix to correctly load original page when toggling Tranquility mode for an offline page.
• Bug fix to handle loading mixed security content pages correctly
• Bug fix to handle pre-formatted pages correctly

Version 3.0/3.0.1

• Written using WebExtensions APIs
• First release with support for Chrome/Chromium browsers (all prior versions work only with Firefox)
• Ability to export/import offline content (please be sure to export offline content from version 2.0 and manually import into version 3.0.1)
• Reduced set of customization options (limitation of WebExtensions APIs)
• Removed support for background image and wikipedia/wiktionary search facility
• No keyboard shortcuts (very limited options available through WebExtensions APIs - waiting for more customization capabilities)
• Several minor bug fixes that were put off until this version

Version 2.0

• Ability to export saved offline content to a .json file (right click on link at the top of the list of offline files available and select "Save As", to save as a .json file. This file can be imported into future versions of Tranquility.

Version 1.2.1

• Moved Menu to the bottom of the window; hide it faster (less obtrusive)
• Tranquility font size will override the page specific cached zoom level
• Support for a background image (FilePicker to select local file)
• Support for custom hex color codes for background, font, links, annotation highlighting
• Converted some hard coded string values to use localization
• Reduced complexity by eliminating support for defaultFontColor and defaultBackgroundColor etc.
• Removed support for Firefox versions prior to Firefox 20.0
• No longer detect documents with minimal content and no longer warn about document still loading (did not help the user experience; more negative feedback than positive regarding these features)
• Now when offline reading list is requested when the active tab is not in tranquility view (or not a html document, such as the "New Tab" view), then the offline reading list is opened in a new tab.

Version 1.1.8

• Check private browsing mode and alert that "Read Later" functionality is not available.
• Minor changes to menu show/hide logic. The menu is now almost completely hidden, and the expand menu button (+) is now moved to the top right of the browser window. so that when printing the page, neither the menu nor the button obscure the text on the page.
• Handle url's that point to text files better. Files that have only preformatted content were not being processed correctly (line breaks were being removed from the preformatted contents also).

Version 1.1.7

• Ability to edit notes/annotations.
• Minor algorithm changes to remove additional hidden elements.
• Autohide menu after a few seconds for improved readability.

Version 1.1.6

• Ability to add notes and annotations to offline content; Select a portion of the text and right click to get the context menu "Tranquility - Add Annotation" to add a new annotation.
• A summary of all the annotations is available via the "View Notes" button. This is a convenient way to collate all notes and compile them for a report (or for later review).
• The layout of the tranquility mode has been streamlined and given a more minimal appearance. Buttons have been moved from the side to the top. The reading area border has been removed to improve readability.

Version 1.1.5

• Invalid Release

Version 1.1.4

• "Read Later" functionality to store tranquility view of pages for offline reading

Version 1.1.3

• Support for customization of link color, line width, text-justification
• Bug fix for a corner case where the tranquility view reversed the display order of all paragraphs in the web page

Version 1.1.2

• Non-English users can now select the Wikipedia language of choice from the Preferences window
• Images and Preformatted content will be resized to fit within the reading width
• Additional support for multi-page articles. A navigation pane is provided at the top and bottom of the web page to navigate to the Next or Previous page or to a specific numbered page/link, if available
• Modification of code to use String Bundles to allow for localization
• Improved handling of formatted links in the Tranquil Browsing Mode
• If the Print or Single Page View does not return sufficient content Tranquility will now try to process the original page. This may help in some cases where the Print or Single Page View is available only to registered/premium users
• Users can now select the pruning strategy used by Tranquility in its attempt to get a readable web page. The default option is a Conservative pruning strategy. The Moderate and Aggressive pruning strategies may result in truncation of relevant/useful content depending on the structure of the web page

Version 1.1.1

• Tranquility ToolBar button provides direct access to Tranquility Preferences
• Additional preference to enable PAUSE/BREAK button as a single keystroke shortcut for heavy users of Tranquility. This shortcut is disabled by default
• Ability to customize background color and font color (or revert back to the defaults)
• Additional links are now available through a "More Links" button
• Tranquil Browsing Mode is enabled by default. In this mode, left clicking on a link in the Tranquility view will also open the link URL in the Tranquility view in the current tab. Ctrl+Left Click will open the link URL in the Tranquility view in a new tab
• The main article s grayed out when viewing the Wiki panel or the "More Links" panel
• If a web page has not completed loading fully, Tranquility will wait for it to complete loading before processing the document
• Tranquility informs you when a web page has very little text content and reverts back to the original web page view. You can always force Tranquility to proceed anyway and show you the Tranquility view
• FreeDictionary has been replaced with Wiktionary (no ads)
• Bug fixes to improve handling of certain webpages

Version 1.0.6

• Improved handling of some web sites that were not processed correctly
• Preliminary support for HTML5 tags (article, section)

Version 1.0.5

• Clicking outside the wikipedia/freedictionary.org panel will hide the panel. This is more user friendly than clicking on the toolbar button or keyboard shortcut options to hide the panel

Version 1.0.4

• Fixed bug in font-size modification code
• Preference settings accessbile now through the Tools menu
• Keyboard access-keys added to Tools menu items
• Preference changes will update all tabs in the tranquility mode immediately. Prior to 1.0.4, the preference changes would take effect only the next time Tranquility is run

Version 1.0.3

• Wider range of font-sizes are now available (up to 64px)
• Ability to select text in the tranquility mode and right click to search wikipedia or freedictionary.org
• Keyboard shortcut Ctrl+Alt+D will toggle visibility of freedictionary.org query/panel
• Keyboard shortcut Ctrl+Alt+W will toggle visibility of wikipedia query/panel
• Clicking on the toolbar button will hide the wikipedia/freedictionary.org panel if it is visible; else, it will toggle the view with the orginal web content

Version 1.0.2

• New preference to control the width of the readable portion of the webpage
• Toolbar button size changed based on AMO review feedback

Version 1.0.1

• Toolbar button position changed based on original review feedback
• Ability to customize the font-family and font-size through preferences. These changes will take effect only on the subsequent webpages on which Tranquility is run

Version 1.0

• Invoke tranquility via Toolbar icon, Ctrl+Alt+T keyboard shortcut or right click context menu to open link in a new tab
• Unlike iReader and Readability, compatible with NoScript
• Preliminary support for multi-page documents (where a print view of a single page view is provided)
• Ability to disable the background image from the preferences window

Back to Tranquility main page