MDN এ ট্যাগ করার আদর্শরীতি

This translation is incomplete. Please help translate this article from English.

MDN এর একটি গুরুত্বপূর্ণ ফিচার হচ্ছে article tag এর মাধ্যমে ব্যবহারকারীরা কনটেন্ট খুঁজে পায়। প্রতিটি কনটেন্টকে বিভিন্ন ক্যাটাগরিতে বিভক্ত করতে প্রতিটি পেইজকে শূন্য থেকে শুরু করে একাধিক ট্যাগ (অন্তত একটি) দেয়া যেতে পারে। MDN e বিভিন্ন তথ্য বিন্যস্ত করতে বিভিন্ন ধরণের ট্যাগ এর ব্যবহার হয়ে থাকে; কিভাবে পেইজগুলোকে ভালো উপায়ে ট্যাগ করতে হয় সেই বিষয়ে এই পেইজ আপনাকে সাহায্য করবে যাতে তথ্যগুলো সথিকভাবে বিন্যস্ত করা যায় এবং পাঠকগণ সহজেই খুঁজে পায়।

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

লক্ষ্য করুন ট্যাগ এর সঠিক ব্যবহার খুবই গুরুত্বপূর্ণ; আমরা অটোমেটিক ভাবে কনটেন্ট এর লিস্ট তৈরি, পেইজ লোড করা, এবং আর্টিকেল এর ক্রস-লিঙ্কিং আরও বেশি করে ব্যবহার করছি। নিচে দেখানো অনুসারে সঠিকভাবে আর্টিকেল ট্যাগ করতে না পারলে আর্টিকেলটি সঠিকভাবে লিস্ট এ অন্তর্ভুক্ত হবেনা।

যেসকল প্রকারে MDN এ ট্যাগ ব্যবহার করা হয়

There are several ways tags get used on MDN:

Categorization
What type of document is it? Is it a reference? A tutorial? A landing page? These can be used when filtering searches, so they're really important!
Topic identification
What topic does the article cover? Is it about an API? The DOM? Graphics? These, too, are important, because they can be used as filters on searches.
Technology status
What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?
Skill level
For tutorials and guides, how advanced is the material covered by the article?
Document metadata
The writing community often needs a way to track information about pages in need of specific kinds of work. This is done using tags.

ট্যাগ টাইপ গাইড

Here's a quick guide to the types of tags and possible values for them.

ক্যাটাগরি

Tagging an article with one of these categories will help automatically constructed landing pages, table of contents pages, and the like be more accurately built. These terms will also be used by our new search system, eventually, to let the user locate reference or guide information by their choice.

The following category names are standard tagging terms used on MDN.

Intro
The article provides introductory material about a topic. In theory there should be only one of these per technology area.
Featured
The article is a high-importance article that should be featured in a special way on landing pages; this must be used sparingly. Only three or fewer of these should exist in any documentation area.
Reference
The article contains reference material about an API, element, attribute, property, or the like.
Landing
The page is a landing page.
Guide
The article is a how-to or guide page.
Example
The article is a code sample page, or has code samples. This shouldn't be used for very one-liner "syntax examples" but actual snippets of useful code, or for full usable samples.

টপিক

By identifying the article's topic area, you can also help to generate better search results as well as landing pages and other navigational aids.

While there's some room for flexibility here as new topic areas are identified, we try to keep these to the names of APIs or technologies. Some useful examples:

  • HTML
  • CSS
  • JavaScript (notice the capital "S"!)
  • Document
  • DOM
  • API for each interface, method and property.
  • Method for each method of an API
  • Property for each property of an API
  • Graphics
  • Firefox OS
  • Gecko
  • XUL
  • XPCOM
  • SVG
  • WebGL
  • Element
  • Node
  • Tools
  • Web

In general, the name of an interface that has a number of related pages, such as Node (which has many pages for its various properties and methods) makes a good topic identification tag, as does the name of an overall technology or technology type. A page about WebGL might be tagged with Graphics and WebGL, for example, while a page about the <canvas> element might be tagged HTML, Element, Canvas, and Graphics.

Technology status

To help the reader understand how viable a technology is, we use tags to label pages as to what the status of the technology's specification is. This isn't as detailed as actually explaining what the spec is and where in the specification process the technology is (that's what the Specifications table is for), but it will help the reader judge, at a glance, whether using the technology described in the article is a good idea or not.

Here are possible values for these tags:

Non-standard
Indicates that the technology or API described on the page is not part of a standard, but is considered stable in the browser or browsers that do implement it. If you don't use this tag, the assumption is made that the article covers something that's standard. The compatibility table on the page should clarify which browser(s) support this technology or API.
Deprecated
The technology or API covered on the page has been marked as deprecated in the specification, and is expected to eventually be removed, but is generally still available in current versions of browsers.
Obsolete
The technology or API has been deemed obsolete and has been removed (or is actively in the process of being removed) from all or most current browsers.
Experimental
The technology is not standardized, and is an experimental technology or API that may or may not ever become part of a standard.
Needs Privileges
The API requires privileged access to the device on which the code is running.
Certified Only
The API only works in certified code.

Regardless of the use of these tags, you should be sure to include a compatibility table in your article!

Skill level

The skill level tag type is only used for guides and tutorials (that is, pages tagged Guide). It's used to help users whittle down tutorials based on their familiarity level with a technology, for example. There are three values for this:

Beginner
Articles designed to introduce the reader to a technology they've never used or have only a passing familiarity with.
Intermediate
Articles for users that have gotten started with the technology but aren't experts.
Advanced
Articles about stretching the capabilities of a technology and of the reader.

Document metadata

The writing community uses tags to label articles as requiring specific types of work. Here's a list of the ones we use most:

junk
The article needs to be deleted.
NeedsContent
The article is a stub, or is otherwise lacking information. This tag means that someone should review the content and add more details and/or finish writing the article.
NeedsExample
The article needs one or more examples created to help illustrate the article's point. These examples should use the live sample system.
NeedsLiveSamples
The article has one or more examples that need to be updated to use the live sample system.
NeedsUpdate
The content is out of date and needs to be updated.

একীভূতকরণ

So, with these different types of tags, you assemble them together to get the full set of tags for a page. A few examples:

A tutorial about WebGL for beginners
Appropriate tags would be: WebGL, Graphics, Guide, Beginner
Reference page for the <canvas> element
This should be tagged with Canvas, HTML, Element, Graphics, Reference
A landing page for Firefox OS developer tools
This should be tagged with Tools, Firefox OS, Landing

সার্চ ফিল্টার ও ট্যাগ

The upcoming search filter implementation, which will let users restrict the results of their searches based on criteria they specify, will rely on proper tagging of pages on MDN. Here's a table of the various search filters and which tags they look for.

Note: If multiple tags are listed under "Tag name," that means any one or more of those tags need to be present for the article to match.

Filter group Search filter name Tag name
Topic Open Web Apps Apps
  HTML HTML
  CSS CSS
  JavaScript JavaScript
  APIs and DOM API
  Canvas Canvas
  SVG SVG
  MathML MathML
  WebGL WebGL
  XUL XUL
  Marketplace Marketplace
  Firefox Firefox
  Firefox for Android Firefox Mobile
  Firefox for Desktop Firefox Desktop
  Firefox OS Firefox OS
  Mobile Mobile
  Web Development Web Development
  Add-ons & Extensions Add-ons || Extensions || Plugins || Themes
  Games Games
Skill level I'm an Expert Advanced
  Intermediate Intermediate
  I'm Learning Beginner
Document type Docs This will restrict the search to docs content, leaving out Hacks and other MDN content.
  Demos This will include Demo Studio content in the search results.
  Tools Tools
  Code Samples Example
  How-To & Tutorial Guide
  Developer Profiles This will include developer profiles from the MDN site in the search results.
  External Resources This is something the dev team will need to figure out.

 

ডকুমেন্ট ট্যাগ এবং অবদানকারী

 Contributors to this page: mdasrafulalam, faria, badsha_eee
 সর্বশেষ হালনাগাদ করেছেন: mdasrafulalam,