Przewodnik po stylu szablonu

Ten przewodnik po stylach pomoże Ci zdecydować, jak przygotować szablony do Galerii szablonów. Ten przewodnik dotyczący stylu opiera się na zasadach pisania Google Material Design. Krótko mówiąc:

• Zadbaj o zwięzłość
• Pisanie proste i bezpośrednie
• Zwracaj się bezpośrednio do użytkowników
• Przekaż najważniejsze informacje
• Pisz na wszystkich poziomach odczytu
• Postaw na ludzkie: pisz dla ludzi, a nie dla robotów

Postępuj zgodnie z tymi wskazówkami, aby wszystkie szablony miały spójny wygląd i mogły być zrozumiałe dla użytkowników.

Informacje

Te wskazówki dotyczą elementów na karcie Informacje w Edytorze szablonów.

Nazwa

Nazwa szablonu jest widoczna dla użytkowników Menedżera tagów w interfejsie Menedżera tagów i w Galerii szablonów. Pojawia się on u góry strony z informacjami o szablonie i pojawia się po wyświetleniu szablonów.

• Podaj nazwę firmy/organizacji i funkcjonalną nazwę szablonu: nazwa organizacji nazwa szablonu.
• Używaj wielkich liter.
• Używaj opisów, które opisują poszczególne funkcje.
• Unikaj używania terminu „oficjalny” w nazwach szablonów, chyba że masz do tego upoważnienie odpowiedniej organizacji.

Przykłady: tag pomiaru konwersji MyCompany, zmienna identyfikatora kampanii MyCompany

Opis

Opis szablonu to opis, który pojawia się na stronach szczegółów w formie krótkiego podsumowania jego funkcji.

• Użyj jasnych i zwięzłych zdań, które opisują działanie szablonu.
• Jasno określ, jakie korzyści może przynieść Twój szablon. Na przykład: „Przykładowy szablon Kreatora odbiorców Audience.com może pomóc w tworzeniu nowych list odbiorców od użytkowników witryny”.
• Unikaj żargonu.
• Dołącz linki do dodatkowych informacji, dokumentacji i pomocy.

Ikona

Ikona wyświetlana w Menedżerze tagów i w Galerii szablonów społeczności to miniatura.

• Użyj formatu PNG, JPEG lub GIF.
• Obraz powinien być kwadratowy, mieć co najmniej 48 × 48 pikseli i nie większy niż 96 × 96 pikseli.
• Rozmiar pliku nie może przekraczać 50 kilobajtów.
• Unikaj korzystania z oficjalnych logo firmy, chyba że masz do tego upoważnienie odpowiedniej organizacji.
• Pola
• Na karcie Pola edytora szablonów możesz dodawać elementy formularza, takie jak tekst, pola wyboru itp.

Pola

Wskazówki te dotyczą karty Pola w edytorze szablonów.

Nazwa parametru

Nazwa pola będzie widoczna w edytorze szablonów, ale nie będzie widoczna dla użytkownika. Nazwy powinny opisywać rodzaj używanych danych. Sformatuj nazwy parametrów jako lowerCamelCase. Przykłady: userName, clientID, shoppingCartValue.

Etykiety pól

Etykiety pól zawierają pola nazwy wyświetlanej, tekst pola wyboru i powiązane elementy.

• Używaj wielkości liter jak w zdaniu.
• Im krócej, tym lepiej.
• Stosuj styl opisowy.
• Stosuj popularne słowa.

Tekst pomocy

Tekst pomocy to treść informacyjna, która pomaga użytkownikowi wpisać prawidłową wartość w polu szablonu. Jeśli to możliwe, podaj przykładowe dane i opisz, jak używane jest pole szablonu, lub jaki jest wpływ podania wartości.

• Używaj wielkości liter jak w zdaniu.
• Zadbaj o zwięzłość, ale zachowuj się jak człowiek. Stosowanie skurczów i pisanie w drugiej osobie (Ty) jest dozwolone.
• Obsługiwane typy pól
• Podstawowe formatowanie HTML jest dozwolone. Przykłady: <strong>, <em>.

Obsługiwane typy pól

Typ	Opis
Wpisywanie tekstu	Pole tekstowe. Wartość parametru tego typu będzie ciągiem tekstowym, który może odnosić się do zmiennych. Widżet do wprowadzania tekstu wyświetlany w interfejsie Menedżera tagów może zawierać pole jednowierszowe lub wielowierszowe.
Menu	Menu, w którym jako wartość parametru szablonu można wybrać tylko 1 element. Pozycje elementów w kolejności alfabetycznej, chyba że nie ma uzasadnionego powodu.
Pole wyboru	Pole wyboru. Wartość parametru szablonu tego typu ma wartość logiczną: prawda w przypadku zaznaczenia, fałsz w przypadku zaznaczenia.
Przycisk	Źródło sygnału. Parametr szablonu tego typu zawiera listę opcji dostępnych w interfejsie Menedżera tagów. Użytkownik może wybrać tylko jedną z opcji jako wartość parametru szablonu.
Prosta tabela	Proste dane wejściowe w tabeli. Możesz edytować każdą komórkę tabeli, a każda komórka może zawierać tylko dwa typy: tekst lub menu. Wartość parametru szablonu tego typu to tablica obiektów: każdy obiekt koduje wiersz, każdy klucz w obiekcie musi być jedną z nazw kolumn, a każda wartość w obiekcie jest wartością odpowiedniej komórki.