Vollumfängliche Dokumentation?

Übersicht

BlitzMax, BlitzMax NG

Allgemein

	Holzchopf Meisterpacker Betreff: Vollumfängliche Dokumentation?	So, Jun 12, 2011 12:10 Antworten mit Zitat
Hallo zusammen! Also, eigentlich arbeite ich ja schon lange mit BMax, ärgere mich aber immer noch oft über die Dokumentation. Ich verwende sowohl die alte Dok (die ich über die help-Leiste rechts erreiche) und HotDocs 1.3 (2xF1 oder Help - Home). Was mich bei beiden Dokumentationen stört: es gibt kein funktionierendes Parameter-Dokumentations-Keyword Oder ich hätte zumindest noch nicht herausgefunden, wie es funktionieren würde und habe auch noch nie ein Modul gesehen, bei dem es in der Doku vorkommt. Meiner Meinung nach ein sehr wichtiges Feature =/ (So wie ich das sehe, wurde es zwar implementiert, aber wird nie in die HTML-Hilfe ausgegeben) So bleibt mir eigentlich nur die unschöne Variante, Parameter im about-Abschnitt zu erklären. Aber da kommt mein zweites Problem: Ich hätte Parameter gerne in einer Tabelle dargestellt. Das geht ja auch, dank Code: [AUSKLAPPEN] [EINKLAPPEN] [ @Item \| @Value * item1 \| value1 ] sogar ganz gut - nur nicht in HotDocs. D.h: HotDocs ignoriert erfolgreich sämtliche Formatierungen, das stört mich. Relativ grob sogar. Ich bin nicht immer auf dem Laufenden (viel BMax-Zeugs läuft ja vor allem in der engl. Community ab) und wollte darum fragen: Gibt es irgendwo da draussen eine kompatible, schicke Alternative zur Original-Doku (BBDoc)? 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

Betreff: Vollumfängliche Dokumentation?

So, Jun 12, 2011 12:10
Antworten mit Zitat

Hallo zusammen!

Also, eigentlich arbeite ich ja schon lange mit BMax, ärgere mich aber immer noch oft über die Dokumentation. Ich verwende sowohl die alte Dok (die ich über die help-Leiste rechts erreiche) und HotDocs 1.3 (2xF1 oder Help - Home).

Was mich bei beiden Dokumentationen stört: es gibt kein funktionierendes Parameter-Dokumentations-Keyword Confused

Oder ich hätte zumindest noch nicht herausgefunden, wie es funktionieren würde und habe auch noch nie ein Modul gesehen, bei dem es in der Doku vorkommt. Meiner Meinung nach ein sehr wichtiges Feature =/ (So wie ich das sehe, wurde es zwar implementiert, aber wird nie in die HTML-Hilfe ausgegeben)

So bleibt mir eigentlich nur die unschöne Variante, Parameter im about-Abschnitt zu erklären.

Aber da kommt mein zweites Problem:
Ich hätte Parameter gerne in einer Tabelle dargestellt. Das geht ja auch, dank Code: [AUSKLAPPEN]

[ @Item | @Value
* item1 | value1
]

sogar ganz gut - nur nicht in HotDocs. D.h: HotDocs ignoriert erfolgreich sämtliche Formatierungen, das stört mich. Relativ grob sogar.

Ich bin nicht immer auf dem Laufenden (viel BMax-Zeugs läuft ja vor allem in der engl. Community ab) und wollte darum fragen:
Gibt es irgendwo da draussen eine kompatible, schicke Alternative zur Original-Doku (BBDoc)?

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

	Xeres Moderator	So, Jun 12, 2011 12:31 Antworten mit Zitat
In der Doku kann man eigentlich gleich Html benutzen: Code: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Macht dies und das. about: <table> <tr><th>Titel 1</th><th>Titel 2</th></tr> <tr><td>Eintrag 1A</td><td>Eintrag 2A</td></tr> <tr><td>Eintrag 1B</td><td>Eintrag 2B</td></tr> </table> End Rem Kommt HotDocs damit besser zurecht?
Win10 Prof.(x64)/Ubuntu 16.04\|CPU 4x3Ghz (Intel i5-4590S)\|RAM 8 GB\|GeForce GTX 960 Wie man Fragen richtig stellt \|\| "Es geht nicht" \|\| Video-Tutorial: Sinus & Cosinus THERE IS NO FAIR. THERE IS NO JUSTICE. THERE IS JUST ME. (Death, Discworld)

Xeres

Moderator

So, Jun 12, 2011 12:31
Antworten mit Zitat

In der Doku kann man eigentlich gleich Html benutzen:
Code: [AUSKLAPPEN]

Rem
bbdoc: Macht dies und das.
about:
<table>
<tr><th>Titel 1</th><th>Titel 2</th></tr>
<tr><td>Eintrag 1A</td><td>Eintrag 2A</td></tr>
<tr><td>Eintrag 1B</td><td>Eintrag 2B</td></tr>
</table>
End Rem

Kommt HotDocs damit besser zurecht?

Win10 Prof.(x64)/Ubuntu 16.04|CPU 4x3Ghz (Intel i5-4590S)|RAM 8 GB|GeForce GTX 960
Wie man Fragen richtig stellt || "Es geht nicht" || Video-Tutorial: Sinus & Cosinus
THERE IS NO FAIR. THERE IS NO JUSTICE. THERE IS JUST ME. (Death, Discworld)

	Holzchopf Meisterpacker	So, Jun 12, 2011 13:26 Antworten mit Zitat
Ja, tut es. Aber ich verstehe nicht, wieso man HotDocs da nicht kompatibel zu BBDocs machte. Ich meine, der Sinn der Dok-Sache sollte ja sein, dass man eben nicht mehr selber html-Code schreiben muss =/
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

So, Jun 12, 2011 13:26
Antworten mit Zitat

Ja, tut es. Aber ich verstehe nicht, wieso man HotDocs da nicht kompatibel zu BBDocs machte. Ich meine, der Sinn der Dok-Sache sollte ja sein, dass man eben nicht mehr selber html-Code schreiben muss =/

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	So, Jun 12, 2011 13:48 Antworten mit Zitat
Wenn ich mich recht erinnere wurde die BMax-Dokumentation NACH release von Hotdocs durch Marc S. nochmal umgestellt. Das könnte die Inkonsistenzen erklären. Vielleicht findet sich ja mal ein mutiges Köpfchen was HotDocs an die Gegebenheiten anpasst.
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

So, Jun 12, 2011 13:48
Antworten mit Zitat

Wenn ich mich recht erinnere wurde die BMax-Dokumentation NACH release von Hotdocs durch Marc S. nochmal umgestellt. Das könnte die Inkonsistenzen erklären.
Vielleicht findet sich ja mal ein mutiges Köpfchen was HotDocs an die Gegebenheiten anpasst.

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

Übersicht

BlitzMax, BlitzMax NG

Allgemein

Nach Oben

BlitzBasic Portal

Vollumfängliche Dokumentation?

Holzchopf

Betreff: Vollumfängliche Dokumentation?

Xeres

Holzchopf

BladeRunner