תיעוד/צילומי מסך

From The Document Foundation Wiki
Jump to navigation Jump to search
This page is a translated version of the page Documentation/Screenshots and the translation is 58% complete.
Other languages:
English • ‎dansk • ‎español • ‎italiano • ‎português do Brasil • ‎עברית

צילומי מסך לתיעוד

This page describes how to create screenshots of LibreOffice dialogs and include them in LibreOffice documentation/help. The precondition is to have a git clone of LibreOffice help repository and/or to build core LibreOffice code including help (--with-help switch). For screenshots in multiple languages, build with --with-lang=$language_list, where $language list is a list of two- or three-letter language codes separated by space, for example en-us de fr es ru

עקרונות בסיסיים

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

cui/ui/areatabpage/AreaTabPage

i.e. it resembles a path where this dialog's .ui file is stored. We have decided to have IDs of dialog screenshots (and thus file paths where screenshot images are stored) copy their help IDs in order to avoid maintaining of alternate mapping. Given that, the screenshot of the dialog above (Format ▸ Area) will be found in the following path:

cui/ui/areatabpage/AreaTabPage.png

and its localized version (where $language_code is a two- or three-letter code of the given language) in:

cui/ui/areatabpage/$language_code/AreaTabPage.png

Within LibreOffice (help) source tree, files with screenshot images that are included in help pages (.xhp files) are stored in the following folder:

helpcontent2/source/media/screenshots

in the paths corresponding to their screenshot IDs as outlined above.

יצירת סדרה של צילומי מסך אוטומטית

כדי ליצור צילומי מסך של כל חלונית שהיא ב־LibreOffice בבת אחת, יש להריץ את:

make screenshot

בתיקיית הבסיס של עץ קוד ה־LibreOffice שלך. ניתן גם ליצור צילומי מסך של מודולים פרטניים. למשל, הפקודה הבאה מייצרת צילומי מסך של כל החלוניות של LibreOffice Calc (sc):

make sc.screenshot

לאחר השלמת הפקודה הזאת, צילומי המסך יופיעו בתיקייה הבאה בעץ קוד המקור של ה־LibreOffice שלך:

workdir/screenshots

in the paths corresponding to their screenshot IDs as outlined above. If you have built LibreOffice with multiple language/locale support (--with-lang, see above), this screenshot run will automatically create screenshots in all languages you are building with.

יצירת צילומי מסך ידנית

To create dialog screenshots from running LibreOffice, you need to activate screenshotting mode (akin to experimental mode) in Tools ▸ Options ▸ Advanced ▸ Open Expert Configuration, the relevant configuration key is org.openoffice.Office.Common.Misc.ScreenshotMode. Once screenshotting mode is active, right mouse click into any dialog action area (where "OK", "Cancel" etc. buttons are) will make a context menu appear:

Screenshotmode.png

Click Screenshot item of the context menu to create screenshot of the current dialog. In the dialog that appears, you'll see a screenshot preview and a text area. If you're happy with the result, click Save Screenshot... button to store the screenshot into the folder of choice, preferably directly to helpcontent2/source/media/screenshots folder and the path corresponding to their screenshot ID.

= הסבר בסרטון

יש להפעיל כתוביות באנגלית:

הוספת צילומי מסך לעמודי עזרה

  1. If you have created screenshot with the help of make screenshot, copy the screenshot image from workdir/screenshots folder to helpcontent2/source/media/screenshot folder
  2. If you have created screenshot manually, the best approach is to save it directly to helpcontent/source/media/screenshots, respecting screenshot ID path.

Now you can use your preferred way of editing help files (either manually or using HelpAuthoring extension). A .xhp snippet to be included in the help file can look for example like this (for the above area tab dialog, path to screenshot image highlighted):

<paragraph id="par_id083120160609088310" role="paragraph" xml-lang="en-US"><image id="img_id083120160608495768" src="media/screenshots/cui/ui/areatabpage/AreaTabPage.png"
 width="9.0417in" height="6.9791in"><alt xml-lang="en-US" id="alt_id083120160608495768">Area dialog</alt></image></paragraph>

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

ScreenshotMarkup.png

הגשת השינויים שלך

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

git add source/media/screenshots/screenshot/you/have/added.png 
git add source/text/help/file/you/have/changed.xhp
git commit -m "נוספו צילומי מסך מגניבים"