New Readingtime extension

[schulle4u]

Hello,

I've published Readingtime, an extension which adds a simple reading time indicator to your pages. The estimated reading time is based on a words per minute calculation (word count / words per minute). You can modify the words per minute value for your content and audience. The shortcut has been designed as inline shortcut and only displays the numeric value, meaning you can put whatever text you like around it, should also work in layouts. Please se examples section for more details.

The extension uses the partly undocumented getTextWords() function from Yellow's toolbox to ensure unicode/multibyte compatibility. So far I've tested with some russian text, but I'm not sure if it works well with asian languages. Feedback as always welcome. 🙂

[pftnhr]

Hi Steffen,

I would like to place the estimated reading time in a layout and not include it in a *.md via shortcut. Unfortunately, I am at a loss and would be pleased if you could help me.

Many thanks in advance
Robert

[pftnhr]

I see what you mean. I have now also entered a longer text and 4 minutes are displayed in blog.html and blog-start.html, but only 3 minutes in the search.

[markseuffert]

I think the second argument to parseContentShortcut() should be an empty string not null. See also #884.

[pftnhr]

Unfortunately, that was not it either. I have just created a text with 2472 words and for this I am given 10 min reading time everywhere except in the search, there it is 3 min.

[markseuffert]

You can use $page->parseContentShortcut("readingtime", "", "inline"). Please note this API method expects strings as input parameters, if you write null instead of "" you'll get some cryptic deprecation warnings in PHP 8. I didn't mean to say that this change fixes the reading time display in your layout file, but a different problem. Sorry for the confusion.

[pftnhr]

That's exactly how I've done it lately.

[schulle4u]

After some more research I came to the conclusion that the readingtime extension currently cannot be properly used in the search extension layout. Like previously assumed, the search extension works a little differently when parsing pages, and improves the search results before the layout renders them. Unfortunately it is far beyond my programming skills to write a workaround, assuming this is actually possible, and it is worth doing this for such a small gadget. Ideas and pull requests are of course welcome. 🙂

[pftnhr]

My programming skills are also limited. To a minimum, even. I'll remove the reading time from the search results for now and keep watching your extension. Thanks for your efforts!

[schulle4u]

An update to the search extension is available, which also should fix the word count issue in the search results layout. Could you please try if this works for you now?

[pftnhr]

It works! 😃

[schulle4u]

This extension has moved to individual repository