Dokumentation / Screenshots

TDF LibreOffice Document Liberation Project Community Blogs Weblate Nextcloud Redmine Ask LibreOffice Spende

• Start
• Entwicklung
• Gestaltung
• QA
• Events
• Dokumentation
• Webseite
• Lokalisierung
• Barrierefreiheit
• Marketing
• Diversität
• Wiki Hilfe

• Dokumentation Start
• Handbücher
• Andere Quellen
• FAQ
• HowTo
• Makros
• Doku Entwicklung

Screenshots zur Dokumentation

Diese Seite beschreibt, wie man Screenshots der LibreOffice Dialoge anfertigt und sie in die LibreOffice Dokumentation/Hilfe einfügt. Die Voraussetzung ist ein git clone des LibreOffice Hilfe repositorys und/oder des build core LibreOffice Kerns inklusive der Hilfe (--with-help switch). Für Screenshots in mehreren Sprachen verwende die --with-lang=$language_list, wobei "$language_list" eine Liste von zwei- oder drei-stelligen Sprachcodes getrennt durch ein Leerzeichen ist, also zum Beispiel en-us de fr es ru.

Grundfunktionen

Jeder LibreOffice Dialog hat eine eindeutige Hilfe-ID so dass die Hilfe die korrekte Hilfe-Seite aufrufen kann, wenn der Nutzer Informationen zu einem bestimmten Dialog benötigt. Die Hilfe-ID sieht üblicherweise so aus:

cui/ui/areatabpage/AreaTabPage

Z. Bsp. wird hier ein Pfad zur .ui-Datei des Dialoges gespeichert. Wir haben uns entschieden, IDs der Dialog-Screenshots zu verwenden (und deren Pfade wo die Bilder gespeichert sind). Bitte benutze die Hilfe-IDS, um unnötige Redundanzen zu vermeiden. In diesem Beispiel liegt der obige Dialog unter (Format ▸ Area).

cui/ui/areatabpage/AreaTabPage.png

und seine lokalisierte Version (wobei "$language_code" ein zwei- oder drei-stelliger Sprachcode der vorgegebenen Sprache ist) hier zu finden ist:

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

Innerhalb des LibreOffice (Hilfe-)Quelltextes werden die Dateien mit den Screenshot-Bildern der Hilfe-Seiten (.xhp-Dateien) im folgenden Ordner gespeichert:

helpcontent2/source/media/screenshots

in den zugehörigen Pfade zu den Screenshot-IDs wie oben angegeben.

Serien von Screenshots automatisch erstellen

Um Screenshots for jeden Dialog in LibreOffice in einem Arbeitsgang zu erzeugen, gehe wie folgt vor:

Schreenshot erzeugen

im Wurzel-Verzeichnis Deines LibreOffice Verzeichnis-Baumes. Du kannst außerdem Screenshots aus individuellen Modulen erzeugen. Für den Moment erzeugt das folgende Kommando Screenshots für alle LibreOffice Calc (sc) Dialoge:

make sc.screenshot

Nachdem das Kommando ausgeführt wurde befindet sich der Screenshot im folgenden Verzeichnis in Ihrem LibrerOffice Verzeichnis-Baum:

workdir/screenshots

in den zugehörigen Pfaden zu den Screenshot-IDs wie oben beschrieben. Falls Du LibreOffice mit mehrfacher Sprach-Unterstüzung erzeugt hast (--with-lang, wie oben beschrieben), wird dieser Screenshot automatisch in all languages erzeugt werden, die Sie verwenden.

Screenshots automatisch erzeugen

Um Dialog-Screeshots aus dem laufenden LibreOffice zu erzeugen aktiviere bitte den Screenshot-Modus (ähnlich dem Experimental Modus) in Extras ▸ Optionen... ▸ Erweitert ▸ Experteneinstellungen... der betreffende Einstellungs-Key ist org.openoffice.Office.Common.Misc.ScreenshotMode. Sobald der Screenshot-Modus aktiviert ist führt ein Rechts-Klick in irgendeinen Aktivierungs Bereich eines Dialogs (dort wo "OK" und "Abbruch"-Buttons sind) zum Kontext-Menü:

Klicke auf "Screenshot" im Kontext-Menü um einen Screenshot des aktuellen Dialoges zu erzeugen. In dem Fenster das sich öffnet erscheint eine Vorschau des Screenshots und ein Text-Bereich. Wenn das Ergebnis passt, klicke bitte auf "Screenshot speichern..." um den Screenshot ins Verzeichnis Deiner Wahl zu speichern, vorzugsweise in den Ordner helpcontent2/source/media/screenshots im Pfad der Screenshot-ID.

Erklärung im Video

Bitte ggf. passende Untertitel aktivieren:

Bitte akzeptieren Sie dieses Video. Dadurch gelangen Sie an Inhalt von YouTube, einem Service, der von einer dritten Partei bereitgestellt wird.

YouTube privacy policy

Akzeptiere YouTube

Screenshots in Hilfe-Seiten einfügen

1. Falls Sie den Screenshot mit make screenshot erzeugt haben, kopieren Sie bitte den Screenshot aus dem Ordner workdir/screenshots in den Ordner helpcontent2/source/media/screenshot.
2. Falls Sie den Screenshot manuell erzeugt haben ist der beste Ansatz, den Screenshot direkt unter helpcontent/source/media/screenshots entsprechend dem Screenshot-ID Pfad zu speichern.

Nun können Sie Ihren bevorzugten Weg, die Hilfe zu bearbeiten nutzen (entweder manuell oder HelpAuthoring extension). Ein .xhp Schnipsel in die Hilfe-Datei eingefügt kann z. Bsp. wie folgt suchen (für den oben im Screenshot hervorgehobenen Bereich)

<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>

Alternativ können Sie, wenn Sie den Screenshot manuell erzeugt haben, den markierten Schnipsel wie erzeugt in den Screenshot Dialog einfügen.

Ihre Änderungen bestätigen

Es gibt keine Unterschiede beim Bestätigen anderer Änderungen in der Hilfe, der einzige Trick besteht darin, neue Dateien mit den Screenshots in die neueste Version einzufügen.

git add source/media/screenshots/screenshot/you/have/added.png 
git add source/text/help/file/you/have/changed.xhp
git commit -m "Added new cool screenshots"