עריכת הדף "חב"דפדיה:מדריך לעיצוב דפים"

{{חב"דפדיה - סגנון}}
ל'''מדריך לעיצוב דפים''' מטרה ברורה ופשוטה - לגרום לאחידות עיצובית בערכים של [[חב"דפדיה]] - זהו מדריך סגנוני. לפעמים, דרך מסוימת טובה מאחרת, אך עדיף שכל הערכים יהיו מסודרים ואחידים בעיצובם עד כמה שניתן, על מנת שיהיו ברורים ונוחים לצפייה, לקריאה ולעריכה. מדריך זה מתמקד במבנה הערך. למידע על כתיבת תוכנו של הערך - ראו '''[[חב"דפדיה:מדריך לכתיבת ערכים]]'''. למעוניינים לדעת איך מתבצע העיצוב בפועל ישנו '''[[עזרה:תחביר ויקי|מדריך לעריכת דפים]]''', שבו תלמדו '''איך''' להדגיש, לסמן, להוסיף קישורים ועוד. המדריך אותו אתם קוראים כעת, מתעסק בעיקר ב'''מתי''' - באילו מקרים ולמען איזה סגנון כדאי להשתמש בהם. 

לפני שמתחילים להשקיע בכתיבת ערך, רצוי לבדוק האם הוא בכלל ראוי להיות ערך אנציקלופדי או ש[[חב"דפדיה:מה חב"דפדיה איננה|אינו מקובל בחב"דפדיה]]. יש להזכיר לתורמים החדשים שכתיבה ברורה, אינפורמטיבית, [[חב"דפדיה:מדריך לנקודת מבט נייטרלית|נייטרלית]], מקורית ומועילה תמיד תהיה יותר חשובה מתצוגה ומפורמט. מכיוון שאנחנו כותבים ב[[עברית]], נוסחו כללים הרלוונטיים רק לשפה זו ב[[חב"דפדיה:לשון]].

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

== מבנה כללי לערכים ==
===מבוא הערך===
{| class="wikitable"
! !! הנחיה !! הסבר !! דוגמאות
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הגדרת הנושא''' || הערך צריך להיפתח ב'''הגדרה ברורה, קצרה ולעניין''' המתארת היטב את הנושא, וסיכום מאוד גס וכללי של תוכנו העיקרי. 

:[[קובץ:Noia_64_apps_ktip.png|20px]] כדאי מאוד ששם הערך יהיה חלק מהמשפט הראשון, ורצוי בתחילתו.
:[[קובץ:Noia_64_apps_ktip.png|20px]] גודל פרק המבוא הרצוי הוא בדר"כ 2-4 פסקאות.
:[[קובץ:Noia_64_apps_ktip.png|20px]] עדיף להימנע משימוש בכותרת "הקדמה" ככותרת ראשונה, מפני שההקדמה צריכה לבוא בראש הערך עוד לפניה. שם אחר לחלק הראשון בערך, לאחר ההקדמה, הוא "סקירה כללית", אבל עדיף לחפש ניסוח יותר ספציפי לכותרת (אם התוכן מאפשר זאת).
|
* קוד: <nowiki> '''יין''', הוא משקה המיוצר מפירות ה[[גפן]], שהם מ[[שבעת המינים]] שנשתבחה בהם [[ארץ ישראל]].</nowiki>
* תוצאה: '''יין''', הוא משקה המיוצר מפירות ה[[גפן]], שהם מ[[שבעת המינים]] שנשתבחה בהם [[ארץ ישראל]].
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הדגשת מונחים '''
| שמו/נושאו של כל ערך צריך להיות '''מודגש''' בהופעתו הראשונה בערך. אם לנושא הערך יש יותר משם אחד, ציינו את כולם בפסקה הראשונה בערך ו'''הדגישו''' את העיקריים שבהם.
|
*קוד: <nowiki>'''הרב יוסף יצחק אופן''' (מכונה: '''פיצ'ע'''...</nowiki>
*תוצאה: '''הרב יוסף יצחק אופן''' (מכונה: '''פיצ'ע'''...
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הבהרת הקשר'''
| כדאי גם להבהיר, עוד בשורת הפתיחה, את הקשרו של נושא הערך (במידה וזה אינו ברור דיו). אם הערך עוסק בנושא מעולם דמיוני כלשהו - למשל דמות, מקום, מושג וכולי, מקור המושג וכיוצא בזה - יש לציין זאת בפירוש בתחילת הערך, כולל מקור המונח.
|
*קוד: <nowiki>'''סולם''', ב[[מוזיקה]], הוא...</nowiki>
*תוצאה: '''סולם''', ב[[מוזיקה]], הוא...

|}

===גוף הערך===
{| class="wikitable"
! !! הנחיה !! הסבר !! דוגמאות
|-
! colspan="5" style="background:#ddeeff;" | <h4>תוכן</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''חלוקה לפסקאות קצרות''' || רצוי לשמור על פסקאות קצרות, מאחר שהעין מתעייפת לאחר קריאת טקסט רצוף ממושך. מסיבה דומה, יש לרווח את הערך - רווח שורה בין פסקה לפסקה, בין כותרת לפסקה וכן הלאה. || תחביר ויקי ליצירת פסקה: שורת רווח ריקה שנמצאת בין שתי פסקאות.
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הפניה למקורות''' ||חשוב לכלול הפניות למקורות חיצוניים באמצעות הערות שוליים המאששים את נכונות העובדות הנכתבות. ראו: '''[[עזרה:הערות שוליים]]'''

:[[קובץ:Noia_64_apps_ktip.png|20px]] ניתן לשלב מעט ציטוטים, אך רצוי שציטוטים מלאים או ציטוטים פחות מהותיים יקושרו מהערך.
|
דוגמה לקוד להערת שוליים: 
:<nowiki>{{הערה|שם המקור}}</nowiki>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''שילוב תמונות ואיורים'''
| רצוי שהערך ישלב תמונות, איורים ועזרים גרפיים לצד הפסקאות, בדרך כלל משמאל לטקסט.
: [[קובץ:Noia_64_apps_ktip.png|20px]] העדיפו '''תמונות חופשיות''' על פני תמונות שימוש הוגן.
: [[קובץ:Noia_64_apps_ktip.png|20px]] הימנעו מ'''עומס ויזואלי'''; העדיפו קישור לגלרייה על פני שילוב תמונות רבות. 
: [[קובץ:Noia_64_apps_ktip.png|20px]] '''הנגשת הערך לבעלי לקויות''': לתמונה רצוי להוסיף כיתוב (תיאור), גם אם התמונה ברורה או כוללת הסבר עצמי וכיתוב, לטובת הנגשה לנכים ובעלי לקויות.

|-
! colspan="5" style="background:#ddeeff;" | <h4>כותרות הערך</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] ||'''חלוקה לכותרות'''
| כותרות יכולות לעזור להבהיר ולסדר את הערך על ידי חלוקתו לתתי-נושאים, וכמו כן, לעשות אותו נוח לשימוש ולניווט דרך תוכן העניינים (נוצר ומוצג באופן אוטומטי). למילים אשר נמצאות בראשי הפרקים בערך, ניתן יותר משקל בעת [[חב"דפדיה:ניווט|ביצוע חיפוש באנציקלופדיה]]. 
| דוגמת קוד:
{{ללא גלישה|1=== כותרת ==}}
|-
| [[קובץ:Check mark.svg.png|25px]] || '''חלוקה לכותרות משנה'''
| מספר סימני השווה (זהה משני צדי הכותרת) קובע את גודל הכותרת ואת רמת כותרת המשנה.

:[[קובץ:Noia_64_apps_ktip.png|20px]] השתמשו בכותרת רמת 2 לכותרות הגדולות ביותר (הימנעו מכותרת ברמה 1)
:[[קובץ:Noia_64_apps_ktip.png|20px]] השתמשו בכותרות רמה 3 לנושאי משנה ובכותרות 4 לכותרות הקטנות ביותר ולתתי-נושא משנה או חלקים מיוחדים.
:[[קובץ:Noia_64_apps_ktip.png|20px]] כאשר כל פרק עומד בפני עצמו, קוראים שמתעניינים בעיקר בהיבט מסוים יכולים לדלג לפרק המתאים.

| דוגמת קוד:
{{ללא גלישה|1=== כותרת ראשית==}}
{{ללא גלישה|1==== כותרת משנית ===}}
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הימנעו מחלוקת יתר'''
|
אין להציף את הערך בפיצול יתר - לרוחב (עודף נושאים) או לעומק (עודף רמות פיצול) - מפני שהדבר עלול ליצור בלבול ופיזור ותקורת תוכן מיותרת. בדרך כלל, פסקאות קצרות אינן מצדיקות כותרת משנה משלהן.

:[[קובץ:Noia_64_apps_ktip.png|20px]] ניתן להשתמש בנקודות (רשימת תבליטים, על ידי כוכבית (*)) או '''טקסט מודגש''' (על ידי גרש (')). יתרון נוסף של סימון זה הוא, שאין צורך לרווח (לרדת שתי שורות) לאחר מכן. המערכת מרווחת את הכותרת מהטקסט בעצמה.
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הימנעו מקישור כותרות'''
| יש להימנע מ[[עזרה:קישורים|קישור]] כותרות פסקאות וראשי פרקים (או חלקים מהן), מפני שזה גורם לבלבול. עדיף להכניס את הקישורים הרלוונטיים באחד המשפטים הראשונים תחת הכותרת.

:[[קובץ:Noia_64_apps_ktip.png|20px]] הסתייעו בקישורים ל'''[[תבנית:ערך מורחב|ערכים מורחבים]]''', והימנעו מלפרט פרטים בלתי הכרחיים, שיכולים להכלל בערכי משנה.
|-
! colspan="5" style="background:#ddeeff;" | <h4>קישורים פנימיים</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''שילוב קישורים פנימיים'''
|
כחלק מהטקסט יש לשלב הפניות לערכים קשורים אחרים, מה שמכונה "'''[[עזרה:קישורים|קישורים פנימיים]]'''", כלומר, מילה (או רצף מילים) בתוכן, המהווה קישור לערך אחר.

:[[קובץ:Noia_64_apps_ktip.png|20px]] יש להשתמש בקישורים עבור מונח, מושג, זמן, מקום, אדם, חפץ, וכו' - המופיעה בערך ושווה בעצמה ערך (בין אם קיים ובין אם לאו), ויכולה להרחיב ולהעמיק מעבר לתוכן הערך עצמו. 
:[[קובץ:Noia_64_apps_ktip.png|20px]] קישורים התואמים ל[[חב"דפדיה:מתן שם לערך|מוסכמות נתינת השם בחב"דפדיה]], סביר שיובילו לערכים קיימים ואם לא, יקלו על כתיבת ערכים חדשים בשם ה"נכון". 
:[[קובץ:Noia_64_apps_ktip.png|20px]] '''יש לדייק בקישורים'''. לעתים, נמצא את הערך המבוקש בשם שונה במקצת ממה שאנו מצפים, כך שכדאי לבדוק כל קישור שמוסיפים, ולוודא שהוא אכן מוביל לערך הנכון.
| הקישור נעשה באמצעות צמד סוגריים מרובעים מכל צד של המילה: למשל, <nowiki>[[שדים ורוחות]]</nowiki>.
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הימנעו מקישור יתר'''
| אל תסמנו כקישור כל הופעה של המילה - '''מספיק סימון הופעתה הראשונה'''. 

[[קובץ:Noia 64 apps xclipboard.png|20px]] הסוגיה מתי להפוך מילה לקישור ומתי לא לעשות זאת אינה פשוטה, כפי שמבהירה הדוגמה הבאה: המילה "עיר" היא מילה טריוויאלית, שכל הקוראים מבינים אותה היטב, ולכן עולה השאלה מתי ראוי להפוך אותה לקישור, ומתי יהיה זה קישור שהקוראים לא ירגישו צורך ללחוץ עליו.
:* בערך העוסק בסופר משה כהן נאמר שהוא "עבר להתגורר בעיר ערד". בהקשר זה ברור שאין טעם לתת קישור למילה "עיר", משום שהקישור לא יתרום מידע מהותי להבנת הערך משה כהן.
:*בערך העוסק בעיר כלשהי, ראוי לתת קישור לערך המבהיר את המושג "עיר", בדיוק כפי שבערך העוסק בקיבוץ ראוי לתת קישור לערך המבהיר את המושג "קיבוץ".
|-
| [[קובץ:Check mark.svg.png|25px]] || '''קישורים ברורים'''
| ניתן לקשר מילים שאינן בדיוק כשם הערך אליו רוצים לקשר, כפי שמפורט בדף [[עזרה:קישורים]]. עם זאת, יש לוודא, שברור לאן הקישור מוביל, מבלי שיהיה צורך להיכנס אליו. במקרים של מופע בצורת ריבוי, תוספת ה' הידיעה, אותיות השימוש או כל אות אחרת שאינה חלק מהמילה עצמה, ניתן לסמן רק את חלק המילה הרצוי במקום לסמן את כולה. זה קל יותר לקריאה, להבנה ולהדפסה.

:[[קובץ:Noia_64_apps_ktip.png|20px]] '''אין להשתמש''' ב"לחצו כאן" כמילה לקישור, מאחר שאינה מוסרת מידע.
:[[קובץ:Noia_64_apps_ktip.png|20px]] יש לקשר רק מילים שכבר נמצאות בתוכן, או לנסות להכניס את הקישור לרצף התוכן (או להוסיף לערך תוכן, באופן לא מאולץ, שיאפשר את הוספת הקישור). אם לא - ניתן לשים את הקישור בסוף הערך, תחת פסקת "ראו גם". בכל מקרה, שם הקישור צריך לציין את הנושא אליו הוא מקשר.
| ניתן לקשר מילים שאינן בדיוק כשם הערך אליו רוצים לקשר:
:<nowiki>[[שם הערך אליו מקשרים|המילה המקשרת]]</nowiki>
|}

===ראו גם ולקריאה נוספת===

{| class="wikitable"
! !! הנחיה !! הסבר !! דוגמאות
|-
| [[קובץ:Check mark.svg.png|25px]] || '''מיקום פרקים נוספים''' || ראש פרק "ראו גם" יבוא לפני פרק "לקריאה נוספת" ופרק "קישורים חיצוניים". 
|-
! colspan="5" style="background:#ddeeff;" | <h4>ראו גם</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''קישורים בפרק ראו גם''' || פרק "ראו גם" נועד לקשר את הקוראים לערכים רלוונטיים, שיש בהם רקע או הרחבה שמסייעים בהבנת הנושא שבו עוסק הערך הנוכחי.

:[[קובץ:Noia_64_apps_ktip.png|20px]] על פי רוב, הכוונה לערכים '''שלא נזכרו''' עדיין בין קישורי גוף הערך, ולעתים, לכאלו שכן נזכרו, אך הם מרכזיים וחשוב להדגישם, שכן הבנת הנושא עשויה שלא להיות שלמה ללא קריאתם, או שאזכורם הקודם בערך היה אגבי מדי ביחס לחשיבותו.
:[[קובץ:Noia_64_apps_ktip.png|20px]] בדרך כלל, אין צורך לכלול בסעיף זה ערכים הנכללים ב[[חב"דפדיה:קטגוריה|קטגוריה]] שאליה משתייך הערך, משום שדי בשיוך לקטגוריה להגשמת מטרתו של הסעיף "ראו גם". כאשר הקטגוריה גדולה, ורוצים להסב את תשומת לב הקורא לערכים מעטים מתוכה, יש מקום לכלול אותם גם תחת "ראו גם". 
:[[קובץ:Noia_64_apps_ktip.png|20px]] פסקת "ראו גם" מעוצבת כרשימה, והערכים יימנו שם ברשימת תבליטים - כל קישור לערך בשורה משלו.
|
<poem>{{ללא גלישה|<nowiki>== ראו גם ==</nowiki>}}
<nowiki>* [[שורו]]</nowiki>
<nowiki>* [[הביטו]]</nowiki>
<nowiki>* [[וראו]]</nowiki>
</poem>
|-
! colspan="5" style="background:#ddeeff;" | <h4>לקריאה נוספת</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הפניות לספרות''' || מעבר לקישורי אינטרנט, אפשר לציין מקורות פיזיים לא מקוונים (לא באינטרנט) למידע, שיכולים להרחיב עליו (ביבליוגרפיה): ספר או מאמר רלוונטי. רוב המידע בימינו עודנו נמצא בספרים, ורצוי להפנות אליהם.

כמו כן, רצוי לכלול "מראי מקום" - אם יש בערך התייחסות ספציפית למקור חיצוני או ציטוט ממנו. למשל, אם בערך מוזכר למשל מאמר, כדאי להפנות למאמר עצמו ב'''[[חב"דפדיה:ביבליוגרפיה]]'''.
|-
! colspan="5" style="background:#ddeeff;" | <h4>קישורים חיצוניים</h4>
|-
| [[קובץ:Check mark.svg.png|25px]] || '''הפניות לאתרים''' || יש מקרים בהם ראוי להוסיף מידע יותר מפורט, או בנושא יותר ספציפי, או תוכן שאינו מילולי (תמונות, נתונים, גרפים וכדומה), שמקורו ברשת האינטרנט. הדבר חשוב במיוחד, כשאתר אינטרנט משמש כמקור מידע עיקרי. הפרק "קישורים חיצוניים" יבוא בסוף הערך אחרי הפרק "לקריאה נוספת". דרך כתיבת הקישור בוחב"דפדיה מוסברת ב[[חב"דפדיה:קישורים חיצוניים]].

:[[קובץ:Noia_64_apps_ktip.png|20px]] הסתייעו ב[[:קטגוריה:תבניות קישורים חיצוניים|תבניות קישורים חיצוניים]] לשמירת אחידות במראה ההפניות לקישורים חיצוניים
|}

===שיוך לקטגוריות ולתבניות ניווט===
ראו: [[חב"דפדיה:קטגוריה]] וכן [[חב"דפדיה:תבניות]]

== טקסט מיוחד ==
כאשר מתייחסים במשפט למונח מסוים ולא משתמשים בו באופן או במובנו הרגיל, יש לסמנו במרכאות כפולות (") או בכתב מודגש. ב[[עברית]], אין משתמשים בכתב נטוי (''Italic''. למשל:
* המונח "התאבכות" מקורו במילה ה[[תלמוד]]ית "אובך".
* '''י''' היא העשירית באותיות ה[[אלפבית עברי|אלפבית העברי]].

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

בציון [[תאריך|תאריכים]] יש להשתמש בפורמט מסוים כפי שנכתב בדף [[חב"דפדיה:תאריכים]]. כך גם לגבי [[מספר]]ים. ככלל, מספרים עד עשר או כל מספר בראש מילה צריכים להיכתב במילים ולא בספרות. אין להשתמש בסימן % אלא במילה "אחוזים".

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

===תבניות===
נמצאות גם [[חב"דפדיה:תבנית|תבניות]] מוכנות שחוזרות בחב"דפדיה ותורמות לשמירה על [[חב"דפדיה:אחידות|אחידות]] וניתן להעתיקן לעבודה מהירה יותר, ובכל אופן רצוי להשתמש בפורמט אותן הן מציגות. לרשימת תבניות מלאה ראו [[חב"דפדיה:רשימת תבניות|רשימת תבניות]]. דוגמאות ספציפיות:
* [[חב"דפדיה:תבנית דף|תבנית דף]] - לכתיבת ערך

אל תתחכמו ותתהדרו. לא תמיד תוספות סגנוניות ועיצוב מיוחד שאתם כותבים באמת יופיעו כפי שתכננתם. ערך גם לא אמור להיות חזיון טכניקולור מולטימדי, זאת עדיין אנציקלופדיה. קל להציג את חב"דפדיה, וקל לערוך ולהוסיף לערכיה, כל עוד אנחנו לא הופכים את שפת הכתיבה למסובכת מכדי הצורך להציג את המידע בדרך שימושית ובהירה. מכאן שהוספת קודי HTML צריכה לעשות בקומץ יד ומסיבה מוצדקת. זכרו שהמטרה היא קודם כל אנציקלופדיה שימושית, ומיד אחר-כך קלה לעריכה ולשיפוץ. עיצוב ואפקטים הם אמצעים לשירות מטרה זו ותו לא.

[[קטגוריה:חב"דפדיה: סגנון|מדריך לעיצוב]]