יחידה:שטומף/דאק

פון המכלול
< יחידה:שטומף
ווערסיע פון 22:50, 12 מערץ 2023 דורך צמא לדעת (שמועס | ביישטייערונגען) (החלפת טקסט – "\[\[\s?תבנית\s?:" ב־"[[מוסטער:")
קפיצה לניווט קפיצה לחיפוש

דאָס איז דער דאקומענטאציע בלאַט פאַר יחידה:שטומף

היחידה קיימת עבור תבנית {{קצרמר}}. היא מאפשרת לנהל את היחידה בלי צורך בהוספת קוד כפול בכל פעם שיש צורך בסוג חדש. היחידה מחזירה שלוש פונקציות:

  1. הפונקציה main מחזירה את התבנית "קצרמר" עבור סוג קצרמר מסויים.
  2. הפונקציה templatedata מחזירה רשימה ממויינת של כל סוגי הקצרמרים עבור templatedata.
  3. הפונקציה categories מחזירה רשימה ממויינת של קטגוריות הערכים מכל הסוגים עבור התיעוד.

היחידה משתמשת ברשימת סוגים בדף יחידה:קצרמר/list.json. היא כתובה בשפת json. מבנה הרשומה הוא כדלקמן:

  • עבור רוב הסוגים המפתח הוא שם הסוג והתוכן הוא שם קובץ האייקון.
  • עבור הסוגים בהם שם הסוג שונה משם הקטגוריה, התוכן הוא מערך בן שני איברים. הראשון הוא שם קובץ האייקון, והשני הוא שם הקטגוריה.

למשל:

    "תל אביב-יפו": "Tel-aviv city hall.jpg",
    "תל אביב": [
        "Tel-aviv city hall.jpg",
        "תל אביב-יפו"
    ],

הנחיות להוספת סוגים חדשים

  • להוספת קצרמר "Tel-Aviv" יש לבצע את הפעולות הבאות
  • להוסיף לקובץ יחידה:קצרמר/list.json שורה ,"Tel-Aviv": "Tel-aviv city hall.jpg"
  • במידה ושם הסוג שונה משם הקטגוריה, השורה היא ,"Tel-Aviv": ["Tel-aviv city hall.jpg", "Tel-Aviv-Yafo"]
  • במידה ויש צורך להוסיף מסגרת לתמונה, יש לעדכן את הקוד בצורה הבאה: "יפן": "Flag of Japan.svg{{!}}גבול",
  • שימו לב לפסיק לפני הטקסט. הוא נוסף כי צריך להיות פסיק אחרי כל שורה ברשימה, חוץ מהאחרונה.
  • המנוע דואג אוטומטית לפורמט לאחר השמירה, כך שהפסיק יועבר לסוף השורה הקודמת. כך גם עם פרמוט נאות של סוגריים מרובעים.
  • במידה ובאחד השמות ישנו סימן מרכאות כפולות, יש לכתוב סימן קו נטוי הפוך לפניו, למשל "תנ\"ך"
  • הרשימה הראשונית מויינה, אך אין בכך צורך, כי היחידה ממיינת אותה אוטומטית אחרי הקריאה.
  • ניתן לעדכן את הרשימה ב-templatedata למטה באמצעות העתקה מדף מוסטער:קצרמר/רשימה. במידץ הצורך יש לנקות את המטמון באמצעות הכפתור בדף הזה. במידה בשם הסוג ישנם גרשיים כפולים, יש לשים קו נטוי הפוך לפני, למשל צה\"ל.
  • רשימת הקטגוריות בדף הזה מתעדכנת אוטומטית. במידת הצורך ניתן לנקות את המטמון באמצעות הכפתור המצורף.