saulteafarmer/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2025-09-24 12:36:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update ADDING_TOOLS.md

Browse Source
This commit is contained in:
Anthony Stirling 2025-09-04 12:55:20 +01:00 committed by GitHub
parent 7dbf3daaf1
commit f534022f09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ADDING_TOOLS.md
View File

@ -268,9 +268,9 @@ Update translation files. **Important: Only update `en-GB` files** - other langu
When migrating existing Thymeleaf templates: When migrating existing Thymeleaf templates:
1. **Identify Form Parameters**: Look at the original `<form>` inputs to determine parameter structure 1. **Identify Form Parameters**: Look at the original `<form>` inputs to determine parameter structure
2. **Extract Translation Keys**: Find `#{key.name}` references and add them to JSON translations 2. **Extract Translation Keys**: Find `#{key.name}` references and add them to JSON translations (For many tools these translations will already exist but some parts will be missing)
3. **Map API Endpoint**: Note the `th:action` URL for the operation hook 3. **Map API Endpoint**: Note the `th:action` URL for the operation hook
4. **Preserve Functionality**: Ensure all original form behavior is replicated 4. **Preserve Functionality**: Ensure all original form behaviour is replicated which is applicable to V2 react UI
## 7. Testing Your Tool ## 7. Testing Your Tool
- Verify tool appears in UI with correct icon and description - Verify tool appears in UI with correct icon and description
@ -298,11 +298,3 @@ When migrating existing Thymeleaf templates:
- Tools with complex routing logic or non-standard processing - Tools with complex routing logic or non-standard processing
- Provide `customProcessor` for full control - Provide `customProcessor` for full control
- Examples: Convert, OCR - Examples: Convert, OCR
## Benefits of This Architecture:
- **No Timeouts**: Operations run until completion (supports 100GB+ files)
- **Consistent**: All tools follow same pattern and interface
- **Maintainable**: Single responsibility hooks, easy to test and modify
- **i18n Ready**: Built-in internationalization support
- **Type Safe**: Full TypeScript support with generic interfaces
- **Memory Safe**: Automatic resource cleanup and blob URL management