Add README.md documentation for the module

This commit is contained in:
Mohamed Eltayar 2025-08-29 02:58:46 +03:00
parent d4aa5714db
commit 99e9e5db1f
1 changed files with 80 additions and 0 deletions

View File

@ -0,0 +1,80 @@
# Web Hijri Datepicker Module
## الوصف / Description
موديول يضيف إمكانية عرض التاريخ الهجري بجانب التاريخ الميلادي في حقول التاريخ في نظام Odoo.
This module adds the ability to display Hijri calendar dates alongside Gregorian dates in Odoo date fields.
## المميزات / Features
- عرض التاريخ الهجري والميلادي معاً في نفس الحقل
- التحكم الكامل في أي حقل يظهر معه التاريخ الهجري
- دعم اللغة العربية والإنجليزية
- يعمل في جميع أنواع العروض (Form, List, etc.)
- لا يؤثر على الحقول الموجودة إلا عند تحديد ذلك صراحةً
## الاستخدام / Usage
### في ملفات XML:
```xml
<!-- حقل تاريخ عادي (بدون تاريخ هجري) -->
<field name="date_field"/>
<!-- حقل تاريخ مع التاريخ الهجري -->
<field name="date_field" widget="hijri_date"/>
<!-- حقل تاريخ ووقت مع التاريخ الهجري -->
<field name="datetime_field" widget="hijri_datetime"/>
```
### مثال كامل / Complete Example:
```xml
<record id="view_form_example" model="ir.ui.view">
<field name="name">example.form</field>
<field name="model">your.model</field>
<field name="arch" type="xml">
<form>
<group>
<!-- حقل عادي -->
<field name="normal_date"/>
<!-- حقل مع تاريخ هجري -->
<field name="hijri_date" widget="hijri_date"/>
<!-- حقل تاريخ ووقت مع تاريخ هجري -->
<field name="hijri_datetime" widget="hijri_datetime"/>
</group>
</form>
</field>
</record>
```
## التحديث من الإصدار السابق / Upgrading from Previous Version
إذا كنت تستخدم الإصدار السابق الذي يضيف التاريخ الهجري لجميع الحقول تلقائياً:
1. قم بتحديث الموديول
2. أضف `widget="hijri_date"` للحقول التي تريد إظهار التاريخ الهجري معها
3. الحقول التي لا تحتوي على هذا الـ widget ستعود للعرض العادي
## المتطلبات / Requirements
- Odoo 14.0+
- موديول web
## التثبيت / Installation
1. ضع الموديول في مجلد addons
2. قم بتحديث قائمة الموديولات
3. قم بتثبيت موديول "Web Hijri"
## الترخيص / License
LGPL-3
## المطور / Developer
Odex25 Team