Welcome to our new forum
All users of the legacy CODESYS Forums, please create a new account at account.codesys.com. But make sure to use the same E-Mail address as in the old Forum. Then your posts will be matched. Close

Biliotheken-Dokumentation funktioniert nicht....

wiegi
2017-06-13
2017-06-23
  • wiegi - 2017-06-13

    Hallo ich hab da noch ein weiteres Problem bzgl. meinen Bibliotheken gefunden!
    Und zwar, ich habe mir das Webinar "Bibliotheks-Manager Basics" oder so ähnlich von Codesys
    angesehen, dort bin ich dann dem Video gefolgt und habe eine Bibliothek mit Dokumentation im Deklarationsteil erstellt. Alles hat super funktioniert!
    Dann habe ich meine eigene Bib. erstellt und dort ging keine meiner Dokus!

    Hier mal der Code als Beispiel:

    // Dokumentation
    //
    // Dies ist die Dokumentation für das Testprojekt
    // vom 13.06.2017
    //
    // * Input = Eingang
    // * Output = Ausgang
    //
    FUNCTION_BLOCK LibTest_POU
    VAR_INPUT
       InputVar   :BOOL;
    END_VAR
    VAR_OUTPUT
       OutputVar   :BOOL;
    END_VAR
    VAR
       InternVar   :BOOL;
    END_VAR
    

    Könnt ihr einen Fehler sehen?
    Gibt es ein Manual wo die Syntax der Dokumentation beschrieben ist?

    Gruß wiegi

     
  • wiegi - 2017-06-13

    Nachtrag: Ich meine mit Dokumentation die kurze Funktionsbeschreibung die man angezeigt bekommt
    wenn man im Bibliotheksverwalter auf eine Lib clickt und dann eine kurze Beschreibung der Funktion bekommt, siehe Bild:

    IMG: Lib

     
  • r.evbatyrov - 2017-06-19

    Hall wiegi,

    bitte die Eigenschaften der Bibliothek überprüfen; insbesondere den Wert von "DocFormat" muss "reStructuredText" sein.

    Gruß
    Roman

     
  • wiegi - 2017-06-20

    Hallo Roman,

    dank Dir für deine Antwort, aber das DocFormat ist auf reStructuredText eingestellt gewesen.
    Das habe ich schon von diesem Codesys-Video auf YouTube mitgenommen.
    Wie gesagt als ich das parallel zum Video gemacht habe hat es einwandfrei funktioniert, nur jetzt mit meiner eigenen Lib funktionierts nicht mehr!
    Vom Codesys-Support habe ich einen Verweis auf die F1-Hilfe bekommen, aber das dauert bis ich da durch bin!

    Gruß wiegi

    IMG: LibDocImg.jpg

     
  • r.evbatyrov - 2017-06-20

    Hallo wiegi,

    dann folgendes ausprobieren:
    - das Bibliotheksprojekt öffnen
    - File->Save Project as Compiled Library...
    - dabei sollte in Meldungen, Kategorie 'Library Documentation' den Ablauf protokolliert werden (Fehlermeldungen beachten)
    - lib.compiled-library nach .zip umbenennen und den Inhalt checken
    - gibt's lmd.auxiliary? wenn nicht => die Doku ist nicht erzeugt worden (es stimmt dann mit dem Projekt was nicht)
    - wenn ja, diese lmd aus dem Archive extrahieren, wieder nach .zip umbebennen und wiederum extrahieren.
    - sind die HTML Dateien da? index im Browser aufmachen, die Doku checken.

    Gruß
    Roman

     
  • wiegi - 2017-06-22

    Hallo Roman,
    ich schmeiss es bald weg! Habe alles gemacht was Du beschrieben hast (siehe Bilder)
    Das Index.html sieht nicht toll aus aber es ist da und zeigt was an!

    Das ist der Text aus der Library, wobei nach "Nockenschaltwerk" bis "{attrib...." alles aus der Hilfe kopiert ist

    /// Nockenschaltwerk
    ///
    /// .. list-table:: Frozen Delights!
    ///    :widths: 15 10 30
    ///    :header-rows: 1
    ///
    ///    * - Treat
    ///      - Quantity
    ///      - Description
    ///    * - Albatross
    ///      - 2.99
    ///      - On a stick!
    ///    * - Crunchy Frog
    ///      - 1.49
    ///      - If we took the bones out, it wouldn't be
    ///        crunchy, now would it?
    ///    * - Gannet Ripple
    ///      - 1.99
    ///      - On a stick!
    {attribute 'hide_all_locals'}
    FUNCTION_BLOCK Cam_Ctrl_POU
    VAR_INPUT........
    

    IMG: lmd auxiliary.JPG

    IMG: html

    IMG: Browseransicht.JPG

     
  • wiegi - 2017-06-22

    zus. Bild vom Projekt

    IMG: ProjektAnsicht.png

     
  • r.evbatyrov - 2017-06-22

    Hi wiegi,

    das ist also 3.5.10.40...
    Da gibt es da wirklich einen Bug
    CDS-55281 LibDoc: Generated documentation cannot be displayed in LibraryManager

    Workarounds:
    1. V3.5.10.30 verwenden oder
    2. V3.5.10.30 installieren, DocScripting/3.5.10.30 irgendwo sichern, dabei 3.5.10.30 nach 3.5.10.40 umbennen.
    Den CODESYS 3.5.10.40/DocScripting/3.5.10.40/ durch den gesicherten ersetzten.
    3. Auf 3.5.10.50 warten (13. Juli) oder
    4. Lohnt sich nur zum ausprobieren - nur wenn die Lib nicht mehr geändert wird:
    Die Datei manifest.json vorsichtig aufmachen (mit Notepad++ o.ä). Es gibt einen Abschnitt 'mapping', der so aussieht:
    "mapping": {
    "XXX": {"path": "pou-my"},
    "YYY": {"path": "pou2"},
    ...
    }

    Soll aber so aussehen:

    "mapping": {
        "XXX": "pou-my",
        "YYY": "pou2",
        ....
    }
    

    Speichern, wieder alles zippen (zweimal).
    Bereits installierte Lib deinstallieren. Die lib aus compiled-lib installieren.

    Grüße
    Roman

     
  • wiegi - 2017-06-23

    Hallo Roman,
    na das ist ja'n Ding, hätte ich wohl mal die Versions-Nr. erwähnt Leider hat aber auch niemand danach gefragt, selbst der Codesys-Support nicht!
    Ok, dann werd ich mal eine Version "Downgraden" und werde dann nächsten Monat mal reinschneien und mir die neuste Version Downloaden.
    Komisch ist halt nur als ich das parallel zum Video gemacht habe, hat es einwandfrei funktioniert und ich bin mir ziemlich sicher das da schon die
    V3.5.10.40 installiert war! Na egal.

    Schönen Tag noch, gruß wiegi.

     
  • wiegi - 2017-06-23

    Hallo,
    mit der V3.5.10.30 funktioniert die Dokumentation nun wie erwartet !!!
    Recht herzlichen Dank, gruß wiegi

     

Log in to post a comment.