Module Reading Time
This Module displays the estimated reading time for the words on a Wiki page (inner modules are excluded). To avoid displaying empty module on non wiki page object, set the module Visibility Section to wiki.
Usage
To use module Reading Time in a wiki page:
Copy to clipboard
{module module="reading_time" wordsPerMinutes="200" minTimeThreshold="1" minTimeThresholdText="Reading time: Less than a minute" maxTimeThreshold="30" maxTimeThresholdText="Reading time: Less than a minute" timePrefixText="Approximate reading time:" timePostfixText="min." timeMinutesOnly="n"}
Where:
Displays the estimated reading time for the words on a Wiki page (inner modules are excluded). To avoid displaying empty module on non wiki page object, set the module Visibility,Section to wiki.
Go to the source code
Preferences required: feature_wiki
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
maxTimeThreshold |
int | value in minutes above which it is not needed to display the time. Set to 0 for none. | 30 | |
maxTimeThresholdText |
text | Text displayed when the reading time is above the maximum threshold value. | Reading time: More than 30 minutes | |
minTimeThreshold |
int | value in minutes below which it is not needed to display the time. Set to 0 for none. | 1 | |
minTimeThresholdText |
text | Text displayed when the reading time is below the minimum threshold value. | Reading time: Less than a minute | |
timePostfixText |
text | Text displayed after the result (the reading time). | min. | |
timePrefixText |
text | Text displayed before the result (the reading time). | Approximate reading time: | |
wordsPerMinutes |
int | The number of words human can read per minute. | 200 | |
timeMinutesOnly |
(blank) y n |
Will not displays the seconds and round up the result if the value is bigger than 30s. | n |
Example
In the example below we pass in a wiki page the module Reading Time through the plugin module.
So, this code:
Copy to clipboard
{module module="reading_time" wordsPerMinutes="200" minTimeThreshold="1" minTimeThresholdText="Reading time: Less than a minute" maxTimeThreshold="30" maxTimeThresholdText="Reading time: Less than a minute" timePrefixText="Approximate reading time:" timePostfixText="minutes" timeMinutesOnly="y"}
Produces on this site:
Reading Time
Reading time: Less than a minute
Related Pages
See these pages for information that applies for all modules:
- Module — Overall introduction and overview
- Module Admin — Introduction to the module admin pages for site-wide and individual module settings
- Assigning Modules — How to select a module to configure it
- Module Settings Interface — Interface for configuring individual module settings
- Module Settings Parameters — Explanation of standard parameter settings for modules
- Creating Custom Modules — How to create user modules
- Index of Modules — Links to the documentation of individual modules
- User Modules — How (if the feature is active) users can choose and place their modules
- Mods Type Modules — Links to modules that are installed as components