Difference between revisions of "Report API/he"

From Gramps
m (→‎מסמך API מילולי: format)
m (→‎מסמך API מילולי: format)
 
(6 intermediate revisions by the same user not shown)
Line 32: Line 32:
 
==מסמך API מילולי ==
 
==מסמך API מילולי ==
  
−
את מפרט ה־API לרכיב Textdoc  ניתן למצוא בקישור הבא: [https://gramps-project.org/docs/gen/gen_plug.html#gramps.gen.plug.docgen.textdoc.TextDoc]
+
את מפרט ה־API לרכיב Textdoc  ניתן למצוא בקישור הבא: [https://gramps-project.org/docs/gen/gen_plug.html#gramps.gen.plug.docgen.textdoc.TextDoc TextDoc]
  
 
המנשק להוספת עצמי מדיה הוא כדלקמן:
 
המנשק להוספת עצמי מדיה הוא כדלקמן:
Line 45: Line 45:
 
<div dir="ltr">
 
<div dir="ltr">
 
<pre>
 
<pre>
−
  name - שם קובץ התמונה אותה מעוניינים להוסיף
+
  name – שם קובץ התמונה אותה מעוניינים להוסיף&rlm;
−
  align – יישור התמונה. ערכים תקינים הם 'שמאל', 'ימין', 'מרכז' ו'יחיד'
+
  align – יישור התמונה. ערכים תקינים הם 'שמאל', 'ימין', 'מרכז' ו'יחיד'&rlm;
−
  w_cm - רוחב בסנטימטרים
+
  w_cm – &rlm; רוחב בסנטימטרים
−
  h_cm - גובה בסנטימטרים
+
  h_cm – גובה בסנטימטרים
−
  alt - מלל חלופי בו ניתן להשתמש. שימושי לדוגמה בדוחות HTML
+
  alt – מלל חלופי בו ניתן להשתמש. שימושי לדוגמה בדוחות HTML
−
  style_name - שם הסגנון בו יעשה שימוש בכתוביות
+
  style_name – שם הסגנון בו יעשה שימוש בכתוביות
−
  crop - משתנים לחיתוך תמונה
+
  crop – משתנים לחיתוך תמונה
 
</pre>
 
</pre>
 
</div>
 
</div>
Line 57: Line 57:
  
 
מנשק זה משמש בדוחות הבאים:
 
מנשק זה משמש בדוחות הבאים:
−
{| {{Prettytable}}  
+
{| {{Prettytable}}
 
|-
 
|-
−
! Report
+
! דוח
−
! Built-in
+
! סוג
−
! align
+
! יישור
−
! style_name
+
! שם סגנון
−
! how called
+
! אופן קריאה
 
|-
 
|-
−
| Detailed Ancestral Report
+
| דו"ח אבות־קדמונים מפורט
−
| Built-in
+
| מובנה
−
| right
+
| ימין
 
| DDR-Caption
 
| DDR-Caption
−
| via gen/plug/report/utils.py
+
| על־ידי gen/plug/report/utils.py
 
|-
 
|-
−
| Detailed Descendant Report
+
| דוח צאצאים מפורט
−
| Built-in
+
| מובנה
−
| right
+
| ימין
 
| DDR-Caption
 
| DDR-Caption
−
| via gen/plug/report/utils.py
+
| על־ידי gen/plug/report/utils.py
 
|-
 
|-
−
| Individual Complete Report
+
| דוח  אישי מלא
−
| Built-in
+
| מובנה
−
| right
+
| ימין
−
| None
+
| ללא
−
| direct
+
| יָשִׁיר
 
|-
 
|-
−
| Book (Title Page)
+
| ספר דוחות (עמוד השער)
−
| Built-in
+
| מובנה
−
| center
+
| מֶרְכָּז
−
| None
+
| ללא
−
| direct
+
| יָשִׁיר
 
|-
 
|-
−
| Person Everything
+
| דוח אדם כולל
−
| Addon
+
| תוסף
−
| single
+
| יחיד
 
| PE-Level%d
 
| PE-Level%d
−
| direct
+
| יָשִׁיר
 
|-
 
|-
 
|}
 
|}
  
−
None of the reports use 'alt'. It is understood (from looking at the code in odfdoc.py) that '''left''' and '''right''' alignment should cause the text to wrap around the media object, while for '''single''' alignment, there should be no text on either side of the media object.
+
הדוחות הללו לא משתמש במלל חלופי 'alt'. מבחינת  שורות הקוד ב־odfdoc.py ברור כי יישור ל'''שמאל''' ול'''ימין''' אמור לגרום למלל להתעטף סביב לעצם המדיה, בעוד שליישור  '''יחיד'', לא אמור להיות מלל משני הצדי עצם המדיה.
−
 
 
−
Since style_name should be used as the style for the caption (i.e. the '''alt''' string) it should also be used for the image itself. Otherwise the caption would not be below the picture.
 
  
−
As at December 2014, output appears as follows:
+
מכיוון ש־style_name צריך לשמש כסגנון עבור הכתובית (כלומר מחרוזת '''alt'''), יש להשתמש בו גם עבור התמונה עצמה. אחרת הכתובית לא תופיעה מתחת ובצמוד לתמונה.<br>
  
 +
נכון לדצמבר 2014, הפלט מופיע כדלקמן:
 
{| {{Prettytable}}
 
{| {{Prettytable}}
 
|-
 
|-
−
! Format
+
! תסדיר
−
! right
+
! ימין
−
! center
+
! מרכז
−
! single
+
! יחיד
 
|-
 
|-
 
| HTML
 
| HTML
−
| '''OK''' Picture on right, text wrapped round it
+
| '''בסדר''' תמונה מימין, מלל עטוף סביבה
 
| ?
 
| ?
−
| Picture on left margin, text not wrapped
+
| תמונה בצמוד לשוליים השמאליים, מלל לא עטוף
 
|-
 
|-
 
| RTF
 
| RTF
−
| Picture on left margin, text not wrapped
+
| תמונה בצמוד לשוליים השמאליים, מלל לא עטוף
 
| ?
 
| ?
−
| '''OK''' Picture aligned with previous paragraph, text not wrapped
+
| '''בסדר''' תמונה מיושרת לפסקה הקודמת, מלל לא עטוף
 
|-
 
|-
 
| ODF
 
| ODF
−
| '''OK''' Picture on right, text wrapped round it
+
| '''בסדר''' תמונה מימין, מלל עטוף סביבה
 
| ?
 
| ?
−
| Picture centred, text not wrapped
+
| התמונה ממורכזת, מלל לא עטוף
 
|-
 
|-
 
| PDF
 
| PDF
−
| Picture on right, text not wrapped
+
| תמונה מימין, מלל לא עטוף
 
| ?
 
| ?
−
| Picture on left margin, text not wrapped
+
| תמונה בצמוד לשוליים השמאליים, מלל לא עטוף
 
|-
 
|-
 
|}
 
|}

Latest revision as of 12:32, 8 October 2024

Gramps-config-language.png שפות: 

אנגלית  • עברית  • русский

Gramps-notes.png
מנשק Simple Document API

הוא מנשק API שנועד לדוחות (מנשק תכנות יישומים ) כדי לשרת כותבי תוספים עבור גרמפס

מנשק API של מסמך פשוט מיועד להצגה קלה של הנתונים וניתן להשתמש בו עם מנשק API לגישה קלה.

Gramps-notes.png

תוכן מאמר זה לא שלם או שהוא 'בדל' שמשמש כמציין מיקום.
נא לעדכן או להרחיב את הקטע הזה.


קיימים בגרמפס חמישה סוגים שונים של דוחות:

  • דוח מילולי
  • דוח חזותי
  • תרשים
  • ספר דוחות
  • עמודי מרשתת

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

API משותף

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

Gramps-notes.png
הערה!

את שיטות BaseDoc.open ו-BaseDoc.close יש ליישם על ידי מחוללי מסמכים מחלקה משנית.

עימוד

Doc paper.png
התיאור ומאפייני הדף אליו יועבר תצוג כל דוח באשר הוא, מאוחסן על ידי אדגם Classyle. אדגם זה זמין דרך תכונת מחלקה basedoc.paper_style. סוג ה־PaperStyle שנבחר מועבר למחולל המסמכים בעת האתחול, ומטופל על ידי מסגרת פתוח הדוחות.

רכיב PaperStyle מכיל מידע על גודל הדף (מחלקה PaperSize לדוגמה), גודל השוליים וכיוון הדף. כדי לקבל את הערכים יש להשתמש בשיטות העזר המתאימות. כדי לקבל את תשקיל האזור בו ניתן להשתמש בדף (דף ללא שוליים) אפשר גם להשתמש בשיטות נוחות. רוחב שמיש ו־גובה שמיש. רוחב וגובה מתקבלים תמיד לפי כיוון הנייר (לאורך או לרוחב), ולכן הרוחב הוא תמיד הממד האופקי והגובה הוא תמיד הממד האנכי.

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

מקור מערכת הצירים הוא תמיד הפינה השמאלית העליונה של האזור בו ניתן להשתמש.

מסמך API מילולי

את מפרט ה־API לרכיב Textdoc ניתן למצוא בקישור הבא: TextDoc

המנשק להוספת עצמי מדיה הוא כדלקמן: 

 add_media_object(name, align, w_cm, h_cm, alt='', style_name=None, crop=None)[מקור]

הוספת תמונה ברוחב שצוין (בסנטימטרים). משתנים: 

 name – שם קובץ התמונה אותה מעוניינים להוסיף‏
 align – יישור התמונה. ערכים תקינים הם 'שמאל', 'ימין', 'מרכז' ו'יחיד'‏
 w_cm – ‏ רוחב בסנטימטרים
 h_cm – גובה בסנטימטרים
 alt – מלל חלופי בו ניתן להשתמש. שימושי לדוגמה בדוחות HTML
 style_name – שם הסגנון בו יעשה שימוש בכתוביות
 crop – משתנים לחיתוך תמונה

לתשומת לב! עקב מבנה מסמכים אלה, תמונות מותרות רק כמסמכי או תאי צאצא (כלומר עקיבה).

מנשק זה משמש בדוחות הבאים:

דוח סוג יישור שם סגנון אופן קריאה
דו"ח אבות־קדמונים מפורט מובנה ימין DDR-Caption על־ידי gen/plug/report/utils.py
דוח צאצאים מפורט מובנה ימין DDR-Caption על־ידי gen/plug/report/utils.py
דוח אישי מלא מובנה ימין ללא יָשִׁיר
ספר דוחות (עמוד השער) מובנה מֶרְכָּז ללא יָשִׁיר
דוח אדם כולל תוסף יחיד PE-Level%d יָשִׁיר

הדוחות הללו לא משתמש במלל חלופי 'alt'. מבחינת שורות הקוד ב־odfdoc.py ברור כי יישור ל'שמאל ולימין אמור לגרום למלל להתעטף סביב לעצם המדיה, בעוד שליישור יחיד, לא אמור להיות מלל משני הצדי עצם המדיה.

מכיוון ש־style_name צריך לשמש כסגנון עבור הכתובית (כלומר מחרוזת alt), יש להשתמש בו גם עבור התמונה עצמה. אחרת הכתובית לא תופיעה מתחת ובצמוד לתמונה.

נכון לדצמבר 2014, הפלט מופיע כדלקמן:

תסדיר ימין מרכז יחיד
HTML בסדר תמונה מימין, מלל עטוף סביבה ? תמונה בצמוד לשוליים השמאליים, מלל לא עטוף
RTF תמונה בצמוד לשוליים השמאליים, מלל לא עטוף ? בסדר תמונה מיושרת לפסקה הקודמת, מלל לא עטוף
ODF בסדר תמונה מימין, מלל עטוף סביבה ? התמונה ממורכזת, מלל לא עטוף
PDF תמונה מימין, מלל לא עטוף ? תמונה בצמוד לשוליים השמאליים, מלל לא עטוף

מסמך תרשים API

Gramps-notes.png

This article's content is incomplete or a placeholder stub.
Please update or expand this section.


מסמך חזותי API

Gramps-notes.png

תוכן מאמר זה לא שלם או שהוא 'בדל' שמשמש כמציין מיקום.
נא לעדכן או להרחיב את הקטע הזה.


Retrieved from "https://www.gramps-project.org/wiki/index.php?title=Report_API/he&oldid=106361"