Installation 

Requirements 

Installation via Composer 

The recommended way to install this extension is via Composer:

composer require netresearch/nr-textdb

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

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

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

Localization 

The extension backend interface is available in 23 languages out of the box:

European: Afrikaans, Czech, Danish, German, Spanish, Finnish, French, Italian, Dutch, Norwegian, Polish, Portuguese, Swedish

Asian & African: Arabic, Hindi, Indonesian, Japanese, Korean, Russian, Swahili, Thai, Vietnamese, Chinese

The interface language follows your TYPO3 backend user settings. To change the backend language:

1. Navigate to User Settings (click your username in top bar)
2. Change Interface Language to your preferred language
3. Save and reload the backend

Contribute Translations: Help translate the extension into more languages or improve existing translations through the TYPO3 Crowdin project. No technical knowledge required! See the Contributing Guide for details.

Upgrade Instructions 

Troubleshooting 

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!