Formatierung der Dokumentation

Das Basisausgabeformat für die generierte Dokumentation ist HTML. Für die Formatierung von HTML-Dateien wurde mit CSS (Cascading Style Sheets) durch das World Wide Web Consortium (W3C) eine Stylesheet-Sprache zur Verfügung gestellt, welche die Darstellungsvorgaben von den Inhalten trennt. Bei der Generierung der Dokumentation stellen Sie somit durch die Auswahl einer CSS-Datei ein, wie die generierte Dokumentation formatiert sein soll (siehe Auswahlfeld CSS template).

Der Vorteil dieses Vorgehens ist, dass Sie die Dokumentation im SPS-Code frei von Formatierungsanweisungen erstellen können. Für die Formatierung stellen Sie eine oder mehrere CSS-Dateien zur Verfügung, die die generierte Dokumentation entsprechend anpassen, ohne dass Änderungen an der Dokumentation erfolgen müssen.

Nach der Installation des Workloads TE1030 | TwinCAT 3 Documentation Generation befinden sich im Ordner
C:\Program Files (x86)\Beckhoff\TwinCAT\3.1\Components\TcDocGen\Templates\CSS
zwei Beispieltemplates für CSS-Dateien. Diese können Sie entsprechend Ihrer Bedürfnisse erweitern oder abändern. Die abgeänderten oder neu erstellten Templates müssen wieder in diesem Ordner verfügbar sein, um verwendet werden zu können.
Es gibt zwei Möglichkeiten die Templates in diesem Ordner zur Verfügung zu stellen:

  1. Sie können die geänderten oder neuen Templates manuell in den Ordner kopieren.
  2. Sie können anhand des Buttons hinter den CSS-Templates ein Auswahlfenster öffnen und die Templates auswählen. Diese werden dann automatisch in den Ordner kopiert.