Web Helper: User Documentation#

Purpose#

The Web Helper tool supports you in migrating web content from the Plone content management system to the TYPO3 system. The tool automates the migration process by processing JSON export files from Plone, structuring the content and generating content analysis and text improvement suggestions using large language models (LLMs).

The basic principle consists of three steps: You upload a JSON file with your Plone content, the tool automatically structures it and creates exportable formats. Optionally, you can perform an AI-supported analysis that evaluates your content and generates suggestions for improvement.

Range of functions#

The tool offers the following core functions:

  • JSON import: Processing of Plone JSON export files up to a size of 100 MB
  • Content structuring: Automatic recognition of page hierarchies and different content types
  • Markdown export: Generation of a single structured Markdown file with all content
  • ZIP export: Export as an organised file structure with separate Markdown files per page
  • LLM content analysis: AI-supported evaluation of text quality, structure and readability
  • Text improvement suggestions: Generation of revised content based on the analysis
  • Download management: Automatic provision of all results as downloadable files

Operation#

Step 1: Upload JSON file#

Click on the ‘Upload Plone JSON file’ field and select your export file. Alternatively, you can use the ‘📋 Load sample’ button to load a sample file to test how it works.

Step 2: Process JSON#

Click on ‘1. Process JSON’. The tool analyses the structure of your content and displays an overview of the pages and content types found in the ‘Statistics’ area.

Step 3: Create export (optional)#

You can now decide in which format you want to export your content:

  • Create Markdown file: Creates a single Markdown file with all pages
  • Create ZIP file: Creates a ZIP file with separate Markdown files for each page, organised according to the original hierarchy

The download links appear automatically after generation.

Step 4: Start LLM analysis (optional)#

Click on ‘2. Start LLM analysis’ to obtain an AI-supported evaluation of your content. The tool performs two analyses:

  • Content analysis: Evaluates the structure, quality and readability of the texts
  • Text suggestions: Generates specific suggestions for improving your content

The results are displayed directly in the interface. Use the ‘📄 Generate download’ buttons to download the analyses as separate files.

Important notes#

  • The tool supports JSON files up to 100 MB in size
  • The LLM analysis requires a configured API connection to an OpenAI-compatible LLM service
  • Base64-encoded images are automatically replaced with placeholders
  • All exports are UTF-8 encoded

Application example#

Initial situation: You operate a university website on Plone with around 300 pages of different content types (standard pages, FAQ pages, news articles). The website is to be migrated to TYPO3.

Step 1: You export your Plone content as a JSON file (25 MB) and upload it to the Web Helper.

Step 2: After processing, the tool shows that 287 pages have been recognised: 180 documents, 45 folders, 35 news articles and 27 FAQ pages.

Step 3: You create a ZIP export to import the content individually into TYPO3 in the next step. The ZIP file contains the pages in their original folder structure.

Step 4: You start the LLM analysis. The content analysis shows that many pages contain outdated HTML structures and that readability could be improved. The text suggestions provide specific wording alternatives for the most critical pages.

Result: You have exportable files and detailed analyses that help you prepare for migration and identify weaknesses in your content before importing it into TYPO3.

Recommendations for efficient use#

  • First test the tool with the sample file to understand how it works.
  • Check the statistics after import to ensure that all expected content types have been recognised
  • Use the ZIP export if you want to process the pages individually
  • Use the Markdown file if you need a quick overview of all content
  • Only perform the LLM analysis if a corresponding API is configured
  • Download the analysis results before processing a new JSON file
  • For very large files (over 50 MB), you should allow for longer processing times

System limitations#

The tool cannot perform the following tasks:

  • Direct import into TYPO3 (the tool only prepares the data)
  • Automatic migration of permissions and access rights
  • Processing of embedded media such as videos (only images are recognised)
  • Translation of content (this feature is planned but not yet implemented)
  • Processing of Plone workflows or versioning
  • Duplicate detection across multiple JSON files
  • Automatic quality assurance without manual review

LLM analysis depends on an external API connection. Without a configured LLM API, only the export functions can be used.

Summary#

The Web Helper Tool is an intermediate step in the migration process from Plone to TYPO3. It structures your exported content, makes it readable and offers optional AI-supported evaluation. The tool takes care of the time-consuming preparation of raw data and enables you to make informed decisions about necessary content updates.

You remain responsible for the final quality control and import into TYPO3. The tool supports you with automation and intelligent analysis, but does not replace the professional evaluation by you as the user.

Backward Translate Experiments Forward