Hot News:

Mit Unterstützung durch:

  Foren auf CAD.de (alle Foren)
  EPLAN Electric P8
  Eplan-Api Doku selbst erstellen

Antwort erstellen  Neues Thema erstellen
CAD.de Login | Logout | Profil | Profil bearbeiten | Registrieren | Voreinstellungen | Hilfe | Suchen

Anzeige:

Darstellung des Themas zum Ausdrucken. Bitte dann die Druckfunktion des Browsers verwenden. | Suche nach Beiträgen nächster neuer Beitrag | nächster älterer Beitrag
  
Gut zu wissen: Hilfreiche Tipps und Tricks aus der Praxis prägnant, und auf den Punkt gebracht für EPLAN
Autor Thema:  Eplan-Api Doku selbst erstellen (5795 mal gelesen)
DanielPa
Mitglied
Consultant


Sehen Sie sich das Profil von DanielPa an!   Senden Sie eine Private Message an DanielPa  Schreiben Sie einen Gästebucheintrag für DanielPa

Beiträge: 377
Registriert: 21.05.2009

WSCAD Suit Ultimate 2015
Eplan P8 2.2.5 und 2.4

erstellt am: 15. Apr. 2015 17:27    Editieren oder löschen Sie diesen Beitrag!  <-- editieren / zitieren -->   Antwort mit Zitat in Fett Antwort mit kursivem Zitat    Unities abgeben: 1 Unity (wenig hilfreich, aber dennoch)2 Unities3 Unities4 Unities5 Unities6 Unities7 Unities8 Unities9 Unities10 Unities


Screenshot.JPG

 
Hi,

durch das ein oder andere Scripting Projekt und dessen Dokumentation bin ich neulich über das Tool "Sandcastle" gestolpert. Dieses ist in der Lage aus Code-Kommentaren einer dll-Datei, Hilfe-Dateien für eben diese zu erzeugen.
Nicht jeder verfügt über das Modul "API-Extension", mit der auch die API-Doku ausgeliefert wird. Jedoch können die Infos aus der Doku für den einen oder anderen Script-Bastler hilfreich sein. Deshalb habe ich hier mal eine zwar englische aber recht einfach zu folgende Anleitung zum Doku-selber-bauen rausgesucht.
http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html
Nicht erschrecken! Wir brauchen nur Step 1, Step 4 und den Anfang von 5.
Anstelle der in der Anleitung erzeugten Guy.dll + Guy.xml, binden wir die folgenden Dateien aus dem "..\EPLAN\Platform\[version]\Bin" Ordner ein:

    Eplan.EplApi.AFu.dll
    Eplan.EplApi.AFu.xml
    Eplan.EplApi.Baseu.dll
    Eplan.EplApi.Baseu.xml
    Eplan.EplApi.DataModelu.dll
    Eplan.EplApi.DataModelu.xml
    Eplan.EplApi.EServicesu.dll
    Eplan.EplApi.EServicesu.xml
    Eplan.EplApi.Guiu.dll
    Eplan.EplApi.Guiu.xml
    Eplan.EplApi.HEServicesu.dll
    Eplan.EplApi.HEServicesu.xml
    Eplan.EplApi.MasterData.dll
    Eplan.EplApi.Ppeu.dll
    Eplan.EplApi.Ppeu.xml
    Eplan.EplApi.Systemu.dll
    Eplan.EplApi.Systemu.xml

In den Project Properties (Taste F4) kann man noch ein paar Einstellungen wie den Ausgabepfad, Format, Titel, Name etc. vornehmen.
Die Durchlaufzeit des Build-Prozesses kann je nach Rechnerleistung relativ hoch sein (Intel Core2, 2,4GHz ca. 50min).
Es werden auch Tausende Warnungen wegen fehlender Referenzen ausgegeben. Diesen bin ich nicht weiter nachgegangen. Das Ergebnis ist dennoch brauchbar.
Der User, und Migration Guide aus der Originaldoku fehlen. Der Rest scheint sehr ähnlich zu sein.
Man könnte so auch eigene Doku anfügen, oder sich nur die für das Scripting relevanten Bibliotheken (*.AFu.*; *.Baseu.*; *.Guiu.*) erzeugen.
Anbei noch ein Screenshot mit vergleich Original zu "Selbstgemacht".
Viel Spaß!

MfG Daniel

------------------
“Hacker (noun): An organism that converts caffeine or alcohol into code.”
~ Standard Definition
YouTube
GitHub
DokuWiki

Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP

F.S.
Moderator



Sehen Sie sich das Profil von F.S. an!   Senden Sie eine Private Message an F.S.  Schreiben Sie einen Gästebucheintrag für F.S.

Beiträge: 1815
Registriert: 23.04.2003

EPLAN Electric P8
2023 Prof.

erstellt am: 16. Apr. 2015 07:19    Editieren oder löschen Sie diesen Beitrag!  <-- editieren / zitieren -->   Antwort mit Zitat in Fett Antwort mit kursivem Zitat    Unities abgeben: 1 Unity (wenig hilfreich, aber dennoch)2 Unities3 Unities4 Unities5 Unities6 Unities7 Unities8 Unities9 Unities10 Unities Nur für DanielPa 10 Unities + Antwort hilfreich

Sehr interessant, danke für den Tip und die Anleitung. 

------------------
grüße
FrankS

Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP

Balage
Mitglied
Dipl.-Ing. Elektrotechnik


Sehen Sie sich das Profil von Balage an!   Senden Sie eine Private Message an Balage  Schreiben Sie einen Gästebucheintrag für Balage

Beiträge: 522
Registriert: 13.03.2008

Win10 x64Pro,
EPLAN 5.70 SP1,
EPLAN electric P8 Pro 2.x
EPLAN Engineering Center/Configuration

erstellt am: 16. Apr. 2015 12:23    Editieren oder löschen Sie diesen Beitrag!  <-- editieren / zitieren -->   Antwort mit Zitat in Fett Antwort mit kursivem Zitat    Unities abgeben: 1 Unity (wenig hilfreich, aber dennoch)2 Unities3 Unities4 Unities5 Unities6 Unities7 Unities8 Unities9 Unities10 Unities Nur für DanielPa 10 Unities + Antwort hilfreich

Hallo Daniel,

das ist geil! 
Aber, sag mal, schläfst Du auch irgendwann? 
Tja, man sieht's: du hast richtig Spaß an der Sache...   

Gruß
Ferenc

------------------
Until you spread your wings,
you'll have no idea how far you can walk.

Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP

Jonny Wire
Mitglied
Script-Troll


Sehen Sie sich das Profil von Jonny Wire an!   Senden Sie eine Private Message an Jonny Wire  Schreiben Sie einen Gästebucheintrag für Jonny Wire

Beiträge: 786
Registriert: 08.12.2008

EPLAN Electric P8
... in allen Versionen/Varianten

erstellt am: 17. Apr. 2015 11:01    Editieren oder löschen Sie diesen Beitrag!  <-- editieren / zitieren -->   Antwort mit Zitat in Fett Antwort mit kursivem Zitat    Unities abgeben: 1 Unity (wenig hilfreich, aber dennoch)2 Unities3 Unities4 Unities5 Unities6 Unities7 Unities8 Unities9 Unities10 Unities Nur für DanielPa 10 Unities + Antwort hilfreich

nairolf
Ehrenmitglied
Elektroingenieur


Sehen Sie sich das Profil von nairolf an!   Senden Sie eine Private Message an nairolf  Schreiben Sie einen Gästebucheintrag für nairolf

Beiträge: 1987
Registriert: 21.01.2006

EPLAN Electric P8 2022.0.3 Update 2 (Build 17673)
EPLAN Pro Panel Professional Addon
EPLAN Fluid Addon

erstellt am: 17. Apr. 2015 11:55    Editieren oder löschen Sie diesen Beitrag!  <-- editieren / zitieren -->   Antwort mit Zitat in Fett Antwort mit kursivem Zitat    Unities abgeben: 1 Unity (wenig hilfreich, aber dennoch)2 Unities3 Unities4 Unities5 Unities6 Unities7 Unities8 Unities9 Unities10 Unities Nur für DanielPa 10 Unities + Antwort hilfreich

Sehr, sehr geil ... DANKE ! 

LG
nairolf

------------------
Der Fuchs ist schlau und stellt sich dumm.
Bei vielen ist es andersrum 
------------------------------------------
Da lernt man mühevoll laufen und sprechen,
und nun soll ich stillsitzen und die Klappe halten !

Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP

Anzeige.:

Anzeige: (Infos zum Werbeplatz >>)

Darstellung des Themas zum Ausdrucken. Bitte dann die Druckfunktion des Browsers verwenden. | Suche nach Beiträgen

nächster neuerer Beitrag | nächster älterer Beitrag
Antwort erstellen


Diesen Beitrag mit Lesezeichen versehen ... | Nach anderen Beiträgen suchen | CAD.de-Newsletter

Administrative Optionen: Beitrag schliessen | Archivieren/Bewegen | Beitrag melden!

Fragen und Anregungen: Kritik-Forum | Neues aus der Community: Community-Forum

(c)2023 CAD.de | Impressum | Datenschutz