Problem mit DocMods

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

	Tritium Betreff: Problem mit DocMods	Fr, Apr 22, 2011 22:29 Antworten mit Zitat
So, wie dem einen oder anderen auffallen dürfte versuche ich in den letzten Tagen, mich in BlitzMax einzuarbeiten Mein momentanes Problem hab ich mit dem Erstellen der Dokumentation für ein Modul. Ich hab mir selbst ein Modul geschrieben (ist ein INI-Parser geworden) und den Code auch mit den entsprechenden Rem-Blöcken versehen. Dann hab ich das Modul gebuildet und auf "Rebuild Documentation" geklickt, was ohne Probleme funktioniert hat. Wenn ich im Ordner des Moduls bin und nach "doc" wechsle, dann wurde dort eine Datei mit dem Namen "commands.html" erstellt, die die Seite mit der Beschreibung des Moduls enthält, soweit also wunderbar. Allerdings kann ich diese Seite nicht aus der MaxIDE erreichen. Ich habe mein Modul mittels BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Miscellaneous/INI Parser about: Simple parser to read and manipulate *.ini files. <br>NOTE: This module can only parse one file at once. EndRem Module ... unter "Modules" unter dem Punkt "Miscellaneous" einbinden wollen. Dort - und auch sonst - taucht es allerdings nicht auf. Kann mir jemand sagen, was ich falsch mache? P.S.: Ich habe im Inet jetzt öfter was von einer Datei namens "syncdocs.exe" gelesen, die befindet sich aber nicht in meinem BMax-Ordner (unter "bin"). Bezieht sich das auf eine ältere Version oder fehlt mir da tatsächlich was? Würde mich wundern, habs schließlich normal gekauft und mir auf blitzbasic.com Version 1.42 runtergeladen.

Tritium

Betreff: Problem mit DocMods

Fr, Apr 22, 2011 22:29
Antworten mit Zitat

So, wie dem einen oder anderen auffallen dürfte versuche ich in den letzten Tagen, mich in BlitzMax einzuarbeiten Very Happy

Mein momentanes Problem hab ich mit dem Erstellen der Dokumentation für ein Modul. Ich hab mir selbst ein Modul geschrieben (ist ein INI-Parser geworden) und den Code auch mit den entsprechenden Rem-Blöcken versehen. Dann hab ich das Modul gebuildet und auf "Rebuild Documentation" geklickt, was ohne Probleme funktioniert hat. Wenn ich im Ordner des Moduls bin und nach "doc" wechsle, dann wurde dort eine Datei mit dem Namen "commands.html" erstellt, die die Seite mit der Beschreibung des Moduls enthält, soweit also wunderbar. Allerdings kann ich diese Seite nicht aus der MaxIDE erreichen. Ich habe mein Modul mittels
BlitzMax: [AUSKLAPPEN]

Rem
	bbdoc: Miscellaneous/INI Parser
	about: Simple parser to read and manipulate *.ini files. <br>NOTE: This module can only parse one file at once.
EndRem
Module ...

unter "Modules" unter dem Punkt "Miscellaneous" einbinden wollen. Dort - und auch sonst - taucht es allerdings nicht auf.

Kann mir jemand sagen, was ich falsch mache?

P.S.: Ich habe im Inet jetzt öfter was von einer Datei namens "syncdocs.exe" gelesen, die befindet sich aber nicht in meinem BMax-Ordner (unter "bin"). Bezieht sich das auf eine ältere Version oder fehlt mir da tatsächlich was? Würde mich wundern, habs schließlich normal gekauft und mir auf blitzbasic.com Version 1.42 runtergeladen.

	Holzchopf Meisterpacker	Fr, Apr 22, 2011 22:40 Antworten mit Zitat
Hast du die IDE mal neu gestartet? Wie lautet der genaue Dateipfad und Dateiname deines Moduls? Und was genau steht hinter dem Befehl Module? mfG Holzchopf
Erledige alles Schritt um Schritt - erledige alles. - Holzchopf CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018) Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Holzchopf

Meisterpacker

Fr, Apr 22, 2011 22:40
Antworten mit Zitat

Hast du die IDE mal neu gestartet?

Wie lautet der genaue Dateipfad und Dateiname deines Moduls? Und was genau steht hinter dem Befehl Module?

mfG
Holzchopf

Erledige alles Schritt um Schritt - erledige alles. - Holzchopf
CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018)
Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

	Tritium	Fr, Apr 22, 2011 23:30 Antworten mit Zitat
Jau, die IDE hab ich mehrmals neu gestartet. Der Dateipfad lautet "E:\BlitzMax\mod\ipdprojects.mod\iniparser.mod" und die Datei heißt "iniparser.bmx". Sie beginnt folgendermaßen: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Miscellaneous/INI Parser about: Simple parser to read and manipulate *.ini files. <br>NOTE: This module can only parse one file at once. EndRem Module IPDProjects.INIParser ModuleInfo "Version: 0.10" ModuleInfo "Author: XXX" ModuleInfo "License: XXX" ModuleInfo "Copyright: XXX" ModuleInfo "History: 0.10 Module created" Strict ' - Imports - Import BRL.FileSystem ...

Tritium

Fr, Apr 22, 2011 23:30
Antworten mit Zitat

Jau, die IDE hab ich mehrmals neu gestartet.

Der Dateipfad lautet "E:\BlitzMax\mod\ipdprojects.mod\iniparser.mod" und die Datei heißt "iniparser.bmx". Sie beginnt folgendermaßen:
BlitzMax: [AUSKLAPPEN]

Rem
	bbdoc: Miscellaneous/INI Parser
	about: Simple parser to read and manipulate *.ini files. <br>NOTE: This module can only parse one file at once.
EndRem
Module IPDProjects.INIParser
ModuleInfo "Version: 0.10"
ModuleInfo "Author: XXX"
ModuleInfo "License: XXX"
ModuleInfo "Copyright: XXX"

ModuleInfo "History: 0.10 Module created"

Strict


' - Imports -

Import BRL.FileSystem
...

	Holzchopf Meisterpacker	Fr, Apr 22, 2011 23:52 Antworten mit Zitat
Hmm. Scheint alles richtig zu sein Versuch's mal hiermit: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Miscellaneous/INI Parser about: Simple parser to read and manipulate .ini files. NOTE: This module can only parse one file at once. EndRem (also ohne die Tabstops am Zeilenanfang) Und wenn's immer noch nicht klappt: BlitzMax:* [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: IPDProjects/INIParser about: Simple parser to read and manipulate .ini files. NOTE: This module can only parse one file at once. EndRem Und dann schauen, ob das Modul unter "Third Party Modules" auftaucht. mfG Edit* Oh, ich vermute, dass das Modul sowieso nur unter "Third Party Modules" zu finden sein wird.
Erledige alles Schritt um Schritt - erledige alles. - Holzchopf CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018) Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Holzchopf

Meisterpacker

Fr, Apr 22, 2011 23:52
Antworten mit Zitat

Hmm. Scheint alles richtig zu sein Confused

Versuch's mal hiermit: BlitzMax: [AUSKLAPPEN]

Rem
bbdoc: Miscellaneous/INI Parser
about: Simple parser to read and manipulate *.ini files. 
NOTE: This module can only parse one file at once.
EndRem

(also ohne die Tabstops am Zeilenanfang)

Und wenn's immer noch nicht klappt: BlitzMax: [AUSKLAPPEN]

Rem
bbdoc: IPDProjects/INIParser
about: Simple parser to read and manipulate *.ini files.
NOTE: This module can only parse one file at once.
EndRem

Und dann schauen, ob das Modul unter "Third Party Modules" auftaucht.

mfG

Edit
Oh, ich vermute, dass das Modul sowieso nur unter "Third Party Modules" zu finden sein wird.

Erledige alles Schritt um Schritt - erledige alles. - Holzchopf
CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018)
Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

	Tritium	Sa, Apr 23, 2011 1:07 Antworten mit Zitat
Hilft leider beides nichts Unter "Modules" (also in der IDE) gibt es bei mir keinen Punkt "Third Party Modules". In die Richtung gehen nur "Other" und "Miscellaneous". Leider taucht mein Modul aber nirgends auf, hab alle verfügbaren Punkte durchgesehen, auch so in diesem Zusammenhang unlogische wie "Audio".

Tritium

Sa, Apr 23, 2011 1:07
Antworten mit Zitat

Hilft leider beides nichts Sad

Unter "Modules" (also in der IDE) gibt es bei mir keinen Punkt "Third Party Modules". In die Richtung gehen nur "Other" und "Miscellaneous". Leider taucht mein Modul aber nirgends auf, hab alle verfügbaren Punkte durchgesehen, auch so in diesem Zusammenhang unlogische wie "Audio".

	Holzchopf Meisterpacker	Sa, Apr 23, 2011 1:13 Antworten mit Zitat
Also ich habe bei mir rechts in der Sidebar unter help: Zitat: User Guide Language Modules Third Party Modules Index Tutorials Samples Licences Source Code Und unter Third Party Modules werden bei mir alle aufgelistet, die nicht in den Scopes BRL, PUB oder MaxGUI sind. Werden denn die Befehle in der IDE gehighlighted? Was passiert, wenn du einen deiner Befehle zwei mal mit F1 "anklickst"?
Erledige alles Schritt um Schritt - erledige alles. - Holzchopf CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018) Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Holzchopf

Meisterpacker

Sa, Apr 23, 2011 1:13
Antworten mit Zitat

Also ich habe bei mir rechts in der Sidebar unter help:
Zitat:

User Guide
Language
Modules
Third Party Modules
Index
Tutorials
Samples
Licences
Source Code

Und unter Third Party Modules werden bei mir alle aufgelistet, die nicht in den Scopes BRL, PUB oder MaxGUI sind.

Werden denn die Befehle in der IDE gehighlighted? Was passiert, wenn du einen deiner Befehle zwei mal mit F1 "anklickst"?

Erledige alles Schritt um Schritt - erledige alles. - Holzchopf
CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018)
Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

	BladeRunner Moderator	Sa, Apr 23, 2011 7:31 Antworten mit Zitat
...und dann würde ich dir Hot Docs (Forensuche) empfehlen, macht eine wesentlich bessere Dokumentation als die mitgelieferte.
Zu Diensten, Bürger. Intel T2300, 2.5GB DDR 533, Mobility Radeon X1600 Win XP Home SP3 Intel T8400, 4GB DDR3, Nvidia GF9700M GTS Win 7/64 B3D BMax MaxGUI Stolzer Gewinner des BAC#48, #52 & #92

BladeRunner

Moderator

Sa, Apr 23, 2011 7:31
Antworten mit Zitat

...und dann würde ich dir Hot Docs (Forensuche) empfehlen, macht eine wesentlich bessere Dokumentation als die mitgelieferte.

Zu Diensten, Bürger.
Intel T2300, 2.5GB DDR 533, Mobility Radeon X1600 Win XP Home SP3
Intel T8400, 4GB DDR3, Nvidia GF9700M GTS Win 7/64
B3D BMax MaxGUI
Stolzer Gewinner des BAC#48, #52 & #92

	Tritium	Sa, Apr 23, 2011 8:45 Antworten mit Zitat
@Holzchopf: Oh, ich seh grad, dass wir aneinander vorbeigeredet haben Ich bin davon ausgegangen, dass meine Dokumentation zu erreichen ist, indem ich auf der Startseite der Hilfe (in der IDE) auf Modules und dann auf Miscellaneous klicke. Die Sidebar hatte ich die ganze Zeit ausgeblendet, da ich hier nur ein Netbook zur Verfügung hab. In der Sidebar komme ich tatsächlich über "Third Party Modules" auf die Hilfeseite, Syntax-Highlighting funktioniert auch Gibt es denn eine Möglichkeit, dass man die Dokumentation des eigenen Moduls über die gleichen Seiten (also "Modules" auf der Startseite) wie die anderen, eingebauten Module erreicht bzw. warum wird die Seite nicht unter Miscellaneous eingetragen? @Bladerunner: OK, seh ich mir an. [Edit]: Mh, hab mir HotDocs mal angesehen... Macht auf jeden Fall vieles besser als die nomale Dokumentation, trotzdem überzeugt es mich nicht so 100% - ich werd einfach die nächsten Tage mal beide Dokumentationen immer wieder erstellen und dann sehen, womit ich langfristig besser zurechtkomme.

Tritium

Sa, Apr 23, 2011 8:45
Antworten mit Zitat

@Holzchopf: Oh, ich seh grad, dass wir aneinander vorbeigeredet haben Embarassed

Ich bin davon ausgegangen, dass meine Dokumentation zu erreichen ist, indem ich auf der Startseite der Hilfe (in der IDE) auf Modules und dann auf Miscellaneous klicke. Die Sidebar hatte ich die ganze Zeit ausgeblendet, da ich hier nur ein Netbook zur Verfügung hab. In der Sidebar komme ich tatsächlich über "Third Party Modules" auf die Hilfeseite, Syntax-Highlighting funktioniert auch Smile

Gibt es denn eine Möglichkeit, dass man die Dokumentation des eigenen Moduls über die gleichen Seiten (also "Modules" auf der Startseite) wie die anderen, eingebauten Module erreicht bzw. warum wird die Seite nicht unter Miscellaneous eingetragen?

@Bladerunner: OK, seh ich mir an.
[Edit]: Mh, hab mir HotDocs mal angesehen... Macht auf jeden Fall vieles besser als die nomale Dokumentation, trotzdem überzeugt es mich nicht so 100% - ich werd einfach die nächsten Tage mal beide Dokumentationen immer wieder erstellen und dann sehen, womit ich langfristig besser zurechtkomme.

	Holzchopf Meisterpacker	Sa, Apr 23, 2011 11:04 Antworten mit Zitat
Es können übrigens beide Dokumentationen nebeneinander existieren. Ich benutze auch HotDocs, weil... keine Ahnung, aber ich benutze es aus irgend einem Grund. Wahrscheinlich weil es alle Module auflistet Aber ganz sicher nicht aus dem Grund, weil es alles schön alphabetisch sortiert dafür hasse ich es manchmal. Aber da bleibt mir ja eben die Möglichkeit, in der Sidebar die alte Dok aufzurufen (eben über Third Party Modules - wasauchimmer). Damit du deine eigenen Module dort hinein kriegst, müsstet du wahrscheinlich was an der docmods.bmx (E:\BlitzMax\src\docmods) oder makedocs (E:\BlitzMax\src\makedocs) ändern. Aber genauere Infos dazu kann ich dir auch nicht geben, denn mit dem Innenleben der BlitzMax-Doku habe ich mich noch nie auseinandergesetzt.
Erledige alles Schritt um Schritt - erledige alles. - Holzchopf CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018) Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Holzchopf

Meisterpacker

Sa, Apr 23, 2011 11:04
Antworten mit Zitat

Es können übrigens beide Dokumentationen nebeneinander existieren. Ich benutze auch HotDocs, weil... keine Ahnung, aber ich benutze es aus irgend einem Grund. Wahrscheinlich weil es alle Module auflistet Wink

Aber ganz sicher nicht aus dem Grund, weil es alles schön alphabetisch sortiert Rolling Eyes

dafür hasse ich es manchmal. Aber da bleibt mir ja eben die Möglichkeit, in der Sidebar die alte Dok aufzurufen (eben über Third Party Modules - wasauchimmer).

Damit du deine eigenen Module dort hinein kriegst, müsstet du wahrscheinlich was an der docmods.bmx (E:\BlitzMax\src\docmods) oder makedocs (E:\BlitzMax\src\makedocs) ändern. Aber genauere Infos dazu kann ich dir auch nicht geben, denn mit dem Innenleben der BlitzMax-Doku habe ich mich noch nie auseinandergesetzt.

Erledige alles Schritt um Schritt - erledige alles. - Holzchopf
CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018)
Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

	BladeRunner Moderator	Sa, Apr 23, 2011 11:14 Antworten mit Zitat
Nunja, dank der Schlüsselwortsuche und anderer Späße die HotDocs bietet finde ich es wesentlich gelungener, in der Regel habe ich was ich suche mit 2-3 Klicks erreicht. Zudem sind innerhalb der einzelnen Module auch die Verlinkungen deutlich ansprechender gelöst. Die Orginaldoku stürzte mich immer nur in Verzweiflung.
Zu Diensten, Bürger. Intel T2300, 2.5GB DDR 533, Mobility Radeon X1600 Win XP Home SP3 Intel T8400, 4GB DDR3, Nvidia GF9700M GTS Win 7/64 B3D BMax MaxGUI Stolzer Gewinner des BAC#48, #52 & #92

BladeRunner

Moderator

Sa, Apr 23, 2011 11:14
Antworten mit Zitat

Nunja, dank der Schlüsselwortsuche und anderer Späße die HotDocs bietet finde ich es wesentlich gelungener, in der Regel habe ich was ich suche mit 2-3 Klicks erreicht. Zudem sind innerhalb der einzelnen Module auch die Verlinkungen deutlich ansprechender gelöst. Die Orginaldoku stürzte mich immer nur in Verzweiflung.

Zu Diensten, Bürger.
Intel T2300, 2.5GB DDR 533, Mobility Radeon X1600 Win XP Home SP3
Intel T8400, 4GB DDR3, Nvidia GF9700M GTS Win 7/64
B3D BMax MaxGUI
Stolzer Gewinner des BAC#48, #52 & #92

	Tritium	Sa, Apr 23, 2011 13:13 Antworten mit Zitat
Holzchopf hat Folgendes geschrieben: Damit du deine eigenen Module dort hinein kriegst, müsstet du wahrscheinlich was an der docmods.bmx (E:\BlitzMax\src\docmods) oder makedocs (E:\BlitzMax\src\makedocs) ändern. Ja, folgendes hab ich gefunden: Code: [AUSKLAPPEN] [EINKLAPPEN] 'docmods.bmx Rem Note: docmods is now only used to build 3rd party modules. BRL, MAXGUI and PUB mods are built by new makedocs. End Rem ... If modid.StartsWith( "brl." ) Or modid.StartsWith( "pub." ) Or modid.StartsWith( "maxgui." ) Continue Code: [AUSKLAPPEN] [EINKLAPPEN] 'makedocs.bmx Rem Build new style docs. Only builds official docs and brl, maxgui and pub modules. Calls 'docmods' first, which builds 3rd party modules. End Rem ... If Not modid.StartsWith( "brl." ) And Not modid.StartsWith( "pub." ) And Not modid.StartsWith("maxgui.") Continue Zusätzlich kann ich noch die Datei "src\makedocs\readme.txt" empfehlen, da findet sich auch einiges zur Formatierung der eigenen Dokumentation. Das sind jetzt keine großen Erkentnisse, aber vielleicht Anhaltspunkte für Leute, die sich damit eingehender beschäftigen wollen. Evtl. reicht es schon, den eigenen Scopebezeichner oben hinzuzufügen und alles neu zu bilden, ich möchte aber grade nicht die Gefahr eingehen, meine Installation zu ruinieren BTW: Was müsste man denn eigentlich neu builden?

Tritium

Sa, Apr 23, 2011 13:13
Antworten mit Zitat

Holzchopf hat Folgendes geschrieben:

Damit du deine eigenen Module dort hinein kriegst, müsstet du wahrscheinlich was an der docmods.bmx (E:\BlitzMax\src\docmods) oder makedocs (E:\BlitzMax\src\makedocs) ändern.

Ja, folgendes hab ich gefunden:
Code: [AUSKLAPPEN]

'docmods.bmx

Rem
Note: docmods is now only used to build 3rd party modules.
BRL, MAXGUI and PUB mods are built by new makedocs.
End Rem
...
If modid.StartsWith( "brl." ) Or modid.StartsWith( "pub." ) Or modid.StartsWith( "maxgui." ) Continue

Code: [AUSKLAPPEN]

'makedocs.bmx

Rem
Build new style docs.
Only builds official docs and brl, maxgui and pub modules.
Calls 'docmods' first, which builds 3rd party modules.
End Rem
...
If Not modid.StartsWith( "brl." ) And Not modid.StartsWith( "pub." ) And Not modid.StartsWith("maxgui.") Continue

Zusätzlich kann ich noch die Datei "src\makedocs\readme.txt" empfehlen, da findet sich auch einiges zur Formatierung der eigenen Dokumentation.

Das sind jetzt keine großen Erkentnisse, aber vielleicht Anhaltspunkte für Leute, die sich damit eingehender beschäftigen wollen. Evtl. reicht es schon, den eigenen Scopebezeichner oben hinzuzufügen und alles neu zu bilden, ich möchte aber grade nicht die Gefahr eingehen, meine Installation zu ruinieren Wink

BTW: Was müsste man denn eigentlich neu builden?

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

Nach Oben

BlitzBasic Portal

Problem mit DocMods

Betreff: Problem mit DocMods