Skip to content

Commit 9bd0cb6

Browse files
committed
feat(translations): added documentation for translation adapters, closes #3720
1 parent ad9b057 commit 9bd0cb6

File tree

8 files changed

+574
-72
lines changed

8 files changed

+574
-72
lines changed

docs/administration.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,139 @@ Super admins have all permissions by default.
422422
- Check page exists and is active
423423
- Clear cache if using caching
424424

425+
### 5.2.11 AI-Assisted Translation
426+
427+
phpMyFAQ includes an AI-assisted translation feature that helps you translate FAQ content, custom pages, categories, and
428+
news articles into multiple languages using professional translation APIs. The feature preserves HTML formatting and
429+
provides high-quality automated translations.
430+
431+
#### 5.2.11.1 Overview
432+
433+
The AI translation feature integrates with leading translation services:
434+
435+
- **Google Cloud Translation** - Neural machine translation with 100+ languages
436+
- **DeepL** - Premium quality translations, especially for European languages
437+
- **Azure Translator** - Microsoft's translation service with generous free tier
438+
- **Amazon Translate** - AWS translation service with 75+ languages
439+
- **LibreTranslate** - Open-source, self-hosted option for privacy
440+
441+
#### 5.2.11.2 Configuration
442+
443+
Navigate to **Configuration → Translation** tab to configure your translation provider:
444+
445+
1. Select your preferred **Translation Provider** from the dropdown
446+
2. Enter the required API credentials for your chosen provider
447+
3. Click **Save Configuration** to activate
448+
449+
**Provider-Specific Credentials:**
450+
451+
- **Google**: API key from Google Cloud Console
452+
- **DeepL**: API key from DeepL dashboard (Free or Pro)
453+
- **Azure**: API key and region from Azure Portal
454+
- **Amazon**: AWS Access Key ID, Secret Access Key, and region
455+
- **LibreTranslate**: Server URL and optional API key
456+
457+
For detailed setup instructions for each provider, see the [AI Translation Guide](ai-translation.md) and
458+
[Quick Start Guide](ai-translation-quickstart.md).
459+
460+
#### 5.2.11.3 Translating Content
461+
462+
**Translating FAQs:**
463+
464+
1. Navigate to **FAQs** and select an FAQ to translate
465+
2. Click on the **Translation** tab or **Translate FAQ**
466+
3. Select the target language from the dropdown
467+
4. Click the **"Translate with AI"** button
468+
5. Review the translated question, answer, and keywords
469+
6. Make any necessary edits
470+
7. Click **Save** to store the translation
471+
472+
The AI will translate:
473+
- Question text
474+
- Answer (HTML formatting preserved)
475+
- Keywords/tags
476+
477+
**Translating Custom Pages:**
478+
479+
1. Navigate to **Content → Custom Pages**
480+
2. Select a page and click **Translate**
481+
3. Select the target language
482+
4. Click **"Translate with AI"**
483+
5. Review translated content (title, content, SEO fields)
484+
6. Adjust settings in the **Settings** tab
485+
7. Click **Save**
486+
487+
The AI will translate:
488+
- Page title
489+
- Page content (HTML formatting preserved)
490+
- SEO title
491+
- SEO description
492+
493+
**Translating Categories:**
494+
495+
1. Navigate to **Categories**
496+
2. Select a category and click **Translate Category**
497+
3. Select the target language
498+
4. Click **"Translate with AI"**
499+
5. Review the translated name and description
500+
6. Click **Save**
501+
502+
**Translating News:**
503+
504+
1. Create or edit a news article
505+
2. Use the translation interface to create language versions
506+
3. The AI assists with translating headline and content
507+
508+
#### 5.2.11.4 Best Practices
509+
510+
**Review All Translations:**
511+
- AI translation is very accurate but not perfect
512+
- Always review technical terms, brand names, and legal content
513+
- Edit translations before publishing to ensure quality
514+
515+
**Maintain Consistency:**
516+
- Use the same translation provider across your site
517+
- Keep a glossary of key terms and their preferred translations
518+
- Use consistent terminology in source content
519+
520+
**HTML Formatting:**
521+
- Simple HTML (bold, italic, links, lists) translates best
522+
- Complex nested structures may need manual adjustment
523+
- Always preview translated content before publishing
524+
525+
**Cost Management:**
526+
- Start with free tiers (DeepL Free: 500k chars/month, Azure: 2M chars/month)
527+
- Monitor usage in your provider's dashboard
528+
- Don't re-translate unnecessarily - review and edit instead
529+
530+
#### 5.2.11.5 Troubleshooting
531+
532+
**Translation button is disabled:**
533+
- Verify translation provider is configured in settings
534+
- Ensure source and target languages are different
535+
- Check that both languages are supported by your provider
536+
537+
**Translation fails with error:**
538+
- Verify API credentials are correct
539+
- Check you haven't exceeded free tier limits
540+
- For Azure: ensure region format is correct (e.g., "eastus" not "East US")
541+
542+
**Poor translation quality:**
543+
- Try DeepL for better quality (European languages)
544+
- Simplify source text (shorter sentences, clear language)
545+
- Review and edit translations manually
546+
- Verify language is well-supported by your provider
547+
548+
**HTML formatting issues:**
549+
- Ensure source content has valid, clean HTML
550+
- Simplify complex HTML structures
551+
- Preview before saving
552+
- Re-translate if formatting is broken
553+
554+
For comprehensive documentation, see:
555+
- [Complete AI Translation Guide](ai-translation.md) - Full documentation
556+
- [Quick Start Guide](ai-translation-quickstart.md) - Get started in 5 minutes
557+
425558
## 5.3 Statistics
426559

427560
### 5.3.1 Ratings

0 commit comments

Comments
 (0)