editor.json: מסך העריכה של בעל האתר

הקובץ הזה מעצב את מסך עריכת התוכן בלוח הבקרה. הוא אינו משנה את עיצוב האתר הציבורי ואינו מגדיר שדות תוכן חדשים.

התחילו מהשדות שב־definition.json, ואז החליטו כיצד בעל האתר ימצא אותם:

editor.json

{
  "contractVersion": 1,
  "groups": [
    {
      "id": "homepage",
      "label": "Home page",
      "sections": [
        {
          "id": "opening",
          "label": "Opening section",
          "fields": [
            "hero"
          ]
        },
        {
          "id": "offer",
          "label": "What we offer",
          "fields": [
            "showServices",
            "services"
          ]
        }
      ]
    },
    {
      "id": "shared",
      "label": "Shared content",
      "sections": [
        {
          "id": "details",
          "label": "Business details",
          "fields": [
            "business"
          ]
        }
      ]
    }
  ],
  "collections": [
    {
      "path": "services",
      "view": "gallery",
      "labelField": "title",
      "descriptionField": "summary",
      "imageField": "image"
    }
  ]
}

הבנת ההיררכיה

המערך groups מכיל קבוצות ניווט ראשיות, למשל Home page ו־Shared content. בכל קבוצה יש sections. לכל מקטע יש תווית ורשימה מסודרת של מזהי שדות קיימים מהרמה העליונה.

בדוגמה בעל האתר רואה:

1. Home page ← Opening section: קבוצת hero, ובתוכה כותרת, הקדמה ותמונה.
2. Home page ← What we offer: תיבת סימון להצגת שירותים, ולאחריה רשימת השירותים החוזרת.
3. Shared content ← Business details: שם העסק ומספר הטלפון.

סדר המערכים הוא סדר העורך. מזהי הקבוצות והמקטעים מזהים את סידור העורך; הם אינם הופכים למפתחות תוכן.

השדות הם הפניות

ההגדרה "fields": ["hero"] מציבה במקטע את כל קבוצת הסכמה hero. ההגדרה "fields": ["hero.title"] אינה נתמכת כאן. שדה מהרמה העליונה יכול להופיע פעם אחת בלבד בכל המקטעים שהוגדרו.

שדות שלא שובצו עדיין זמינים: קבוצות ורשימות מקבלות מקטעים אוטומטיים, ושדות פשוטים שנותרו מופיעים במקטע כללי אוטומטי. השמטת שדה אינה דרך להסתיר אותו.

הקובץ צריך להתקיים, אך אפשר שתוכנו יהיה null כדי להשתמש בסידור אוטומטי. אובייקט הגדרות דורש contractVersion: 1. התוויות הן מחרוזות שמוצגות כפי שנכתבו, ולא מפות תרגום.

הגדרות אוסף משפרות את תקציר הפריטים

המערך collections קובע כיצד מוצגים פריטי רשימה. path מצביע על הרשימה; labelField, ‏descriptionField ו־imageField מצביעים על שדות בתוך פריט יחיד. הם מסייעים לבעל האתר לזהות כרטיס, בלי לשנות את הנתונים שלו.

להדרכה מלאה ולשיקולי העיצוב המשיכו אל עיצוב עורך התוכן.