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