עזרה:אשף התבניות

מתוך חב"דפדיה, אנציקלופדיה חב"דית חופשית
קפיצה לניווט קפיצה לחיפוש

אשף התבניות (לא "אשף תבניות קישורים"), מאפשר הוספה ומילוי של תבניות קיימות היישר מדף העריכה, בקלות ובמהירות. האשף הכללי עובד בצורה חלקית. אשף התבניות עובד באופן שלם, רק כאשר יש לתבנית מבוקשת דף משנה של פרמטרים כמוסבר להלן.

התקנת האשף[עריכה]

תחת "העדפות => גאדג'טים" (מיוחד:העדפות#mw-prefsection-gadgets) יש לבחור "הוספת כפתור לעריכת תבניות בסרגל הכלים (ברירת מחדל). שימו לב שהבחירה הזו מאופשרת כברירת מחדל.

אם הוספתם שורה זו למיוחד:הדף שלי/common.js אנא הסירו אותה:

importScript('mediawiki:TemplateParamWizard.js');

שימוש[עריכה]

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

יצירת תבנית חדשה[עריכה]

בכדי ליצור תבנית חדשה יש ללחוץ על הכפתור כאשר נמצאים במוד עריכה, קובץ:Vector toolbar template button.png. האשף יפתח חלון שמאפשר להזין את שם התבנית הרצויה מתוך רשימה. לאחר לחיצה על "אישור", תגיעו לאשף עצמו.

ניתן גם לרשום את שם התבנית בערך באופן הבא {{שם תבנית}}, ואז לסמן את התבנית וללחוץ על הכפתור קובץ:Vector toolbar template button.png. הסקריפט מנסה לקרוא את דף המשנה של התבנית בשם הקבוע - תבנית:שם התבנית/פרמטרים. האשף מייצר ומציג טופס עם שם הפרמטר, ותיבת הכנסת טקסט. במידה ואין דף משנה לתבנית, האשף מנתח את הפרמטרים בתבנית ומייצר דף עבודה. בשיטה זו יתכן שיסתננו גם פרמטרים כמו "רוחב" או "ללא קטגוריה" שאינם בהכרח חלק אינטגרלי של התבנית. אפשר להסיר אותם לאחר הרישום.

עדכון תבנית קיימת[עריכה]

ניתן להשתמש באשף גם לתיקונים קטנים (או גדולים) בתבנית קיימת שכבר מולאה באופן חלקי, כאשר מסמנים את התבנית הקיימת בערך, ולוחצים על כפתור קובץ:Vector toolbar template button.png. האשף יקרא את הנתונים מהערך עצמו.

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

בזמן עריכה, אם מאופשר אצלכם הגאדג'ט של autocomplete, הוא יעבוד גם על השדות באשף, כלומר כאשר תוסיפו [[ לאחד השדות באשף ותתחילו להקיש שם ערך, האשף יציע ערכים מתאימים לתווים שכבר הקשתם, בדומה לתיבת החיפוש.

דף המשנה[עריכה]

יש לאשף שני מודי עבודה: מוד עבודה "מלא" עבור תבניות נתמכות, ומוד עבודה שני ("פשוט" או "raw") עבור כל השאר. במוד העבודה הפשוט, האשף ממצה את הפרמטרים מדף התבנית, אך ללא הבנה מה כל פרמטר עושה. אין הבחנה, למשל, בין פרמטרים שחיוניים לתבנית לפרמטרים אופציונליים. גם סדר הפרמטרים שהאשף מציג הוא לפי סדר הופעתם בקוד של תבנית, ולאו דווקא סדר הגיוני.

כדי להעביר תבנית למוד העבודה המלא, יש להכין לה דף משנה בשם "תבנית:שם התבנית/פרמטרים", ובו רשימת הפרמטרים עם תיאור, וכן תכונות נוספות.

דף המשנה "פרמטרים" מכיל טבלה. חשוב: התאים בטבלה מופרדים על ידי ||, ולא בירידת שורה ו- | יחיד.

הטורים של הטבלה הם:

  1. שם הפרמטר
  2. תיאור
  3. אופציות, מופרדות על ידי נקודה-פסיק (";"). האופציות הנתמכות כעת הן:
    1. "ברירת מחדל=" - ערך ברירת מחדל
    2. "אפשרויות=": הערכים השונים מופרדים בפסיקים. במידה ויש יותר מאפשרות אחת, שדה זה יופיע כתפריט נגלל. אם יש אפשרות יחידה, השדה הופך לתיבת סימון. אפשרות זו מכבדת את ברירת המחדל: במקרה של אפשרות יחידה, ברירת המחדל תגרום לתיבה להופיע כמסומנת.
    3. "שדה חובה": שדות המסומנים כ"חובה" יוקפו במסגרת אדומה, וכל עוד שכל השדות הללו לא מולאו, לא ניתן ללחוץ על "אישור".
    4. "מספר שורות" (עם או בלי ערך - ללא ערך ברירת המחדל היא 5). אפשרות זו מיועדת עבור פרמטרים שערכיהם עשויים לכלול מספר שורות.
    5. "תלוי" - שם שדה אחר שהשדה הזה תלוי בו. שימושי בתבניות בהן יש שדות רבים מסוג "מפלגה1, מפלגה2, מפלגה3" וכדומה, כאשר מספר המפלגות משתנה. במצב כזה אפשר לשים בטור של מפלגה5 "תלוי=מפלגה4". באופן כזה הטופס יכיל רק מה שרלוונטי (כלומר, ברגע שהמשתמש יתחיל למלא את "מפלגה4", תתווסף לטופס שורה עבור "מפלגה5"). בדומה, אם יש למשל "אלבום קודם" ו-"תאריך אלבום קודם", ניתן להגדיר את השדה השני כתלוי בראשון.
    6. "תאריך" - בלחיצה על השדה ייפתח וידג'ט של תאריך. עדיין ניתן למלא את השדה באופן ידני.
    7. "משני" - אם יש שדות המסומנים "משני", שדות אלו יהיו מוסתרים כאשר הטופס נפתח, ומעל השדות תתווסף תיבת סימון "הראה את כל הפרמטרים". סימון התיבה יגרום להופעת השדות עם הסימון "משני".

הערה: כל הפרמטרים צריכים להיכתב ללא גרשיים. לדוגמה: ברירת מחדל = 10.

טבלת פרמטרים לדוגמה, המדגימה את השימוש באופציות השונות:

שם הפרמטר תיאור אופציות
סוג פרמטר זה יכול לקבל ערך מתוך רשימה מוגבלת. שימוש באופציה "אפשרויות" גורמת לכך שהכנסת הנתונים מתבצעת על ידי בחירה מתפריט. בין האפשרויות מפרידים פסיקים. אפשרויות=מיני-אלבום, EP, הופעה, אוסף, מארז תקליטורים, גרסאות כיסוי, פסקול, וידאו, רמיקס
אפשרות יחידה גם שדה זה מסומן עם "אפשרויות", אך מכיוון שיש רק אפשרות אחת, במקום תפריט נגלל תופיע תיבת סימון. אפשרויות=כן
חייבים פרמטר זה הוא פרמטר חובה, כלומר אין להשאירו ריק. השדה באשף יהיה מוקף במסגרת אדומה, וכל עוד אין בפרמטר הזה ערך, כפתור "אישור" לא יהיה פעיל שדה חובה
סיפור פרמטר זה מקבל תוכן ארוך יחסית, ולכן באשף נקצה לשדה מספר שורות (ללא קשר להופעת התוכן בתבנית עצמה: לצורך שבירת שורות בתבנית כפי שתופיע לקוראים, יש להשתמש ב{{ש}}). אם לא נוסיף מספר (בדוגמה - 7), האשף יקצה לשדה 5 שורות. כשמשתמשים ב"שורות", אם העורך רושם יותר שורות מהמספר שהוגדר, השדה יצמיח פס גלילה אנכי. מספר שורות = 7
זכייה ראשונה שדה מסוג "תאריך". לחיצה על השדה תפתח ווידג'ט "תאריך", אך ניתן גם למלא את תוכן השדה ידנית. תאריך
זכייה שנייה רק אם המשתמשת מילאה "זכייה ראשונה" יש טעם להציע לה למלא גם "זכייה שנייה". כאשר משתמשים במספר אופציות, מפרידים ביניהן בעזרת נקודה-פסיק: ; תלוי=זכייה ראשונה ; תאריך
לאום יש תבניות בהן אם לא ממלאים פרמטר מסוים, התבנית משתמשת בערך ברירת מחדל. אם הערך שנמלא באשף זהה לערך ברירת המחדל, האשף ישמיט את הפרמטר הזה לחלוטין ברירת מחדל = פרסי
שם החתול שדה זה הוא "משני", ולכן לא יופיע בעת פתיחת הטופס. כאשר יש שדה משני אחד או יותר, תופיע בראש הטופס תיבת סימון "הראה את כל הפרמטרים". סימון התיבה יגרום להופעת השדות המסומנים "משני". שדה שמסומן גם "משני" וגם "תלוי", יופיע רק כאשר מתקיימים שני התנאים: התיבה מסומנת והשדה בו תלוי שדה זה אינו ריק. משני

אחרי בניית דף המשנה[עריכה]

לאחר שבניית דף המשנה "פרמטרים" ובדיקתו הסתיימו, יש להוסיף בראש דף התבנית עצמו, כמובן תחת תג noinclude, את התבנית {{אשף תבניות}}.

דוגמה[עריכה]