-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
91 lines (64 loc) · 2.97 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
=== HeadlineEngine ===
Contributors: jasonny
Tags: headline, title, readability
Requires at least:
Tested up to: 6.0
Stable tag: 0.4.1
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
What makes a good headline? Get instant headline analysis based on readability, length, and powerwords.
== Description ==
HeadlineEngine is part of a suite of tools for news publishers, built by [MavEngine](https://mavengine.com), a division of [Daily Maverick](https://dailymaverick.co.za).
It analyses your headline as you type it and provides a score, based on the readability (how complex it is), length (how long it is), and powerwords (how many words it contains).
== Features ==
= Readability =
We use the [Flesch Kincaid](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) formula to calculate readability. A good range of not too complex or too simple would be between 45 and 90. This is configurable in the system.
= Reading Grade =
We use the [Flesch Kincaid](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) formula to calculate reading grade. This is configurable in the system.
= Length =
You should aim for a letter count in the mid-80s. We recommend between 40 and 90 characters. This is configurable in the system.
= Word Count =
Our analysis of best-performing headlines shows that the ideal limit for a news article is around 12 to 14 words. This is configurable in the system.
= Powerwords =
Powerwords are emotional words. You can set your own, or use the words from [RankMath](https://rankmath.com/blog/power-words/).
== Screenshots ==
1. HeadlineEngine in the Gutenberg editor.
2. HeadlineEngine in the Classic editor.
3. Customise settings to suit your audience.
== Changelog ==
= 0.4.2 =
* Suggest feature
= 0.2.0 =
* Complete refactor
* Seperate scorers to make it easy to add more
* Move most of the code to Typescript
* Scorer: Word count
* Scorer: Reading grade
* Replace MathRank Powerword list with our own Powerword list
* Single Javascript and CSS for both Classic and Gutenberg
* Colour fade
* Only calculate on 0.5 sec delay or space
* Don't hide score if mouseovering title block
= 0.1.3 =
* Fix issue with calculating scores above target
* Remove red to make it a little less perscriptive
= 0.1.2 =
* Block editor support for Wordpress v5.8
= 0.1.1 =
* Fix bug affecting new posts in Gutenberg
* Be a bit stricter about showing the score if there is no headline
= 0.1.0 =
* Gutenberg Block Editor support
* Remove unnecessary code
= 0.0.3 =
* The scoring is now more nuanced
* We have a target length and target readability
* We made a bunch of fixes suggested by Wordpress
= 0.0.2 =
* We have changed how we insert the element into the editor, to avoid fighting with other plugins.
* The score title has been changed from "Headline Score" to "HeadlineEngine Score".
* The score was made a bit smaller (40px from 60px).
* Readme.txt has been brought into the main project.
= 0.0.1 =
* Initial release