Enhance Documentation for Internationalization Support

[sidfakenews986]

Description

The current documentation briefly mentions internationalization support and provides a code snippet, but it lacks in-depth explanation and examples. It would be beneficial to expand this section to include:

• A detailed use case showcasing how to implement internationalization in a real-world scenario.
• Best practices for managing translations and integrating them into the swift-html framework.
• Examples of handling pluralization and context in translations, as these are often critical for proper localization.

By enhancing the documentation, users will better understand how to effectively utilize the internationalization feature, making swift-html more accessible for diverse applications.

Suggested Changes

1. Add a section titled "Internationalization in Depth".
2. Include examples for handling different languages and locales.
3. Provide a guide on testing translations within the framework.

Having comprehensive documentation would significantly improve the user experience and broaden the appeal of the library.

[coenttb]

Thanks for the detailed feedback, @sidfakenews986! You're absolutely right that the internationalization section could be more comprehensive.

Our Documentation Philosophy

This package relies on swift-translating for internationalization functionality. Our goal is to keep swift-translating as the primary, comprehensive documentation source for translation features (fallback chains, language support, performance considerations, etc.), while swift-html documents the HTML-specific integration.

Proposed Enhancement

I'll expand the internationalization section to focus on HTML-specific integration patterns while directing users to swift-translating for comprehensive translation documentation. Here's what I plan to add:

1. Server Context Integration - How to set up language switching based on request locale using dependency injection (the most common real-world use case)
2. Complex HTML Content - Multi-line translated content, string interpolation, and composition patterns
3. Best Practices - Performance considerations and links to specific swift-translating sections

Each section will link to the corresponding swift-translating documentation for deeper dives into the translation features themselves. And I'll consider whether I should expand swift-translating documentation, too.

I'd Love Your Feedback

Both swift-html and swift-translating are actively evolving. If you have specific use cases or expected syntax patterns you'd like to see supported, please share them! This helps us prioritize what to document and potentially what features to enhance.

Note: coenttb-com-server demonstrates production usage of internationalization with swift-html (see the blog posts available in English and Dutch). However, note that that website will soon receive a major refactoring.

Does this approach address your needs?

[coenttb]

Hi @sidfakenews986 , I just wanted to verify with you whether the proposal addresses your needs. Hope to hear from you!