diff --git a/persian/Features/JCB-Admin-Views.md b/persian/Features/JCB-Admin-Views.md new file mode 100644 index 0000000..3be9052 --- /dev/null +++ b/persian/Features/JCB-Admin-Views.md @@ -0,0 +1,83 @@ +# ویوهای مدیریتی JCB + + +ویوهای مدیریتی JCB قلب هر کامپوننت تولید شده توسط Joomla Component Builder هستند. آنها مدل داده شما را با کامپایل یک‌جای جداول پایگاه داده، کنترلرهای CRUD (Create, Read, Update, Delete)، لایه‌های لیست و ویرایش، دکمه‌های نوار ابزار، قوانین ACL و حتی ویجت‌های اختیاری داشبورد، به یک تجربه مدیریتی کامل Joomla تبدیل می‌کنند. از آنجا که کامپایلر درک می‌کند که ویوهای مدیریتی چگونه با فیلدها، Dynamic Gets و دارایی‌های سمت سایت ارتباط دارند، یک ویو منظم واحد از نمونه‌های اولیه سریع تا برنامه‌های داده‌ای در سطح سازمانی، بدون نیاز به کدهای تکراری دستی، مقیاس می‌پذیرد. + +> 🧭 **تازه‌کار هستید؟** با [فهرست مستندات](../index.md) برای یک نقشه کلی شروع کنید، سپس هنگامی که آماده مدل‌سازی داده هستید به این بررسی عمیق قابلیت بازگردید. + +## چرا ویوهای مدیریتی یک قابلیت برتر هستند + +کمپوننت JCB با اجازه دادن به شما برای توصیف یک ویو مدیریتی تنها یک بار و واگذار کردن کارهای سنگین به کامپایلر، توسعه Joomla را تسریع می‌کند. ویژگی‌های حاصل شامل موارد زیر است: + +* **طرح پایگاه داده فوری** – هر ویو مدیریتی ساختار جدول خود را با نسخه‌بندی در سطح فیلد تعریف و نگهداری می‌کند. +* **پشته MVC تولید شده** – لایه‌های لیست و ویرایش، مدل‌ها، کنترلرها، عملیات گروهی، فیلترها و نوار ابزار به طور خودکار کامپایل می‌شوند. +* **دسترسی‌های دقیق** – سوئیچ‌های ACL جوملا دسترسی به ازای هر ویو و هر فیلد را در دسترس قرار می‌دهند و برای حاکمیت سازمانی آماده هستند. +* **مدیریت روابط** – فرم‌های فرعی، Dynamic Gets، فیلترهای زنجیره‌ای و منطق نمایش شرطی، ویوهای مدیریتی را بدون SQL اضافی به هم متصل می‌کنند. +* **دارایی‌های قابل استفاده مجدد** – لایه‌ها، قالب‌ها، مکان‌نماهای کد سفارشی و رشته‌های زبان همراه با ویو منتقل می‌شوند تا بتوانید آن‌ها را بین پروژه‌ها شاخه‌گیری یا بازنشانی کنید. + +این مرور مفهومی را هر زمان که به زمان‌بندی‌ها، تصاویر یا مثال‌های عمیق‌تر نیاز دارید، با راهنمای بلند [متن آموزش ویوهای مدیریتی JCB](../Admin-Views.md) همراه کنید. + +## چه زمانی یک ویو مدیریتی ایجاد کنیم + +هرگاه نیاز به مدیریت داده‌های ساختاریافته درون یک کامپوننت دارید - مانند مقالات، تنظیمات، کاتالوگ‌ها یا هر شیئی که شایسته عملیات CRUD باشد - یک ویو مدیریتی ایجاد کنید. کامپوننت‌های JCB بدون حداقل یک ویو مدیریتی کامپایل نخواهند شد، بنابراین آن را به عنوان نقطه شروع هر پروژه در نظر بگیرید. از آنجا می‌توانید [ویوهای مدیریتی سفارشی](../Custom-Admin-Views.md) برای داشبوردها یا [ویوهای سایت](../Adding-Site-Views-to-a-Component.md) برای رابط عمومی را به همان پایه داده متصل کنید. + +## چک‌لیست پیش‌نیازها + +قبل از شیرجه زدن در سازنده، مطمئن شوید که: + +1. درک کرده‌اید که [فیلدهای JCB](../JCB-Fields.md) چگونه ستون‌های پایگاه داده و ویجت‌های فرم را کنترل می‌کنند. +2. ساختار داده خود را با استفاده از نکات [برنامه‌ریزی کلی](../General-Planning.md#12-admin-views-and-field-creation) برنامه‌ریزی کرده‌اید. +3. کمپوننت JCB را با دنبال کردن [راهنمای نصب](../Installation-of-JCB.md) نصب یا به‌روز کرده‌اید تا داده‌های نمونه و کتابخانه‌های فیلد در دسترس باشند. + +## گام به گام: ساخت اولین ویو مدیریتی خود + +این مراحل عملی را برای ایجاد یک ویو مدیریتی قوی دنبال کنید. هر مرحله طوری طراحی شده است که حتی کاربران بار اول نیز می‌توانند در اولین تلاش خود یک صفحه حرفه‌ای بک‌اند جوملا تولید کنند. + +1. **بخش ویوهای مدیریتی را باز کنید** + 1. جوملا کامپوننت بیلدر JCB را در بخش مدیریت جوملای خود راه‌اندازی کنید. + 2. در نوار کناری، **Admin Views → New** را انتخاب کنید. + 3. به ویو خود یک **نام مفرد** (مفرد) و **نام جمع** (برچسب لیست) بدهید. برای نام‌های مستعار جدول قابل پیش‌بینی، به نام‌های کوچک با جداکننده زیرخطی پایبند باشید. + +2. **ویوی خود را توصیف کنید** + 1. توضیحات کوتاه و بلند اضافه کنید تا به هم‌تیمی‌ها در درک هدف کمک کنید. + 2. **نوع** را انتخاب کنید: `Read/Write` برای رکوردهای قابل ویرایش یا `Read Only` برای سیاهه‌های ممیزی و جداول جستجو. + 3. یک آیکون اختصاص دهید تا ویو در داشبورد کامپوننت برجسته شود. راهنمای [افزودن ویوهای مدیریتی به یک کامپوننت](../Adding-Admin-Views-to-a-Component.md#2-adding-view-icons) اندازه‌های توصیه شده را نشان می‌دهد. + +3. **فیلدها را ضمیمه کنید** + 1. به تب **Fields** بروید. + 2. روی **Add Field** کلیک کنید و تعاریف فیلد موجود را مجدداً استفاده کنید یا در لحظه جدید ایجاد کنید. + 3. فیلدها را با کشیدن و رها کردن مرتب کنید تا ورودی‌های مرتبط گروه‌بندی شوند. برای ویجت‌های مناسب به [مرور انواع فیلد](../Field-Types.md#7-admin-fields-and-views) مراجعه کنید. + +4. **روابط را مدل‌سازی کنید** + 1. از تب **Linked Views** برای اتصال فرم‌های فرعی یا روابط والد-فرزند استفاده کنید. + 2. فیلترهای لیست و ترتیب‌دهی را برای فیلدهای رابطه‌ای پیکربندی کنید تا پیمایش، شهودی باشد. + 3. هنگامی که به داده‌های تجمیع شده نیاز دارید، با دنبال کردن [راهنمای dynamicGet](../dynamicGet.md#overview)، Dynamic Gets را ضمیمه کنید. + +5. **تجربه را اصلاح کنید** + 1. تاریخچه نسخه، عملیات گروهی، صادرات/واردات و سوئیچ‌های فراداده را در تب **Options** فعال کنید. + 2. پیش‌فرض‌های ACL جوملا را در تب **Permissions** تنظیم کنید تا ویراستاران، مدیران و ادمین‌ها از ابتدا دسترسی مناسب داشته باشند. + 3. CSS، جاوااسکریپت یا PHP سفارشی را در مکان‌نماهای ارائه شده قرار دهید تا رفتار را بدون هک کد تولید شده گسترش دهید. + +6. **ویوی خود را به کامپوننتتان پیوند دهید** + 1. درون JCB به **Components → Your Component → Admin Views** بروید. + 2. تنظیم کنید که ویو در کجا ظاهر شود (منوی اصلی، ماژول داشبورد، زیرمنو، اقدامات سریع). + 3. کامپوننت را کامپایل و نصب کنید. تصاویر دقیق در [راهنمای یکپارچه‌سازی ویو مدیریتی](../Adding-Admin-Views-to-a-Component.md) موجود است. + +7. **آزمایش و تکرار** + 1. کامپوننت کامپایل شده را در بخش مدیریت جوملا باز کنید تا رکوردهای نمونه اضافه کنید. + 2. تأیید کنید که فیلترهای لیست، دسترسی‌ها و دکمه‌های نوار ابزار مطابق انتظار رفتار می‌کنند. + 3. اگر نیاز به تنظیم طرح دارید، ویو مدیریتی را به‌روز کرده و مجدداً کامپایل کنید — JCB مدیریت مهاجرت پایگاه داده را از طریق [به‌روزرسان SQL خودکار](../Auto-create-SQL-updates-for-Componets-in-JCB.md) انجام می‌دهد. + +## نکات بهره‌وری + +* **از ویوهای اثبات شده مجدداً استفاده کنید** – ویوهای مدیریتی را از مخازن مشترک بازنشانی یا شاخه‌گیری کنید تا تیم شما با طرح‌های ممیزی شده و الگوهای UI شروع کند. +* **منطق را اعلانی نگه دارید** – قبل از نوشتن PHP سفارشی، از شرایط، فیلدهای زنجیره‌ای و Dynamic Gets استفاده کنید. تنظیمات اعلانی پس از تولید مجدد باقی می‌مانند و فرآیند آشنایی را تسریع می‌کنند. +* **انتخاب‌ها را مستند کنید** – از فیلدهای توضیحات و پیام‌های کامیت استفاده کنید تا توضیح دهید چرا هر ویو وجود دارد. همکاران آینده می‌توانند سپس با استفاده از پیوندهای بالا مستقیماً به سراغ قابلیت بروند. + +## گام‌های بعدی و یادگیری مرتبط + +* با [ویوهای مدیریتی سفارشی](../Custom-Admin-Views.md) ادامه دهید تا داشبوردهایی بسازید که از همان داده استفاده می‌کنند. +* [راه‌اندازی ویو ویرایش سایت](../Setup-Site-Edit-View-in-JCB.md) را کاوش کنید تا داده‌های ویو مدیریتی خود را در فرانت‌اند نمایش دهید. +* پس از انتشار راهنماهای قابلیت اضافی (به زودی)، [فهرست پوشه ویژگی‌ها](../Features/README.md) را نشانک گذاری کنید. + +هر زمان که به موضوع دیگری نیاز دارید، به [فهرست اصلی مستندات](../index.md) بازگردید. diff --git a/persian/Features/README.md b/persian/Features/README.md new file mode 100644 index 0000000..35e2d2d --- /dev/null +++ b/persian/Features/README.md @@ -0,0 +1,9 @@ +# بررسی عمیق قابلیت‌های JCB + +پوشه **Features** مجموعه‌ای از راهنمایی‌های متمرکز را گردآوری می‌کند که قابلیت‌های کلیدی Joomla Component Builder را بسط می‌دهد. هر مقاله توضیح می‌دهد که چه زمانی از هر قابلیت استفاده کنید، چرا اهمیت دارد و چگونه مرحله‌به‌مرحله آن را پیکربندی کنید تا اعضای جدید تیم بتوانند با اطمینان مشارکت کنند. اگر نیاز به یک مسیر پایدار گام‌به‌گام، قابل دنبال کردن و مرور در بقیه مستندات دارید، از این نقطه با [راهنمای شروع کار](../README.md) همراه شوید. + +## قابلیت‌های موجود + +* [ویوی مدیریتی JCB](./JCB-Admin-Views.md) — داده‌های خود را یک بار مدل‌سازی کنید و اجازه دهید JCB تمام تجربه بخش ادمین Joomla را کامپایل کند. + +برای دسترسی به فهرست و سایر آموزشها، به [فهرست اصلی مستندات](../index.md) بازگردید. diff --git a/persian/README.md b/persian/README.md new file mode 100644 index 0000000..53e8c22 --- /dev/null +++ b/persian/README.md @@ -0,0 +1,133 @@ +# Start Here: Onboarding Guide for Joomla Component Builder + +## What this page does + +Joomla Component Builder (JCB) packs years of community knowledge into one documentation set. This page curates the most important links and concepts so that a newcomer can move from “I have Joomla experience” to “I can ship a JCB component” without getting lost in the library. Use it together with the [Home](./index.md) index: Start Here gives you the narrative path, while Home provides a chapter-by-chapter reference. + +--- + +## Step 1 – Understand the landscape + +1. **See the big picture of a component** so you understand what JCB ultimately packages. [Joomla Components in JCB](./Joomla-Components.md) explains how every view, helper, script, and configuration ends up inside the compiled extension. +2. **Review Joomla's MVC structure** to see how administrator and site applications mirror each other, how controllers, models, and views are named, and how packages are assembled. [Component Structure and MVC Implementation](./Component-Structure-and-MVC-Implementation.md) bridges the gap between Joomla theory and JCB's automation. +3. **Clarify the JCB workflow mindset**—what the tool automates, what remains in your control, and how Dynamic Gets act as graphically designed database queries that feed your views. [Joomla Component Builder – Beginner-Friendly Guide](./Intro-to-JCB.md) summarises prerequisites, environment expectations, and the overall build loop, while the updated [Dynamic Get overview](./dynamicGet.md#overview) explains how the visual query builder maps to generated models. +4. **Map the database-to-interface relationship** so you know how admin views, site views, and fields combine to deliver data to users. Start with the new [JCB Fields primer](./JCB-Fields.md) to see how a single field definition controls storage, rendering, validation, and sharing. Then use [General Planning](./General-Planning.md) and [Field Types](./Field-Types.md) to plan entities, choose field types, and prepare for compilation, while the refreshed [Adding Site Views](./Adding-Site-Views-to-a-Component.md) guide explains how Dynamic Gets, templates, layouts, reusable code blocks, and libraries assemble the public experience. + +> 🧭 **Outcome:** you should be able to describe the main Joomla directories, explain how JCB mirrors them, and articulate the planning steps before touching the builder interface. + +--- + +## Step 2 – Prepare your toolchain + +1. **Set up a local Joomla environment** using the OctoJoom toolchain, which provisions Joomla's official Docker containers and Traefik for you. Follow [Setup Local Development Environment with OctoJoom](./Setup-Local-Development-Environment-with-OctoJoom.md) for a guided walkthrough, or replicate the same containerised requirements manually. +2. **Install Joomla Component Builder** using the [Installation walkthrough](./Installation-of-JCB.md) (single public package, compiler usage, clearing temporary files). +3. **Verify PHP and server requirements** so compilation succeeds. The [PHP Settings reference](./PHP-Settings.md) lists recommended configuration values and troubleshooting tips. +4. **Import demo data (optional)** to explore working examples. The [Using the JCB Demo Component](./Using-the-JCB-Demo-Component-While-Building-Your-Local-Development-System.md) guide explains how to load and inspect it. + +> 🧭 **Outcome:** you have a working Joomla site with JCB installed, demo data available, and confidence that server settings will not block builds. + +--- + +## Step 3 – Build your first component + +1. **Start with a guided example:** follow [Hello World with Joomla Component Builder](./Hello-World-with-Joomla-Component-Builder.md) to create a simple component from scratch, including admin and site views, menu links, and permissions. +2. **Reinforce the foundations** by revisiting [Basic Fields](./Basic-Fields.md), [Admin Views](./Admin-Views.md), and the [JCB Admin Views feature deep dive](./Features/JCB-Admin-Views.md) to understand how fields populate lists and forms while the builder automates the surrounding MVC code. +3. **Practice compilation and installation** by iterating through small changes, recompiling, and reinstalling within Joomla using the instructions in the Hello World tutorial and [Field Types](./Field-Types.md#5-compiling-and-installing-your-component). +4. **Document your learning**—update component notes, track field names, and keep a changelog. This habit will ease later export/import or collaboration tasks. + +> 🧭 **Outcome:** you can create a functioning component, compile it, install it, and recognise how admin data flows to the site frontend. + +--- + +## Step 4 – Explore core building blocks + +| Concept | Why it matters | Key resources | +| --- | --- | --- | +| **Planning views and fields** | Translating requirements into database tables, relationships, and permissions. | [General Planning](./General-Planning.md), [JCB Admin Views feature guide](./Features/JCB-Admin-Views.md), [Adding Admin Views](./Adding-Admin-Views-to-a-Component.md), [Adding Site Views](./Adding-Site-Views-to-a-Component.md) | +| **Site View composition & reuse** | Design public layouts by pairing a main Dynamic Get with templates, layouts, custom code placeholders, and optional JS/CSS libraries, then manage updates through resets or forks. | [Adding Site Views](./Adding-Site-Views-to-a-Component.md), [Adding Templates & Layouts](./Adding-Templates-and-Layouts-to-a-Site-View.md), [JCB Layouts](./JCB-Layouts.md), [dynamicGet](./dynamicGet.md) | +| **Field types and validation** | Selecting the right inputs and enforcing correct data. | [JCB Fields](./JCB-Fields.md), [Field Types](./Field-Types.md), [Advanced Fields](./Advanced-Fields.md), [Adding Rule Validation](./Adding-your-own-rule-validation-to-a-field-in-JCB.md), [Easy Validation Rules](./Easy-Validation-Rules-for-Fields-in-JCB.md) | +| **Dynamic data retrieval** | Combining records across tables without manual SQL. | [dynamicGet](./dynamicGet.md), [Add dynamicGet to a Site View](./Adding-dynamicGet-to-a-Site-View.md), [Automatic Custom Code Import](./Automatic-import-of-custom-code-during-compilation-in-JCB.md) | +| **Modules and placements** | Ship reusable widgets that surface component data in Joomla module positions and keep them synced via Reset/Fork workflows. | [JCB Joomla Modules](./Joomla-Modules.md) | +| **Templates and layouts** | Wrap site/admin views with modular structures, nest layouts, and sync reusable markup from shared repositories. | [Templates & Layouts](./Adding-Templates-and-Layouts-to-a-Site-View.md), [Template Setup](./Template-Setup.md), [Layout Setup](./Layout-Setup.md) | +| **Custom code and helpers** | Extending generated components safely with argument-aware snippets and hash automation. | [JCB Custom Codes Overview](./JCB-Custom-Codes.md), [Manual Custom Code Implementation](./JCB-manual-custom-code-implementation.md), [Helper Structures](./Adding-Helper-Structures-to-any-JCB-component.md), [Additional Helper Methods](./How-to-Add-More-Helper-Methods-to-Your-Components-Helper-Class.md) | + +> 💡 **Dynamic Gets refresher:** treat every main get as the canonical description of how a view sources its data. The visual builder lets you align joins, filters, ordering, and grouping without writing SQL, and the generated model code keeps those rules version-controlled alongside your templates. + +> 🧭 **Outcome:** you know where to deepen knowledge on each pillar as soon as your project requires it. + +--- + +## Step 5 – Choose your learning pathway + +### 1. Project planning & collaboration +- [Component Settings Deep Dive](./Component-Settings.md) +- [Component Settings](./Component-Settings-Overview.md) +- [Collaborative Workflow](./Proposed-Collaborative-Workflow-in-JCB.md) +- [Export/Import Fully Mapped Components](./Export-Import-of-fully-mapped-components.md) +- [Automated Backup System](./Automated-backup-system-in-JCB.md) + +### 2. Data management & automation +- [Tweaking MySQL Demo Data](./Tweaking-MySQL-Demo-Data.md) +- [Auto-create SQL Updates](./Auto-create-SQL-updates-for-Componets-in-JCB.md) +- [Automated Database Updates](./Automated-database-updates-in-Joomla-during-development-of-a-component.md) +- [JCB Custom Codes Overview](./JCB-Custom-Codes.md) +- [Reuse Custom Code](./Reuse-Custom-Code.md) + +### 3. User experience & site delivery +Combine layouts, Dynamic Gets, optional JavaScript/CSS libraries, and reusable custom code placeholders to craft polished administrator and frontend experiences that mirror your data model. Reset or fork Site Views when you need to sync with shared repositories or maintain long-term customisations. +- [Custom Admin Views](./Custom-Admin-Views.md) +- [Setup Site Edit View](./Setup-Site-Edit-View-in-JCB.md) +- [Quick Hello World (accelerated build)](./The-Quick-Hello-Word-with-JCB.md) +- [Custom Dashboard Option](./The-custom-dashboard-option-in-JCB.md) + +### 4. Extensibility & ecosystem +- [Community Snippets Overview](./General-overview-of-how-community-snippets-work.md) +- [Power-Based Class Overriding & Source Injection](./Power-Based-Class-Overriding-and-Source-Injection.md) +- [Forking JCB Snippets](./Tutorial-on-forking-JCB-snippets-so-you-can-share-your-snippets-with-the-rest-of-the-Community.md) +- [Making a Snippet Pull Request](./Tutorial-on-making-a-pull-request-at-Joomla-Component-Builder-Snippets.md) +- [JCB Packaging Engine](./JCB-Packaging-Engine.md) +- [Publish Your JCB Packages](./Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md) +- [CLI Command Suite](./CLI-Command-Suite.md) + +> 🧭 **Outcome:** pick the pathway that matches your immediate project stage and follow the linked tutorials in sequence. + +--- + +## Step 6 – Maintain and scale your builds + +1. **Global configuration management:** master component-level settings via [Global Settings](./Global-Settings-of-Component-Builder.md) and learn how menu parameters interact in [Manage Component Config Options](./Manage-a-Components-Global-Config-Option-Field-in-Relation-With-Menu-Params.md). +2. **Deploy upgrades confidently:** study [Auto-create SQL updates](./Auto-create-SQL-updates-for-Componets-in-JCB.md) alongside [License Template Changes](./How-to-change-the-License-Template-in-JCB.md) to automate schema migrations and package metadata. +3. **Handle translations and localisation:** combine [Easy Translation via Excel](./Easy-Translation-via-excel.md) with [Translation Manager](./Translation-Mananger-in-JCB-explained.md) to streamline multilingual work. +4. **Monitor performance and stability:** leverage [Automated Backup System](./Automated-backup-system-in-JCB.md) and [Dynamic File Inclusion Concept](./Dynamic-File-and-Folder-Inclusion-concept.md) to keep generated code maintainable. + +> 🧭 **Outcome:** you have a checklist for long-term maintenance tasks that go beyond the first release. + +--- + +## How to navigate the documentation efficiently + +- **Use Start Here + Home together:** Start Here points you to the right topic; Home lists every chapter with timeline references for quick scanning. +- **Understand how the documentation is produced:** [Developing with Joomla Component Builder](./Developing-with-Joomla-Component-Builder.md) outlines the transcription project and gives tips for studying alongside the videos. +- **Search within the repository:** use your editor's search or command-line tools (`rg "keyword" english/`) to find specific features, field names, or helper references across the Markdown files. +- **Leverage the sidebar:** [`_Sidebar.md`](./_Sidebar.md) mirrors the Home index and can be pinned in GitHub or wiki views for persistent navigation. Use the new **Features** section there to jump straight into deep dives like [JCB Admin Views](./Features/JCB-Admin-Views.md). +- **Bookmark the feature hub:** The [Features index](./Features/README.md) lists every flagship capability with links to detailed walkthroughs so you can brief teammates quickly. +- **Track revision status:** chapter titles include progress notes while the editing project is underway. Prioritise fully edited lessons like [Field Types](./Field-Types.md) when you need polished guidance. +- **Keep personal notes:** maintain a `docs/notes.md` or issue tracker in your project repo to record how you applied tutorials—this shortens the feedback loop when troubleshooting. + +--- + +## Where to get help and stay updated + +- **Community discussions:** join ongoing conversations and ask questions in the [JCB Discussions board](https://github.com/orgs/joomengine/discussions). +- **Video playlist:** follow the full [YouTube tutorial playlist](https://www.youtube.com/playlist?list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE) alongside the written chapters. +- **Beta testing updates:** keep an eye on [Beta Testing](./Beta-Testing.md) for release notes and calls for testers. +- **Contribute back:** when you craft helpers, layouts, or snippets, consider sharing them via the snippets workflow or package directory linked above. + +> 🧭 **Outcome:** you know where to ask questions, watch demonstrations, and contribute improvements as you grow into the platform. + +--- + +## Ready for your next step? + +Revisit this page whenever you need to re-orient yourself or onboard a teammate. Start from Step 1 if you need a refresher on architecture, jump to Step 4 to drill into a feature, or head straight to Step 6 when preparing a release. Happy building! + diff --git a/persian/index.md b/persian/index.md new file mode 100644 index 0000000..12e569a --- /dev/null +++ b/persian/index.md @@ -0,0 +1,604 @@ +# Welcome to the Joomla Component Builder Learning Hub + +## Start here + +These tutorials will give you a practical understanding of how Joomla Component Builder (JCB) works. The documentation below pairs each walkthrough with timeline references from its companion video so you can jump straight to the moment you need. As you read, pay particular attention to how **Custom Admin Views** extend Joomla's backend and how the refreshed **Joomla Plugins** guide documents background automation—JCB now captures how Dynamic Gets, templates, layouts, reusable code blocks, and plugin-driven services come together so your component's UI and event logic stay aligned. + +A revision of this knowledge base is underway to add timelines and polish every transcript. Chapters one through seventy-one already include raw transcriptions and are actively being edited. Progress updates will continue to appear in the title of the chapter currently being refined, and new announcements are posted in the community forum once a chapter is finished. + +For a glimpse at the target quality, review the fully edited [Field Types](./Field-Types.md) chapter. Work is progressing through the earlier lessons before continuing with chapters six through seventy-one. Pair it with the new [JCB Fields overview](./JCB-Fields.md) whenever you need a refresher on how field definitions govern database schema, rendering, validation, and sharing. + +If you have questions or want to get involved, join the project [discussions](https://github.com/orgs/joomengine/discussions). You can also explore the complete [YouTube playlist](https://www.youtube.com/playlist?list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE) of JCB tutorials. + +> 🧱 **Updated: JCB Fields foundation** – The [JCB Fields chapter](./JCB-Fields.md) now consolidates how field definitions control database schema, rendering, validation, sharing, and repository-driven versioning so you can explain the workflow to new teammates quickly. +> 🆕 **Dynamic Gets deep dive** – The refreshed [Dynamic Get guide](./dynamicGet.md#overview) now explains how the visual query builder selects tables, joins, filters, ordering, and grouping, how multiple gets combine inside a single view, and how Init/Reset/Fork workflows keep complex queries version-controlled. + +> 📌 **New: Site View Architecture Explained** – Start with the revised [Adding Site Views](./Adding-Site-Views-to-a-Component.md) guide to see how Dynamic Gets, templates, layouts, custom code placeholders, and optional JS/CSS libraries assemble your frontend. Pair it with the updated [Template Setup](./Template-Setup.md) chapter to understand how these modular wrappers shape both site and admin experiences and how to keep them maintained across projects. + +> 🧱 **New: JCB Layouts overview** – The dedicated [JCB Layouts guide](./JCB-Layouts.md) now explains how to initialise, reset, push, and fork layout repositories inside the Layouts tab so your reusable markup stays version-controlled alongside your components. + +> 🔌 **New: JCB Joomla Plugins** – Read the [Joomla Plugins overview](./Joomla-Plugins.md) to learn how event-driven logic travels with your component. The article now explains how plugins are bundled, configured, and shipped with each build so you can document automation next to the component features that depend on it. + +> 🧩 **Updated: Custom Code Workflows** – The new [JCB Custom Codes Overview](./JCB-Custom-Codes.md) distils how argument-based manual snippets and hash-driven automation complement each other, including encoding rules, language-string round trips, and collaboration tips. + +> 📦 **New: JCB Joomla Modules** – Explore the [JCB Joomla Modules](./Joomla-Modules.md) overview to understand how modules compile with your components, inherit Reset/Fork versioning, and deliver reusable widgets to Joomla module positions. + +--- + +### Feature deep dives + +| Feature | Why it matters | +| --- | --- | +| [JCB Admin Views](./Features/JCB-Admin-Views.md) | Shows how JCB turns a single data definition into a full Joomla administration experience, complete with ACL, relationships, and generated CRUD screens. | + +--- + +### [Joomla Components in JCB](./Joomla-Components.md) + +| Focus | Why it matters | +| --- | --- | +| Component overview | Summarises how admin views, site views, helpers, assets, and configuration are compiled into a Joomla extension. | +| Release management | Explains how version targets, changelogs, and distribution metadata anchor each component. | +| Collaboration links | Points you to deeper tutorials covering component settings, packaging, and team workflows. | + +--- + +### [JCB Joomla Modules](./Joomla-Modules.md) + +| Focus | Why it matters | +| --- | --- | +| Module fundamentals | Shows how modules attach to components, inherit Joomla structure, and render in module positions. | +| Workflow integration | Explains Reset/Fork maintenance, version targeting, and how modules reuse component helpers and custom code. | +| Placement planning | Highlights how to design administrator parameters and document recommended module placements. | + +--- + +### [Building a "Hello World" Component with Joomla Component Builder](./Hello-World-with-Joomla-Component-Builder.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Joomla Component Builder - Beginner-Friendly Guide](./Intro-to-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Installation Of Joomla Component Builder](./Installation-of-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**General Planning: Joomla Component Builder**](./General-Planning.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [JCB Fields](./JCB-Fields.md) + +| Focus | Why it matters | +| --- | --- | +| Field foundations | Summarises how a single field definition governs storage, rendering, validation, and permissions across every JCB context. | +| Workflow overview | Provides a quick-start path from planning to mapping, compiling, and maintaining reusable fields. | +| Repository alignment | Explains how reset/fork workflows keep shared field libraries versioned and in sync. | + +### [Field Types in Joomla Component Builder](./Field-Types.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Joomla Component Builder - Basic Fields](./Basic-Fields.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Joomla Component Builder - Admin Views**](./Admin-Views.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Advanced Fields - Joomla Component Builder (JCB)](./Advanced-Fields.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Adding Admin Views to a Component**](./Adding-Admin-Views-to-a-Component.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Component Settings](./Component-Settings-Overview.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Component Scripts**](./Component-Scripts.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Component FTP and More](./Component-FTP-and-more.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [DynamicGet](./dynamicGet.md#dynamicget) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding dynamicGet to a Site View](./Adding-dynamicGet-to-a-Site-View.md#adding-dynamicget-to-a-site-view) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Adding Templates and Layouts to a Site View**](./Adding-Templates-and-Layouts-to-a-Site-View.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Template Setup](./Template-Setup.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Layout Setup](./Layout-Setup.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Custom Admin Views](./Custom-Admin-Views.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding Site Views to a Component in Joomla Component Builder (JCB)](./Adding-Site-Views-to-a-Component.md#adding-site-views-to-a-component-in-joomla-component-builder-jcb) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Adding Custom Admin Views to a Component**](./Adding-Custom-Admin-Views-to-a-Component.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Tweaking MySQL Demo Data in Joomla Component Builder](./Tweaking-MySQL-Demo-Data.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Global Settings of Joomla Component Builder (JCB)](./Global-Settings-of-Component-Builder.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding a Custom Time Field](./Adding-a-custom-time-field.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Integrate the Create User Helper Method in Your Components](./How-to-integrate-the-Create-User-Helper-Method-in-your-Components.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Use the Email Helper in Your Components](./How-to-use-email-helper-in-your-components.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Set Up a Store Message Method Alongside the Email Helper Class](./How-to-setup-a-store-message-method-along-side-the-email-helper-class.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Ensure That a Field Is Not Escaped When Added to List Views](./How-to-ensure-that-a-field-is-not-escaped-when-added-to-list-views.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Overwrite the Custom Fields](./How-to-overwrite-the-custom-fields.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Filter a List Field Based on Association with Another Field](./How-to-filter-a-list-field-based-on-association-with-another-field.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Automatic Import of Custom Code During Compilation In JCB](./Automatic-import-of-custom-code-during-compilation-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [JCB Manual Custom Code](./JCB-manual-custom-code-implementation.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Export & Import of Fully Mapped Components in Joomla Component Builder (JCB)](./Export-Import-of-fully-mapped-components.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Add Custom Buttons in JCB to Your Component Admin Area](./How-to-add-Custom-Buttons-in-JCB-to-your-component-Admin-Area.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Translation Manager in Joomla Component Builder (JCB)](./Translation-Mananger-in-JCB-explained.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Setting Site View Permission in Joomla Component Builder**](./Setting-Site-View-Permission.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Auto Create SQL Updates for Components in JCB](./Auto-create-SQL-updates-for-Componets-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Setup Site Edit View in Joomla Component Builder](./Setup-Site-Edit-View-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Automated Backup System in Joomla Component Builder](./Automated-backup-system-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding Helper Structures to Any JCB Component](./Adding-Helper-Structures-to-any-JCB-component.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Upgrading Joomla 3 + JCB 3 Sites to Joomla 5 + JCB 5](./Upgrade-Joomla3-JCB3-to-Joomla5-JCB5.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Set Up Tabs After Upgrade to JCB v2.5.8](./How-to-setup-tabs-after-upgrade-to-v2.5.8-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Building a Hello World Component with Joomla Component Builder v2.6.0](./Hello-World-Component-with-Joomla-Component-Builder-Creator-Extended.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding Your Own Rule Validation to a Field in Joomla Component Builder (JCB)](./Adding-your-own-rule-validation-to-a-field-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [General Overview of How Community Snippets Work in Joomla Component Builder](./General-overview-of-how-community-snippets-work.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Forking JCB Snippets to Share with the Community](./Tutorial-on-forking-JCB-snippets-so-you-can-share-your-snippets-with-the-rest-of-the-Community.md#forking-jcb-snippets-to-share-with-the-community) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Making a Pull Request at Joomla Component Builder Snippets](./Tutorial-on-making-a-pull-request-at-Joomla-Component-Builder-Snippets.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Managing Libraries Dynamically in JCB](./The-New-Library-Manager-Area.md#managing-libraries-dynamically-in-jcb) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Easy Translation via Excel in Joomla Component Builder (JCB)](./Easy-Translation-via-excel.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Dynamic Router Implementation Explained](./Dynamic-Router-Implementation-Explained.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Automated Database Updates in Joomla During Component Development](./Automated-database-updates-in-Joomla-during-development-of-a-component.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Quick Subform Demonstration](./Quick-Subform-Demonstration.md#quick-subform-demonstration) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [JCB Packaging Engine](./JCB-Packaging-Engine.md) + +| Focus | Documentation sections | +| --- | --- | +| | | + +### [Repository Index & Demo Packages](./VDM-Package-Import-Option.md) + +| Focus | Documentation sections | +| --- | --- | +| | | + +### [Import JCB Packages with the Repository Engine](./How-to-install-jcb-packages.md) + +| Focus | Documentation sections | +| --- | --- | +| | | + +### [Publish Your JCB Packages to the Community Catalogue](./Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md) + +| Focus | Documentation sections | +| --- | --- | +| | | + +### [Proposed Collaborative Workflow in JCB](./Proposed-Collaborative-Workflow-in-JCB.md) + +| Focus | Documentation sections | +| --- | --- | +| | | + +### [Joomla Component Builder - Dynamic File and Folder Inclusion](./Dynamic-File-and-Folder-Inclusion-concept.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Use the File Field Type to Upload a File in JCB](./How-to-use-the-file-field-type-to-upload-a-file-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [**Drag and Drop Upload Functionality in Joomla Component Builder (JCB)**](./Drag-and-Drop-Upload-functionality-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [The Quick Hello World with Joomla Component Builder (JCB)](./The-Quick-Hello-Word-with-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding None Database Fields to an Admin View](./Adding-none-database-fields-to-an-admin-view.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [The Custom Dashboard Option in Joomla Component Builder (JCB)](./The-custom-dashboard-option-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Add or Remove Prefix to Component Name in Joomla Menu](./Add-or-Remove-Prefix-to-Component-Name-in-Joomla-Menu.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + + +### [JAB18 Using Joomla Component Builder (JCB)](./JAB18-Using-Joomla-Component-Builder.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [The New Fields Area in Joomla Component Builder](./The-new-fields-Area-to-make-things-easier.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Adding Language Strings and Dynamic Placeholders in JCB](./Adding-Language-String-to-your-Component-and-get-the-Language-Placeholder-for-dynamic-use.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Library Manager - Anticipated Functionality](./Library-Manager-Anticipated-Functionality.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Join Fields in the Admin List View with Field Relations](./Join-Fields-in-the-admin-list-view-with-field-relations.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Change the License Template in Joomla Component Builder (JCB)](./How-to-change-the-License-Template-in-JCB.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Reusing Custom Code in Joomla Component Builder (JCB)](./Reuse-Custom-Code.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Setup Local Development Environment with OctoJoom](./Setup-Local-Development-Environment-with-OctoJoom.md) + +| Resources | Documentation sections | +| --- | --- | +| | | + +### [JCB Fields Type Extended](./JCB-Fields-Type-Extended.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Add Joomla Custom Fields in Joomla Component Builder (JCB)](./How-to-add-Joomla-Custom-Fields.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Expand Custom Field Type Beyond the Default](./Expand-Custom-Field-Type-Beyond-The-Default.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [A Quick Demonstration to Load a List of Items in a Site View](./A-Quick-Demonstration-to-Load-a-List-of-Items-in-a-Site-View.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Add a Form to a Site View](./How-to-Add-a-Form-to-a-Site-View.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Update the Site Form Field via URL Parameter](./Update-the-Site-Form-Field-via-URL-Parameter.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [How to Add More Helper Methods to Your Component's Helper Class](./How-to-Add-More-Helper-Methods-to-Your-Components-Helper-Class.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Easy Validation Rules for Fields in Joomla Component Builder (JCB)](./Easy-Validation-Rules-for-Fields-in-JCB.md#easy-validation-rules-for-fields-in-joomla-component-builder-jcb) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [New Placeholders Feature in Joomla Component Builder](./New-Placeholders-Feature.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Manage a Component's Global Config Option Field in Relation with Menu Params](./Manage-a-Components-Global-Config-Option-Field-in-Relation-With-Menu-Params.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Default Database Values Can Be Set Per Field Type](./Default-Database-Values-can-be-set-per-Field-Type.md) + +| Video timeline | Documentation sections | +| --- | --- | +| | | + +### [Beta Testing](./Beta-Testing.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Component Settings](./Component-Settings.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Component Structure And Mvc Implementation](./Component-Structure-and-MVC-Implementation.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Introduction](./Develop-a-Joomla-Component---Guide-to-use-the-Component-Builder.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Developing With Joomla Component Builder](./Developing-with-Joomla-Component-Builder.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [PHP Settings](./PHP-Settings.md#php-settings-documentation-for-joomla-component-builder-jcb) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Tips: Custom Code](./TIPS:-Custom-Code.md) + +| Video timeline | Documentation sections | +| --- | --- | +| _No linked videos yet._ | | + +### [Using the JCB Demo Component While Building Your Local Development System](./Using-the-JCB-Demo-Component-While-Building-Your-Local-Development-System.md#demophp) + +| Video timeline | Documentation sections | +| --- | --- | +| | | +