חב"דפדיה:מדריך לעיצוב דפים
| תוכן וסגנון כתיבה |
למדריך לעיצוב דפים מטרה ברורה ופשוטה - לגרום לאחידות עיצובית בערכים של חב"דפדיה - זהו מדריך סגנוני. לפעמים, דרך מסוימת טובה מאחרת, אך עדיף שכל הערכים יהיו מסודרים ואחידים בעיצובם עד כמה שניתן, על מנת שיהיו ברורים ונוחים לצפייה, לקריאה ולעריכה. מדריך זה מתמקד במבנה הערך. למידע על כתיבת תוכנו של הערך - ראו חב"דפדיה:מדריך לכתיבת ערכים. למעוניינים לדעת איך מתבצע העיצוב בפועל ישנו מדריך לעריכת דפים, שבו תלמדו איך להדגיש, לסמן, להוסיף קישורים ועוד. המדריך אותו אתם קוראים כעת, מתעסק בעיקר במתי - באילו מקרים ולמען איזה סגנון כדאי להשתמש בהם.
לפני שמתחילים להשקיע בכתיבת ערך, רצוי לבדוק האם הוא בכלל ראוי להיות ערך אנציקלופדי או שאינו מקובל בחב"דפדיה. יש להזכיר לתורמים החדשים שכתיבה ברורה, אינפורמטיבית, נייטרלית, מקורית ומועילה תמיד תהיה יותר חשובה מתצוגה ומפורמט. מכיוון שאנחנו כותבים בעברית, נוסחו כללים הרלוונטיים רק לשפה זו בחב"דפדיה:לשון.
מעבר לקריאה התאורטית כאן, ניתן לקחת דוגמה מערכים שאהבתם את עיצובם. קחו ערך ובדקו לעומק כיצד הוא בנוי וכתוב על ידי פתיחתו לעריכה (לחיצה על לשונית "עריכת קוד מקור" בראש הערך). אתם יכולים לסגור אותו בסוף בלי לשנותו, אבל כל ערך ניתן לשפר, ונשמח אם תעשו כך.
מבנה כללי לערכים
מבוא הערך
| הנחיה | הסבר | דוגמאות | |
|---|---|---|---|
 |
הגדרת הנושא | הערך צריך להיפתח בהגדרה ברורה, קצרה ולעניין המתארת היטב את הנושא, וסיכום מאוד גס וכללי של תוכנו העיקרי.
|
|
|
הדגשת מונחים | שמו/נושאו של כל ערך צריך להיות מודגש בהופעתו הראשונה בערך. אם לנושא הערך יש יותר משם אחד, ציינו את כולם בפסקה הראשונה בערך והדגישו את העיקריים שבהם. |
|
|
הבהרת הקשר | כדאי גם להבהיר, עוד בשורת הפתיחה, את הקשרו של נושא הערך (במידה וזה אינו ברור דיו). אם הערך עוסק בנושא מעולם דמיוני כלשהו - למשל דמות, מקום, מושג וכולי, מקור המושג וכיוצא בזה - יש לציין זאת בפירוש בתחילת הערך, כולל מקור המונח. |
|
גוף הערך
| הנחיה | הסבר | דוגמאות | ||
|---|---|---|---|---|
תוכן | ||||
|
חלוקה לפסקאות קצרות | רצוי לשמור על פסקאות קצרות, מאחר שהעין מתעייפת לאחר קריאת טקסט רצוף ממושך. מסיבה דומה, יש לרווח את הערך - רווח שורה בין פסקה לפסקה, בין כותרת לפסקה וכן הלאה. | תחביר ויקי ליצירת פסקה: שורת רווח ריקה שנמצאת בין שתי פסקאות. | |
|
הפניה למקורות | חשוב לכלול הפניות למקורות חיצוניים באמצעות הערות שוליים המאששים את נכונות העובדות הנכתבות. ראו: עזרה:הערות שוליים
|
דוגמה לקוד להערת שוליים:
| |
|
שילוב תמונות ואיורים | רצוי שהערך ישלב תמונות, איורים ועזרים גרפיים לצד הפסקאות, בדרך כלל משמאל לטקסט.
| ||
כותרות הערך | ||||
|
חלוקה לכותרות | כותרות יכולות לעזור להבהיר ולסדר את הערך על ידי חלוקתו לתתי-נושאים, וכמו כן, לעשות אותו נוח לשימוש ולניווט דרך תוכן העניינים (נוצר ומוצג באופן אוטומטי). למילים אשר נמצאות בראשי הפרקים בערך, ניתן יותר משקל בעת ביצוע חיפוש באנציקלופדיה. | דוגמת קוד:
== כותרת == | |
|
חלוקה לכותרות משנה | מספר סימני השווה (זהה משני צדי הכותרת) קובע את גודל הכותרת ואת רמת כותרת המשנה.
|
דוגמת קוד:
== כותרת ראשית== === כותרת משנית === | |
|
הימנעו מחלוקת יתר |
אין להציף את הערך בפיצול יתר - לרוחב (עודף נושאים) או לעומק (עודף רמות פיצול) - מפני שהדבר עלול ליצור בלבול ופיזור ותקורת תוכן מיותרת. בדרך כלל, פסקאות קצרות אינן מצדיקות כותרת משנה משלהן.
| ||
|
הימנעו מקישור כותרות | יש להימנע מקישור כותרות פסקאות וראשי פרקים (או חלקים מהן), מפני שזה גורם לבלבול. עדיף להכניס את הקישורים הרלוונטיים באחד המשפטים הראשונים תחת הכותרת.
| ||
קישורים פנימיים | ||||
|
שילוב קישורים פנימיים |
כחלק מהטקסט יש לשלב הפניות לערכים קשורים אחרים, מה שמכונה "קישורים פנימיים", כלומר, מילה (או רצף מילים) בתוכן, המהווה קישור לערך אחר.
|
הקישור נעשה באמצעות צמד סוגריים מרובעים מכל צד של המילה: למשל, [[שדים ורוחות]]. | |
|
הימנעו מקישור יתר | אל תסמנו כקישור כל הופעה של המילה - מספיק סימון הופעתה הראשונה.
| ||
|
קישורים ברורים | ניתן לקשר מילים שאינן בדיוק כשם הערך אליו רוצים לקשר, כפי שמפורט בדף עזרה:קישורים. עם זאת, יש לוודא, שברור לאן הקישור מוביל, מבלי שיהיה צורך להיכנס אליו. במקרים של מופע בצורת ריבוי, תוספת ה' הידיעה, אותיות השימוש או כל אות אחרת שאינה חלק מהמילה עצמה, ניתן לסמן רק את חלק המילה הרצוי במקום לסמן את כולה. זה קל יותר לקריאה, להבנה ולהדפסה.
|
ניתן לקשר מילים שאינן בדיוק כשם הערך אליו רוצים לקשר:
| |
ראו גם ולקריאה נוספת
| הנחיה | הסבר | דוגמאות | ||
|---|---|---|---|---|
|
מיקום פרקים נוספים | ראש פרק "ראו גם" יבוא לפני פרק "לקריאה נוספת" ופרק "קישורים חיצוניים". | ||
ראו גם | ||||
|
קישורים בפרק ראו גם | פרק "ראו גם" נועד לקשר את הקוראים לערכים רלוונטיים, שיש בהם רקע או הרחבה שמסייעים בהבנת הנושא שבו עוסק הערך הנוכחי.
|
== ראו גם == | |
לקריאה נוספת | ||||
|
הפניות לספרות | מעבר לקישורי אינטרנט, אפשר לציין מקורות פיזיים לא מקוונים (לא באינטרנט) למידע, שיכולים להרחיב עליו (ביבליוגרפיה): ספר או מאמר רלוונטי. רוב המידע בימינו עודנו נמצא בספרים, ורצוי להפנות אליהם.
כמו כן, רצוי לכלול "מראי מקום" - אם יש בערך התייחסות ספציפית למקור חיצוני או ציטוט ממנו. למשל, אם בערך מוזכר למשל מאמר, כדאי להפנות למאמר עצמו בחב"דפדיה:ביבליוגרפיה. | ||
קישורים חיצוניים | ||||
|
הפניות לאתרים | יש מקרים בהם ראוי להוסיף מידע יותר מפורט, או בנושא יותר ספציפי, או תוכן שאינו מילולי (תמונות, נתונים, גרפים וכדומה), שמקורו ברשת האינטרנט. הדבר חשוב במיוחד, כשאתר אינטרנט משמש כמקור מידע עיקרי. הפרק "קישורים חיצוניים" יבוא בסוף הערך אחרי הפרק "לקריאה נוספת". דרך כתיבת הקישור בוחב"דפדיה מוסברת בחב"דפדיה:קישורים חיצוניים.
| ||
שיוך לקטגוריות ולתבניות ניווט
ראו: חב"דפדיה:קטגוריה וכן חב"דפדיה:תבניות
טקסט מיוחד
כאשר מתייחסים במשפט למונח מסוים ולא משתמשים בו באופן או במובנו הרגיל, יש לסמנו במרכאות כפולות (") או בכתב מודגש. בעברית, אין משתמשים בכתב נטוי (Italic. למשל:
- המונח "התאבכות" מקורו במילה התלמודית "אובך".
- י היא העשירית באותיות האלפבית העברי.
ניתן להוסיף לערך פסקת ציטטות הרלוונטיות לנושא. הציטטה תושם בין מרכאות, ואם אורכה גדול ממשפט או שניים - בפסקה המוסטת פנימה. ראה הרחבה בדף חב"דפדיה:ציטוט. (לכללי עיצוב שמות ספרים ומאמרים ראו חב"דפדיה:ביבליוגרפיה).
בציון תאריכים יש להשתמש בפורמט מסוים כפי שנכתב בדף חב"דפדיה:תאריכים. כך גם לגבי מספרים. ככלל, מספרים עד עשר או כל מספר בראש מילה צריכים להיכתב במילים ולא בספרות. אין להשתמש בסימן % אלא במילה "אחוזים".
חשוב להזכיר ששורה המתחילה בתו רווח ללא המשך תהיה שורת רווח בטקסט. פסקת טקסט המתחילה ברווח תעוצב בגופן קבוע ולא תגלוש לשורה הבאה. שורה כזו מרחיבה את כל הדף וגורמת לבלבול ברצף קריאת הערך, לכן, חשוב לשים לב שפסקת טקסט רגילה אינה מתחילה בסימן רווח.
תבניות
נמצאות גם תבניות מוכנות שחוזרות בחב"דפדיה ותורמות לשמירה על אחידות וניתן להעתיקן לעבודה מהירה יותר, ובכל אופן רצוי להשתמש בפורמט אותן הן מציגות. לרשימת תבניות מלאה ראו רשימת תבניות. דוגמאות ספציפיות:
- תבנית דף - לכתיבת ערך
אל תתחכמו ותתהדרו. לא תמיד תוספות סגנוניות ועיצוב מיוחד שאתם כותבים באמת יופיעו כפי שתכננתם. ערך גם לא אמור להיות חזיון טכניקולור מולטימדי, זאת עדיין אנציקלופדיה. קל להציג את חב"דפדיה, וקל לערוך ולהוסיף לערכיה, כל עוד אנחנו לא הופכים את שפת הכתיבה למסובכת מכדי הצורך להציג את המידע בדרך שימושית ובהירה. מכאן שהוספת קודי HTML צריכה לעשות בקומץ יד ומסיבה מוצדקת. זכרו שהמטרה היא קודם כל אנציקלופדיה שימושית, ומיד אחר-כך קלה לעריכה ולשיפוץ. עיצוב ואפקטים הם אמצעים לשירות מטרה זו ותו לא.