From 1bc36c1c0711e1dac27101e1e07a6d2c2fc0f1b9 Mon Sep 17 00:00:00 2001 From: Jeff Parsons Date: Tue, 12 Sep 2017 08:33:34 -0700 Subject: [PATCH 1/2] Updated Mouse and Serial docs --- _posts/2017-08-28-of-mice-and-when.md | 2 +- docs/pcx86/mouse/README.md | 61 ++++++++++++++++++++------- docs/pcx86/serial/README.md | 22 ++++++---- 3 files changed, 61 insertions(+), 24 deletions(-) diff --git a/_posts/2017-08-28-of-mice-and-when.md b/_posts/2017-08-28-of-mice-and-when.md index 07813715c..ae4b14b4b 100644 --- a/_posts/2017-08-28-of-mice-and-when.md +++ b/_posts/2017-08-28-of-mice-and-when.md @@ -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 diff --git a/docs/pcx86/mouse/README.md b/docs/pcx86/mouse/README.md index 3e4c0654a..575acc24e 100644 --- a/docs/pcx86/mouse/README.md +++ b/docs/pcx86/mouse/README.md @@ -5,43 +5,74 @@ permalink: /docs/pcx86/mouse/ --- PCx86 Mouse Component ---- +--------------------- Format ---- +------ + ```xml ... ``` 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 + +``` + +The "serial" example above shows how the *type* and *binding* attributes combine to supersede the *serial* attribute, +which has been deprecated: + ```xml ``` Output ---- +------ + ```html
-
``` Output ---- +------ + ```html
From 9d356c582b09132807dc80367305de05fd8cfcc9 Mon Sep 17 00:00:00 2001 From: Jeff Parsons Date: Tue, 12 Sep 2017 10:20:20 -0700 Subject: [PATCH 2/2] Updated Keyboard docs --- docs/pcx86/keyboard/README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/pcx86/keyboard/README.md b/docs/pcx86/keyboard/README.md index 36b53b549..c9b979bf3 100644 --- a/docs/pcx86/keyboard/README.md +++ b/docs/pcx86/keyboard/README.md @@ -5,21 +5,24 @@ permalink: /docs/pcx86/keyboard/ --- PCx86 Keyboard Component ---- +------------------------ Format ---- +------ + ```xml ... ``` Purpose ---- +------- + Creates an instance of the Keyboard component, which maps JavaScript key events (or other control events) to IBM PC keyboard scan codes. Attributes ---- +---------- + * *model* (optional) * us83: US keyboard with 83-key layout (default) * us84: US keyboard with 84-key layout @@ -28,7 +31,8 @@ Attributes Also supports the attributes of *[Component](/docs/pcx86/component/)*. Bindings ---- +-------- + * *esc*, *ctrl-c*, *ctrl-alt-del*, *left-arrow*, *up-arrow*, *right-arrow*, *down-arrow*, *f1*, *f2*, *f3*, *f4*, *f5*, *f6*, *f7*, *f8*, *f9*, *f10*, ... For use with a control of type button (or other control that supports the "onclick" event), to simulate the @@ -42,7 +46,8 @@ element to them, so they are generally unavailable for other components to use. for the specified model. Example ---- +------- + ```xml ``` @@ -51,7 +56,8 @@ See [/devices/pcx86/keyboard/us83-softkeys.xml](/devices/pcx86/keyboard/us83-sof complete "soft keyboard". Output ---- +------ + ```html