Documentation 0.1

Common Content

מהדורה 0

Dude McDude

My Org Best Div in the place

הודעה משפטית

Copyright © 2009 Red Hat, Inc.. This material may only be distributed subject to the terms and conditions set forth in the Open Publication License, V1.0, (the latest version is presently available at http://www.opencontent.org/openpub/).
Fedora and the Fedora Infinity Design logo are trademarks or registered trademarks of Red Hat, Inc., in the U.S. and other countries.
Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat Inc. in the United States and other countries.
All other trademarks and copyrights referred to are the property of their respective owners.
Documentation, as with software itself, may be subject to export control. Read about Fedora Project export controls at http://fedoraproject.org/wiki/Legal/Export.

(preface title goes here)

1. מוסכמות לתיעוד

מדריך זה משתמש במספר מוסכמות לצורך הדגשת חלק מהמילים והמשפטים ובכדי להסב את תשומת הלב לפרטי מידע מסוימים.
בגרסאות המסמך המודפסות או השמורות בפורמט PDF, המדריך משתמש בגופנים הנלקחים מתוך Liberation Fonts. אם גופנים אלו מותקנים במערכת, אזי גם גרסת ה-HTML משתמשת בהם לתצוגה. במידה ואין הדבר כך, המסמך מוצג בגופנים שקולים אחרים. הערה: גופני Liberation Fonts כלולים כברירת מחדל במערכת Red Hat Enterprise Linux מגרסה 5 והלאה.

1.1. מוסכמות טיפוגרפיות

ארבע מוסכמות טיפוגרפיות משמשות למשיכת תשומת הלב למילים ומשפטים מסוימים. להלן המוסכמות ונסיבות השימוש בהן.
ריווח קבוע ומודגש
משמש להצגת קלט מהמערכת, לרבות פקודות מעטפת, שמות קבצים ומסלולים. כמו כן, משמש גם להדגיש מקשי מקלדת וצירופי מקשים. לדוגמה:
להצגת תוכן הקובץ my_next_bestselling_novel בתיקיה הנוכחית יש להקליד את הפקודה cat my_next_bestselling_novel בשורת הפקודה ולהקיש על מקש Enter לצורך הפעלתה.
המשפט לעיל מכיל שם קובץ, פקודת מעטפת ותיאור מקש, כולם מוצגים בגופן מודגש בעל ריווח קבוע וניתן להבחין ביניהם על פי ההקשר.
ניתן להבדיל בין מקשים לצירופי מקשים בעזרת המקף המחבר בין החלקים השונים של הצירוף. לדוגמה:
יש להקיש Enter לביצוע הפקודה.
יש להקיש Ctrl+Alt+F1 כדי לעבור למסוף הווירטואלי הראשון. נא להקיש Ctrl+Alt+F7 לצורך חזרה לסביבת העבודה הגרפית.
המשפט הראשון מציין מקש מסוים במקלדת. המשפט השני מציין שני צרופים של שונים של שלושה מקשים כל אחד המופעלים ביחד.
כאשר מדובר על קוד מקור, נשתמש באותן מוסכמות לציון שמות משתנים, פונקציות, ערכים מוחזרים, שמות מחלקות ופונקציות החברות במחלקה. הן יסומנו בתוך הפסקה בגופן מודגש בריווח קבוע. לדוגמה:
מחלקות קשורות לקבצים כוללות filesystem עבור מערכות קבצים, file עבור קבצים וכן dir עבור תיקיות. לכל מחלקה משויך אוסף הרשאות משלה.
גודל מותאם יחסית ומודגש
גופן זה מציין מילים ומשפטים המופיעים במערכת, כגון שמות ישומים; מלל בתיבות שיחה; תגיות של כפתורים מסוגים שונים; כותרות תפריטים ותתי תפריטים. למשל:
יש לבחור מערכת > העדפות > עכבר מסרגל התפריטים הראשי כדי להפעיל את העדפות עכבר. בכרטיסיית כפתורים יש לבחור את עכבר לשמאליים וללחוץ על כפתור סגור לצורך החלפת הכפתור הראשי של העכבר משמאל לימין (כך שיתאים לשימוש ביד שמאל).
להכנסת תווים מיוחדים לקובץ gedit, יש לבחור מסרגל התפריטים הראשי ישומים > עזרים > מפת תווים. מתפריט היישום מפת תווים צריך לבחור חיפוש > מצא ‎…‏ יש להקליד את שם התו בשדה חיפוש וללחוץ על כפתור הבא. התו שחיפשתם יודגש בטבלת התווים. נא ללחוץ לחיצה כפולה על התו המודגש, כדי להעתיק אותו לשדה מלל להעתקה ואז על כפתור העתק. עתה יש לחזור למסמך שלכם ולבחור מהתפריט של gedit את פעולות עריכה > הדבק.
כל שמות היישומים; שמות תפריטי המערכת; הפריטים מתוכם; שמות התפריטים של היישום וכמו כן שמות כפתורים ומלל המופיעים במנשק המשתמש, כולם מוצגים בגופן מותאם יחסית ומודגש וניתן להבחין ביניהם על פי ההקשר.
שימו לב לקיצור > המשמש לציון הניווט בתפריטים ותת-תפריטים. הדבר נעשה כדי להימנע מהצורך בתיאורים שקשה לעקוב אחריהם כמו 'נא לבחור עכבר מתת-התפריט העדפות מתוך תפריט מערכת בסרגל התפריטים'.
ריווח שווה מודגש ומוטה או ריווח יחסי מודגש ומוטה
הן במקרה של גופן בריווח שווה מודגש והן במקרה של גופן בריווח יחסי מודגש, התוספת של ההטיה מציינת שמדובר בטקסט בר החלפה או משתנה. ההטיה מבליטה שאין המדובר בטקסט שיש להקלידו ככתבו או טקסט המוצג כפי שהוא אלא שהטקסט משתנה לפי הנסיבות. למשל:
בכדי להתחבר למחשב מרוחק בעזרת ssh יש להקליד בשורת הפקודה ssh username@domain.name. אם שם המחשב המרוחק הוא example.com ושם המשתמש על המחשב הזה הוא john אז צריך להקליד ssh john@example.com.
הפקודה mount -o remount file-system מעגנת מחדש את מערכת הקבצים שצוינה. לדוגמה, כדי לעגן מחדש את מערכת הקבצים /home, הפקודה הנדרשת היא mount -o remount /home.
כדי לראות את הגרסה של חבילת תכנה מותקנת, יש להריץ את הפקודה rpm -q package. יתקבל פלט במבנה: package-version-release.
שימו לב למילים המודגשות והמוטות לעיל — username, domain.name, file-system, package, version ו-release. כל מילה כזו מציינת מקום של טקסט שיוקלד או שיוצג על ידי המערכת.
מלבד השימוש המקובל לכותרת של עבודה, אותיות מוטות מסמנות גם את השימוש הראשון במושג חדש חשוב. לדוגמה:
כאשר שרת HTTP אפאצ'י מקבל בקשות, הוא יוצר נימים או תהליכי בן כדי לטפל בהן. קבוצה זו של נימים או תהליכי בן ידועה בשם server-pool. בגרסה 2.0 של שרת אפאצ'י האחריות ליצירה וניהול של server-pools אלו הוסתרה בקבוצת מודולים הנקראת Multi-Processing Modules או בקיצור MPMs. בניגוד למודולים אחרים, ניתן לטעון רק רק מודול אחד מקבוצת MPM לשרת אפאצ'י.

1.2. מוסכמות לגבי ציטטות

שני מבנים מקובלים, לרוב מרובי שורות, מוצגים בצורה שונה מהטקסט הרגיל.
פלט הנשלח למסוף מוצג בגופן רומי בריווח אחיד כמודגם להלן:
books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs
תדפיס קוד מקור נכתבים בכתב רומי בריווח אחיד אך מודגשים ומוצגים כדלהלן:
package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[]) 
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Created Echo");

      System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
   }
   
}

1.3. הערות ואזהרות

לבסוף, אנו משתמשים בשלושה סימנים חזותיים לצורך הסבת תשומת הלב למידע חשוב.

הערה

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

שימו לב

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

אזהרה

אין להתעלם מאזהרות. התעלמות עלולה לגרום לאבדן מידע.

2. אנו זקוקים למשוב!

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