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 yazma ilkelerine dayanmaktadır. Basitçe açıklamak gerekirse;
- Kısa ve öz olun
- Basit ve doğrudan yazın
- Kullanıcılara açıkça hitap edin
- Temel ayrıntıları paylaşın
- Tüm okuma seviyeleri için yaz
- İnsan olun: Robotlar için değil, insanlar için yazın
Tüm şablonların tutarlı bir görünüm ve düzene sahip olmasını sağlamak ve kullanıcıların, şablonunuzu nasıl kullanacaklarını anlamalarına yardımcı olmak için bu yönergeleri izleyin.
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ü ve Topluluk Şablon Galerisi'nde Etiket Yöneticisi kullanıcılarına sunulur. Bu bilgiler, şablonun ayrıntı sayfasının üst kısmında, şablonlar listelendiğinde gösterilir.
- Şirket/kuruluş adınızı ve şablonun işlevsel adını kullanın: Kuruluş Adı Şablon Adı.
- Yalnızca İlk Harfler Büyük yazın.
- İşlevselliği açıklayan terimler kullanın.
- İlgili kuruluş tarafından izin verilmediği sürece ş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ı, ayrıntılar sayfasında şablon işlevinin kısa bir özeti olarak görünen şablon açıklamasıdır.
- Şablonun ne yaptığını açıklamak için net ve kısa cümleler kullanın.
- Şablonunuzun kullanıcıya nasıl fayda sağladığını açıkça belirtin. Örneğin: "Örnek.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üman ve destek bağlantıları ekleyin.
Simge
Şablon simgeniz, Etiket Yöneticisi'nde ve Topluluk Şablon Galerisi'nde listelendiğinde küçük resim olarak gösterilir.
- Resim biçimi için PNG, JPEG veya GIF kullanın.
- Resim kare, en az 48x48 piksel ve en fazla 96 piksele 96 piksel olmalıdır.
- Dosya boyutu 50 kilobayttan az olmalıdır.
- İlgili kuruluş tarafından izin verilmediği sürece resmi şirket logolarını kullanmaktan kaçının.
- Alanlar
- Metin girişi ve 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 sekmesinde geçerlidir.
Parametre adı
Bu, Şablon Düzenleyici'de görünen, ancak kullanıcıya görünen alanın adı 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 arasında görünen ad alanları, onay kutusu metni ve ilgili öğeler bulunur.
- Normal cümle düzeni kullanın.
- Ne kadar kısaysa o kadar iyi.
- 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ı olması için ipucu olarak gösterilen bilgilendirici içeriktir. Mümkünse örnek giriş yapın ve şablon alanının nasıl kullanıldığını ya da belirli değerleri sağlamanın etkisini açıklayın.
- Normal cümle düzeni kullanın.
- Başlığı kısa ve öz tutun, insani olun. Kasıtları kullanabilir ve ikinci kişiye (siz) yazabilirsiniz.
- 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 başvuruda bulunabilecek bir dize olacaktır. Etiket Yöneticisi kullanıcı arayüzünde oluşturulan metin girişi widget'ı tek satırlık metin alanı veya çok satırlı giriş olabilir. |
| Açılır menü | Şablon parametresinin değeri olarak yalnızca tek bir öğenin seçilebileceği açılır menü. Aksi hâlde iyi bir neden olmadığı sürece öğeleri alfabetik sıraya göre listeleyin. |
| Onay kutusu | Onay kutusu girişi. Bu tür bir şablon parametresinin değeri, kontrol için boole: true, kontrol edilmemiş için false olur. |
| Radyo düğmesi | Radyo girişi. Bu tür bir şablon parametresi, Etiket Yöneticisi kullanıcı arayüzünde bir seçenek listesi sunar ve kullanıcının şablon parametresinin değeri olarak yalnızca bir seçenek belirlemesine izin verilir. |
| Basit tablo | Basit bir tablo girişi. Tablodaki her hücre yerinde düzenlenebilir ve her hücre yalnızca iki tür 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ı ve nesnedeki her değer, ilgili hücrenin değeridir. |