יחידה:שטומף/דאק
קפיצה לניווט
קפיצה לחיפוש
דאָס איז דער דאקומענטאציע בלאַט פאַר יחידה:שטומף
היחידה קיימת עבור תבנית {{שטומף}}. היא מאפשרת לנהל את היחידה בלי צורך בהוספת קוד כפול בכל פעם שיש צורך בסוג חדש. היחידה מחזירה שלוש פונקציות:
- הפונקציה main מחזירה את התבנית "שטומף" עבור סוג שטומף מסוים.
- הפונקציה templatedata מחזירה רשימה ממויינת של כל סוגי השטומףים עבור templatedata.
- הפונקציה 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 למטה באמצעות העתקה מדף מוסטער:שטומף/ליסטע. במידץ הצורך יש לנקות את המטמון באמצעות הכפתור בדף הזה. במידה בשם הסוג ישנם גרשיים כפולים, יש לשים קו נטוי הפוך לפני, למשל צה\"ל.
- רשימת הקטגוריות בדף הזה מתעדכנת אוטומטית. במידת הצורך ניתן לנקות את המטמון באמצעות הכפתור המצורף.