| Name | Modified | Size | Downloads / Week |
|---|---|---|---|
| README.md | 2026-11-10 | 5.0 kB | |
| msxbasicdoc_linux64_0.4.0.zip | 2026-10-27 | 106.9 kB | |
| msxbasicdoc_win64_0.4.0.zip | 2026-10-27 | 196.5 kB | |
| Totals: 3 Items | 308.3 kB | 0 |
MSX-BASIC documentatietool
Commandline-tool die documentatie genereert uit BASIC-broncode:
| msxbasicdoc | MSX-BASIC (ASCII-opgeslagen .BAS) | HTML, optioneel Graphviz |
English summary: see below.
Inhoud van de repository
msxbasicdoc/
msxbasicdoc.bas
inc/
mbd_globals.bi mbd_lang.bi mbd_util.bi mbd_lexer.bi
mbd_load.bi mbd_analyse.bi mbd_flow.bi mbd_html.bi
mbd_svg.bi
lang/
msxbasicdoc.pot nl.po
examplemsxbasic
LICENSE
CHANGELOG.md
README.md
Compileren
Je hebt de FreeBASIC-compiler (fbc) nodig.
cd msxbasicdoc fbc -lang fblite msxbasicdoc.bas
Werkt op Linux en Windows; het padscheidingsteken wordt bij het compileren gekozen.
Wil je een vertaling gebruiken, zet dan de map `lang` naast het programma (zie [Vertalingen](#vertalingen)).
## msxbasicdoc
Brengt de structuur van een MSX-BASIC-programma in kaart door `GOTO`, `GOSUB`, `RETURN` en verwante sprongen te volgen, en maakt daar één HTML-pagina van.
### Wat het doet
- Deelt het programma op in routines op basis van sprongdoelen
- Toont welke routine welke aanroept, met een aanroepgraaf (SVG in de HTML, optioneel Graphviz)
- Bepaalt welke regels bereikbaar zijn
- Maakt een overzicht van gebruikte variabelen (met `DEFINT`/`DEFSTR`/... in acht genomen)
- Geeft waarschuwingen, bijvoorbeeld bij sprongen naar niet-bestaande regels
### Invoer
Het programma moet als **ASCII** zijn opgeslagen. Op de MSX:
SAVE "NAAM.BAS",A
Een getokeniseerd bestand wordt herkend en geweigerd met een melding.
### Commentaar schrijven
10 '## Kleuren - klein demoprogramma 20 ' Laat zien hoe msxbasicdoc commentaar oppikt. 30 GOSUB 1000 40 END 1000 '## TekenRand - tekent een rand om het scherm 1010 '@in K = kleur 1020 '@uit niets 1030 ' Wist eerst het scherm. 1040 CLS 1050 RETURN
| Vorm | Betekenis |
|---|---|
| `'## Naam - omschrijving` | naam van de routine; bovenaan het programma: titel van het programma |
| `'@tag waarde` | vrije tags, bijvoorbeeld `'@in X,Y` of `'@uit A$` |
| `' tekst` | omschrijving |
### Gebruik
msxbasicdoc [opties] PROGRAMMA.BAS [...]
| Optie | Betekenis |
|---|---|
| `-o MAP` | uitvoer in MAP (standaard naast het bronbestand) |
| `-dot` | ook een Graphviz `.dot`-bestand maken |
| `-l CODE` | taal van alle teksten (standaard `en`), zie [Vertalingen](#vertalingen) |
| `-q` | stil: alleen fouten tonen |
| `-h` | hulp |
Per bestand ontstaat `PROGRAMMA.html` (en met `-dot` ook `PROGRAMMA.dot`).
---
## Vertalingen
Standaard Engelstalig. Een vertaling is een gettext `.po`-bestand in de map
`lang` naast het programma. Met `-l` kies je de taal:
```sh
msxbasicdoc -l nl JAGER.BAS
-l nllaadtlang/nl.ponaast het programma, en anderslang/nl.poin de huidige map-l pad/naar/es.polaadt een.po-bestand op een willekeurige plek- de omgevingsvariabelen
MSXBASICDOC_LANGzetten de standaardtaal - ontbreekt een tekst in de vertaling, dan blijft die Engels
Een Nederlandse vertaling (nl.po) wordt meegeleverd.
Een taal toevoegen
- Kopieer
lang/msxbasicdoc.potnaarlang/<code>.po, bijvoorbeeldlang/es.pooflang/ja.po. - Vul de
msgstr-regels in en zet de taalcode bijLanguage:in de kop. Een programma als Poedit werkt ook. - Sla het bestand op als UTF-8.
%1, %2 en %3 worden door het programma ingevuld; houd ze aan, in elke gewenste volgorde.
Voor de datumnotatie (%1-%2-%3) en het decimaalteken (%1.%2).
Licentie
Copyright © 2026 Marcel "SmartDuck" Beekman
Uitgebracht onder de 3-clause BSD-licentie.
Je mag de tools vrij gebruiken, aanpassen en verspreiden, ook commercieel, zolang de
copyrightvermelding en licentietekst behouden blijven. Zie LICENSE voor de
volledige tekst.
In English
Command-line tool that generates documentation from BASIC source code, written in FreeBASIC with no external dependencies.
msxbasicdoc maps the structure of an MSX-BASIC program by following GOTO/GOSUB/RETURN. It splits the program into routines, draws a call graph, lists variables, checks reachability and warns about jumps to missing lines. Input must be saved as ASCII on the MSX (SAVE "NAME.BAS",A). Name routines with '## Name - description and add tags with '@tag value.
English by default. Translations are gettext .po files in a lang
folder next to the program; select one with -l (for example -l nl, which ships with the
tools) or with the MSXBASICDOC_LANG environment variable. To add a language,
copy lang/msxbasicdoc.pot to lang/<code>.po, fill in the msgstr
lines and save as UTF-8. Untranslated lines stay in English.
Build:
fbc -lang fblite msxbasicdoc/msxbasicdoc.bas
Released under the 3-clause BSD license, copyright © 2026 Marcel "SmartDuck" Beekman.
See LICENSE.