ডেফিনিশন লিস্ট
ডেফিনিশন লিস্ট মার্কডাউনের একটি এক্সটেন্ডেড ফিচার, যা শব্দ এবং তাদের সংশ্লিষ্ট সংজ্ঞার তালিকা তৈরি করতে ব্যবহৃত হয়। এগুলি সাধারণত শব্দকোষ, শব্দের ব্যাখ্যা বা প্যারামিটার বর্ণনার জন্য ব্যবহৃত হয়।
বেসিক সিনট্যাক্স
বেসিক ফরম্যাট
ডেফিনিশন লিস্টের বেসিক ফরম্যাটে একটি শব্দ নিজস্ব লাইনে থাকে, এর পরে পরবর্তী লাইনে কোলন দিয়ে শুরু হওয়া সংজ্ঞা থাকে:
শব্দ
: সংজ্ঞা কন্টেন্টরেন্ডারিং ইফেক্ট:
শব্দ : সংজ্ঞা কন্টেন্ট
একাধিক শব্দ এবং সংজ্ঞা
Markdown
: একটি লাইটওয়েট মার্কআপ ভাষা
: 2004 সালে জন গ্রুবার দ্বারা তৈরি
HTML
: ওয়েব পেজ তৈরি করতে ব্যবহৃত একটি স্ট্যান্ডার্ড মার্কআপ ভাষা
: ওয়েব পেজ তৈরি করতে ব্যবহৃতরেন্ডারিং ইফেক্ট:
Markdown : একটি লাইটওয়েট মার্কআপ ভাষা : 2004 সালে জন গ্রুবার দ্বারা তৈরি
HTML : ওয়েব পেজ তৈরি করতে ব্যবহৃত একটি স্ট্যান্ডার্ড মার্কআপ ভাষা : ওয়েব পেজ তৈরি করতে ব্যবহৃত
উন্নত ব্যবহার
মাল্টি-লাইন ডেফিনিশন
ডেফিনিশন কন্টেন্টে একাধিক লাইন থাকতে পারে, পরবর্তী লাইনগুলি ইনডেন্ট করতে হবে:
শব্দ
: এটি ডেফিনিশন কন্টেন্টের প্রথম লাইন
এটি দ্বিতীয় লাইন, কমপক্ষে এক স্পেস ইনডেন্টেশন প্রয়োজন
এটি একটি নতুন প্যারাগ্রাফ, কমপক্ষে এক স্পেস ইনডেন্টেশন এবং পূর্বে একটি খালি লাইন প্রয়োজনরেন্ডারিং ইফেক্ট:
শব্দ : এটি ডেফিনিশন কন্টেন্টের প্রথম লাইন এটি দ্বিতীয় লাইন, কমপক্ষে এক স্পেস ইনডেন্টেশন প্রয়োজন
এটি একটি নতুন প্যারাগ্রাফ, কমপক্ষে এক স্পেস ইনডেন্টেশন এবং পূর্বে একটি খালি লাইন প্রয়োজন
ডেফিনিশনে অন্যান্য মার্কডাউন উপাদান ব্যবহার
ডেফিনিশনে লিঙ্ক, এমফ্যাসিস, কোড সহ অন্যান্য মার্কডাউন উপাদান থাকতে পারে:
Markdown সিনট্যাক্স
: **Markdown** একাধিক টেক্সট ফরম্যাটিং সমর্থন করে:
- *ইটালিক* এবং **বোল্ড**
- [লিঙ্ক](https://www.markdownlang.com)
- `ইনলাইন কোড`
- > ব্লক কোট
- লিস্ট এবং অন্যান্য উপাদানরেন্ডারিং ইফেক্ট:
Markdown সিনট্যাক্স : Markdown একাধিক টেক্সট ফরম্যাটিং সমর্থন করে:
- ইটালিক এবং বোল্ড
- লিঙ্ক
ইনলাইন কোডব্লক কোট
- লিস্ট এবং অন্যান্য উপাদান
নেস্টেড ডেফিনিশন লিস্ট
কিছু মার্কডাউন ইমপ্লিমেন্টেশনে, আপনি নেস্টেড ডেফিনিশন লিস্ট তৈরি করতে পারেন:
আউটার শব্দ
: আউটার ডেফিনিশন
ইনার শব্দ
: ইনার ডেফিনিশন
: আরেকটি ইনার ডেফিনিশনরেন্ডারিং ইফেক্ট (সমর্থিত প্ল্যাটফর্মে):
আউটার শব্দ : আউটার ডেফিনিশন
ইনার শব্দ : ইনার ডেফিনিশন : আরেকটি ইনার ডেফিনিশন
কম্প্যাটিবিলিটি এবং ইমপ্লিমেন্টেশন পার্থক্য
বিভিন্ন প্ল্যাটফর্ম সমর্থন
| প্ল্যাটফর্ম/টুল | ডেফিনিশন লিস্ট সমর্থন | বিশেষ সিনট্যাক্স | নেস্টেড সমর্থন |
|---|---|---|---|
| GitHub Markdown | ❌ | - | - |
| GitLab Markdown | ✅ | স্ট্যান্ডার্ড | ✅ |
| Jekyll (kramdown) | ✅ | স্ট্যান্ডার্ড | ✅ |
| Hugo | ✅ | স্ট্যান্ডার্ড | ✅ |
| CommonMark | ❌ | - | - |
| VitePress | ✅ | স্ট্যান্ডার্ড | ✅ |
| Pandoc | ✅ | স্ট্যান্ডার্ড | ✅ |
HTML আউটপুট ফরম্যাট
বেশিরভাগ মার্কডাউন প্রসেসর ডেফিনিশন লিস্টকে HTML <dl>, <dt> এবং <dd> এলিমেন্টে রূপান্তরিত করে:
<dl>
<dt>শব্দ</dt>
<dd>ডেফিনিশন কন্টেন্ট</dd>
<dt>আরেকটি শব্দ</dt>
<dd>আরেকটি ডেফিনিশন</dd>
</dl>বিভিন্ন সিনট্যাক্স ভেরিয়েশন
কিছু প্রসেসরের বিভিন্ন সিনট্যাক্স ভেরিয়েশন প্রয়োজন হতে পারে:
<!-- স্ট্যান্ডার্ড সিনট্যাক্স -->
শব্দ
: ডেফিনিশন
<!-- কমপ্যাক্ট সিনট্যাক্স (কিছু প্রসেসর) -->
শব্দ: ডেফিনিশন
<!-- অতিরিক্ত স্পেস সিনট্যাক্স (কিছু প্রসেসর) -->
শব্দ
: ডেফিনিশনব্যবহারের ক্ষেত্র
শব্দকোষ
ডেফিনিশন লিস্ট শব্দকোষ বা শব্দভাণ্ডার তৈরির জন্য উপযুক্ত:
## প্রোগ্রামিং শব্দকোষ
API
: একটি অ্যাপ্লিকেশন প্রোগ্রামিং ইন্টারফেস, বিভিন্ন সফটওয়্যার অ্যাপ্লিকেশনের মধ্যে যোগাযোগের জন্য নিয়মের সেট।
Framework
: একটি সফটওয়্যার লাইব্রেরি যা অ্যাপ্লিকেশন ডেভেলপমেন্টের জন্য একটি স্ট্যান্ডার্ডাইজড স্ট্রাকচার প্রদান করে।
Git
: একটি ডিস্ট্রিবিউটেড ভার্সন কন্ট্রোল সিস্টেম যা প্রজেক্ট ডেভেলপমেন্ট প্রক্রিয়ায় পরিবর্তন ট্র্যাক করতে ব্যবহৃত হয়।
IDE
: একটি ইন্টিগ্রেটেড ডেভেলপমেন্ট এনভায়রনমেন্ট, একটি সফটওয়্যার অ্যাপ্লিকেশন যাতে কোড এডিটর এবং বিভিন্ন ডেভেলপমেন্ট টুল থাকে।রেন্ডারিং ইফেক্ট:
প্রোগ্রামিং শব্দকোষ
API : একটি অ্যাপ্লিকেশন প্রোগ্রামিং ইন্টারফেস, বিভিন্ন সফটওয়্যার অ্যাপ্লিকেশনের মধ্যে যোগাযোগের জন্য নিয়মের সেট।
Framework : একটি সফটওয়্যার লাইব্রেরি যা অ্যাপ্লিকেশন ডেভেলপমেন্টের জন্য একটি স্ট্যান্ডার্ডাইজড স্ট্রাকচার প্রদান করে।
Git : একটি ডিস্ট্রিবিউটেড ভার্সন কন্ট্রোল সিস্টেম যা প্রজেক্ট ডেভেলপমেন্ট প্রক্রিয়ায় পরিবর্তন ট্র্যাক করতে ব্যবহৃত হয়।
IDE : একটি ইন্টিগ্রেটেড ডেভেলপমেন্ট এনভায়রনমেন্ট, একটি সফটওয়্যার অ্যাপ্লিকেশন যাতে কোড এডিটর এবং বিভিন্ন ডেভেলপমেন্ট টুল থাকে।
API ডকুমেন্টেশন
ডেফিনিশন লিস্ট API ডকুমেন্টেশনে প্যারামিটার বা অপশন ব্যাখ্যা করতে ব্যবহৃত হয়:
## রিকোয়েস্ট প্যারামিটার
user_id
: **প্রয়োজনীয়** - ব্যবহারকারীর জন্য অনন্য আইডেন্টিফায়ার।
: টাইপ: `integer`
name
: **ঐচ্ছিক** - ব্যবহারকারীর জন্য ডিসপ্লে নাম।
: টাইপ: `string`
: ডিফল্ট: `null`
status
: **ঐচ্ছিক** - ব্যবহারকারীর স্ট্যাটাস।
: টাইপ: `string`
: অনুমোদিত মান: `active`, `inactive`, `suspended`
: ডিফল্ট: `active`রেন্ডারিং ইফেক্ট:
রিকোয়েস্ট প্যারামিটার
user_id : প্রয়োজনীয় - ব্যবহারকারীর জন্য অনন্য আইডেন্টিফায়ার। : টাইপ: integer
name : ঐচ্ছিক - ব্যবহারকারীর জন্য ডিসপ্লে নাম। : টাইপ: string : ডিফল্ট: null
status : ঐচ্ছিক - ব্যবহারকারীর স্ট্যাটাস। : টাইপ: string : অনুমোদিত মান: active, inactive, suspended : ডিফল্ট: active
কনফিগারেশন নোট
ডেফিনিশন লিস্ট কনফিগারেশন অপশন ব্যাখ্যা করার জন্যও উপযুক্ত:
## কনফিগারেশন অপশন
debug
: ডিবাগ মোড সক্রিয় বা নিষ্ক্রিয় করুন।
: টাইপ: `boolean`
: ডিফল্ট: `false`
: উদাহরণ: `debug: true`
log_level
: লগিংয়ের জন্য বিস্তারিত স্তর।
: টাইপ: `string`
: অনুমোদিত মান: `error`, `warn`, `info`, `debug`
: ডিফল্ট: `info`
: উদাহরণ: `log_level: debug`
max_connections
: অনুমোদিত সর্বোচ্চ সমান্তরাল সংযোগ সংখ্যা।
: টাইপ: `integer`
: ডিফল্ট: `100`
: উদাহরণ: `max_connections: 500`সেরা অনুশীলন
সামঞ্জস্য
✅ সুপারিশকৃত অনুশীলন:
১. **শব্দ এবং সংজ্ঞার জন্য সামঞ্জস্যপূর্ণ স্টাইল বজায় রাখুন**:
- শব্দ সংক্ষিপ্ত বিশেষ্য বা বাক্যাংশ ব্যবহার করে
- সংজ্ঞা বাক্য ফরম্যাটে, প্রথম অক্ষর বড় হাতের, শেষে পিরিয়ড
- মাল্টি-লাইন ডেফিনিশনের জন্য, সামঞ্জস্যপূর্ণ ইনডেন্টেশন বজায় রাখুন
২. **যুক্তিসঙ্গত গ্রুপিং**:
- সম্পর্কিত শব্দ একসাথে রাখুন
- বিভিন্ন ডেফিনিশন লিস্ট আলাদা করতে হেডিং ব্যবহার করুন
৩. **টেকনিক্যাল শব্দের জন্য**:
- টাইপ তথ্য অন্তর্ভুক্ত করুন
- উদাহরণ যোগ করুন
- প্রয়োজনীয় বা ঐচ্ছিক নির্দেশ করুন
❌ এড়ানো উচিত:
১. শব্দ খুব দীর্ঘ, এক লাইনের বেশি
২. শব্দে বড় ফরম্যাটেড টেক্সট ব্যবহার
৩. স্পষ্ট শ্রেণীবিভাগের অভাব
৪. সংজ্ঞায় অসম্পর্কিত তথ্য থাকাবিকল্প সমাধান
যেসব প্ল্যাটফর্ম ডেফিনিশন লিস্ট সমর্থন করে না, সেখানে আপনি অন্যান্য ফরম্যাট ব্যবহার করে সিমুলেট করতে পারেন:
<!-- বোল্ড এবং ইনডেন্টেশন ব্যবহার করে -->
**শব্দ**
সংজ্ঞা কন্টেন্ট
**আরেকটি শব্দ**
আরেকটি সংজ্ঞা কন্টেন্ট
<!-- টেবিল ব্যবহার করে -->
| শব্দ | সংজ্ঞা |
|------|------|
| API | অ্যাপ্লিকেশন প্রোগ্রামিং ইন্টারফেস |
| IDE | ইন্টিগ্রেটেড ডেভেলপমেন্ট এনভায়রনমেন্ট |
<!-- হেডিং এবং প্যারাগ্রাফ ব্যবহার করে -->
### শব্দ
সংজ্ঞা কন্টেন্ট
### আরেকটি শব্দ
আরেকটি সংজ্ঞা কন্টেন্টব্যবহারিক অ্যাপ্লিকেশন উদাহরণ
সফটওয়্যার ডকুমেন্টেশন
## সিস্টেম রিকোয়ারমেন্ট
অপারেটিং সিস্টেম
: **Windows**: Windows 10 বা উচ্চতর
: **macOS**: macOS 10.14 (Mojave) বা উচ্চতর
: **Linux**: Ubuntu 18.04+, Debian 10+, CentOS 7+
হার্ডওয়্যার
: **প্রসেসর**: কোয়াড-কোর 2.0 GHz বা দ্রুত
: **মেমোরি**: কমপক্ষে 8GB RAM, 16GB সুপারিশকৃত
: **স্টোরেজ**: কমপক্ষে 10GB খালি জায়গা, SSD স্টোরেজ
নেটওয়ার্ক
: ব্রডব্যান্ড ইন্টারনেট সংযোগ (কমপক্ষে 10 Mbps)
: অনুমোদিত আউটবাউন্ড সংযোগ পোর্ট: 80, 443, 22একাডেমিক ডকুমেন্টেশন
## গবেষণা শব্দ
Dataset
: বিশ্লেষণ বা মূল্যায়নের জন্য ব্যবহৃত ডেটার সংগ্রহ।
: এই গবেষণায় একটি পাবলিক রিপোজিটরি থেকে নমুনা ব্যবহার করা হয়েছে (n=1000)।
Variable
: **স্বাধীন ভেরিয়েবল**: গবেষক দ্বারা পরিচালিত ইনপুট ফ্যাক্টর।
এই গবেষণায়, স্বাধীন ভেরিয়েবল ছিল পরিবেশগত তাপমাত্রা।
: **নির্ভরশীল ভেরিয়েবল**: গবেষণায় পরিমাপ করা আউটপুট ফ্যাক্টর।
এই গবেষণায়, নির্ভরশীল ভেরিয়েবল ছিল প্রসেসিং স্পিড।
: **কন্ট্রোল ভেরিয়েবল**: পরীক্ষায় ধ্রুবক রাখা ফ্যাক্টর।
এই গবেষণায়, আর্দ্রতা এবং প্রসেসর লোড অন্তর্ভুক্ত ছিল।
Significance Level
: পরিসংখ্যানগত বিশ্লেষণে ফলাফল অর্থবহ কিনা নির্ধারণের জন্য ব্যবহৃত সম্ভাবনা থ্রেশহোল্ড।
: এই গবেষণায় p < 0.05 কে তাৎপর্যপূর্ণ স্ট্যান্ডার্ড হিসেবে ব্যবহার করা হয়েছে।সাধারণ সমস্যা এবং সমাধান
ডেফিনিশন লিস্ট প্রদর্শিত হচ্ছে না
আপনার ডেফিনিশন লিস্ট যদি সঠিকভাবে প্রদর্শিত না হয়:
১. প্ল্যাটফর্ম ডেফিনিশন লিস্ট সিনট্যাক্স সমর্থন করে কিনা পরীক্ষা করুন ২. শব্দ এবং সংজ্ঞার মধ্যে খালি লাইন নেই কিনা নিশ্চিত করুন ৩. কোলনের আগে উপযুক্ত স্পেসিং আছে কিনা যাচাই করুন (কিছু প্রসেসরের নির্দিষ্ট প্রয়োজনীয়তা থাকতে পারে) ৪. ইনডেন্টেশন পরিমাণ বাড়ানোর চেষ্টা করুন বা সিনট্যাক্স ভেরিয়েশন পরিবর্তন করুন
নেস্টেড লিস্ট ইস্যু
নেস্টেড ডেফিনিশন লিস্ট কিছু প্রসেসরে সমস্যা হতে পারে:
১. ইনডেন্টেশন লেভেল বাড়ান (যেমন, ইনার শব্দ 4 বা 8 স্পেস ব্যবহার করে) ২. লেভেলের মধ্যে উপযুক্ত খালি লাইন নিশ্চিত করুন ৩. সমস্যা চলতে থাকলে, অন্যান্য স্ট্রাকচার ব্যবহার বিবেচনা করুন (যেমন, নিয়মিত লিস্ট)
ফরম্যাটিং ইস্যু
ডেফিনিশনে ফরম্যাটিং ভুল হলে:
১. সমস্ত প্যারাগ্রাফ এবং উপাদানের ইনডেন্টেশন সঠিক কিনা পরীক্ষা করুন ২. ডেফিনিশনের মধ্যে ব্লক-লেভেল উপাদান (যেমন, কোড ব্লক, লিস্ট) সঠিক খালি লাইন সেপারেশন আছে কিনা নিশ্চিত করুন ৩. ইনডেন্টেশন পরিমাণ বাড়ানোর চেষ্টা করুন
সম্পর্কিত সিনট্যাক্স
- লিস্ট - বেসিক লিস্ট সিনট্যাক্স
- টেবিল - স্ট্রাকচার্ড ডেটা ডিসপ্লে
- ফেন্সড কোড ব্লক - কোড ব্লক সিনট্যাক্স
টুলস এবং প্লাগিন
- markdown-it-deflist: markdown-it এ ডেফিনিশন লিস্ট সমর্থন যোগ করে
- kramdown: নেটিভ ডেফিনিশন লিস্ট মার্কডাউন পার্সার
- remark-definition-list: remark পার্সারের জন্য ডেফিনিশন লিস্ট প্লাগিন
ডেফিনিশন লিস্ট মার্কডাউনের একটি শক্তিশালী এক্সটেন্ডেড ফিচার, বিশেষভাবে শব্দ, প্যারামিটার এবং কনফিগারেশনের ব্যাখ্যামূলক ডকুমেন্ট তৈরির জন্য উপযুক্ত। যদিও সব মার্কডাউন প্রসেসর এই সিনট্যাক্স সমর্থন করে না, সমর্থিত প্ল্যাটফর্মে, এটি টেকনিক্যাল ডকুমেন্টেশনের জন্য একটি পরিষ্কার, স্ট্রাকচার্ড ফরম্যাট প্রদান করে, জটিল তথ্যকে বোঝা এবং রেফারেন্স করা সহজ করে তোলে।