Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ep_readability

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ep_readability

Calculates the Flesch readability index in Etherpad, client based.

  • 0.0.19
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Click button to calculate the Flesch readability index

There'll be a button which calculates and displays the Flesch redability index.

Calculation of the Flesch index is triggered by entering !, ?, RETURN or BACKSPACE. Or by pushing the button.

The button shows a tooltip, which provides additional information.

Short sentences and words with only a few syllables ensure the readability of a text.

Calculation details

The original Flesch index is calculated for all languages. German umlauts are replaced (ä = a, ß = ss...).

Numbers are counted as a single syllable (1000,56 = one syllable).

Links are split into subparts (http://aaa-bbb.bla?foo=bar = http aaa bbb bla foo bar).

Readability scale

  • -1000: Dissertation, red
  • 10: Officialese, red
  • 20: AmbitiousNewspaper, orange
  • 35: AverageNewspaper, yellow
  • 50: YellowPress, green
  • 60: SalesLetter, green
  • 80: Slogan, green
  • 90: Comic, green

Demo

A demonstration can be found here:

http://palinode-langeweile.rhcloud.com

Install

On the command line, run npm install ep_readability.

Alternatively, browse to http://yourEtherpadliteInstan.ce/admin/plugins, search for readability and click install.

After restarting the server, the plugin takes effect.

TODO

Options to fine tune the counting process

The plugin interprets a line break (paragraph) as the end of a sentence. If text is copied into the pad, the line breaks may be incorrect and manual adjustment may be necessary.

Problematic text, counted as two sentences:

1. All participants
2. are expected to be awake.

Corrected text, counted as one sentence:

1. All participants are expected to be awake.
2. 

Numbers

Rethink the current solution for counting numbers as one syllable.

Rethink time definitions e.g., 20:30.

Regex

The internal work is based on a regex orgy. Which could be rewritten, maybe using DOM for additional capabilities like highlighting long words and sentences.

License

MIT

Other Resources

Some code of the TextStatistics package is being used.

TextStatistics.js, Christopher Giffard (2012)

https://github.com/DaveChild/Text-Statistics

Keywords

FAQs

Package last updated on 10 Sep 2013

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc