VKRC Documentation Generator Pro
dramat.eu
Home » VKRC-Handbuch » Plugins » Documentation Generator Pro English

Warum die Dokumentationserstellung seit 2024 fehlschlagen oder sich anders verhalten kann

Seit 2024 hat Microsoft ActiveX-Steuerelemente standardmäßig deaktiviert in Microsoft 365 und Office 2024 (siehe offizielle Ankündigung von Microsoft).
Dieses Plugin steuert MS Word über dessen COM/ActiveX-Automatisierungsschnittstelle, und Word verweigert jetzt das Erstellen neuer ActiveX-Objekte, solange es auf diese Weise automatisiert wird, sofern Sie dies nicht ausdrücklich erlauben.
Am stärksten betroffen ist das Tag recursiveimg mit einem *.xlsx-Filter, das ein aktives MS Excel-Arbeitsblatt als ActiveX/OLE-Objekt in das Dokument einbettet – genau diese Art von Vorgang blockiert die neue Standardeinstellung von Microsoft. Normale Bilder (*.png, *.jpg, ...) sind keine ActiveX-Objekte und nicht betroffen.

So umgehen Sie das Problem:
  • Öffnen Sie in Word File » Options » Trust Center » Trust Center Settings » ActiveX Settings (in deutschem Word: Datei » Optionen » Trust Center » Einstellungen für das Trust Center » ActiveX-Einstellungen) und wählen Sie "Prompt me before enabling all controls with minimal restrictions".
    Beachten Sie, dass diese Einstellung für alle Office-Anwendungen auf diesem Computer gilt (Word, Excel, PowerPoint, Visio), nicht nur für die von diesem Plugin erzeugten Dokumente.
  • Schlägt die Erstellung mit einer Vorlagendatei danach weiterhin fehl, wählen Sie unten die Option "MS Office interactive mode".
    Dadurch bleibt Word während der Dokumenterstellung sichtbar, sodass jede Sicherheitsabfrage von Word angezeigt und manuell bestätigt werden kann, statt die Automatisierung im Hintergrund unbemerkt zu blockieren.
  • Wenn Sie keine eingebetteten Excel-Arbeitsblätter benötigen, verwenden Sie in Ihrer Projektdatei das Tag recursiveimg nicht mit einem *.xlsx-Filter – so vermeiden Sie genau den Vorgang, der die Blockierung auslöst.
  • Wenn nichts davon hilft und die Dokumentationserstellung weiterhin fehlschlägt, entfernen Sie den Pfad zur Vorlagendatei und lassen Sie dieses Feld leer. Das Plugin erstellt dann ein neues, leeres Word-Dokument, statt Ihre angepasste Vorlage zu öffnen, und die Dokumentationserstellung wird erfolgreich abgeschlossen.
    Der einzige Nachteil dieser Umgehung: Das erzeugte Dokument enthält nicht die Titelseite, die normalerweise von der Vorlage bereitgestellt wird (Firmenlogo, vorformatiertes Deckblatt usw.) – alle anderen erzeugten Inhalte (Abschnitte, Tabellen, Bilder, Referenzen) sind nicht betroffen und werden wie gewohnt erstellt. So können Sie weiterhin Dokumentation erstellen, während das zugrunde liegende Problem der Word-Automatisierung auf Ihrem Rechner behoben wird.
Wir arbeiten an einer Methode zur Dokumentationserstellung, die nicht mehr auf der Automatisierung von MS Word beruht, damit künftige Sicherheitsänderungen von Microsoft dieses Plugin nicht mehr beeinträchtigen.

Kommen Sie immer noch nicht weiter? Auch andere Software auf Ihrem Rechner (Sicherheitssuiten, Add-ins für Rechteverwaltung/DLP, alte zurückgebliebene Treiber, ...) kann die Automatisierung von Word/Excel unbemerkt blockieren, manchmal ganz ohne eindeutige Fehlermeldung. Mehr zu diesem Problem mit der Word-Automatisierung und wie Sie es diagnostizieren »





▲ Überblick

Das Plugin Documentation Generator Pro erzeugt automatisch eine Dokumentation für die Archivdateien mehrerer Roboter im Format MS Word oder PDF.

Um das Aussehen der erzeugten Dokumente anzupassen, können Sie eine XML-Dokumentationsprojektdatei bearbeiten oder neu erstellen.

Das Plugin verwendet ein angepasstes MS-Word-Dokument als Vorlage, um die endgültige Dokumentation zu erzeugen.
Sie können eine MS-Word-Vorlage mit angepasster Kopf- und Fußzeile und sogar einer eigenen Titelseite vorbereiten.

Die Abbildung unten zeigt ein Beispiel einer Dokumentationsvorlage.
In das erste leere Textfeld auf der ersten Seite wird automatisch der Robotername eingetragen.
Das zweite Textfeld kann den vom Benutzer festgelegten Projektnamen enthalten.


  kuka.doc.pro.template.pdf


Unten finden Sie die Beschreibung einer einfachen Projektdatei und der vordefinierten XML-Tags, mit denen Sie die Quellen externer Dateien einbinden, Systeminformationen des Roboters anzeigen, eine Referenztabelle der Variablen ausgeben und vieles mehr.
Wenn Sie Ihre eigene Dokumentationsprojektdatei erstellen möchten, kontaktieren Sie uns - wir helfen Ihnen kostenlos.

Erzeugen Sie vor dem Start unbedingt eine aktuelle Referenzliste des Roboters.



▲ Plugin-Fenster





▲ Einfache Projektdatei

Um das Aussehen der erzeugten Dokumentation anzupassen, können Sie eine einfache XML-Projektdatei mit einigen vordefinierten Tags erstellen oder bearbeiten.
Mit diesen Tags schreiben Sie normalen Text mit festgelegter Schriftart, Farbe und Ausrichtung oder fügen zusätzliche Informationen über den Roboter ein.

▲ Die XML-Projektdatei beginnt mit dem Haupt-Tag VKRCDocumentationProProject.
<VKRCDocumentationProProject version="">

</VKRCDocumentationProProject>
Zwischen diesen Tags definieren Sie den gesamten Inhalt der Dokumentation.

EigenschaftWerteBeschreibung
version Beliebiger gültiger Versionsnummer-Text Versionsnummer der Projektdatei.



▲ Das Tag section dient zum Einfügen von Roboterinformationen und Listings externer Dateien.
<VKRCDocumentationProProject version="1.0">

<section title="" style="" align="" include="">

</section>

</VKRCDocumentationProProject>

EigenschaftWerteBeschreibung
title Beliebiger gültiger Text Titel des Abschnitts.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den Abschnittstitel.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Ausrichtung des Abschnittstitels.
include [ 1 | 0 ] Bei 1 wird der Abschnitt in das Dokument aufgenommen. Bei 0 oder ohne Angabe wird dieser Abschnitt nicht angezeigt.

Das Tag section kann folgende Unter-Tags enthalten: img, text, robot, breakline, breakpage, filelist, reference.


▲ Das Tag makeindex erstellt ein Seitenverzeichnis.
Wenn für jeden eingebundenen Abschnitt die richtige Seitenzahl im Dokument angezeigt werden soll, fügen Sie dieses Tag am Ende der Projektdatei ein.
Nur so kann das Plugin korrekt auf die Seitenzahlen verweisen.
<VKRCDocumentationProProject version="1.0">

<makeindex title="" style="" style2="" align="" include="" />

</VKRCDocumentationProProject>

EigenschaftWerteBeschreibung
title Beliebiger gültiger Text Titel der Verzeichnisseite.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den Titel des Seitenverzeichnisses.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
style2 Stylesheet Ermöglicht Formatierungsangaben im Rich Text für die Seitenliste mit den Abschnittsnamen.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.
include [ 1 | 0 ] Bei 1 wird das Seitenverzeichnis in das Dokument aufgenommen. Bei 0 oder ohne Angabe wird dieser Abschnitt nicht angezeigt.



▲ Das Tag robotapplication definiert die Projektressourcen, mit denen die vom Roboter verwendeten Applikationen ermittelt werden.

<VKRCDocumentationProProject version="1.0">

<robotapplication include="">

    <app text="" makro="" />

</robotapplication>

</VKRCDocumentationProProject>

EigenschaftWerteBeschreibung
include [ 1 | 0 ] Diesen Abschnitt auswerten und in die Projektressourcen aufnehmen.

Weitere Informationen finden Sie bei den Tags app und robot.


▲ Das Tag app definiert die Beschreibung einer Roboterapplikation.

<app text="" makro="" />

EigenschaftWerteBeschreibung
text Beliebiger gültiger Text Beschreibungstext der Applikation, z. B.: Handling, Kleben, Schweissen.
makro Durch Semikolon getrennte Textliste Durch Semikolon getrennte Liste der Makronummern, die von der angegebenen Applikation verwendet werden.
Zum Beispiel verwenden die Handling-Applikationen die Makros 340;342;343 und Glue (Kleben) die Makros 180;181;190;191;200;201.

Weitere Informationen finden Sie bei den Tags robotapplication und robot.


▲ Das Tag stations definiert die langen Stationsnamen.

<VKRCDocumentationProProject version="1.0">

<stations include="">

    <name short="" long="" />

</stations>

</VKRCDocumentationProProject>

EigenschaftWerteBeschreibung
short Beliebiger gültiger Text
long Beliebiger gültiger Text

Weitere Informationen finden Sie beim Tag robot.


▲ Das Tag filelist dient zum Einbinden des Quellcodes der Roboterprogramme.

<filelist filter="" viewer="" comment="" style="" style2="" align="" />

EigenschaftWerteBeschreibung
filter Gültiger regulärer Ausdruck Dieser reguläre Ausdruck definiert einen Filter für die Dateien, die gesucht und in die Dokumentation aufgenommen werden.
Wenn Sie zum Beispiel nur vom Benutzer definierte Makro aufnehmen möchten, verwenden Sie den Filter makro5[0-9].src.
Dieser Filter nimmt die Makro 50, 51, 52, 53, 54, 55, 56, 57, 58 und 59 auf, sofern sie vorhanden sind.
Der Filter folge*.src nimmt alle Folge-Dateien auf, up*.src nur die UP.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den angezeigten Dateinamen.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
style2 Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den Quellcode der eingebundenen Dateien.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.
viewer [ -1 | 0 | 1 ] Bei 0 wird der Dateiinhalt als reiner Text angezeigt. Bei 1 wird der Text wie im VKRC-Viewer angezeigt. Bei -1 wird der Dateiinhalt nicht angezeigt.
comment [ 0 | 1 ] Bei 1 wird der Dateikommentar hinter dem Dateinamen angezeigt.



▲ Das Tag reference dient zum Einfügen einer Referenzliste für die angegebene Variable.
Diese Referenzliste wird aus der Referenzliste des Roboters erzeugt. Stellen Sie sicher, dass Sie die Referenzliste des Roboters vor dem Start erstellt haben.

Die Ausgabe dieses Befehls ist eine Tabelle mit 3 Spalten.
Die erste Spalte enthält den Variablennamen, die zweite den Langtext der Variablen und die dritte die Dateien, in denen diese Variable verwendet wird.
<reference variable="" from="" to="" exclude="" lang="" style="" align="" cellpadding="" border="" />

EigenschaftWerteBeschreibung
variable Regulärer Ausdruck mit Variablenname(n) Der Variablenname ist eine der gültigen Variablen aus der Referenzdatei, z. B.: (E|A) - zeigt alle Eingänge und Ausgänge an, Makro, M, bin, F, I usw.
from Zahl Untergrenze des Variablenbereichs. Weglassen oder leer lassen, um bei 1 zu beginnen.
to Zahl Obergrenze des Variablenbereichs. Weglassen oder leer lassen, um bei der letzten verfügbaren Variablen zu enden.
exclude comment:<Regular expression> Mit dieser Eigenschaft lassen sich bestimmte Langtexte ausschließen. Derzeit wird ein Filter auf Basis des Variablenkommentars unterstützt. Zum Beispiel schließt exclude="comment:Roboterfreigabe\s+d+" alle Variablen aus, deren Kommentar Roboterfreigabe gefolgt von einer Zahl enthält.
lang Übersetzungssprache Ist eine Übersetzungssprache angegeben, lädt das Plugin das Work-Visual-Projekt, sofern vorhanden, und fügt für jede Variable einen passenden Übersetzungstext ein, wenn dieser nicht leer ist.
Der Sprachwert ist eine der gültigen Work-Visual-Sprachbezeichnungen, z. B.:
  • ces - Tschechisch
  • deu - Deutsch
  • eng - Englisch
  • hun - Ungarisch
  • slk - Slowakisch
  • slv - Slowenisch
  • spa - Spanisch
  • por - Portugiesisch
Ist der Wert leer oder nicht angegeben, wird der Text aus der Referenzdatei eingefügt.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den angezeigten Text.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.

Anwendungsbeispiel: 
		<section title="Verwendete Eingänge" include="1" align="left" style="font-weight: bold; font-size: 12pt;">
		  <breakline/>
		  <breakline/>
		  <reference lang="" align="left" style="font-size: 10pt;" border="0" cellpadding="2" variable="E"/>
		  <breakline/>
		  <breakline/>
		  <reference lang="slk" align="left" style="font-size: 10pt;" border="0" cellpadding="2" variable="E"/>
		</section>



▲ Das Tag img fügt das angegebene Bild aus der Ressource ein.
<img src="" style="" height="" width="" rotation="" align="" />

EigenschaftWerteBeschreibung
src Bild Enthält einen URI, der auf den Speicherort der Bildressource verweist.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für das Bild.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
width <length> px Gibt die Breite des Bildes an.
height <length> px Gibt die Höhe des Bildes an.
rotation <angle> Gibt den Drehwinkel in Grad an. Positiver Wert für Drehung im Uhrzeigersinn, negativer Wert für Drehung gegen den Uhrzeigersinn.
align [ left | right | center | justify ] Horizontale Ausrichtung des Bildes.



▲ Das Tag recursiveimg fügt Bilder rekursiv ein.
Damit können Sie Traglastprotokolle, die Sicherheitskonfiguration usw. einfügen.

Wenn Sie mehr als ein Bild eines Traglastprotokolls einfügen möchten, können Sie die Dateinamen wie folgt festlegen:
loaddata_kahka1516480r01rs--kux_T7.pdf
loaddata_kahka1516480r01rs--kux_T8.pdf
loaddata_kahka1516480r01rs--kux_T9.pdf
loaddata_kahka1516480r01rs--kux_T10.pdf
...
und folgenden Dateifilter verwenden:
loaddata_*__ROBOTNAME__*.pdf

Das Tag __ROBOTNAME__ wird durch den Namen des aktuellen Roboters ersetzt.
<recursiveimg path="" filter="" align="" scaleW="" scaleH="" rotation="" breakpage="" />

EigenschaftWerteBeschreibung
path Beliebiger gültiger Systempfad Pfad zum Verzeichnis mit den Bildern.
filter Durch Semikolon getrennte Liste von Dateifiltern Mit dem Filter werden passende Bilder im Verzeichnis gesucht, z. B.: *.png;*.bmp;*.gif;*.jpg;*.jpeg
Sie können sogar ein MS-Office-Excel-Arbeitsblatt aus Kuka Load einfügen. Verwenden Sie in diesem Fall den Filter *.xlsx.
Im Filter können Sie das Tag __ROBOTNAME__ verwenden, das durch den Namen des aktuellen Roboters ersetzt wird.
align [ left | right | center | justify ] Horizontale Ausrichtung des Bildes.
scaleW Beliebige gültige Gleitkommazahl Skalierungsfaktor für die Bildbreite.
scaleH Beliebige gültige Gleitkommazahl Skalierungsfaktor für die Bildhöhe.
rotation <angle> Gibt den Drehwinkel in Grad an. Positiver Wert für Drehung im Uhrzeigersinn, negativer Wert für Drehung gegen den Uhrzeigersinn.
breakpage [true | false] Bei true folgt nach diesem Bild ein Seitenumbruch.



▲ Das Tag text fügt reinen Text in das Dokument ein.
Für das Zeichen < verwenden Sie bitte &lt; und für das Zeichen > &gt;.
<text style="" align="">

</text>

EigenschaftWerteBeschreibung
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den eingefügten Text.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.



▲ Das Tag robot fügt zusätzliche Informationen über das Robotersystem ein.
<robot attr="" title="" style="" style2="" align="" regexp="" from="" to="" />

EigenschaftWerteBeschreibung
attr [ name | type | serial | software |
  ip | gateway | subnetmask |
  vwuser | station | plc | safety |
  application | absolutmotor |
  calibrationdifference| calibration |
  limits-positive | limits-negative |
  tool | base | load
  profinet | cell | used_coll ]		 Name der anzuzeigenden Robotereigenschaft.

Einige Eigenschaften liefern nur eine einzelne Textzeile. Andere wie absolutmotor, calibrationdifference, calibration, limits-positive, limits-negative, tool, base und load liefern eine Tabelle.
Die Eigenschaft Profinet gibt einen Graphen mit der Profinet-Topologie des Roboters aus.
Die Eigenschaft Application gibt eine Liste der Namen der vom Roboter verwendeten Applikationen aus.
title Beliebiger gültiger Text Name der Eigenschaft, der vor dem Textwert angezeigt wird.
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den Namen der Eigenschaft.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
style2 Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den eingefügten Text der Eigenschaft.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.
regexp Beliebiger gültiger regulärer Ausdruck Sucht den regulären Ausdruck im angegebenen Roboterattribut und gibt den erfassten Text zurück.
So lässt sich ein Teil einer Zeichenkette extrahieren, z. B. der Stationsname aus dem Roboternamen.
from Beliebiger gültiger Zeichenindex Gibt einen Teilstring des angegebenen Roboterattributs zurück, beginnend an der Position from bis zur Position to.
So lässt sich ein Teil einer Zeichenkette extrahieren, z. B. der Stationsname aus dem Roboternamen.
to Beliebiger gültiger Zeichenindex Gibt einen Teilstring des angegebenen Roboterattributs zurück, beginnend an der Position from bis zur Position to.
So lässt sich ein Teil einer Zeichenkette extrahieren, z. B. der Stationsname aus dem Roboternamen.
stationname [ 1 | 0 ] Fügt dem aktuellen Attributwert den Stationsnamen hinzu. Weitere Informationen finden Sie beim Tag stations.



▲ Das Tag breakline fügt am Ende der aktuellen Zeile einen Zeilenumbruch ein.
<breakline />


▲ Das Tag breakpage beendet die aktuelle Seite und setzt den Textcursor in die erste Zeile der nächsten Seite.
<breakpage />


▲ Das Tag date fügt das aktuelle Datum im angegebenen Format ein.
<date style="" align="" format="" />

EigenschaftWerteBeschreibung
style Stylesheet Ermöglicht Formatierungsangaben im Rich Text für den Namen der Eigenschaft.
Mit einer eingeschränkten Teilmenge der CSS-Syntax kann das Aussehen des Texts geändert werden. Weitere Informationen finden Sie unter Quellen.
align [ left | right | center | justify ] Horizontale Textausrichtung.
format Datumsformat Ist der Wert leer, wird der Standardwert dd.MM.yyyy verwendet.
Weitere Informationen finden Sie in der Online-Dokumentation von Qt.



▲ Beispiele

Alle aufgeführten Beispiele wurden automatisch mit unserem Plugin erzeugt.

kahka1516480r01rs--kux.pdf

  kahka1516480r01rs--kux.pdf



▲ Quellen