مستندات پلاس

افزونه Documentation (مستندات) برای Botble CMS

اگر نرم‌افزار، افزونه یا قالب می‌ فروشید، مشتری‌ ها بدون مستندات خوب بیشتر تیکت می‌ زنند و بیشتر پشیمان می‌ شوند. Documentation راه‌ حل ساخت مستندات حرفه‌ای را مستقیم داخل پنل Botble به شما می‌ دهد، مشابه سایت‌ هایی مثل docs.botble.com.

هر محصول یک صفحه یکتا دارد، مثلاً /docs/نام-محصول. زیر آن می‌ توانید هر تعداد صفحه و زیرصفحه بسازید و با کشیدن و رها کردن ترتیبشان را تغییر دهید. بازدید کننده‌ ها هم منوی کناری، جستجو و فهرست «در این صفحه» را می‌ بینند.

این افزونه برای چه کسانی مناسب است؟

• فروشندگان افزونه، قالب و نرم‌افزار که می‌ خواهند راهنمای نصب و استفاده منتشر کنند
• تیم‌ های پشتیبانی که می‌ خواهند پایگاه دانش و راهنمای محصول داشته باشند
• آژانس‌ ها و توسعه‌ دهندگانی که برای پروژه‌ های مشتریان مستندات می‌ نویسند
• هر سایتی که محصولات متعدد دارد و برای هرکدام مستندات جدا لازم دارد

امکانات اصلی

مدیریت مستندات

• ساختار درختی نامحدود: صفحه، زیرصفحه و زیرِ زیرصفحه بدون محدودیت عمق
• مدیریت با کشیدن و رها کردن: تغییر والد و ترتیب صفحات با ذخیره خودکار
• صفحه یکتا برای هر مستندات: نام، توضیح، متن معرفی، لوگو و نسخه‌ی محصول
• آدرس‌ های تمیز و پایدار: /docs/محصول/والد/فرزند، با پشتیبانی کامل از اسلاگ فارسی
• پیشوند قابل تغییر: پیشوند docs را از بخش پیوندهای یکتای Botble عوض کنید
• پیش‌ نویس و انتشار: پیش‌ نمایش پیش‌ نویس ها فقط برای مدیران دارای دسترسی ویرایش ممکن است

تجربه‌ی بازدیدکننده

• طراحی کاملاً واکنش‌ گرا با منوی کشویی در موبایل
• سازگار با RTL و LTR و هماهنگ با رنگ و فونت قالب سایت شما
• منوی کناری درختی با امکان فیلتر کردن صفحات
• جستجوی درون مستندات (با محدودیت نرخ برای جلوگیری از سوءاستفاده)
• فهرست «در این صفحه» که از سرتیترها ساخته می‌ شود
• ناوبری قبلی/بعدی برای مطالعه‌ی پشت‌ سرهم
• دکمه‌ی کپی کد روی بلاک‌ های کد
• مسیر breadcrumb و نمایش تاریخ آخرین به‌ روزرسانی
• پردازش هوشمند محتوا: سرتیترها لینک مستقیم می‌ گیرند، جدول‌ های عریض اسکرول می‌خ ورند و تصاویر lazy load می‌ شوند

سئو و چندزبانه

• متای اختصاصی هر صفحه، Open Graph و داده‌ی ساختاریافته‌ی JSON-LD
• افزوده شدن خودکار به نقشه سایت
• پشتیبانی از چندزبانه بودن از طریق Language Advanced
• ترجمه‌ی فارسی و انگلیسی پنل

ادغام با Botble

• شورت‌ کد [documentations limit="6"] برای نمایش کارت مستندات در هر صفحه
• گزینه‌ی منو برای افزودن مستندات به منو های سایت
• تنظیمات نمایشی در بخش تنظیمات ← سایر ← مستندات: عنوان و توضیح صفحه‌ی اصلی، نمایش جستجو، فهرست «در این صفحه»، قبلی/بعدی، تاریخ به‌روزرسانی و فاصله‌ی sticky از بالا
• سازگار با هدر ثابت: فاصله‌ی منوی کناری را با ارتفاع هدر قالب تنظیم کنید
• سیستم دسترسی Botble: دسترسی‌ ها برای مستندات و صفحات جداگانه تعریف می‌ شوند

شخصی‌سازی برای توسعه‌دهندگان

ویوها را بدون دست زدن به افزونه در قالب خود بازنویسی کنید:

• themes/<قالب>/views/documentation-index.blade.php
• themes/<قالب>/views/documentation-show.blade.php
• themes/<قالب>/views/documentation-page.blade.php

اگر فایل‌های CSS/JS منتشر نشده باشند، افزونه آنها را به‌ صورت درون‌ صفحه‌ای بارگذاری می‌ کند و صفحه همیشه با آخرین نسخه‌ی استایل نمایش داده می‌ شود.

امنیت

• خروجی تمام فیلدها escape می‌ شود.
• محتوای ویرایشگر پاک‌ سازی می‌ شود و بعد از پردازش دوباره بررسی می‌ شود.
• مسیرهای مدیریت با سیستم دسترسی Botble و CSRF محافظت می‌ شوند.
• جستجوی عمومی محدودیت نرخ دارد (۳۰ درخواست در دقیقه).
• یکتا بودن آدرس صفحات هم‌ سطح با ایندکس دیتابیس تضمین می‌ شود.

پیش‌ نیازها

• Botble CMS نسخه‌ی ۷.۴.۰ یا بالاتر
• افزونه‌ های Language Advanced (برای چندزبانه بودن) و SEO Helper اختیاری هستند.

نصب

1. پوشه‌ی documentation را در platform/plugins/ قرار دهید.
2. از پنل مدیریت به بخش افزونه‌ ها بروید و Documentation را فعال کنید. مایگریشن‌ها خودکار اجرا می‌شوند.
3. اگر استایل بارگذاری نشد، دستور php artisan cms:publish:assets را اجرا کنید.

شروع کار در ۳ قدم

1. از مستندات ← مستندات ← ایجاد، نام نرم‌ افزار، توضیح، لوگو و نسخه را وارد کنید.
2. روی مدیریت صفحات بزنید و صفحه‌ ها را اضافه کنید. با کشیدن و رها کردن، درخت و ترتیب را بسازید.
3. مستندات منتشر شد. آدرس آن /docs/نام-نرم‌افزار است و می‌ توانید آن را به منو اضافه کنید یا با شورت‌ کد در صفحه‌ ها نمایش دهید.

سوالات متداول

آیا می‌توانم برای چند محصول مستندات جدا بسازم؟
بله، هر مستندات صفحه‌ی اختصاصی و درخت صفحات مستقل خودش را دارد.

آیا با فونت و رنگ قالب سایت من هماهنگ می‌ شود؟
بله، قالب افزونه از رنگ و فونت قالب سایت استفاده می‌ کند و با RTL و LTR سازگار است.

اگر قالب من هدر ثابت دارد، منوی کناری زیر آن می‌ رود؟
در تنظیمات افزونه ارتفاع هدر را وارد کنید تا منوی کناری زیر آن بماند.

آیا می‌ توانم ظاهر صفحات را تغییر دهم؟
بله، ویوها را در پوشه‌ی قالب خود بازنویسی کنید. نیازی به تغییر در فایل‌های افزونه نیست.

آیا مستندات من در موتورهای جستجو دیده می‌شود؟
هر صفحه متای اختصاصی، Open Graph و JSON-LD دارد و در نقشه سایت هم ثبت می‌ شود.