פנגייה

סטנדרט SI-Fang

הקדמה

קובץ זה מכיל מספר חוקי עשה/אל תעשה, שאני בעצמי לא תמיד עוקב אחריהם (במיוחד הישנים יותר), אבל כדאי לשמור עליהם כדי להיות כמה שיותר עקביים. חוקים בסיסיים כמו לכתוב במקום לא אתייחס.

חלק מהחוקים כאן אולי נדמים כלא יעילים, או לא אסתטיים. יכול להיות כי אני מטומטם יכול להיות כי ככה יותר נוח לי להמיר את הקבצים ל-.

צורת הסיכומים

מבנה כללי

  • כל קורס יימצא תחת תיקייה עם שלוש אותיות בלועזית שמדמות את שם הקורס, עם ספרה אחת המציינת את מספר הקורס. למשל, עבור מכניקת מוצקים 2מ’: SLD2 Solid Mechanics 2.
  • כל קובץ סיכום בתוך תיקיית הקורס יתחיל עם תעודת זהות זאת של הקורס, כולל תת-תיקיות.
  • הקובץ הראשי בתיקיית הקורס יכלול את השם המלא של הקורס, מספר הקורס, ויהיה בעל מספור תלת ספרי 000. למשל, SLD2_000 034053 מכניקת מוצקים 2מ. שאר הסיכומים, יכללו גם מספור תחת ספרתי, בסדר עולה - 001, 002, 003.
  • הקובץ הראשי יכיל קישורים לשאר הסיכומים בקורס.
  • לכל קובץ סיכום תותאם תיקיית קבצים רלוונטיים, ששמה הוא תעודת הזהות הספציפית עבור קובץ סיכום זה. למשל, עבור SLD2_001 טנזור המאמץ, שם התיקייה הרלוונטית היא SLD2_001. אם יש קוד רלוונטי לסיכום, הוא יימצא תחת תיקיה בשם code תחת תיקיה זו.
  • כל קובץ סיכום, שנקרא לו נושא/פרק למען נוחיות, לא יכיל מספר רב תת-נושאים שלא יכלו כבר לקבל קובץ סיכום משלהם. רוב הקורסים יכילו בין 7 ל-15 נושאים. בדרך כלל נושא אחד להרצאה אחת.

תוכן ומבנה הנושאים

  • רוב הנושאים יתחילו בכותרת ראשית (# ב-markdown) של ‘מבוא’ או ‘הקדמה’.

  • מותר יותר מכותרת ראשית אחת בנושא. כמובן גם זה במידה.

  • כל נושא יכיל גם את התרגולים הרלוונטיים אליו, ולא בקובץ תרגול נפרד.

  • כל תרגיל נפרד בתרגולים לא יופרד ע”י מספור, אלא פשוט ע”י ---.

    עשה

    תרגיל:
    תרגיל מספר 1.

    תרגיל:
    תרגיל מספר 2.

    אל תעשה

    תרגיל:

    1. תרגיל מספר 1
    2. תרגיל מספר 2

  • ככלל, כדאי להימנע מ-nesting - רשימת נקודות בתוך רשימה ממסופרת בתוך עוד רשימה וכו’…

  • את שאר

תכנים כלליים

תמונות

  • לכל תמונה יש לשים caption, כלומר תיאור תמונה (חוץ מתמונות בתוך callouts, שמה נתון לשיקול דעת).

    עשה

    לוגו הפנגייה

  • אין להגדיר לתמונות להיות עם אורך של יותר מ-600px.

  • יש תמיד להגדיר תמונות כך שהרקע שלהן ישתלב ביחד עם הרקע של העמוד. ניתן לעשות זאת בעזרת book או, אם רוצים כמה שיותר לשמר את הצבעים, bookhue.

משוואות

  • אין לרשום משוואות ארוכות סתם כי אפשר.

    עשה:

    אל תעשה:

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

    עשה:

    אל תעשה:

    אבל, לפעמים, אם לאחר הסימן שווה () השני או יותר מופיעה הצבה של פרמטרים, אז זה בסדר:

    עשה:

יחידות

  • יש לשים יחידות בתוך \pu{}. כפל בין היחידות לסמן ב-., ויחידות בסימונם ההופכי ב-^{-1}. אם אין הרבה מקום אופקי, ניתן גם לשים את היחידות ב-\frac{}{}.

    עשה:

    1. \pu{523.53kPa}
    1. \pu{231.5kJ.kmol.km^{-1}.m^{-1}}
    1. \pu{250\frac{kJ}{kg.K}}

    אל תעשה:

    1. 10kg*m*s^{-2}

סימונים

  • במידה ומופיע חזקה על ביטוי עם צִיּוּן תַּחְתִּי, החזקה תופיע ימינה מהציון תחתי, ולא מעליו.

    עשה:

    אל תעשה: