6,817
edits
Changes
From Gramps
m
The specification of the את מפרט ה־API לרכיב Textdoc API is ניתן למצוא בקישור הבא: [https://gramps-project.org/docs/gen/gen_plug.html#gramps.gen.plug.docgen.textdoc.TextDoc hereTextDoc]
The interface for adding media objects is as followsהמנשק להוספת עצמי מדיה הוא כדלקמן:
Note that because of the structure of these documents, Images are only allowed as children (i.e. following) Document or Cell. This interface is used in the following reportsמנשק זה משמש בדוחות הבאים: {| {{Prettytable}}
None of the reports use הדוחות הללו לא משתמש במלל חלופי 'alt'. It is understood (from looking at the code in odfdocמבחינת שורות הקוד ב־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. 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מכיוון ש־style_name צריך לשמש כסגנון עבור הכתובית (כלומר מחרוזת '''alt'''), output appears as follows:יש להשתמש בו גם עבור התמונה עצמה. אחרת הכתובית לא תופיעה מתחת ובצמוד לתמונה.<br>
→מסמך API מילולי: format
[[Image:Doc_paper.png|left|thumb|400px]] התיאור ומאפייני הדף אליו יועבר תצוג כל דוח באשר הוא, מאוחסן על ידי אדגם [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.paperstyle Classyle]. אדגם זה זמין דרך תכונת מחלקה <tt>basedoc.paper_style</tt>. סוג ה־PaperStyle שנבחר מועבר למחולל המסמכים בעת האתחול, ומטופל על ידי מסגרת פתוח הדוחות.
רכיב <tt>PaperStyle</tt> מכיל מידע על גודל הדף ([http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle מחלקה PaperSize ] לדוגמה), גודל השוליים וכיוון הדף. כדי לקבל את הערכים יש להשתמש בשיטות העזר המתאימות. כדי לקבל את תשקיל האזור בו ניתן להשתמש בדף (דף ללא שוליים) אפשר גם להשתמש ב[http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle שיטות נוחות .PaperStyle.get_usable_width PaperStyle.get_usable_widthרוחב שמיש] ו־[http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle.get_usable_height PaperStyle.get_usable_heightגובה שמיש]. רוחב וגובה מתקבלים תמיד לפי כיוון הנייר (לאורך או לרוחב), ולכן הרוחב הוא תמיד הממד האופקי והגובה הוא תמיד הממד האנכי.
לדוחות מלל אין צורך לדאוג למאפייני דף, שכן מחולל המסמכים (או המשקף החיצוני) מספרר את הדוח בהתאם לאותם מאפיינים. מאידך, דוחות חזותיים כן נדרשים להתחשב במאפייני הדף בעת יצירת רכיבים חזותיים, כלומר הם לא אמורים לגלוש לשוליים.
{{-}}
==מסמך API מילולי API==
<div dir="ltr">
<pre>
add_media_object(name, align, w_cm, h_cm, alt='', style_name=None, crop=None)[sourceמקור]</pre> Add a photo of the specified width </div>הוספת תמונה ברוחב שצוין (in centimetersבסנטימטרים). Parametersמשתנים: <div dir="ltr"> <pre> name – filename of the image to addשם קובץ התמונה אותה מעוניינים להוסיף‏ align – alignment of the imageיישור התמונה. Valid values are ‘left’, ‘right’ערכים תקינים הם 'שמאל', ‘center’'ימין', and ‘single’'מרכז' ו'יחיד'‏ w_cm – width in centimeters‏ רוחב בסנטימטרים h_cm – height in centimetersגובה בסנטימטרים alt – an alternative text to useמלל חלופי בו ניתן להשתמש. Useful for eg html reportsשימושי לדוגמה בדוחות HTML style_name – style to use for captionsשם הסגנון בו יעשה שימוש בכתוביות crop – image cropping parametersמשתנים לחיתוך תמונה
</pre>
</div>
לתשומת לב! עקב מבנה מסמכים אלה, תמונות מותרות רק כמסמכי או תאי צאצא (כלומר עקיבה).
|-
! Reportדוח! Built-inסוג! alignיישור! style_nameשם סגנון! how calledאופן קריאה
|-
| Detailed Ancestral Reportדו"ח אבות־קדמונים מפורט| Built-inמובנה| rightימין
| DDR-Caption
| via על־ידי gen/plug/report/utils.py
|-
| Detailed Descendant Reportדוח צאצאים מפורט| Built-inמובנה| rightימין
| DDR-Caption
| via על־ידי 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
| directיָשִׁיר
|-
|}
נכון לדצמבר 2014, הפלט מופיע כדלקמן:
{| {{Prettytable}}
|-
! Formatתסדיר! rightימין! centerמרכז! singleיחיד
|-
| HTML
| '''OKבסדר''' Picture on rightתמונה מימין, text wrapped round itמלל עטוף סביבה
| ?
| Picture on left marginתמונה בצמוד לשוליים השמאליים, text not wrappedמלל לא עטוף
|-
| RTF
| Picture on left marginתמונה בצמוד לשוליים השמאליים, text not wrappedמלל לא עטוף
| ?
| '''OKבסדר''' Picture aligned with previous paragraphתמונה מיושרת לפסקה הקודמת, text not wrappedמלל לא עטוף
|-
| ODF
| '''OKבסדר''' Picture on rightתמונה מימין, text wrapped round itמלל עטוף סביבה
| ?
| Picture centredהתמונה ממורכזת, text not wrappedמלל לא עטוף
|-
| PDF
| Picture on rightתמונה מימין, text not wrappedמלל לא עטוף
| ?
| Picture on left marginתמונה בצמוד לשוליים השמאליים, text not wrappedמלל לא עטוף
|-
|}
