فهرست مستندات پروژه
نصب و فعالسازی
افزونه ساختهشده را نصب کنید یا محیط توسعه را آماده کنید.
پیشنیازها
- طبق هدر افزونه و Composer، وردپرس 6.8+ و PHP 8.1+ لازم است.
- فقط برای اتصال WooCommerce به نسخه 9.9+ نیاز دارید. اتصال Forminator به 1.50+، Gravity Forms به 2.9+ و WPForms به 1.9.1+ نیاز دارد. برای بقیه، کد فعال بودن افزونه را بررسی میکند و حداقل نسخه تعیین نکرده است؛ این به معنی پشتیبانی از همه نسخههای قدیمی نیست.
- کتابخانه همراه Abzar به extension به نام
mbstringنیاز دارد. برای مرتبسازی درست فارسی،intlهم لازم است؛ بدون آن تابع مرتبسازی از ترتیب بایتها استفاده میکند. افزونه هنگام فعالسازی این extensionها را بررسی نمیکند. - انتخابگر تاریخ و بخشهای تعاملی تنظیمات و ابزارها به JavaScript و فایلهای ساختهشده نیاز دارند. توابع PHP و بررسی ورودی در سرور جدا هستند.
ترکیبهای نسخه در تستها را ببینید. حداقل نسخه به معنی تضمین سازگاری در هر شرایطی نیست.
نصب ZIP ساختهشده
این مخزن ابزار ساخت ZIP دارد و CI خروجی را با نام persian-kit نگه میدارد. فایل persian-kit.zip را از release نسخه 1.0.1 یا ZIP ساختهشده نسخه موردنظرتان بگیرید. فایل source archive در GitHub با ZIP قابل نصب یکی نیست. فایل ZIP در release برای نصب است؛ مستندات مخزن از snapshot کد tag خوانده میشوند.
- پیش از جایگزین کردن نصب قبلی، از سایت backup بگیرید.
- در وردپرس از افزونهها > افزودن افزونه تازه > بارگذاری افزونه، ZIP را انتخاب و نصب کنید؛ سپس Persian Kit را فعال کنید.
- منوی Persian Kit را باز کنید، پیام شروع را بخوانید و شروع کار را انجام دهید.
در نصب تازه باید منوی تنظیمات را ببینید؛ تاریخ شمسی روشن و تبدیل اعداد فارسی خاموش است. بهروزرسانی تنظیمات قبلی را نگه میدارد و گزینههای تازه پیشفرض خودشان را میگیرند. فعالسازی شبکه برای سایتهای موجود و سایتهای تازه انجام میشود، ولی تنظیمات هر سایت جداست.
ساخت از کد
در پوشه اصلی مخزن و در محیط توسعه اجرا کنید:
composer install
npm ci
npm run build
Composer وابستگیها را با namespace جدا در packages/ آماده میکند و build فایلهای public/ را میسازد. سپس افزونه را در وردپرس محلی فعال کنید. برای ساخت ZIP قابل نصب:
npm run dist
اسکریپت ساخت به wp یا WP-CLI، composer، npm، rsync و zip نیاز دارد. وابستگیها را نصب میکند، فایلها و قالب ترجمه را دوباره میسازد و پوشه dist/ را جایگزین میکند. خروجی dist/persian-kit.zip است؛ release منتشر نمیکند. CI از Node 22 استفاده میکند. Node و Composer ابزار ساخت هستند و کاربر سایت به آنها نیاز ندارد.
.distignore مستندات مخزن را از ZIP نصب کنار میگذارد. این فایلها در commit مربوط به release باقی میمانند تا وبسایت آنها را بخواند. یادداشتهای توسعه توضیح بیشتری درباره build و تست دارد.
مشکلهای رایج نصب
کدی که packages/ یا فایلهای ساختهشده public/ را ندارد کامل نیست؛ پیش از فعالسازی آن را build کنید. اگر یک اتصال در دسترس نیست، فعال بودن افزونه و حداقل نسخه را در تب یکپارچهسازی بررسی کنید. WooCommerce وقتی فعال باشد تب جدا دارد. برای بهروزرسانی یا حذف، راهنمای سازگاری را بخوانید.