টেমপ্লেট শৈলী গাইড

কমিউনিটি টেমপ্লেট গ্যালারির জন্য কীভাবে টেমপ্লেট প্রস্তুত করবেন সে বিষয়ে সিদ্ধান্ত নিতে আপনাকে সাহায্য করার জন্য এই শৈলী নির্দেশিকা প্রস্তুত করা হয়েছে। এই শৈলী নির্দেশিকাটি Google Material Design লেখার নীতির উপর ভিত্তি করে তৈরি করা হয়েছে। সহজভাবে বলতে গেলে, এগুলি হল:

  • সংক্ষিপ্ত হোন
  • সহজভাবে এবং সরাসরি লিখুন
  • স্পষ্টভাবে ব্যবহারকারীদের সম্বোধন করুন
  • প্রয়োজনীয় বিবরণ যোগাযোগ
  • সমস্ত পড়ার স্তরের জন্য লিখুন
  • মানুষ হও: মানুষের জন্য লিখুন, রোবট নয়

সমস্ত টেমপ্লেটের একটি সামঞ্জস্যপূর্ণ চেহারা এবং অনুভূতি নিশ্চিত করতে এবং ব্যবহারকারীদের কীভাবে আপনার টেমপ্লেট ব্যবহার করতে হয় তা বুঝতে সাহায্য করার জন্য এই নির্দেশিকাগুলি অনুসরণ করুন৷

তথ্য

এই নির্দেশিকাগুলি টেমপ্লেট সম্পাদকের তথ্য ট্যাবে পাওয়া আইটেমগুলিতে প্রযোজ্য।

নাম

ট্যাগ ম্যানেজার ব্যবহারকারী ইন্টারফেস এবং কমিউনিটি টেমপ্লেট গ্যালারী জুড়ে টেমপ্লেট নামটি ট্যাগ ম্যানেজার ব্যবহারকারীদের কাছে উপস্থাপন করা হয়। এটি একটি টেমপ্লেটের বিশদ পৃষ্ঠার শীর্ষে প্রদর্শিত হয় এবং যখন টেমপ্লেট তালিকাভুক্ত হয় তখন এটি প্রদর্শিত হয়।

  • আপনার কোম্পানি/সংস্থার নাম এবং টেমপ্লেটের কার্যকরী নাম ব্যবহার করুন: প্রতিষ্ঠানের নাম টেমপ্লেট নাম
  • টাইটেল কেস ব্যবহার করুন।
  • কার্যকারিতার বর্ণনামূলক পদ ব্যবহার করুন।
  • টেমপ্লেটের নামগুলিতে "অফিসিয়াল" শব্দটি ব্যবহার এড়িয়ে চলুন, যদি না আপনি প্রাসঙ্গিক সংস্থার দ্বারা এটি করার জন্য অনুমোদিত হন।

উদাহরণ: MyCompany রূপান্তর পরিমাপ ট্যাগ, MyCompany ক্যাম্পেইন আইডি পরিবর্তনশীল

বর্ণনা

টেমপ্লেট বিবরণ হল টেমপ্লেটের একটি বিবরণ যা টেমপ্লেট কার্যকারিতার সংক্ষিপ্ত সারাংশ হিসাবে বিশদ পৃষ্ঠাগুলিতে প্রদর্শিত হয়।

  • টেমপ্লেটটি কী করে তা বর্ণনা করতে স্পষ্ট এবং সংক্ষিপ্ত বাক্য ব্যবহার করুন।
  • আপনার টেমপ্লেট ব্যবহারকারীকে কীভাবে উপকৃত করে তা স্পষ্টভাবে বলুন। যেমন: "Example.com অডিয়েন্স বিল্ডার টেমপ্লেট আপনাকে ওয়েবসাইট ভিজিটরদের থেকে নতুন দর্শক তালিকা তৈরি করতে সাহায্য করতে পারে।"
  • পরিভাষা এড়িয়ে চলুন।
  • অতিরিক্ত তথ্য, ডকুমেন্টেশন এবং সমর্থনের জন্য লিঙ্কগুলি অন্তর্ভুক্ত করুন।

আইকন

ট্যাগ ম্যানেজার এবং কমিউনিটি টেমপ্লেট গ্যালারিতে তালিকাভুক্ত হলে আপনার টেমপ্লেট আইকনটি থাম্বনেইল হিসেবে উপস্থাপন করা হয়।

  • ইমেজ ফরম্যাটের জন্য PNG, JPEG, বা GIF ব্যবহার করুন।
  • ছবি বর্গাকার হওয়া উচিত, কমপক্ষে 48px x 48px, এবং 96px x 96px এর চেয়ে বড় হওয়া উচিত নয়।
  • ফাইলের আকার 50 কিলোবাইটের কম হতে হবে।
  • অফিসিয়াল কোম্পানির লোগো ব্যবহার এড়িয়ে চলুন, যদি না আপনি প্রাসঙ্গিক সংস্থার দ্বারা এটি করার জন্য অনুমোদিত হন।
  • ক্ষেত্র
  • ফর্ম উপাদান যেমন টেক্সট ইনপুট, চেকবক্স ইত্যাদি যোগ করতে টেমপ্লেট সম্পাদকের ক্ষেত্র ট্যাব ব্যবহার করুন।

ক্ষেত্র

এই শৈলী নির্দেশিকাগুলি টেমপ্লেট সম্পাদকের ক্ষেত্র ট্যাবে প্রযোজ্য।

পরামিতি নাম

এটি টেমপ্লেট এডিটরে প্রদর্শিত ক্ষেত্রের নাম, কিন্তু ব্যবহারকারীর কাছে এটির মতো নয়। নামগুলি ব্যবহার করা ডেটার প্রকারের বর্ণনামূলক হওয়া উচিত। lowerCamelCase হিসাবে প্যারামিটার নামগুলি ফর্ম্যাট করুন। উদাহরণ: username, customerID, shoppingCartValue

ক্ষেত্র লেবেল

ক্ষেত্র লেবেল প্রদর্শন নামের ক্ষেত্র, চেকবক্স পাঠ্য, এবং সম্পর্কিত আইটেম অন্তর্ভুক্ত।

  • বাক্যের ক্ষেত্রে ব্যবহার করুন।
  • ছোট হলে ভালো।
  • বর্ণনামূলক হন।
  • সাধারণ শব্দ ব্যবহার করুন।

সাহায্যকারী লেখা

সাহায্য টেক্সট তথ্যমূলক বিষয়বস্তু, একটি টুলটিপ হিসাবে দেখানো হয়, যাতে ব্যবহারকারীকে টেমপ্লেট ক্ষেত্রে একটি বৈধ মান প্রবেশ করাতে সাহায্য করে। সম্ভব হলে উদাহরণ ইনপুট দিন এবং টেমপ্লেট ক্ষেত্রটি কীভাবে ব্যবহার করা হয় বা নির্দিষ্ট মান প্রদানের প্রভাব বর্ণনা করুন।

  • বাক্যের ক্ষেত্রে ব্যবহার করুন।
  • সংক্ষিপ্ত হন, কিন্তু মানুষ হন। সংকোচন ব্যবহার করা এবং ২য় ব্যক্তি (আপনি) লিখতে ঠিক আছে।
  • সমর্থিত ক্ষেত্রের প্রকার
  • মৌলিক HTML বিন্যাস অনুমোদিত. উদাহরণ: <strong> , <em>

সমর্থিত ক্ষেত্রের প্রকার

টাইপ
বর্ণনা
টেক্সট ইনপুট টেক্সট ইনপুট। এই ধরনের একটি টেমপ্লেট প্যারামিটারের মান একটি স্ট্রিং হবে যা ভেরিয়েবলকে উল্লেখ করতে পারে। ট্যাগ ম্যানেজার ইউজার ইন্টারফেসে রেন্ডার করা টেক্সট ইনপুট উইজেট একটি একক-লাইন টেক্সট ফিল্ড বা মাল্টি-লাইন ইনপুট হতে পারে।
ড্রপ-ডাউন মেনু ড্রপ-ডাউন মেনু যেখানে টেমপ্লেট প্যারামিটারের মান হিসাবে শুধুমাত্র একটি আইটেম নির্বাচন করা যেতে পারে। অন্যথা করার একটি ভাল কারণ না থাকলে বর্ণানুক্রমিক ক্রমে আইটেমগুলি তালিকাভুক্ত করুন।
চেকবক্স চেকবক্স ইনপুট। এই ধরনের টেমপ্লেট প্যারামিটারের মান হবে বুলিয়ান: চেক করা হলে সত্য, চেক না করা হলে মিথ্যা।
রেডিও বোতাম রেডিও ইনপুট। এই ধরনের একটি টেমপ্লেট প্যারামিটার ট্যাগ ম্যানেজার ব্যবহারকারী ইন্টারফেসে পছন্দগুলির একটি তালিকা উপস্থাপন করে এবং ব্যবহারকারীকে শুধুমাত্র টেমপ্লেট প্যারামিটারের মান হিসাবে পছন্দগুলির মধ্যে একটি বেছে নেওয়ার অনুমতি দেওয়া হয়।
সহজ টেবিল একটি সাধারণ টেবিল ইনপুট। টেবিলের প্রতিটি কক্ষের জায়গায় সম্পাদনা করা যেতে পারে, এবং প্রতিটি ঘর শুধুমাত্র দুই ধরনের হতে পারে: একটি পাঠ্য ইনপুট বা একটি ড্রপ-ডাউন মেনু৷ এই ধরনের একটি টেমপ্লেট প্যারামিটারের মান হল অবজেক্টের একটি অ্যারে: প্রতিটি অবজেক্ট একটি সারি এনকোড করে, অবজেক্টের প্রতিটি কী অবশ্যই কলামের নামগুলির একটি হতে হবে এবং অবজেক্টের প্রতিটি মান হল সংশ্লিষ্ট কক্ষের মান।