ReadTime

Introduction

ReadTime is a Joomla content plugin which shows the estimated reading time and a progress bar for your posts, enhancing user engagement by providing readers with an idea of how long it will take to read an article. This documentation covers the installation, configuration, and usage of the ReadTime plugin.

Installation

Downloading the Extension

Email: After you purchase the extension from our store, you will receive an email containing a link to download the extension.

Store: Alternatively, you can download the extension from the "Downloads" section in our store. If you are a new user, you need to create an account using the same email address you used for the purchase.

Click to download the extension package: ReadTime_UNZIP.zip

Unzipping the Package

Use any file unzipper tool or WinRAR to unzip the ReadTime_UNZIP.zip package. After unzipping, you will find the following contents:

• plg_readtime.zip: This is the installation file compatible with Joomla 4.x and Joomla 5.x.
• ReadMe.txt: Contains vital information about the current version of the extension.

Installing the Extension

To install the extension, log in to the backend of your Joomla website.

• For Joomla 4 & 5: Navigate to Extensions > Install, then click on the "Upload Package File" tab. Click "Browse" to select the installation file (plg_readtime.zip), then click "Upload and Install."

A success message will be displayed once the installation is complete.

Configuration

After installation, the plugin needs to be configured to suit your requirements. Access the plugin settings by navigating to Extensions > Plugins, and find Content - ReadTime in the list.

General Settings

• Minimum Words Per Minute: Enter the minimum words per minute for reading time calculation.
  • Default: 200
• Maximum Words Per Minute: Enter the maximum words per minute for reading time calculation.
  • Default: 300
• Excluded Categories: Select categories to exclude from showing the reading time. Select 'Uncategorized' to exclude uncategorized articles.
• Exclude Views: Select views to exclude from showing the reading time (e.g., featured, blog, category).
• Exclude Article ID(s): Enter the article IDs to be excluded. Only one article ID per line.
• Reading Time Text: Customize the text for reading time display.
  • Default: Reading Time:
• Singular Minute Text: Customize the text for singular minute.
  • Default: minute
• Plural Minutes Text: Customize the text for plural minutes.
  • Default: minutes
• Singular Second Text: Customize the text for singular second.
  • Default: second
• Plural Seconds Text: Customize the text for plural seconds.
  • Default: seconds
• Show in Seconds: Choose whether to show the reading time in seconds.
  • Options: Yes, No
  • Default: No
• Show Progress Bar: Choose whether to show the progress bar.
  • Options: Yes, No
  • Default: Yes

Styling Options

• Reading Time Color: Set the color of the reading time text.
  • Default: #000000
• Reading Time Font Size: Set the font size of the reading time text.
  • Default: 16px
• Reading Time Font Weight: Set the font weight of the reading time text.
  • Options: Normal, Bold, Bolder, Lighter
  • Default: Normal
• Reading Time Alignment: Set the alignment of the reading time text.
  • Options: Left, Center, Right
  • Default: Left
• Progress Bar Thickness: Set the thickness of the progress bar.
  • Default: 5px
• Progress Bar Color: Set the color of the progress bar.
  • Default: #29e
• Progress Bar Position: Set the position of the progress bar.
  • Options: Top, Bottom
  • Default: Top

Features

Once configured, the ReadTime plugin will automatically display the estimated reading time and a progress bar for your articles based on the settings you have defined. No additional steps are required to activate the plugin for your content.

Features

• Estimated Reading Time: Shows the estimated reading time for articles based on word count and reading speed.
• Progress Bar: Displays a progress bar indicating how much of the article has been read.
• Customizable Text: Customize the display text for reading time and the format for singular and plural minutes and seconds.
• Styling Options: Customize the color, font size, font weight, and alignment of the reading time text, as well as the color, thickness, and position of the progress bar.
• Exclusions: Exclude specific categories, views, and articles from displaying the reading time and progress bar.

FAQ

• How do I change the reading speed?

  • Adjust the Minimum Words Per Minute and Maximum Words Per Minute settings under General Settings.

• Can I exclude certain articles from showing the reading time?

  • Yes, use the Exclude Article ID(s) setting to enter the IDs of articles you want to exclude.

• How do I customize the appearance of the progress bar?

  • Configure the Progress Bar Thickness, Progress Bar Color, and Progress Bar Position settings under Styling Options.

• Can I show the reading time in seconds?

  • Yes, set Show in Seconds to Yes under General Settings.

Troubleshooting

• Reading Time Not Displaying: Ensure the plugin is enabled and the settings are correctly configured.
• Progress Bar Not Visible: Check the Show Progress Bar setting and ensure it is enabled. Verify the Progress Bar Color and Progress Bar Thickness settings.
• Styling Issues: Review the Styling Options for any conflicts or incorrect values.