תבנית:Pgn/תיעוד

תבנית זו מיועדת להצגת משחקי שחמט בעזרת שימוש בפורמט PGN ‏(Portable Game Notation). ניתן להציג עד 40 משחקים בעזרת תבנית אחת.

השימוש בתבנית:

{{pgn
|1=משחק בפורמט PGN
|2=משחק שני בפורמט PGN (אופציונלי)
|3=
|... וכן הלאה, עד לכל היותר 
|40=
}}

פרמטרים אופציונליים:

• גודל גודל המשבצת, בפיקסלים. ברירת מחדל: 26. ערך מינימלי - 20, מקסימלי - 60.
• השהיה: ההשהיה בין שני מסעים באנימציה, במילישניות. אם הפרמטר לא מוגדר, ההשהיה ההתחלתית היא 750 מילישניות, או ¾ שנייה, ויופיעו כפתורי "מהר יותר" ו"לאט יותר" משני צידי כפתור ה-Play: לחיצה על "לאט" מגדילה את ההשהיה, ולחיצה על "מהר" מקטינה.

יש לשים לב, אם ה-pgn מכיל את התו | ("באר אנכי"), יש להחליפו ב {{!}}.

להסבר על פורמט PGN אפשר לקרוא בערך בוויקיפדיה האנגלית: Portable Game Notation.

יש מספר תגי PGN לא סטנדרטיים, שהתבנית מתייחסת אליהם באופן מיוחד (התגים הם Case sensitive, כלומר אי אפשר להשתמש ב-name או NAME במקום Name):

• Direction: אם מופיע תג זה עם ערך "rtl", הפרטים יוצגו בראש המשחק מימין לשמאל (כמו בדוגמה למטה, ב"משחק גומלין")
• Name: אם מופיע פרמטר זה, זה יהיה הטקסט שמוצג עבור אותו משחק בתפריט במקרה והתבנית מכילה יותר ממשחק אחד. אם הפרמטר לא מוצג, התבנית בונה את שם המשחק על ידי שירשור שם האירוע (Event), ושמות השחקנים.
• FirstMove: אם מופיע תג זה, המושחק יוצג במצב הלוח לאחר המסע הזה. אם הפרמטר לא מופיע, יוצג הלוח בסיום המשחק. הערך של התג צגיך להופיע במספר ואחריו האות l או d. למשל, כדי שהלוח יוצג במצבו לאחר המסע ה-21 של השחור, יש להוסיף את התג [FirstMove "21d", וכדי להציג את הלוח לאחר המסע השביעי של הלבן - [FirstMove "7l" (שימו לב שמדובר באות הלטינית L קטנה, כלומר l, ולא בספרה 1). להצגת עמדת הפתיחה, אפשר להזין [FirstMove "0"]
• ניתן להזין תג FEN, לציון התחלת המשחק מעמדה שונה מהעמדה הסטנדרטית, למשל בשח 960, חידות שחמט, או הצגת משחק החל מנקודה מסוימת במהלכו. כאשר משתמשים בתג זה, ואם לא מזינים FirstMove, הלוח יוצג בעמדת הפתיחה ולא בעמדת הסיום.

מגבלות

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

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

דוגמה

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

קוד ויקי של שני משחקי שחמט בפורמט pgn. במשחק הראשון מוגדר "FirstMove" - מסע 33 של השחור
<syntaxhighlight lang="text"> תבנית:Pgn </syntaxhighlight>

והתוצאה: תבנית:Pgn

עם השהיה מוגדרת (1000 מילישניות, כלומר שנייה) | השהיה = 1000 כפתורי "מהר יותר"/"לאט יותר" נעלמים.

קוד הויקי של משחק אחד, השהיה=1000
<syntaxhighlight lang="text"> תבנית:Pgn </syntaxhighlight>

אותו משחק, בגודל משבצת 40 פיקסלים | גודל = 40