डॉक्यूमेंटेशन: बेहतरीन अभ्यास

सर्वोत्तम प्रथाएँ

Hindi

URL को वैरिएबल में रखें

जब आप URL या इसी प्रकार के डेटा वाले स्ट्रिंग्स का अनुवाद करते हैं, तो यह एक अच्छी प्रथा मानी जाती है कि इन URL को वेरिएबल्स के अंदर रखें और फिर उन्हें अपने टेम्प्लेट्स में संदर्भित करें।

<Translate
	string={`Click <a href="{{url}}">here</a>`}
	variables={{url: 'https://tacotranslate.com'}}
/>

जब बटनों जैसे इंटरैक्टिव तत्वों के टेक्स्ट का अनुवाद किया जाए, तो पहुंचनीयता सुनिश्चित करने के लिए ARIA लेबल शामिल करना महत्वपूर्ण होता है। ARIA लेबल स्क्रीन रीडर्स को तत्व के कार्य के बारे में वर्णनात्मक जानकारी प्रदान करने में मदद करते हैं।

उदाहरण के लिए, यदि आपके पास ऐसा बटन है जो उपयोगकर्ताओं को कोड ब्लॉक से टेक्स्ट कॉपी करने देता है, तो आप स्पष्ट विवरण प्रदान करने के लिए aria-label एट्रिब्यूट का उपयोग कर सकते हैं:

<Translate
	aria-label={useTranslation('Copy to clipboard')}
	string="Copy"
/>

इसमें कुछ ऐसा है जो बहुत मेटा लगता है।

ग्लोबल ओरिजिन्स एरे और बहु-कंपोनेंट ओरिजिन्स

यह पैटर्न केवल Next.js Pages Router का उपयोग करते समय काम करता है।

जब बड़े एप्लिकेशनों पर काम करते हैं, तो स्ट्रिंग्स और अनुवादों को कई, छोटे origins में विभाजित करना लाभकारी होता है। यह तरीका बंडल आकार और ट्रांसफर समय को कम करने में मदद करता है, जिससे कुशल और स्केलेबल स्थानीयकरण सुनिश्चित होता है।

जब केवल क्लाइंट साइड पर रेंडरिंग की जाती है तो यह सरल होता है, लेकिन सर्वर-साइड रेंडरिंग के लिए अनुवाद प्राप्त करते समय origins का प्रबंधन जल्दी जटिल हो जाता है। हालांकि, आप TacoTranslate क्लाइंट origins एरे का उपयोग करके origins के प्रबंधन को स्वचालित कर सकते हैं।

इस उदाहरण पर विचार करें, जहाँ हमने अपने घटकों और पृष्ठों को अलग फ़ाइलों में विभाजित किया है।

components/pricing-table.tsx

import TacoTranslate, {Translate} from 'tacotranslate/react';
import tacoTranslate from '../tacotranslate-client';

// Set an origin name for this component
const origin = 'components/pricing-table';

// Push the origin into the origins array as this file is imported
tacoTranslate.origins.push(origin);

export default function PricingTable() {
	return (
		<TacoTranslate origin={origin}>
			<Translate string="Pricing table" />
			// ...
		</TacoTranslate>
	);
}

pages/pricing.tsx

import TacoTranslate, {Translate} from 'tacotranslate/react';
import getTacoTranslateStaticProps from 'tacotranslate/next/get-static-props';
import tacoTranslateClient from '../tacotranslate-client';
import PricingTable from '../components/pricing-table';

const origin = 'pages/pricing';
tacoTranslateClient.origins.push(origin);

export default function PricingPage() {
	return (
		<TacoTranslate origin={origin}>
			<Translate string="Pricing page" />
			<PricingTable />
		</TacoTranslate>
	);
}

// We will now fetch translations for all imported components and their origins automatically
export async function getStaticProps(context) {
	return getTacoTranslateStaticProps(context, {client: tacoTranslateClient});
}

अधिक जानकारी के लिए हमारे सर्वर-साइड रेंडरिंग उदाहरण देखें getTacoTranslateStaticProps.

त्रुटि प्रबंधन और डीबगिंग

सर्वोत्तम प्रथाएँ

ARIA लेबल का उपयोग करें

ग्लोबल ओरिजिन्स एरे और बहु-कंपोनेंट ओरिजिन्स