Updated Mouse and Serial docs

This commit is contained in:
Jeff Parsons 2017-09-12 08:33:34 -07:00 committed by Jeff Parsons
commit 1bc36c1c07
3 changed files with 61 additions and 24 deletions

View file

@ -40,7 +40,7 @@ Even this Wikipedia article on the [Microsoft Mouse](https://en.wikipedia.org/wi
The first Microsoft Mouse, introduced in 1983, was available in Serial and Bus versions. The Serial version required
a serial port using a DB-25 connector, while the Bus version came with a small ISA card that connected to the mouse
with a smaller DB-9 connector. For more details (with pictures), check out this 2014 article on
with a smaller DE-9 connector. For more details (with pictures), check out this 2014 article on
[The Original Microsoft Mouse](https://communities.intel.com/docs/DOC-22714).
Fast-forward to 1986, when Microsoft announced the InPort chip. As of May 9, 1986, all of its "Bus" mice were

View file

@ -5,43 +5,74 @@ permalink: /docs/pcx86/mouse/
---
PCx86 Mouse Component
---
---------------------
Format
---
------
```xml
<mouse>...</mouse>
```
Purpose
---
Creates an instance of the Mouse component, which simulates the original Microsoft Serial Mouse.
-------
Creates an instance of the Mouse component, which can be used simulate a Microsoft Serial mouse, Bus mouse, or
InPort mouse.
Attributes
---
* *serial* (required)
----------
Specifies the id of the Serial component that the mouse must be connected to.
As support for more types of mouse hardware are added, new attributes will be added. Also supports the attributes
of *[Component](/docs/pcx86/component/)*.
* *adapter*
1 (primary), 2 (secondary), 0 if not defined; used to select the port range for an InPort mouse
* *binding*
The name of a corresponding device component (implies *type* of "serial", since none of the other mouse
types require binding with another component)
* *scaleMouse*
A floating-point number used to scale incoming mouse coordinates; the default is 0.5
* *serial* (deprecated; *type* should be set to "serial" and *binding* set to the Serial component ID instead)
The ID of the Serial component that the mouse must be connected to
* *type*
One of "serial", "bus", or "inport"; the default is "serial" if either *serial* or *binding* are set
* Also supports the attributes of *[Component](/docs/pcx86/component/)*.
Bindings
---
None.
--------
No explicit DOM control bindings are used. The Mouse component automatically binds to all Video screens attached
to the machine in order to obtain mouse events from the browser.
Example
---
-------
```xml
<mouse type="serial" binding="com1"/>
```
The "serial" example above shows how the *type* and *binding* attributes combine to supersede the *serial* attribute,
which has been deprecated:
```xml
<mouse serial="com1"/>
```
Output
---
------
```html
<div id="..." class="pc-mouse pc-component">
<div class="pc-container">
<div class="pcx86-mouse" data-value="id:'...',name:'...',serial:'...'>
<div class="pcx86-mouse" data-value="id:'...',name:'...',type:'...',binding:'...'>
</div>
</div>
</div>

View file

@ -5,20 +5,23 @@ permalink: /docs/pcx86/serial/
---
PCx86 SerialPort Component
---
--------------------------
Format
---
------
```xml
<serial>...</serial>
```
Purpose
---
-------
Creates an instance of the SerialPort component, which simulates an IBM PC Asynchronous Adapter (RS-232).
Attributes
---
----------
* *adapter* (required)
A number (1 or 2) indicating whether this is a "Primary" or "Secondary" adapter.
@ -30,23 +33,26 @@ Attributes
For example, if you've defined a Control Panel with a &lt;textarea&gt; control bound to "print", specifying a
binding of "print" for the Serial Port component will bind its port to the same control.
Also supports the attributes of *[Component](/docs/pcx86/component/)*.
* Also supports the attributes of *[Component](/docs/pcx86/component/)*.
Bindings
---
--------
* *buffer*
For use with a control of type "textarea", to send/receive data to/from the port. If you would rather
bind the port to an existing control, then use *binding* attribute instead (see above).
Example
---
-------
```xml
<serial id="com1" adapter="1" binding="print"/>
```
Output
---
------
```html
<div id="..." class="pc-serial pc-component">
<div class="pc-container">