Wat is het?
Een kleine commandline-tool die documentatie maakt uit MSX-BASIC-programma's (als ASCII opgeslagen). msxbasicdoc draait op Windows en Linux, is geschreven in FreeBASIC en heeft geen extra bibliotheken nodig.
Uitvoer: één HTML-pagina per programma, optioneel ook een Graphviz-bestand.
Nieuw in versie 0.4.0
msxbasicdoc is nu standaard Engelstalig en kan worden vertaald. Een Nederlandse
vertaling wordt meegeleverd; gebruik -l nl voor de Nederlandse uitvoer.
Zie Vertalingen.
- Alle teksten zijn vertaalbaar: meldingen, hulptekst en de uitvoer zelf
- Vertalingen zijn gewone
.po-bestanden (gettext), te bewerken met bijvoorbeeld Poedit - Datumnotatie en decimaalteken volgen de gekozen taal
- Vertalingen met bijvoorbeeld Japanse of Spaanse tekens worden goed weergegeven
Wat het doet
Brengt de structuur van een MSX-BASIC-programma in kaart door
GOTO, GOSUB en RETURN te volgen.
Het resultaat is één HTML-pagina met de routines, een aanroepgraaf,
de gebruikte variabelen en waarschuwingen.
Sla het programma op de MSX op als ASCII: SAVE "SPEL.BAS",A
1000 '## TekenRand - tekent een rand om het scherm 1010 '@in K = kleur 1020 ' Wist eerst het scherm.
Een HTML-documentatiepagina genereren (in het Nederlands):
./msxbasicdoc -l nl SPEL.BAS
Ook een dot-bestand voor Graphviz genereren:
./msxbasicdoc -l nl -dot SPEL.BAS
Vertalingen
msxbasicdoc is standaard Engelstalig. Een vertaling is een .po-bestand
in de map lang naast het programma. Met -l kies je de taal:
| Zo | Betekenis |
|---|---|
-l nl | laadt lang/nl.po naast het programma (of in de huidige map) |
-l pad/naar/es.po | laadt een .po-bestand op een andere plek |
MSXBASICDOC_LANG | omgevingsvariabele voor de standaardtaal |
Ontbreekt een tekst in de vertaling, dan blijft die Engels.
Een taal toevoegen
- Kopieer
lang/msxbasicdoc.potnaarlang/<code>.po, bijvoorbeeldlang/es.pooflang/ja.po. - Vul de
msgstr-regels in en zet de taalcode bijLanguage:. - Sla het bestand op als UTF-8.
Nieuwe vertalingen, bijvoorbeeld Spaans of Japans voor de MSX-gemeenschap, zijn welkom via SourceForge.
Compileren
Installeer de FreeBASIC-compiler en voer uit:
fbc -lang fblite -s console msxbasicdoc.bas
Zet de map lang naast het programma als je een vertaling wilt gebruiken.
De broncode, de volledige handleiding (README) en de wijzigingen (CHANGELOG) staan op SourceForge.
Downloaden
| msxbasicdoc 0.4.0 | ||
|---|---|---|
| Windows | msxbasicdoc_win64_0.4.0.zip | 192 KB |
| Linux | msxbasicdoc_linux64_0.4.0.zip | 104 KB |