راهنمای سبک قالب

این راهنمای سبک برای کمک به شما در تصمیم گیری در مورد نحوه تهیه الگوها برای گالری الگوهای انجمن تهیه شده است. این راهنمای سبک بر اساس اصول نوشتن Google Material Design است . به بیان ساده، این موارد عبارتند از:

  • مختصر باشد
  • ساده و مستقیم بنویسید
  • کاربران را به وضوح نشان دهید
  • جزئیات ضروری را به اشتراک بگذارید
  • برای تمام سطوح خواندن بنویسید
  • انسان باش: برای انسان ها بنویس، نه روبات ها

این دستورالعمل‌ها را دنبال کنید تا اطمینان حاصل کنید که همه الگوها ظاهر و احساسی ثابت دارند و به کاربران کمک می‌کند نحوه استفاده از الگوی شما را درک کنند.

اطلاعات

این دستورالعمل ها در مورد مواردی که در برگه اطلاعات ویرایشگر الگو یافت می شوند اعمال می شود.

نام

نام الگو در سراسر رابط کاربری Tag Manager و گالری الگوی انجمن به کاربران Tag Manager ارائه می شود. در بالای صفحه جزئیات یک الگو ظاهر می شود و زمانی که الگوها فهرست می شوند ظاهر می شود.

  • از نام شرکت/سازمان خود و نام کاربردی الگو استفاده کنید: نام سازمان نام الگو .
  • از Title Case استفاده کنید.
  • از عباراتی استفاده کنید که توصیف کننده عملکرد هستند.
  • از استفاده از عبارت "رسمی" در نام الگوها خودداری کنید، مگر اینکه از طرف سازمان مربوطه مجوز این کار را داشته باشید.

مثال‌ها: برچسب اندازه‌گیری تبدیل MyCompany، متغیر ID کمپین MyCompany

شرح

توضیحات قالب شرحی از الگو است که در صفحات جزئیات به عنوان خلاصه ای از عملکرد الگو ظاهر می شود.

  • از جملات واضح و مختصر برای توصیف کارهایی که الگو انجام می دهد استفاده کنید.
  • به وضوح بیان کنید که الگوی شما چه سودی برای کاربر دارد. به عنوان مثال: "الگوی Example.com Audience Builder می تواند به شما در ایجاد لیست مخاطبان جدید از بازدیدکنندگان وب سایت کمک کند."
  • از اصطلاحات خاص خودداری کنید.
  • پیوندهایی برای اطلاعات بیشتر، اسناد و پشتیبانی اضافه کنید.

آیکون

نماد الگوی شما وقتی در Tag Manager و در گالری الگوی انجمن فهرست می‌شود، به‌عنوان یک تصویر کوچک نشان داده می‌شود.

  • برای فرمت تصویر از PNG، JPEG یا GIF استفاده کنید.
  • تصویر باید مربع باشد، حداقل 48 پیکسل در 48 پیکسل، و بزرگتر از 96 پیکسل در 96 پیکسل نباشد.
  • حجم فایل باید کمتر از 50 کیلوبایت باشد.
  • از استفاده از آرم های رسمی شرکت خودداری کنید، مگر اینکه از طرف سازمان مربوطه مجوز این کار را داشته باشید.
  • زمینه های
  • از برگه فیلدهای ویرایشگر الگو برای افزودن عناصر فرم مانند ورودی متن، چک باکس ها و غیره استفاده کنید.

زمینه های

این دستورالعمل‌های سبک برای برگه‌های ویرایشگر الگو اعمال می‌شود.

نام پارامتر

این نام فیلد است که در ویرایشگر الگو ظاهر می شود، اما نه آنطور که برای کاربر ظاهر می شود. نام ها باید توصیفی از نوع داده های مورد استفاده باشد. نام پارامترها را به صورت lowerCamelCase قالب بندی کنید. مثال: نام کاربری، شناسه مشتری، shoppingCartValue .

برچسب های زمینه

برچسب های فیلد شامل فیلدهای نام نمایشی، متن چک باکس و موارد مرتبط است.

  • از حالت جمله استفاده کنید
  • کوتاهتر بهتر است
  • توصیفی باشد.
  • از کلمات رایج استفاده کنید.

متن راهنما

متن راهنما یک محتوای اطلاعاتی است که به عنوان یک راهنمای ابزار نشان داده شده است تا به کاربر کمک کند مقدار معتبری را در قسمت الگو وارد کند. در صورت امکان، ورودی نمونه ارائه دهید و نحوه استفاده از فیلد الگو یا تأثیر ارائه مقادیر خاص را شرح دهید.

  • از حالت جمله استفاده کنید
  • مختصر باشید، اما انسان باشید. اشکالی ندارد از انقباضات استفاده کنید و به صورت دوم شخص (شما) بنویسید.
  • انواع فیلدهای پشتیبانی شده
  • قالب بندی اولیه HTML مجاز است. مثال‌ها: <strong> ، <em> .

انواع فیلدهای پشتیبانی شده

تایپ کنید
 شرح
ورودی متن ورودی متن مقدار یک پارامتر الگو از این نوع رشته ای خواهد بود که ممکن است به متغیرها اشاره کند. ویجت ورودی متن ارائه شده در رابط کاربری Tag Manager می تواند یک فیلد متنی تک خطی یا یک ورودی چند خطی باشد.
منوی کشویی منوی کشویی که در آن فقط یک مورد می تواند به عنوان مقدار پارامتر الگو انتخاب شود. موارد را به ترتیب حروف الفبا فهرست کنید، مگر اینکه دلیل خوبی برای انجام این کار وجود داشته باشد.
چک باکس ورودی چک باکس مقدار یک پارامتر الگو از این نوع خواهد بود بولی: درست برای علامت زده شده، غلط برای علامت نشده است.
دکمه رادیویی ورودی رادیو یک پارامتر الگو از این نوع لیستی از انتخاب ها را در رابط کاربری Tag Manager ارائه می دهد و کاربر فقط مجاز است یکی از گزینه ها را به عنوان مقدار پارامتر الگو انتخاب کند.
میز ساده ورودی جدول ساده هر سلول در جدول را می توان در جای خود ویرایش کرد و هر سلول فقط می تواند دو نوع باشد: یک ورودی متن یا یک منوی کشویی. مقدار پارامتر الگو از این نوع آرایه ای از اشیاء است: هر شی یک ردیف را رمزگذاری می کند، هر کلید در شی باید یکی از نام ستون ها باشد و هر مقدار در شی مقدار سلول مربوطه است.