इस स्टाइल गाइड को समुदाय टेंप्लेट गैलरी के लिए टेंप्लेट तैयार करने के तरीके के बारे में फ़ैसले लेने में आपकी मदद करने के लिए तैयार किया गया है. यह स्टाइल गाइड, Google Material Design के लेखन के सिद्धांतों पर आधारित है. आसान शब्दों में कहें, तो ये हैं:
- कम से कम शब्द इस्तेमाल करें
- आसान और सीधे शब्दों में लिखें
- उपयोगकर्ताओं को साफ़ तौर पर बताएं
- ज़रूरी जानकारी देना
- सभी रीडिंग लेवल के लिए लिखना
- इंसानों के हिसाब से लिखें: रोबोट के लिए नहीं, बल्कि लोगों के लिए लिखें
इन दिशा-निर्देशों का पालन करके, पक्का करें कि सभी टेंप्लेट एक जैसे दिखें. साथ ही, इनसे उपयोगकर्ताओं को आपके टेंप्लेट को इस्तेमाल करने का तरीका समझने में भी मदद मिलेगी.
जानकारी
ये दिशा-निर्देश, टेंप्लेट एडिटर के जानकारी टैब में मौजूद आइटम पर लागू होते हैं.
नाम
टेंप्लेट का नाम, Tag Manager के यूज़र इंटरफ़ेस और समुदाय टेम्प्लेट गैलरी में Tag Manager के उपयोगकर्ताओं को दिखाया जाता है. यह टेंप्लेट की जानकारी वाले पेज पर सबसे ऊपर दिखता है. साथ ही, टेंप्लेट की सूची में भी दिखता है.
- अपनी कंपनी/संगठन का नाम और टेंप्लेट का फ़ंक्शनल नाम इस्तेमाल करें: संगठन का नाम टेंप्लेट का नाम.
- टाइटल केस का इस्तेमाल करें.
- ऐसे शब्दों का इस्तेमाल करें जो सुविधा के बारे में बताते हों.
- टेंप्लेट के नामों में "आधिकारिक" शब्द का इस्तेमाल तब तक न करें, जब तक कि आपको संबंधित संगठन ने ऐसा करने की अनुमति न दी हो.
उदाहरण: MyCompany कन्वर्ज़न मेज़रमेंट टैग, MyCompany कैंपेन आईडी वैरिएबल
ब्यौरा
टेंप्लेट की जानकारी, टेंप्लेट के बारे में जानकारी होती है. यह जानकारी, ज़्यादा जानकारी वाले पेजों पर दिखती है. इसमें टेंप्लेट की सुविधाओं के बारे में खास जानकारी होती है.
- टेंप्लेट के काम करने के तरीके के बारे में बताने के लिए, कम शब्दों में साफ़ और आसान वाक्यों का इस्तेमाल करें.
- साफ़ तौर पर बताएं कि आपके टेंप्लेट से उपयोगकर्ता को क्या फ़ायदा होगा. उदाहरण के लिए: "Example.com के ऑडियंस बिल्डर टेंप्लेट की मदद से, वेबसाइट पर आने वाले लोगों की नई ऑडियंस सूचियां बनाई जा सकती हैं."
- जर्गन का इस्तेमाल न करें.
- ज़्यादा जानकारी, दस्तावेज़, और सहायता के लिए लिंक शामिल करें.
आइकॉन
Tag Manager और कम्यूनिटी टेंप्लेट गैलरी में, आपके टेंप्लेट के आइकॉन को थंबनेल के तौर पर दिखाया जाता है.
- इमेज फ़ॉर्मैट के लिए PNG, JPEG या GIF का इस्तेमाल करें.
- इमेज स्क्वेयर होनी चाहिए. इसका साइज़ कम से कम 48 पिक्सल x 48 पिक्सल और ज़्यादा से ज़्यादा 96 पिक्सल x 96 पिक्सल होना चाहिए.
- फ़ाइल का साइज़ 50 किलोबाइट से कम होना चाहिए.
- किसी कंपनी के आधिकारिक लोगो का इस्तेमाल तब तक न करें, जब तक कि आपको उस संगठन से ऐसा करने की अनुमति न मिली हो.
- फ़ील्ड
- टेक्स्ट इनपुट, चेकबॉक्स वगैरह जैसे फ़ॉर्म एलिमेंट जोड़ने के लिए, टेंप्लेट एडिटर के फ़ील्ड टैब का इस्तेमाल करें.
फ़ील्ड
स्टाइल के ये दिशा-निर्देश, टेंप्लेट एडिटर के फ़ील्ड टैब पर लागू होते हैं.
पैरामीटर का नाम
यह फ़ील्ड का वह नाम है जो टेंप्लेट एडिटर में दिखता है, न कि वह नाम जो उपयोगकर्ता को दिखता है. नामों से यह पता चलना चाहिए कि किस तरह का डेटा इस्तेमाल किया गया है. पैरामीटर के नामों को lowerCamelCase के तौर पर फ़ॉर्मैट करें. उदाहरण: userName, customerID, shoppingCartValue.
फ़ील्ड लेबल
फ़ील्ड लेबल में, डिसप्ले नेम फ़ील्ड, चेकबॉक्स टेक्स्ट, और मिलते-जुलते आइटम शामिल होते हैं.
- अंग्रेज़ी के वाक्यों में, पहला वर्ण बड़ा (अपर केस में) रखें.
- कम शब्दों में लिखना बेहतर है.
- ब्यौरा दें.
- सामान्य शब्दों का इस्तेमाल करें.
सहायता टेक्स्ट
सहायता टेक्स्ट, जानकारी देने वाला कॉन्टेंट होता है. इसे टूलटिप के तौर पर दिखाया जाता है. इससे उपयोगकर्ता को टेंप्लेट फ़ील्ड में मान्य वैल्यू डालने में मदद मिलती है. अगर हो सके, तो इनपुट का उदाहरण दें. साथ ही, यह भी बताएं कि टेंप्लेट फ़ील्ड का इस्तेमाल कैसे किया जाता है या कुछ वैल्यू देने का क्या असर होता है.
- अंग्रेज़ी के वाक्यों में, पहला वर्ण बड़ा (अपर केस में) रखें.
- कम से कम शब्द इस्तेमाल करें, लेकिन भाषा आसान हो. कम शब्दों का इस्तेमाल किया जा सकता है और दूसरे व्यक्ति (आप) के हिसाब से लिखा जा सकता है.
- इस्तेमाल किए जा सकने वाले फ़ील्ड टाइप
- एचटीएमएल के बुनियादी फ़ॉर्मैट का इस्तेमाल किया जा सकता है. उदाहरण:
<strong>,<em>.
इस्तेमाल किए जा सकने वाले फ़ील्ड टाइप
टाइप |
ब्यौरा |
|---|---|
| टेक्स्ट इनपुट | टेक्स्ट इनपुट. इस तरह के टेंप्लेट पैरामीटर की वैल्यू, एक स्ट्रिंग होगी. इसमें वैरिएबल का रेफ़रंस हो सकता है. Tag Manager के यूज़र इंटरफ़ेस में रेंडर किया गया टेक्स्ट इनपुट विजेट, एक लाइन वाला टेक्स्ट फ़ील्ड या कई लाइन वाला इनपुट हो सकता है. |
| ड्रॉप-डाउन मेन्यू | ड्रॉप-डाउन मेन्यू, जिसमें टेंप्लेट पैरामीटर की वैल्यू के तौर पर सिर्फ़ एक आइटम चुना जा सकता है. जब तक कोई खास वजह न हो, तब तक आइटम को वर्णमाला के क्रम में लगाएं. |
| चेकबॉक्स | चेकबॉक्स इनपुट. इस तरह के टेंप्लेट पैरामीटर की वैल्यू बूलियन होगी: सही के लिए 'सही' और गलत के लिए 'गलत'. |
| रेडियो बटन | रेडियो इनपुट. इस तरह का टेंप्लेट पैरामीटर, Tag Manager के यूज़र इंटरफ़ेस में विकल्पों की सूची दिखाता है. साथ ही, उपयोगकर्ता को टेंप्लेट पैरामीटर की वैल्यू के तौर पर, सिर्फ़ एक विकल्प चुनने की अनुमति होती है. |
| सामान्य टेबल | टेबल का आसान इनपुट. टेबल में मौजूद हर सेल में बदलाव किया जा सकता है. साथ ही, हर सेल दो तरह की हो सकती है: टेक्स्ट इनपुट या ड्रॉप-डाउन मेन्यू. इस टाइप के टेंप्लेट पैरामीटर की वैल्यू, ऑब्जेक्ट का कलेक्शन होती है: हर ऑब्जेक्ट एक लाइन को कोड में बदलता है. ऑब्जेक्ट में मौजूद हर कुंजी, कॉलम के नामों में से कोई एक होनी चाहिए. साथ ही, ऑब्जेक्ट में मौजूद हर वैल्यू, उससे जुड़ी सेल की वैल्यू होती है. |