Poradnik dotyczący stylu szablonów

Ten przewodnik stylu ma pomóc Ci w podejmowaniu decyzji dotyczących przygotowywania szablonów do Galerii szablonów społeczności. Ten przewodnik po stylu opiera się na zasadach pisania w ramach Material Design. Mówiąc najprościej, są to:

  • Zadbaj o zwięzłość.
  • Pisz w prosty i bezpośredni sposób
  • wyraźnie kierować się do użytkowników;
  • Przekazywanie najważniejszych informacji
  • Pisanie dla wszystkich poziomów czytania
  • Bądź sobą: pisz dla ludzi, a nie robotów

Przestrzegaj tych wskazówek, aby zapewnić spójny wygląd wszystkich szablonów i ułatwić użytkownikom korzystanie z nich.

Informacje

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

Nazwa

Nazwa szablonu jest wyświetlana użytkownikom Menedżera tagów w interfejsie Menedżera tagów oraz w Galerii szablonów społeczności. Wyświetla się u góry strony z informacjami o szablonie i na liście szablonów.

  • Użyj nazwy firmy lub organizacji oraz nazwy funkcjonalnej szablonu: Nazwa organizacji Nazwa szablonu.
  • Użyj wielkości liter jak w nazwach własnych.
  • Używaj terminów opisujących funkcję.
  • Unikaj używania w nazwach szablonów słowa „oficjalny”, chyba że masz odpowiednie upoważnienie od odpowiedniej organizacji.

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

Opis

Opis szablonu to opis szablonu, który wyświetla się na stronach z informacjami jako krótkie podsumowanie jego funkcji.

  • Użyj zrozumiałych i zwięzłych zdań, aby opisać działanie szablonu.
  • Wyraźnie opisz, jakie korzyści dla użytkownika niesie ze sobą Twój szablon. Przykład: „Szablon Kreator listy odbiorców na stronie Example.com może Ci pomóc w tworzeniu nowych list odbiorców na podstawie użytkowników witryny”.
  • Unikaj żargonu.
  • Dodaj linki do dodatkowych informacji, dokumentacji i pomocy technicznej.

Ikona

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

  • Użyj formatu PNG, JPEG lub GIF.
  • Obraz powinien być kwadratowy i mieć co najmniej 48 × 48 pikseli, ale nie więcej niż 96 × 96 pikseli.
  • Rozmiar pliku nie może przekraczać 50 KB.
  • Unikaj używania oficjalnych logo firm, chyba że masz upoważnienie odpowiedniej organizacji.
  • Pola
  • Na karcie Pola w edytorze szablonów możesz dodawać elementy formularza, takie jak pola tekstowe czy pola wyboru.

Pola

Te wskazówki dotyczące stylu dotyczą karty Pola w Edytorze szablonów.

Nazwa parametru

Jest to nazwa pola widoczna w Edytorze szablonów, ale nie taka, jaką widzi użytkownik. Nazwy powinny opisywać typ używanych danych. Nazwy parametrów powinny mieć format lowerCamelCase. Przykłady: userName, customerID, shoppingCartValue.

Etykiety pól

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

  • Stosuje się w nim wielkości liter jak w zdaniu.
  • Im krócej, tym lepiej.
  • Stosuj styl opisowy.
  • Używaj popularnych słów.

Tekst pomocy

Tekst pomocy to treści informacyjne wyświetlane jako etykieta, które pomagają użytkownikowi w wpisaniu prawidłowej wartości w polu szablonu. Jeśli to możliwe, podaj przykładowe dane wejściowe i opisz, jak używać pola szablonu lub jaki jest efekt podania określonych wartości.

  • Stosuje się w nim wielkości liter jak w zdaniu.
  • Zadbaj o zwięzłość, ale nie zapominaj o człowieczeństwie. Możesz używać skrótów i pisać w drugiej osobie (Ty).
  • Obsługiwane typy pól
  • Dozwolone jest podstawowe formatowanie HTML. Przykłady: <strong>, <em>.

Obsługiwane typy pól

Typ
 Opis
Tekst Pole tekstowe. Wartość parametru szablonu tego typu to ciąg znaków, który może się odwoływać do zmiennych. Widget wprowadzania tekstu renderowany w interfejsie Menedżera tagów może być polem tekstowym jednowierszowym lub wielowierszowym.
Menu Menu, w którym można wybrać tylko jeden element jako wartość parametru szablonu. Wypisz elementy w kolejności alfabetycznej, chyba że masz dobry powód, aby tego nie robić.
Pole wyboru Pole wyboru. Wartość parametru szablonu tego typu będzie typu logicznego: „prawda” (true) w przypadku zaznaczenia i „fałsz” (false) w przypadku niezaznaczenia.
Opcja Wybór radia. Parametr szablonu tego typu wyświetla w interfejsie Menedżera tagów listę opcji, z których użytkownik może wybrać tylko jedną jako wartość parametru szablonu.
Prosta tabela Proste dane wejściowe tabeli. Każdą komórkę w tabeli można edytować oddzielnie. Są tylko dwa typy komórek: z polem tekstowym lub menu z elementami do wyboru. Wartość parametru szablonu tego typu to tablica obiektów: każdy obiekt koduje wiersz, każdy klucz w obiekcie musi być jedną z nazwy kolumn, a każda wartość w obiekcie to wartość odpowiadającej jej komórki.