در اینجا موضوعاتی را ارائه می دهیم که برای مستندات کاربر باید روی آن ها کار شود.

در طول PBF یک صفحه گسترده با تمام موضوعاتی که می توانید روی آن ها کار کنید ارائه خواهیم داد. می توانید نام خود را در آن صفحه پشت موضوعی که روی آن کار می کنید بنویسید، تا از دوباره کاری جلوگیری شود.

می توانید یک لیست جزئی را در https://github.com/joomla/documentation/issues بیابید. در آنجا همچنین می توانید بحث های مربوط به یک موضوع و اطلاعات پس زمینه را بیابید. همچنین می توانید در آنجا مشخص کنید که روی مطلب خاصی کار می کنید، تا از کار کردن شخص دیگری روی همان موضوع جلوگیری شود.



در کانون توجه: صفحات بررسی اجمالی

وقتی به توضیحات راهنمای کاربر نگاه می کنید، می بینید که بر اساس موضوع دسته بندی شده اند. هر موضوع دارای یک مطلب بررسی اجمالی است که به شما اطلاع می دهد چه نوع اطلاعاتی در صفحات زیرین یافت می شود. برای مثال، تحت مطالب 25 صفحه می یابید که انواع مختلف موارد مرتبط با مطالب را توضیح می دهند. در صفحه بررسی اجمالی آن صفحات به شکلی ساختارمند معرفی شده اند.

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

در کانون توجه: آموزش هایی درباره ساخت سایت

در حال حاضر روی آموزش هایی درباره ساخت سایت تمرکز خواهیم کرد. راهنماهای مرحله به مرحله ای که تمام مفاهیم مورد استفاده برای ساخت یک سایت با جوملا را نشان می دهند.

نحوه ساخته شدن این آموزش ها برای ساخت سایت و اینکه کدام مطالب موجود در راهنمای کاربر می توانید برای آن استفاده کنید را می توانید در این صفحه گسترده بیابید (در حال انجام).

می توانید موارد بیشتری را در تمام زیر موضوعات این issue بیابید: ... todo...

به منوی سمت چپ در صفحه آموزش ها مراجعه کنید. در آنجا می توانید ببینید یک آموزش چگونه می تواند باشد.

درباره آموزش ها

  • یک آموزش تقریباً هرگز کامل نیست. فقط یک راه برای انجام کاری را نشان می دهد، نه همه راه های جایگزین برای انجام آن.
  • هدف اصلی نشان دادن برخی مفاهیمی است که می خواهید آموزش دهید. بدون توضیحات طولانی. یک آموزش، یادگیری از طریق انجام دادن است.
  • آموزش مجموعه ای از مراحل را ارائه می دهد که خواننده می تواند آن ها را تکرار کند و به نتیجه ای قابل بازتولید برسد. اما مسیر مهم تر از نتیجه است.
  • ترتیب ثابت:
    • شروع با بررسی اجمالی پیش نیازها: چه آموزش هایی باید قبل از این یکی انجام شوند.
    • سپس خلاصه ای از موضوع این آموزش (توضیح کوتاه مثال).
    • سپس مراحلی که باید دنبال شوند
    • پایان با یک نتیجه گیری: خلاصه ای از مفاهیم پوشش داده شده.

موضوعات دیگری که می توانید روی آن ها کار کنید:

  1. فیلدهای سفارشی.
  2. راهنماهای نحوه انجام با mod_articles.
  3. آموزش: افزودن یک ماژول به میز کار.
  4. لغوهای قالب.
  5. مطالب مجله مفید.

فیلدهای سفارشی

مورد نیاز:

  • یک آموزش که نحوه استفاده از فیلدهای سفارشی را توضیح دهد؛ در حال حاضر: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
  • از تمام مطالبی که در حال حاضر تحت «فیلدها» قرار دارند، 4 مطلب عمومی وجود دارد (فیلدها و گروه های فیلد، پارامترهای فیلد، سایت های چندزبانه و لغوهای قالب). آنها در همان سطح با 15 نوع از فیلدهای سفارشی و یک مطلب درباره یک فیلد سفارشی خاص: زیرفرم قرار دارند. آیا می توانید ساختار بهتری به جای قرار دادن تمام این مطالب در یک سطح ارائه دهید؟ اگر به یک لایه عمیق تر نیاز دارید، صفحه بررسی اجمالی را فراموش نکنید.
  • یک راهنمای گام به گام درباره نحوه تکرار فیلدهای سفارشی (با استفاده از زیرفرم).
  • نمونه ای از استفاده از زیرفرم های تودرتو در فیلدهای سفارشی (جدید از نسخه 5.2).
  • یک مرجع (بررسی اجمالی) از تمام فیلدهای سفارشی + توضیح کوتاه.
  • آموزش درباره لغوهای قالب. نگاه کنید به https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

مجموعه مقالات درباره فیلدهای سفارشی نوشته Marc Dechèvre در مجله را ببینید:

آیا چیزی در این مطالب وجود دارد که باید در مستندات قرار گیرد؟

راهنماهای گام به گام با mod_articles

همچنین: https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules را برای mod_articles بروزرسانی کنید.

آموزش: افزودن یک ماژول به میز کار

لغوهای قالب و قالب های نمای جایگزین

مقالات مفید مجله

برخی از این ها می توانند به عنوان پایه ای برای یک مقاله مستندات استفاده شوند.

انتقال به لیست کارهای راهنمای توسعه دهندگان