CHANGELOG.md

Change History

6.7.0 - November 15, 2022

• Change: Significantly updated hyphenation patterns for:
  • German
  • German (Traditional)
  • German (Swiss Traditional)
• Change: Minimum PHP version increased to 7.4.0.
• Change: The following public methods have been deprecated:
  • Strings::mb_str_split
  • Strings::uchr
• Bugfix: No more deprecation warnings when running on PHP 8.1.
• Bugfix: The ASCII string functions actually get used on pure ASCII fragments (instead of falling back to the slower mb_* functions).

6.6.0 - April 5, 2020

• Feature: Use native mb_str_split on PHP 7.4 and above.
• Change: Significantly updated hyphenation patterns for:
  • Amharic
  • Chinese pinyin (Latin)
  • German
  • German (Traditional)
  • German (Swiss Traditional)
  • Latin (Classical)
  • Latin (Liturgical)
  • Spanish

6.5.3 - March 27, 2020

• Bugfix: Ambiguous blase removed from smart diacritics list for de-DE.`

6.5.2 - December 7, 2019

• Bugfix: PHP 7.4 compatibility.
• Bugfix: Parsing does not break anymore when the returned DOMDocument is invalid.

6.5.1 - July 8, 2019

• Bugfix: The smart area and volume units fix now handles missing whitespace as well (e.g. 5m2 is transformed into 5 m²).

6.5.0 - July 6, 2019

• Feature: Use non-breaking hyphen for connecting one-letter-words and when an elision is followed by a comma.
• Feature: All special unicode characters can now be remapped using the Settings constructor or the new Settings::remap_character() method. By default, U::APOSTROPHE is remapped to U::SINGLE_QUOTE_CLOSE and U::NO_BREAK_NARROW_SPACE to U::NO_BREAK_SPACE, keeping compatibility with previous versions.
• Feature: A new dash style (Dash_Styles::INTERNATIONAL_NO_HAIR_SPACES) has been added, following the Duden convention of not having hair spaces around interval dashes.
• Feature: Metric area and volume units can now be prettified (e.g. m2 to m²).
• Change: All settings keys now have named constants. Going forward, please only use those.
• Bugfix: Decades in the English ('60s) and German ('80er) styles are now rendered with an apostrophe.

6.4.3 - January 29, 2019

• Bugfix: To prevent common false positives for single-letter Roman ordinals (especially in French and Dutch), Roman numeral matching is now only enabled when Settings::set_smart_ordinal_suffix_match_roman_numerals is set to true. In addition, only I, V, and X are accepted as single-letter Roman numbers.

6.4.2 - January 27, 2019

• Bugfix: The Unicode hyphen character (‐) is recognized as a valid word combiner.

6.4.1 - January 27, 2019

• Bugfix: Parts of hyphenated words should not be detected as Roman numerals anymore.

6.4.0 - January 24, 2019

• Feature: French (1^ère) and "Latin" (1^o) ordinal numbers are now supported by the smart ordinals feature (also with Roman numerals, e.g. XIX^ème).
• Bugfix: Unit spacing was not applied to monetary symbols ($, €, etc.).

6.3.1 - January 23, 2019

• Bugfix: Certain entities (e.g. &) were not encoded correctly when modifying a node.

6.3.0 - September 8, 2018

• Feature: The comma can now be used as a decimal separator (e.g. 1,5, in addition to 1.5).
• Change: PHP-Typography now uses the Unicode hyphen character (‐) instead of the hyphen-minus (-).
• Change: Smart dashes has been refactored into a separate token fix.
• Bugfix: Smart maths properly handles 2-digit years in dates.

6.2.2 - August 30, 2018

• Bugfix: Smart diacritics won't try to "correct" the spelling of Uber anymore.

6.2.1 - August 27, 2018

• Bugfix: French punctuation is now correctly applied to quotes preceded or followed by round and square brackets.

6.2.0 - August 26, 2018

• Feature: A narrow no-break space is now inserted between adjacent primary and secondary quotes.
• Feature: The list of "apostrophe exceptions" (like 'tain't, 'til) can now be adjusted.
• Change: Significantly updated hyphenation patterns for:
  • Bulgarian
  • German
  • German (Traditional)
  • German (Swiss Traditional)
  • Latin (Liturgical)
  • Thai
• Bugfix: Smart quotes replacement could result in invalid unicode sequences in rare cases.

6.1.5 - May 10, 2018

• Bugfix: The French spacing rules were not applied to closing guillemets followed by a comma.
• Bugfix: 50/50 (and x/x except 1/1) are not treated as fractions anymore.

6.1.4 - April 08, 2018

• Bugfix: Smart fractions were not matched correctly if the were followed by a comma (i.e. 1/4,).

6.1.3 - March 02, 2018

• Bugfix: In rare cases, UTF-8 characters were broken by a missing 'u' flag in a regular expression.

6.1.2 - February 25, 2018

• Bugfix: The Quotes class was missing from the signature of Settings::set_smart_quotes_*.

6.1.1 - February 04, 2018

• Bugfix: < and > where silently dropped when replacing nodes due to HTML injection.

6.1.0 - January 05, 2018

• Feature: New hyphenation languages
  • Assamese,
  • Belarusian,
  • Bengali,
  • Church Slavonic,
  • Esperanto,
  • Friulan,
  • Gujarati,
  • Kannada,
  • Kurmanji,
  • Malayalam,
  • Norwegian (Bokmål)
  • Norwegian (Nynorsk)
  • Piedmontese,
  • Romansh,
  • Upper Sorbian.

6.0.1 - January 03, 2018

• Bugfix: Default_Registry::get_default_node_fixes and Default_Registry::get_default_token_fixes were missing the static keyword.

6.0.0 - December 25, 2017

• Feature: New Registry class introduced to allow for custom fixes collections.
• Feature: CSS classes for the virtual <body> node can now be set when processing strings.
• Change: "French punctuation spacing" is now off by default.
• Change: The deprecated class Hyphenator_Cache has been removed.
• Change: The deprecated properties Settings::inappropriate_tags and Settings::self_closing_tags have been removed.
• Bugfix: Numbers are treated like characters for the purpose of wrapping emails.

5.2.3 - December 02, 2017

• Bugfix: Sometimes, the French double quotes style generated spurious ».

5.2.2 - November 25, 2017

• Bugfix: Remove some ambiguous diacritics replacements from the German language file.

5.2.1 - October 27, 2017

• Bugfix: Dewidow didn't honor narrow spaces.

5.2.0 - September 30, 2017

• Change: Hyphenator_Cache has been moved to Hyphenator\Cache.
• Change: New method has_changed for Hyphenator\Cache.
• Change: Properties Settings::inappropriate_tags and Settings::self_closing_tags have been deprecated.
• Bugfix: Settings hash omitted some properties (props @shimikano).

5.1.0 - September 10, 2017

• Feature: New hyphenation language "German (Swiss Traditional)" added.
• Feature: Dewidowing can now be applied to the final 1–3 words.
• Change: Started adding some benchmarks.
• Change: Updated HTML5 parser (html5-php) to 2.3.0:
  • Tokenizer performance improved by 20 percent.
  • Various small bugfixes.

5.0.2. - August 28, 2017

• Bugfix: Fatal error on PHP 5.6.x (caused by using __METHOD__ as a variable function) fixed.

5.0.1. - August 26, 2017

• Bugfix: Hyphenator caching was not really working.

5.0.0. - August 13, 2017

• Feature: Use Composer for dependencies.
• Change: API refactoring:
  • Core API refactored and minimum PHP version increased to 5.6.0
  • PHP_Typography broken into smaller classes (one for each "fix").
  • Default Settings removed.
• Bugfix: French punctuation spacing after links (and other inline tags) fixed.
• Bugfix: Lone ampersands are treated as single-character words.
• Bugfix: Hyphenated words are properly de-widowed.

4.2.1 - June 9, 2017

• Bugfix: Prevent crash on PHP 5.x when building the hyphenation trie.

4.2.0 - June 8, 2017

• Feature: Prevent line-breaks in numbered abbreviations (e.g. ISO 9001).
• Change: Core API refactored and minimum PHP version increased to 5.4.0.
• Change: Updated hyphenation patterns:
  • German
  • German (Traditional)
  • Latin
  • Latin (Liturgical)
• Change: Updated list of valid top-level domains.

4.1.2 - May 26, 2017

• Bugfix: Hyphenation patterns at the end of word were accidentally ignored.
• Bugfix: Diacritics replacement does not count soft hyphens as word boundaries anymore.

4.1.1 - March 19, 2017

• Bugfix: Performance issue accidentally introduced in 4.1.0 fixed.

4.1.0 - March 18, 2017

• Feature: Hyphenator instance has been made cacheable.
• Bugfix: Incorrect replacement of initial hyphens fixed.
• Bugfix: French spacing rules improved.
• Bugfix: Proper dashes for German date intervals.

4.0.1 - January 7, 2017

• Bugfix: Workaround for PHP 5.3 issue in dewidow callback.

4.0.0 - January 6, 2017

• Feature: New Settings API added.
• Feature: New hyphenation languages
  • Hindi,
  • Marathi,
  • Occitan,
  • Oriya,
  • Panjabi,
  • Tamil,
  • Telugu.
• Change: Updated list of valid top-level domains.

3.5.3 - December 17, 2016

• Bugfix: Remove ambiguous entries from German diacritics replacement file.

3.5.2

Skipped.

3.5.1 - November 05, 2016

• Bugfix: Quotes ending in numbers were sometimes interpreted as primes.

3.5.0 - October 21, 2016

• Feature: Added "Latin (Liturgical)" as a new hyphenation language.
• Change: Updated list of valid top-level domains.
• Change: Updated HTML5 parser (html5-php) to 2.2.2.
• Bugfix: Custom hyphenations with more than one hyphenation point were not working properly.
• Bugfix: The min_after hyphenation setting was off by one.
• Bugfix: Fractions did not play nice with prime symbols.

3.4.0 - July 10, 2016

• Store hyphenation patterns as JSON files instead of PHP.
• Updated list of valid top-level domains.

3.3.0 - June 27, 2016

• Updated HTML parser (html5-php) to 2.2.1.
• Updated list of valid top-level domains.
• Prevent references to US non-profit organizations like 501(c)(3) being replaced with the copyright symbol (props @randybruder).
• Added CSS classes for smart fractions ("numerator", "denominator") and ordinal suffixes ("ordinal").
• Fixed « and » spacing when French punctuation style is enabled.

3.2.7 - April 14, 2016

• "Duplicate ID" warnings should be gone now, regardless of the installed libXML version.

3.2.1–3.2.6

Skipped.

3.2.0 - March 20, 2016

• Added support for the French punctuation style (thin non-breakable space before ;:?!).
• Added proper hyphenation of hyphenated compound words (e.g. editor-in-chief).
• Added partial support for styling hanging punctuation.

3.1.3 - January 13, 2016

• Pre­vent in­cor­rect re­place­ment of straight quotes with primes (e.g. "number 6" is not re­placed with “num­ber 6″ but with “num­ber 6”).
• Fixed a bug that pre­vented header tags (<h1> … <h6>) that were set as “tags to ig­nore” from ac­tu­ally be­ing left alone by the plu­gin.

3.1.2

Skipped.

3.1.1 - January 5, 2016

• Fixed fatal error when running on PHP 5.3 (use of $this in anonymous function).

3.1.0 - January 3, 2016

• Minimum PHP version updated to 5.3.4 (from 5.3.0) to ensure consistent handling of UTF-8 regular expressions.
• Fixed diacritics replacement for UTF-8 strings
• Date-like values (e.g. "during the fiscal year 2015/2016") are not converted to smart fractions anymore.
• Added ability to switch between dash styles: both traditional US (em dash without spacing) and international usage (en dash with spaces) can be selected.
• Various white-space fixes related to dash styling.
• Fixed a bug where block-level tags where not detected corrected.
• Added workaround for duplicate ID warnings generated by some versions of libXML.
• Updated all hyphenation files and added the following new languages:
  • Afrikaans,
  • Armenian,
  • Dutch,
  • Georgian,
  • German (Traditional),
  • Latin (Classical),
  • Latvian,
  • Thai, and
  • Turkmen.

3.0.4 - December 12, 2015

• Prevent accidentally invalid XPath queries from being fatal on the frontend.

3.0.3 - December 8, 2015

• Fixed a bug in the XPath expression for ignoring tags by CSS ID.

3.0.2 - December 3, 2015

• A typo prevented custom quote styles from working.

3.0.1

Skipped.

3.0.0 - December 2, 2015

• DOM-based HTML parsing with HTML5-PHP
• Added German as a diacritics language (mainly for French words).
• Various optimizations (hyphenation is still slow, though)
• Fixed custom hyphenation patterns.
• Adopted semantic versioning for the project.

2.0 - July 7, 2010

• Simplified acronym identification to not include some obscure uppercase characters. This will reduce support for some non-English languages, but it resolves an issue of catastrophic failure (where the entire page fails to load) with certain server configurations.
• Security Fix: Prevented comments with exceptionally long strings from causing fatal PHP error.

1.22 - March 4, 2010

• Fixed bug that caused occasional hyphenation errors for non-English languages.

1.21 - December 31, 2009

• Fixed bug in custom diacritic handling

1.20 - December 20, 2009

• Resolved uninitialized variable
• Added HTML5 elements to parsing algorithm for greater contextual awareness

1.19 - December 1, 2009

• Fixed bug where dewidow functionality would add broken no-break spaces to the end of texts, and smart_exponents would drop some of the resulting text.
• Declared encoding in all instances of mb_substr to avoid conflicts
• Corrected a few instances of undeclared variables.

1.18 - November 10, 2009

• Added Norwegian Hyphenation Patterns

1.17 - November 9, 2009

• Fixed bug in diacritic handling.

1.16 - November 4, 2009

• Added automated diacritic replacements (i.e. "creme brulee" becomes "crème brûlée").
• Improved smart quotes and smart dashes with sensitivity to adjacent diacritic characters.

1.15 - October 21, 2009

• Replaced quotation language styles with individual selection of primary and secondary quotation styles.

1.14 - September 8, 2009

• Improved space collapse functionality.
• Corrected bug in smart quote and single character word handling where the "0" character may be improperly duplicated

1.13 - August 31, 2009

• Added option to collapse adjacent space characters to a single character

1.12 - August 17, 2009

• Corrected multibyte character handling error that could cause some text to not display properly

1.11 - August 14, 2009

• Added language specific quote handling (for single quotes, not just double) for English, German and French quotation styles

1.10 - August 14, 2009

• Added language specific quote handling for English, German and French quotation styles
• Corrected multibyte character handling error that could cause some text to not display properly
• Expanded the multibyte character set recognized as valid word characters for improved hyphenation

1.9 - August 12, 2009

• Added option to force single character words to wrap to new line (unless they are widows).
• Fixed bug where hyphenation pattern settings were not initialized with multiple phpTypography class instances.

1.8 - August 4, 2009

• Corrected math and dash handling of dates
• Styling of uppercase words now plays nicely with soft-hyphens

1.7 - July 29, 2009

• Reformatted language files for increased stability and to bypass a false positive from Avira's free antivirus software

1.6 - July 28, 2009

• Efficiency Optimizations ( approximately 25% speed increase ). Thanks Jenny!

1.5 - July 27, 2009

• Added the ability to exclude hyphenation of capitalized (title case) words to help protect proper nouns
• Added Hungarian hyphenation patterns

1.4 - July 23, 2009

• Fixed an instance where pre-hyphenated words were hyphenated again

1.3 - July 23, 2009

• Removed two uses of create_function() for improved performance
• Corrected many uninitialized variables
• Corrected two variables that were called out of scope

1.2 - July 23, 2009

• moved the processing of widow handling after hyphenation so that max-pull would not be compared to the length of the adjacent word, but rather the length of the adjacent word segment (i.e. that after a soft hyphen)

1.1 - July 22, 2009

• By default, when class phpTypography is constructed, set_defaults is called. However, if you are going to manually set all settings, you can now bypass the set_defaults call for slightly improved performance. Just call $typo ## new phpTypography(FALSE).
• Decoded special HTML characters (for feeds only) to avoid invalid character injection (according to XML's specs)

1.0.3 - July 17, 2009

• Reverted use of the hyphen character to the basic minus-hyphen in words like "mother-in-law" because of poor support in IE6

1.0.2 - July 16, 2009

• Fixed smart math handling so it can be turned off.
• Corrected smart math handling to not convert slashes in URLs to division signs

1.0.1 - July 15, 2009

• Corrected label in admin interface that indicated pretty fractions were part of basic math handling.

1.0 - July 15, 2009

• Added test to phpTypography methods process() and process_feed() to skip processing if $isTitle parameter is TRUE and h1 or h2 is an excluded HTML tag

1.0 beta 9 - July 14, 2009

• Added catch-all quote handling, now any quotes that escape previous filters will be assumed to be closing quotes

1.0 beta 8 - July 13, 2009

• Changed thin space injection behavior so that for text such as "...often-always?-judging...", the second dash will be wrapped in thin spaces
• Corrected error where fractions were not being styled because of a zero-space insertion with the wrap hard hyphens functionality
• Added default class to exclude: noTypo

1.0 beta 7 - July 10, 2009

• Added "/" as a valid word character so we could capture "this/that" as a word for processing (similar to "mother-in-law")
• Corrected error where characters from the Latin 1 Supplement Block were not recognized as word characters
• Corrected smart quote handling for strings of numbers
• Added smart guillemet conversion: << and >> to « and »
• Added smart Single Low 9 Quote conversion as part of smart quotes: comma followed by non-space becomes Single Low 9 Quote
• Added Single Low 9 Quote, Double Low 9 Quote and » to style_initial_character functionality
• Added a new phpTypography method smart_math that assigns proper characters to minus, multiplication and division characters
• Depreciated the phpTypography method smart_multiplication in favor of smart_math
• Cleaned up some smart quote functionality
• Added ability to wrap after "/" if set_wrap_hard_hyphen is TRUE (like "this/that")

1.0 beta 6 - July 9, 2009

• Critical bug fix: RSS feeds were being disabled by previous versions. This has been corrected.

1.0 beta 5 - July 8, 2009

• Corrected error where requiring Em/En dash thin spacing "word-" would become "word –" instead of "word–"

1.0 beta 4 - July 7, 2009

• Added default encoding value to smart_quote handling to avoid PHP warning messages

1.0 beta 3 - July 6, 2009

• Corrected curling quotes at the end of block level elements

1.0 beta 2 - July 6, 2009

• Corrected multibyte character conflict in smart-quote handling that caused infrequent dropping of text
• Thin space injection included for en-dashes

1.0 beta 1 - July 3, 2009

• Initial release