pixelcoda/typo3-text-flow

Optimizes text flow with dynamic hyphenation

Maintainers

Details

github.com/CasianBlanaru/typo3-text-flow

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:typo3-cms-extension

v1.1.1 2025-05-14 17:10 UTC

Requires

Requires (Dev)

MIT fbcf1123ae29dfcc6b9025faf520d45ad637c642

  • Casian Blanaru <casianus.woop@me.com>

This package is auto-updated.

Last update: 2025-05-14 17:23:43 UTC

README

Optimizes text flow with dynamic hyphenation for multiple languages.

Features

  • Multi-language support (DE, EN, FR, ES, IT, NL, PT, ZH, AR, HI)
  • Smart hyphenation based on language patterns
  • HTML and special character preservation
  • Case-sensitive text processing
  • Performance-optimized caching
  • Backend pattern management
  • Debug mode with visual hyphenation markers
  • Selective activation per content element

Installation

Via Composer

composer require pixelcoda/text-flow

After installation, make sure to:

  1. Activate the extension in the Extension Manager
  2. Clear all caches
  3. Run the import command for additional languages:
vendor/bin/typo3 textflow:import-patterns

Usage

In Backend

  1. Edit any content element
  2. Go to the "Appearance" tab
  3. Find "Text Flow Language" dropdown
  4. Select your preferred language:
    • Disabled [none] (default)
    • All languages [all]
    • German [de]
    • English [en]
    • French [fr]
    • Spanish [es]
    • Italian [it]
    • Dutch [nl]
    • Portuguese [pt]
    • Chinese [zh]
    • Arabic [ar]
    • Hindi [hi]

In Templates

<html xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers"
      xmlns:tf="http://typo3.org/ns/PixelCoda/TextFlow/ViewHelpers"
      data-namespace-typo3-fluid="true">

<!-- Basic usage (using the textflow ViewHelper) -->
<tf:textflow>{text}</tf:textflow>

<!-- With text parameter -->
<tf:textflow text="{text}" />

<!-- With language parameter -->
<tf:textflow text="{text}" language="de" />

<!-- With content element data -->
<tf:textflow data="{data}">{text}</tf:textflow>

<!-- Legacy ViewHelpers (still supported) -->
<tf:process>{text}</tf:process>
<tf:optimize>{text}</tf:optimize>
</html>

Debug Mode

Add one of these URL parameters:

  • ?debug_textflow=1 - Basic text markers ("-||-")
  • ?debug_textflow=3 - Prominent markers ("▼TRENN▼")

Important: The debug mode now only shows hyphenation markers for elements where TextFlow is actually enabled.

Supported Languages

  • German (de)
  • English (en)
  • French (fr)
  • Spanish (es)
  • Italian (it)
  • Dutch (nl)
  • Portuguese (pt)
  • Chinese (zh)
  • Arabic (ar)
  • Hindi (hi)

License

GPL-2.0-or-later. See LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Support