Bu stil kılavuzu, Topluluk Şablon Galerisi için şablonları nasıl hazırlayacağınıza karar vermenize yardımcı olmak amacıyla hazırlanmıştır. Bu stil kılavuzu, Google Materyal Tasarım yazım ilkelerine dayanır. Basitçe belirtmek gerekirse bunlar:
- Kısa ve öz istemler oluşturun
- Basit ve doğrudan yazın
- Kullanıcılara açıkça hitap edin
- Önemli ayrıntıları paylaşın
- Tüm okuma seviyelerine uygun içerikler yazma
- İnsan gibi yazın: Robotlar için değil, insanlar için yazın
Tüm şablonların tutarlı bir görünüme ve tarza sahip olmasını sağlamak ve kullanıcıların şablonunuzu nasıl kullanacağını anlamalarına yardımcı olmak için bu yönergelere uyun.
Bilgi
Bu yönergeler, Şablon Düzenleyici'nin Bilgi sekmesinde bulunan öğeler için geçerlidir.
Ad
Şablon adı, Etiket Yöneticisi kullanıcı arayüzünde ve Topluluk Şablon Galerisi'nde Etiket Yöneticisi kullanıcılarına sunulur. Bu durum, şablonun ayrıntılar sayfasının üst kısmında ve şablonlar listelendiğinde gösterilir.
- Şirket/kuruluş adınızı ve şablonun işlevsel adını kullanın: Kuruluş Adı Şablon Adı.
- Başlık düzeni kullanın.
- İşlevi açıklayan terimler kullanın.
- İlgili kuruluş tarafından yetki verilmedikçe şablon adlarında "Resmi" terimini kullanmaktan kaçının.
Örnekler: Şirketim Dönüşüm Ölçümü Etiketi, Şirketim Kampanya Kimliği Değişkeni
Açıklama
Şablon açıklaması, şablonun işlevinin kısa bir özeti olarak ayrıntılar sayfalarında görünen şablon açıklamasıdır.
- Şablonun işlevini açıklamak için kısa ve net cümleler kullanın.
- Şablonunuzun kullanıcıya nasıl avantaj sağladığını açıkça belirtin. Örneğin: "Example.com Kitle Oluşturucu şablonu, web sitesi ziyaretçilerinden yeni kitle listeleri oluşturmanıza yardımcı olabilir."
- Jargon kullanmaktan kaçının.
- Ek bilgi, dokümanlar ve destek bağlantıları ekleyin.
Simge
Şablon simgeniz, Etiket Yöneticisi'nde ve Topluluk Şablon Galerisi'nde küçük resim olarak gösterilir.
- Resim biçimi için PNG, JPEG veya GIF kullanın.
- Resim kare biçiminde, en az 48x48 piksel ve en fazla 96x96 piksel boyutunda olmalıdır.
- Dosya boyutu 50 kilobayttan az olmalıdır.
- İlgili kuruluş tarafından yetki verilmedikçe resmi şirket logolarını kullanmaktan kaçının.
- Alanlar
- Metin girişi, onay kutuları gibi form öğeleri eklemek için Şablon Düzenleyici'nin Alanlar sekmesini kullanın.
Alanlar
Bu stil yönergeleri, Şablon Düzenleyici'nin Alanlar sekmesi için geçerlidir.
Parametre adı
Bu, alanın Şablon Düzenleyici'de göründüğü şekliyle adıdır ancak kullanıcıya göründüğü şekliyle değildir. Adlar, kullanılan veri türünü açıklayıcı olmalıdır. Parametre adlarını lowerCamelCase olarak biçimlendirin. Örnekler: userName, customerID, shoppingCartValue.
Alan etiketleri
Alan etiketleri; görünen ad alanları, onay kutusu metni ve ilgili öğeleri içerir.
- Normal cümle düzeni kullanın.
- Ne kadar kısa olursa o kadar iyidir.
- Açıklayıcı olun.
- Yaygın kelimeler kullanın.
Yardım metni
Yardım metni, kullanıcının şablon alanına geçerli bir değer girmesine yardımcı olmak için ipucu olarak gösterilen bilgilendirici içeriktir. Mümkünse örnek giriş sağlayın ve şablon alanının nasıl kullanıldığını veya belirli değerlerin sağlanmasının etkisini açıklayın.
- Normal cümle düzeni kullanın.
- Kısa ve öz ama samimi olun. Kısaltmalar kullanmak ve ikinci şahıs (siz) şeklinde yazmak sorun yaratmaz.
- Desteklenen alan türleri
- Temel HTML biçimlendirmesine izin verilir. Örnekler:
<strong>,<em>.
Desteklenen alan türleri
Tür |
Açıklama |
|---|---|
| Metin girişi | Metin girişi. Bu tür bir şablon parametresinin değeri, değişkenlere atıfta bulunabilecek bir dize olur. Etiket Yöneticisi kullanıcı arayüzünde oluşturulan metin girişi widget'ı tek satırlık bir metin alanı veya çok satırlık bir giriş olabilir. |
| Açılır menü | Şablon parametresinin değeri olarak yalnızca tek bir öğenin seçilebileceği açılır menü. Aksini yapmanıza neden olacak bir durum yoksa öğeleri alfabetik olarak listeleyin. |
| Onay kutusu | Onay kutusu girişi. Bu tür bir şablon parametresinin değeri boole olacaktır: işaretli için true, işaretsiz için false. |
| Radyo düğmesi | Radyo girişi. Bu tür bir şablon parametresi, Etiket Yöneticisi kullanıcı arayüzünde seçeneklerin bir listesini sunar ve kullanıcının şablon parametresinin değeri olarak seçeneklerden yalnızca birini seçmesine izin verilir. |
| Basit tablo | Basit bir tablo girişi. Tablodaki her hücre yerinde düzenlenebilir ve her hücre yalnızca iki türden biri olabilir: metin girişi veya açılır menü. Bu tür bir şablon parametresinin değeri bir nesne dizisidir: Her nesne bir satırı kodlar, nesnedeki her anahtar sütun adlarından biri olmalıdır ve nesnedeki her değer, ilgili hücrenin değeridir. |