Initial commit (a clone of the jsmachines project as of v1.15.3)

docs/pcjs/fdc/README.md

@@ -0,0 +1,75 @@
+<FDC>
+===
+
+PCjs *FDC* (Floppy Disk Controller) XML Specification
+---
+
+Format
+---
+	<fdc>...</fdc>
+
+Purpose
+---
+Creates an instance of the Floppy Disk Controller (FDC) component. The FDC is responsible for:
+
+- Automatically loading diskette image files at boot;
+- Simulating the appropriate controller hardware ports;
+- Providing user controls to display available diskettes and load/unload diskettes;
+- Saving/restoring all user diskette modifications in browser local storage.
+
+Attributes
+---
+ * *automount* (optional)
+ 
+	This is an object definition containing one or more drive-letter properties.
+	Each drive-letter property should contain, in turn, another object definition with 'name' and 'path' properties.
+	For example:
+	
+		'{A: {name: "PC-DOS 1.0", path: "pcdos-1.00.json"}}'
+		
+Also supports the attributes of *[Component](/docs/pcjs/component/)*.
+
+Bindings
+---
+ * *listDrives*
+ 
+	For use with a control of type *list*. The list will be populated automatically with a series of &lt;option&gt;
+	elements based on the number of floppy drives, as determined by the SW1 settings obtained from the
+	[ChipSet](/docs/pcjs/chipset/) component.
+	
+ * *listDisks*
+ 
+	For use with a control of type *list*. This list must be manually populated, using &lt;disk&gt; tags.
+	See the example below.
+	
+ * *loadDrive*
+ 
+	For use with a control of type *button*, to load the selected diskette image into the selected drive.
+	This control is also used to unload diskette images. Select the diskette you want to unload, then select
+	"None" from the list of diskettes, and click this button.
+
+Example
+---
+	<fdc id="fdcNEC" automount="'{A: {name: "PC-DOS 1.0", path: "pcdos-1.00.json"}}'">
+    	<control type="container">
+    		<control type="list" class="input" binding="listDrives"/>
+    		<control type="list" class="input" binding="listDisks">
+    			<disk path="">None</disk>
+    			<disk path="pcdos-1.00.json">PC-DOS 1.0</disk>
+    		</control>
+    		<control type="button" class="input" binding="loadDrive">Load Drive</control>
+    	</control>
+    </fdc>
+
+Output
+---
+	<div id="..." class="pc-fdc pc-component">
+		<div class="pc-container">
+			<div class="pcjs-fdc" data-value="id:'...',name:'...',listDrives:'...',listDisks:'...',loadDrive:'...'"></div>
+		</div>
+	</div>
+
+Also, if any controls are defined, another &lt;div&gt; of class="pc-controls" is created in the container &lt;div&gt;,
+with each control inside a &lt;div&gt; of class="pc-control".
+
+[Return to [PCjs Documentation](..)]