Installation 

Requirements 

Minimum Requirements 

  • TYPO3: 13.4.0 or higher
  • PHP: 8.2, 8.3, or 8.4
  • PHP Extensions:
    • ext-zip
    • ext-simplexml
    • ext-libxml

Installation via Composer 

The recommended way to install this extension is via Composer:

composer require netresearch/nr-textdb
Copied!

After requiring the package, activate the extension in the Extension Manager or via command line:

# Via command line
vendor/bin/typo3 extension:activate nr_textdb
Copied!

Installation from TER 

Alternatively, you can install the extension from the TYPO3 Extension Repository (TER):

  1. Navigate to Admin Tools > Extensions
  2. Search for "nr_textdb"
  3. Click the download icon
  4. Activate the extension

Database Setup 

After installation, update the database schema:

# Via command line
vendor/bin/typo3 database:updateschema
Copied!

Or use the Maintenance > Analyze Database Structure module in the backend.

The extension will create the following database tables:

  • tx_nrtextdb_domain_model_translation - Translation records
  • tx_nrtextdb_domain_model_component - Component definitions
  • tx_nrtextdb_domain_model_type - Translation type definitions
  • tx_nrtextdb_domain_model_environment - Environment definitions

Post-Installation Steps 

  1. Create Storage Folder

    Create a dedicated page/folder in the page tree for TextDB records:

    • Page Type: Folder
    • Recommended location: Root level
    • Suggested name: "TextDB Translations"

  2. Configure Extension

    Go to Admin Tools > Settings > Extension Configuration > nr_textdb

    Set the PID (Page ID) of your storage folder.

  3. Create Language Records

    Create the necessary system language records (if not already present):

    • Navigate to your storage folder
    • Create records for Components, Types, and Environments as needed

  4. Set Permissions

    Grant backend user groups access to:

    • TextDB Backend Module
    • Storage folder for TextDB records

Upgrade Instructions 

From Version 2.x to 3.x 

Version 3.0 brings TYPO3 13.4 LTS compatibility:

Breaking Changes:

  • PHP 8.2 minimum requirement
  • TYPO3 13.4 minimum requirement
  • Database schema updates required

Migration Steps:

  1. Ensure PHP 8.2+ is installed

  2. Update composer dependencies:

    composer update netresearch/nr-textdb
    Copied!

  3. Update database schema:

    vendor/bin/typo3 database:updateschema
    Copied!

  4. Clear all caches:

    vendor/bin/typo3 cache:flush
    Copied!
  5. Test translation functionality in backend module

Troubleshooting 

Extension not visible after installation 

  • Clear all caches via Admin Tools > Maintenance > Flush TYPO3 and PHP Cache
  • Verify extension is activated in Extension Manager
  • Check that database tables were created

Missing translations 

  • Verify storage PID is configured correctly in Extension Configuration
  • Check that translations are stored in the correct page/folder
  • Ensure "Create if missing" option is enabled (if desired)

Import fails 

  • Verify XLIFF file format matches expected structure
  • Check file permissions on upload
  • Review logs in Admin Tools > Log
  • Ensure PHP extensions (ext-zip, ext-simplexml, ext-libxml) are installed

Uninstallation 

To remove the extension:

  1. Backup Translation Data (if needed)

    Export all translations before uninstalling.

  2. Deactivate Extension

    vendor/bin/typo3 extension:deactivate nr_textdb
    Copied!

  3. Remove via Composer

    composer remove netresearch/nr-textdb
    Copied!

  4. Clean Database (optional)

    Remove TextDB tables manually if desired:

    DROP TABLE tx_nrtextdb_domain_model_translation;
DROP TABLE tx_nrtextdb_domain_model_component;
DROP TABLE tx_nrtextdb_domain_model_type;
DROP TABLE tx_nrtextdb_domain_model_environment;
    Copied!