Dokumentation mit SymDoc

Hallo lb. Forum,
suchte ein Tool um mein Projekt zu dokumentieren und bin auf SymDoc gestossen.
Die Installation war auch für einen symcon Neuling einfach. Das Tool erzeugt eine .md-Datei.
Nun meine Frage: wie kann ich dieses File drucken? Klar kann ich es mit einem Editor öffnen. Es muss doch einen Grund haben, warum das File die Extension .md hat. Ich dachte auch, dass die Auswertung grafisch wäre.
Danke für Eure Antwort.
Grüße von
Ekkehard

Hallo,

es handelt sich um folgendes Format: Markdown – Wikipedia
Schau mal hier zum Beispiel: MarkdownPad - The Markdown Editor for Windows

Grüße,
Kai

Hallo Kai,
danke für die schnelle Hilfe.
Installation hat geklappt und nun sieht die Ergebnis besser aus.
Grüße von
Ekkehard

Hallo Kai,
eine Frage habe ich doch noch: in der SymDoc Beschreibung des Entwickler ist am Ende ein Muster, bei dem die Überschriften im Rahmen und mit Farbe hinterlegt ist, ebenso sind die Spalten perfekt untereinander. Bekomme ich so einen Ausdruck nur mit der kostenpflichtigen pro-Version? Danke für Deine Antwort.
Grüße von
Ekkehard

Hallo Ekkehard,

nur aus Interesse - woher hast Du denn die Info von SymDoc, bzw. hast Du eine URL dazu?
Was meinst Du mit einer „Pro“ Version?

Gruß & schönes Wochenende
Thorsten

Hallo Thorsten,
diesen Link: GitHub - thorstenMueller/SymDoc: Generates a documentation of an IP-Symcon installation
habe ich von der Firma symcon direkt erhalten. Die Dokumentation die rauskommt (als .MD-Datei)
musst Du aber mit dem Programm Markdown Edit ausdrucken. Dann werden die grafischen Abschnitte
korrekt ausgedruckt. Markdown Pad brachte nicht das gewünschte Ergebnis. Vielleicht liegt’s an Win10
das nicht korrekt unterstützt wird.
Grüße von
Ekkehard

Hallo.

Ich baue gerade das Modul so um, dass es zukünftig ein PDF-Dokument im „Media“ Ordner erzeugt. Dann ist die Anzeige oder der Ausdruck doch etwas einfacher als der Umgang mit MD-Dateien.
Bis es fertig ist dauert es wohl noch etwas, aber so ungefähr wird es dann aussehen.

PS: An einem schönen Deckblatt mit Logo und Name der Installation arbeite ich noch.

Gruß
Thorsten

Moin Thorsten

kurze Frage: Entwickelst du das Modul noch weiter? Ich hätte großes Interesse daran.

Danke und Gruß,
Thomas

Hallo.

Ja und nein.

[ul]
[li]Habe ich Fertigstellung und Veröffentlichung im Modul-Store geplant: Ja!
[/li][li]Bin ich aktuell aktiv an der Entwicklung dran: Nein
[/li][/ul]

Woran scheitert es: Ich war unkreativ was noch ins PDF sollte und hatte daher eine kreative Pause gemacht, die sich spontan in die Länge gezogen hat.

Vielleicht veröffentliche ich den aktuell unvollständigen Stand als Beta-Modul und schaue ob damit die Kreativität zurückkommt.

Gruß
Thorsten

Ich finde es ist ein sehr interessantes Projekt. Es währe schade wenn es im Sand verläuft.

Es eilt ja nicht, also hau rein. :smiley:

Viele Grüße
Thomas

Das klingt gut,- lass dich inspirieren :smiley:

Hallo.

Ich habe den aktuellen Entwicklungsstand (u.a. noch nicht vollständig für alle Objekttypen) im Modul Store „Beta-Kanal“ veröffentlicht. Es darf gerne ausprobiert werden. Vielleicht gibt mir euer Feedback auch wieder etwas Kreativität zurück :D.

Gruß
Thorsten

Hallo Thorsten,

ich habe es mal auf meinem Testsystem getestet. Es wurde auf die schnelle 366 Seiten erzeugt, ich staunte nicht schlecht.

Was nicht funktionierte war der Download, ich habe es mir dann im Mediaortner angesehen.

Viele Grüße
Thomas

Guten Morgen.

Ja der Download ist bei mir auch stellenweise zickig. Ich bin mir nicht sicher, ob ich beim PDF Erzeugen noch etwas falsch mache oder ob der Browser bei der PDF Größe ein Problem hat.

Ich finde das PDF per „Default“ auch etwas groß. Vielleicht lasse ich standardmäßig keine Variablen Eigenschaften dokumentieren, sondern nur Skripte und Instanzen. Bin mir da auch noch unsicher :confused:.

Gruß
Thorsten

Der Download von Medien ist bei größeren Dateien aktuell noch etwas „problematisch“. Ich gehe nicht davon aus, dass es an dir liegt.

paresy

Ich überlege ob es sinnvoll wäre die PHP Skripte mit „PHPDoc“ Syntax zu beschreiben und diese mit in die PDF-Doku aufzunehmen. Habt ihr Ideen welche Informationen zu einem Skript als exportierte Doku sinnvoll wären? Die Skriptinhalte würden die Doku massiv aufblähen.

Gruß
Thorsten

Nur zur Info.
Nach der Migration auf 5.3 fallen mir im Log folgende Warnings auf:


1-SymDoc unter 5.3.jpg

Diese Warnigs kommen nach jedem Start von IP-Syncon