diff --git a/_includes/machine-engines.html b/_includes/machine-engines.html index 1179183e6..35466034a 100644 --- a/_includes/machine-engines.html +++ b/_includes/machine-engines.html @@ -1,3 +1,25 @@ +{% comment %} +As documented in /modules/markout/lib/markout.js, the following machine properties are recognized in Front Matter: + + 'id' (eg, "ibm5150") + 'name' (eg, "IBM PC (Model 5150) with Monochrome Display") + 'type' (eg, "pc" or "pc-dbg") + 'config' (eg, "machine.xml") + 'template' (eg, "machine.xsl") + 'uncompiled' (eg, true) + 'parms' + +and the following properties (along with any property not listed above) will be added to the 'parms' property: + + 'automount' (eg, {"A":{"name":"OS/2 FOOTBALL Boot Disk (v7.68.17)","path":"/disks/pc/os2/misc/football/debugger/FOOTBALL-7.68.17.json"}}) + 'state' (eg, "state.json") + 'messages' (eg, "disk") + +Of all the above properties, the following are purely cosmetic: + + 'name' (used by machine.html, not machine-engines.html) + +{% endcomment %} {% for machine in page.machines %} {% capture machine_embed %}window.embed{{ machine.type | remove:'-dbg' | upcase }}{% endcapture %} {% unless machine.config %} diff --git a/_includes/machine.html b/_includes/machine.html index 69a0ef37f..7b1e4619e 100644 --- a/_includes/machine.html +++ b/_includes/machine.html @@ -1 +1,10 @@ -
+
+ {% assign machine_name = "PCjs: The Virtual IBM PC" %} + {% for machine in page.machines %} + {% if include.id == machine.id and machine.name%} + {% assign machine_name = machine.name %} + {% break %} + {% endif %} + {% endfor %} + [{{ machine_name }}] +
diff --git a/disks/README.md b/disks/README.md index adb26e5d8..28d00a608 100644 --- a/disks/README.md +++ b/disks/README.md @@ -21,5 +21,5 @@ with the *format* parameter set to `img` instead of `json`. For example: In fact, when browsing the disk archives, the PCjs web server automatically provides "onclick" handlers for links to JSON-encoded disk images, which will invoke the API for you. -See **Creating PCjs-Compatible Disk Images** in the [PCjs Documentation](/docs/pcjs/) for more information -about supported disks and formats. +See **Creating PCjs-Compatible Disk Images** in the [PCjs Documentation](/docs/pcjs/#creating-pcjs-compatible-disk-images) +for more information about supported disks and formats. diff --git a/index.md b/index.md index 22d10b56f..f730ecb2d 100644 --- a/index.md +++ b/index.md @@ -4,6 +4,7 @@ permalink: / machines: - type: pc id: ibm5150 + name: "IBM PC (Model 5150) with Monochrome Display" config: /devices/pc/machine/5150/mda/64kb/machine.xml - type: c1p id: demoC1P diff --git a/modules/markout/lib/markout.js b/modules/markout/lib/markout.js index 9fb3f8476..3e49e3fbb 100644 --- a/modules/markout/lib/markout.js +++ b/modules/markout/lib/markout.js @@ -314,7 +314,8 @@ MarkOut.aHTMLEntities = { * to the 'parms' object as a string property. * * 'id' (eg, "ibm5150") - * 'type' (eg, "pc") + * 'name' (eg, "IBM PC (Model 5150) with Monochrome Display") + * 'type' (eg, "pc" or "pc-dbg") * 'config' (eg, "machine.xml") * 'template' (eg, "machine.xsl") * 'uncompiled' (eg, true) @@ -328,7 +329,7 @@ MarkOut.aHTMLEntities = { * * and any other string-based property you wish to pass through to PCjs (via the embedPC() sParms parameter). */ -MarkOut.aFMReservedMachineProps = ['id', 'type', 'config', 'template', 'uncompiled', 'automount', 'parms']; +MarkOut.aFMReservedMachineProps = ['id', 'name', 'type', 'config', 'template', 'uncompiled', 'automount', 'parms']; /** * convertMD()