Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pull in Hemingway app readability grades to CKEditor #292

Closed
davidrkupton opened this issue Mar 8, 2019 · 8 comments
Closed

Pull in Hemingway app readability grades to CKEditor #292

davidrkupton opened this issue Mar 8, 2019 · 8 comments
Assignees

Comments

@davidrkupton
Copy link
Contributor

davidrkupton commented Mar 8, 2019

Using the PHP API at https://github.com/DaveChild/Text-Statistics, make real-time Hemmingway style calculations of readability (e.g. US School Grade) and complexity available on-site to content-editors.

https://ipeirotis-hrd.appspot.com/

Proposed visualization strategy:

  1. When a node is saved, run an assessment on content and provide selected grade and complexity statistics as an on-screen message.
  2. Add grammar/readability and grade-level statistics for a node/page to a new panel on the moderation sidebar

Proposed calculation:

  • use the API to generate statistics on "analyzable content" contained within textboxes that have a WYSIWYG editor (i.e. Drupal Text Long types). The node itself and any components on the node would be analyzed.
  • Join all "analyzable content" fields into s single text block to give an overall complexity for the page.
  • Initially would have a global target for complexity and grade across all pages and page types, possible extension is to set targets for complexity and grade for each node (page type).
@davidrkupton
Copy link
Contributor Author

-Note this could be a second, stand-alone module that the city could contribute to the Drupal community.

@davidrkupton
Copy link
Contributor Author

davidrkupton commented Mar 8, 2019

The grammar element of Hemmingway could possibly be achieved by downloading a JS based grammar checker into the WYSIWYG editor (if there is not already one there) and have it ON by default.

  • Also some browsers may have extensions that do this which could be enabled for frequently active content editors ...

@davidrkupton
Copy link
Contributor Author

davidrkupton commented Mar 8, 2019

More Hemmingway info:
Hemmingway email: https://drive.google.com/file/d/1W9sEdAPJqn-FlV3clB8pxtXhOtpVXbO4/view?usp=sharing
API Doc: http://www.hemingwayapp.com/api/docs.html

Note: Hemmingway API is a fee-based service. The library above is free.

Note: The logic outlined in the original issue above (for analysis and for information supplied to the UI) would hold for the library and the API it just a question of which way we want to go.

@davidrkupton davidrkupton added this to the 6-Updates-Content Types milestone Mar 27, 2019
@reillyzlab reillyzlab changed the title Proposal for D8 - Add Readability to nodes. Update: Add Readability to nodes (hemingway) May 7, 2019
@reillyzlab
Copy link

Pulling in Hemingway app readability grades to CKEditor might require significant effort if there isn't an exiting solution.

Not sure if this is usable, prob worth evaluating: https://www.drupal.org/project/hemingway (From @jimafisk on 5/7/19)

@reillyzlab reillyzlab modified the milestones: 6-Updates-Content Types, 6-Updates-Login/Users May 7, 2019
@andrebtlima andrebtlima changed the title Update: Add Readability to nodes (hemingway) Pull in Hemingway app readability grades to CKEditor Dec 18, 2019
@AmyWipfler AmyWipfler removed this from the 6-Updates-Login/Users milestone Nov 2, 2020
@reillyzlab
Copy link

Matt and Stella did some research but we will de-prioritize for now.

@mgifford
Copy link

mgifford commented Jul 7, 2021

This looks like what you are asking for https://github.com/wooorm/readability

But also some work and other options are explored here nextcloud/text#3

Also, it's always good to have these requests supported in upstream libraries, so if you could add your 2c here that would be great ckeditor/ckeditor5#9819

Last commits on the Drupal module were 7 years ago. I think it is safe to assume this is a dead project https://www.drupal.org/project/hemingway/git-instructions

@rachelsater
Copy link

@duffy-james Do you want to have us look into this again?

@rachelsater
Copy link

closing this ticket and will create a new one if needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests