Bilder

Bilder können mit der Direktive image in den Kommentar eingebunden werden.

Beschreibung

Die Direktivenmarkierung besteht aus einem expliziten Markup-Start („.. “) gefolgt vom Typ der Direktive (image) und zwei Doppelpunkten.

(Siehe auch: Direktiven)

Prinzip

.. image::

Eigenschaften

Der Speicherpfad für die Bildquelldatei wird im Argument der Direktive angegeben. Wie bei Hyperlink-Zielen kann der Speicherpfad in derselben Zeile wie der explizite Markup-Start oder in einem eingerückten Textblock unmittelbar danach beginnen (ohne dazwischenliegende Leerzeilen). Der Speicherpfad kann absolut oder relativ angegeben werden und darf keine Leerzeichen enthalten. (Siehe: Absoluter oder relativer Speicherpfad als Direktivenargument)
Das Bild wird entsprechend der Fensterbreite des Bibliotheksverwalters größtmöglich (=100%) angezeigt. Wird die Fensterbreite des Bibliotheksverwalters verändert, bleibt die Proportionalität des Bildes erhalten.
Zwischen der Direktive und einem vorangehenden Textkörperelement (z. B. einem Absatz mit Text) ist eine Leerzeile notwendig.

Optionen

Optional kann der Direktivenblock eine flache Feldliste mit Bildoptionen enthalten. Folgende Optionen werden erkannt:

height: length	Höhe des Bildes. Wird verwendet, um das Bild vertikal zu skalieren. Die Breite des Bildes wird nach Möglichkeit proportional dazu angepasst. Angabe in px (mit oder ohne Leerzeichen): Die Höhe des angezeigten Bildes entspricht immer der angegebenen Höhe des Bildes in px unabhängig von der Höhe und Breite des Bibliotheksverwalter-Fensters. Wenn die Höhe des Bibliotheksverwalter-Fensters kleiner als die angegebene Bildhöhe ist, können Sie durch Scrollen innerhalb des Bibliotheksverwalters den restlichen Teil des Bildes anzeigen. Die Bildbreite ist maximal so groß wie die Fensterbreite des Bibliotheksverwalters: Wenn das Bibliotheksverwalter-Fenster breit genug ist, wird das Bild proportional dargestellt. Ansonsten wird die Darstellung verzerrt. Die Proportionalität des Bildes ist somit abhängig von der Fensterbreite des Bibliotheksverwalters vorhanden.
width: length or percentage of the current line width	Breite des Bildes. Wird verwendet, um das Bild horizontal zu skalieren. Die Höhe des Bildes wird nach Möglichkeit proportional dazu angepasst. Angabe in px (mit oder ohne Leerzeichen): Die Breite des angezeigten Bildes entspricht nach Möglichkeit der angegebenen Breite des Bildes in px, ist aber maximal so groß wie die Fensterbreite des Bibliotheksverwalters. D. h. falls die Breite des Bibliotheksverwalter-Fensters kleiner als die angegebene Bildbreite ist, ist das Bild nur so breit wie das Bibliotheksverwalter‑Fenster. Die Höhe des Bildes wird proportional zur angegebenen Bildbreite angepasst. Die Proportionalität des Bildes ist somit abhängig von der Fensterbreite des Bibliotheksverwalters vorhanden. Angabe in % (mit oder ohne Leerzeichen): Die Breite des angezeigten Bildes nimmt den angegebenen prozentualen Anteil der Fensterbreite des Bibliotheksverwalters ein. Die Höhe des Bildes wird proportional zur Bildbreite angepasst. Die Proportionalität des Bildes ist somit vorhanden.
align: „left“ or „right“	Ausrichtung des Bildes. Die Werte „left“ und „right“ steuern die horizontale Ausrichtung eines Bildes, sodass das Bild schweben und der Text es umfließen kann.
target: text (URI or reference name)	Macht das Bild zu einem Verweis („clickable“). Das Argument der Option kann ein URI (relativ oder absolut) oder ein Referenzname mit Unterstrich-Suffix (z. B. name_) sein.
scale: integer percentage	Einheitlicher Skalierungsfaktor des Bildes. Wird verwendet, um das Bild proportional zu skalieren. Angabe in % (mit oder ohne Leerzeichen): Die Breite und die Höhe des angezeigten Bildes entsprechen immer dem angegebenen prozentualen Anteil der ursprünglichen Bildgröße (d. h. der Größe der Grafik, die im Dateisystem referenziert wird) unabhängig von der Breite und Höhe des Bibliotheksverwalter‑Fensters. Wenn die Breite bzw. die Höhe des Bibliotheksverwalter-Fensters kleiner als die angegebene Bildbreite bzw. -höhe ist, können Sie durch Scrollen innerhalb des Bibliotheksverwalters den restlichen Teil des Bildes anzeigen. Die Proportionalität des Bildes ist somit vorhanden.

Wenn ein Bild ohne height-, width- oder scale-Option eingebunden wird, entspricht die Breite des angezeigten Bildes der Fensterbreite des Bibliotheksverwalters. Die Höhe des Bildes wird proportional zur Bildbreite angepasst. Das Bild wird somit größtmöglich dargestellt. Die Proportionalität des Bildes ist vorhanden.

Absoluter oder relativer Speicherpfad als Direktivenargument

Im Argument der image-Direktive können Sie sowohl absolute als auch relative Speicherpfade angeben, um Bilder zu referenzieren.

Einen absoluten Speicherpfad geben Sie an, wenn das Bild in einem beliebigen Ordner Ihres Dateisystems gespeichert ist. Einen relativen Speicherpfad geben Sie an, wenn das Bild in das Bibliotheksprojekt eingebunden ist.

	Weitergabe der Bibliotheksdatei Wenn Sie die Bilder in das Bibliotheksprojekt einbinden und relative Speicherpfade verwenden und das Bibliothekprojekt dann als Datei weitergeben, werden die benötigten Bildinformationen direkt als Teil des Bibliotheksprojekts mitgeliefert. Wenn Sie absolute Speicherpfade verwenden, müssen die Bilder separat weitergegeben werden und bei demjenigen, der die Bibliothek verwendet, an der im Speicherpfad angegebenen Stelle im Dateisystem vorhanden sein. Letzteres ist eine statische Vorgehensweise, bei der die Organisation und Pflege der Bildinformationen im Dateisystem zusätzlichen Aufwand bedeutet.

Absoluter Speicherpfad

z. B. C:\Tc3LibDocImages\SamplePicAbsolute.jpg

Bilder 2:

Relativer Speicherpfad

Voraussetzung: TwinCAT 3.1.4022.22

z. B. ../../LibPics/SamplePicRelative.jpg

Bild in das SPS-Projekt einbinden

1. Legen Sie im SPS-Projektbaum für eine einheitliche Ablage und übersichtliche Projektstruktur einen Ordner für Bilder an (z. B. LibPics).

2. Wählen Sie im Kontextmenü des Ordners den Befehl Hinzufügen > Vorhandenes Element.

3. Wählen Sie im Dateisystem das Bild aus (z. B. SamplePicRelative) und bestätigen Sie den Dialog.

Das Bild wird dem SPS-Projekt hinzugefügt und kann bei der Dokumentation eines Bibliotheksobjektes in einem reStructuredText-Kommentar referenziert werden. (Siehe: Beispiele)

Beim Speichern des SPS-Projekts als Bibliothek wird das Bild mit in die Bibliotheksdatei gespeichert (*.library/*.compiled-library). Wenn die Bibliothek in einem SPS-Projekt referenziert wird, wird das Bild mit im Bibliotheksverwalter anzeigt. Per Doppelklick auf das Bild im Bibliotheksverwalter kann das Bild geöffnet werden.

Projektmappen-Explorer:

Bilder 3:

Bibliotheksverwalter:

Bilder 4:

Beispiele

(Im Beispielprojekt: B_DocuElements\Images\FB_Libdoc_Images)

Absoluter oder relativer Speicherpfad als Direktivenargument

(*
Absolute path

.. image:: C:\Tc3LibDocImages\SamplePicAbsolute.jpg
   :width: 70px

Relative path

.. image:: ../../LibPics/SamplePicRelative.jpg
   :width: 70px
*)

Bilder 5:

Bild linksbündig

(*
.. image:: C:\Tc3LibDocImages\SampleLib1\img11.jpg
   :width: 20%

Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
*)

Bilder 6:

Schwebendes Bild linksbündig

(*
.. image:: C:\Tc3LibDocImages\SampleLib1\img11.jpg
   :width: 20%
   :align: left

Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
*)

Bilder 7:

Schwebendes Bild rechtsbündig

(*
.. image:: C:\Tc3LibDocImages\SampleLib1\img11.jpg
   :width: 20%
   :align: right

Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
Description of the function block. Description of the function block. Description of the function block.
*)

Bilder 8:

Inline-Bilder können mit einer image-Direktive in einer Substitutionsdefinition definiert werden (siehe Substitution).