Download the PHP package heimrichhannot/contao-hyphenator-bundle without Composer
On this page you can find all versions of the php package heimrichhannot/contao-hyphenator-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download heimrichhannot/contao-hyphenator-bundle
More information about heimrichhannot/contao-hyphenator-bundle
Files in heimrichhannot/contao-hyphenator-bundle
Package contao-hyphenator-bundle
Short Description Word-Hyphenation for the contao content-management-system.
License LGPL-3.0-or-later
Homepage https://github.com/heimrichhannot/contao-hyphenator-bundle
Informations about the package contao-hyphenator-bundle
Contao Hyphenator Bundle
A contao bundle that grants server-side hyphenation (thanks to vanderlee/phpSyllable). It does support headlines and paragraphs by default.
This module also handles line break exceptions, in order to keep words like company names together and prevent line break (see tl_page
backend entity).
Options
To extend the functionality, all options can be adjusted within your localconfig.
Option | Type | Default | Description |
---|---|---|---|
hyphenator_tags | string | 'h1:not(:empty):not(.hyphen-none), h2:not(:empty):not(.hyphen-none), h3:not(:empty):not(.hyphen-none), h4:not(:empty):not(.hyphen-none), h5:not(:empty):not(.hyphen-none), h6:not(:empty):not(.hyphen-none), p:not(:empty):not(.hyphen-none), a:not(:empty):not(.hyphen-none), dt:not(:empty):not(.hyphen-none), dd:not(:empty):not(.hyphen-none)' | What type of selectors the hyphenator should look at. |
hyphenator_wordMin | int | 10 | Words under the given length will not be hyphenated altogether. |
hyphenator_hyphenedLeftMin | int | 6 | After hyphenation the resulting left part must have at least this many characters. |
hyphenator_hyphenedRightMin | int | 6 | After hyphenation the resulting right part must have at least this many characters. |
hyphenator_hyphen | string | | This character shall be used as Hyphen-Character. |
hyphenator_skipPages | array | empty | Array of Contao Page Ids, the Hyphenator should skip from hyphenation. |
hyphenator_enableCache | bool | true | Enable simple caching and do not hyphenate equal elements twice. |
hyphenator_locale_language_mapping | array | ['en' => 'en-us', 'cz' => 'cs'] | Map locale to hyphenator tex separation pattern dictionary |
Skip hyphenation
If you want to skip several tags from hyphenation simply add hyphen-none
as css-class to the appropriate element or use the tl_page.hyphenation
field.
You also can add tags to be skipped to your project configuration. See configuration reference below
Configuration reference
Line break exceptions
Hyphenator comes with line break exception handling.
Simply add lineBreakExceptions
on tl_page
and prevent line break for connected word groups like:
- Company Names (search:
Heimrich & Hannot(?:\sGmbH)|Heimrich & Hannot(?:s)?
, will be replaced to:<span class="text-nowrap">Heimrich & Hannot GmbH</span>
) - Prices and other units (search:
(\d|€)(\s)(\w)
, replace:$1[nbsp]$3
, Example:160.000 m²
->160.00<span class="text-nowrap">0 m</span>²
,167 Mio. €
->16<span class="text-nowrap">7 M</span>io. €
)
As you can see, if you provide an replace pattern, than an regular expression will handle the replacement, otherwise if only an search pattern is provided, spaces will be protected with
.
Requirements
All versions of contao-hyphenator-bundle with dependencies
contao/core-bundle Version ^4.4
wa72/htmlpagedom Version ^1.3 || ^2.0
heimrichhannot/contao-multi-column-editor-bundle Version ^2.0
heimrichhannot/contao-utils-bundle Version ^2.16
vanderlee/syllable Version ^1.5