maidr 1.0.3 → 1.0.5

package/LICENSE.md

@@ -1,5 +1,4 @@
-GNU General Public License
-==========================
+# GNU General Public License
 
 _Version 3, 29 June 2007_  
 _Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
@@ -193,20 +192,20 @@ You may convey a work based on the Program, or the modifications to produce it f
 the Program, in the form of source code under the terms of section 4, provided that
 you also meet all of these conditions:
 
-* **a)** The work must carry prominent notices stating that you modified it, and giving a
-relevant date.
-* **b)** The work must carry prominent notices stating that it is released under this
-License and any conditions added under section 7. This requirement modifies the
-requirement in section 4 to “keep intact all notices”.
-* **c)** You must license the entire work, as a whole, under this License to anyone who
-comes into possession of a copy. This License will therefore apply, along with any
-applicable section 7 additional terms, to the whole of the work, and all its parts,
-regardless of how they are packaged. This License gives no permission to license the
-work in any other way, but it does not invalidate such permission if you have
-separately received it.
-* **d)** If the work has interactive user interfaces, each must display Appropriate Legal
-Notices; however, if the Program has interactive interfaces that do not display
-Appropriate Legal Notices, your work need not make them do so.
+- **a)** The work must carry prominent notices stating that you modified it, and giving a
+  relevant date.
+- **b)** The work must carry prominent notices stating that it is released under this
+  License and any conditions added under section 7. This requirement modifies the
+  requirement in section 4 to “keep intact all notices”.
+- **c)** You must license the entire work, as a whole, under this License to anyone who
+  comes into possession of a copy. This License will therefore apply, along with any
+  applicable section 7 additional terms, to the whole of the work, and all its parts,
+  regardless of how they are packaged. This License gives no permission to license the
+  work in any other way, but it does not invalidate such permission if you have
+  separately received it.
+- **d)** If the work has interactive user interfaces, each must display Appropriate Legal
+  Notices; however, if the Program has interactive interfaces that do not display
+  Appropriate Legal Notices, your work need not make them do so.
 
 A compilation of a covered work with other separate and independent works, which are
 not by their nature extensions of the covered work, and which are not combined with
@@ -222,35 +221,35 @@ You may convey a covered work in object code form under the terms of sections 4
 5, provided that you also convey the machine-readable Corresponding Source under the
 terms of this License, in one of these ways:
 
-* **a)** Convey the object code in, or embodied in, a physical product (including a
-physical distribution medium), accompanied by the Corresponding Source fixed on a
-durable physical medium customarily used for software interchange.
-* **b)** Convey the object code in, or embodied in, a physical product (including a
-physical distribution medium), accompanied by a written offer, valid for at least
-three years and valid for as long as you offer spare parts or customer support for
-that product model, to give anyone who possesses the object code either **(1)** a copy of
-the Corresponding Source for all the software in the product that is covered by this
-License, on a durable physical medium customarily used for software interchange, for
-a price no more than your reasonable cost of physically performing this conveying of
-source, or **(2)** access to copy the Corresponding Source from a network server at no
-charge.
-* **c)** Convey individual copies of the object code with a copy of the written offer to
-provide the Corresponding Source. This alternative is allowed only occasionally and
-noncommercially, and only if you received the object code with such an offer, in
-accord with subsection 6b.
-* **d)** Convey the object code by offering access from a designated place (gratis or for
-a charge), and offer equivalent access to the Corresponding Source in the same way
-through the same place at no further charge. You need not require recipients to copy
-the Corresponding Source along with the object code. If the place to copy the object
-code is a network server, the Corresponding Source may be on a different server
-(operated by you or a third party) that supports equivalent copying facilities,
-provided you maintain clear directions next to the object code saying where to find
-the Corresponding Source. Regardless of what server hosts the Corresponding Source,
-you remain obligated to ensure that it is available for as long as needed to satisfy
-these requirements.
-* **e)** Convey the object code using peer-to-peer transmission, provided you inform
-other peers where the object code and Corresponding Source of the work are being
-offered to the general public at no charge under subsection 6d.
+- **a)** Convey the object code in, or embodied in, a physical product (including a
+  physical distribution medium), accompanied by the Corresponding Source fixed on a
+  durable physical medium customarily used for software interchange.
+- **b)** Convey the object code in, or embodied in, a physical product (including a
+  physical distribution medium), accompanied by a written offer, valid for at least
+  three years and valid for as long as you offer spare parts or customer support for
+  that product model, to give anyone who possesses the object code either **(1)** a copy of
+  the Corresponding Source for all the software in the product that is covered by this
+  License, on a durable physical medium customarily used for software interchange, for
+  a price no more than your reasonable cost of physically performing this conveying of
+  source, or **(2)** access to copy the Corresponding Source from a network server at no
+  charge.
+- **c)** Convey individual copies of the object code with a copy of the written offer to
+  provide the Corresponding Source. This alternative is allowed only occasionally and
+  noncommercially, and only if you received the object code with such an offer, in
+  accord with subsection 6b.
+- **d)** Convey the object code by offering access from a designated place (gratis or for
+  a charge), and offer equivalent access to the Corresponding Source in the same way
+  through the same place at no further charge. You need not require recipients to copy
+  the Corresponding Source along with the object code. If the place to copy the object
+  code is a network server, the Corresponding Source may be on a different server
+  (operated by you or a third party) that supports equivalent copying facilities,
+  provided you maintain clear directions next to the object code saying where to find
+  the Corresponding Source. Regardless of what server hosts the Corresponding Source,
+  you remain obligated to ensure that it is available for as long as needed to satisfy
+  these requirements.
+- **e)** Convey the object code using peer-to-peer transmission, provided you inform
+  other peers where the object code and Corresponding Source of the work are being
+  offered to the general public at no charge under subsection 6d.
 
 A separable portion of the object code, whose source code is excluded from the
 Corresponding Source as a System Library, need not be included in conveying the
@@ -316,22 +315,22 @@ Notwithstanding any other provision of this License, for material you add to a
 covered work, you may (if authorized by the copyright holders of that material)
 supplement the terms of this License with terms:
 
-* **a)** Disclaiming warranty or limiting liability differently from the terms of
-sections 15 and 16 of this License; or
-* **b)** Requiring preservation of specified reasonable legal notices or author
-attributions in that material or in the Appropriate Legal Notices displayed by works
-containing it; or
-* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that
-modified versions of such material be marked in reasonable ways as different from the
-original version; or
-* **d)** Limiting the use for publicity purposes of names of licensors or authors of the
-material; or
-* **e)** Declining to grant rights under trademark law for use of some trade names,
-trademarks, or service marks; or
-* **f)** Requiring indemnification of licensors and authors of that material by anyone
-who conveys the material (or modified versions of it) with contractual assumptions of
-liability to the recipient, for any liability that these contractual assumptions
-directly impose on those licensors and authors.
+- **a)** Disclaiming warranty or limiting liability differently from the terms of
+  sections 15 and 16 of this License; or
+- **b)** Requiring preservation of specified reasonable legal notices or author
+  attributions in that material or in the Appropriate Legal Notices displayed by works
+  containing it; or
+- **c)** Prohibiting misrepresentation of the origin of that material, or requiring that
+  modified versions of such material be marked in reasonable ways as different from the
+  original version; or
+- **d)** Limiting the use for publicity purposes of names of licensors or authors of the
+  material; or
+- **e)** Declining to grant rights under trademark law for use of some trade names,
+  trademarks, or service marks; or
+- **f)** Requiring indemnification of licensors and authors of that material by anyone
+  who conveys the material (or modified versions of it) with contractual assumptions of
+  liability to the recipient, for any liability that these contractual assumptions
+  directly impose on those licensors and authors.
 
 All other non-permissive additional terms are considered “further
 restrictions” within the meaning of section 10. If the Program as you received

package/README.md

@@ -9,7 +9,7 @@ maidr is a system for non-visual access and control of statistical plots. It aim
 3. [Braille Generation](#braille-generation)
 4. [License](#license)
 5. [Contact](#contact)
-6. [Acknowledgements](#acknowledgements)
+6. [Acknowledgments](#acknowledgments)
 
 ## Usage
 
@@ -25,16 +25,16 @@ To use maidr, follow these steps:
   <head>
     <meta charset="UTF-8" />
     <title>maidr Example</title>
-    <link rel="stylesheet" href="styles.min.css" />
+    <link
+      rel="stylesheet"
+      href="https://cdn.jsdelivr.net/npm/maidr/dist/maidr_style.min.css"
+    />
+    <script src="https://cdn.jsdelivr.net/npm/maidr/dist/maidr.min.js"></script>
   </head>
   <body>
     <div>
       <!-- Your SVG plot is here -->
     </div>
-    <script>
-      <!-- json data is here -->
-    </script>
-    <script src="maidr.min.js"></script>
   </body>
 </html>
 ```
@@ -236,20 +236,29 @@ Below is a detailed list of keyboard shortcuts for various functions:
 
 ### Scatterplot Controls
 
-In the Scatterplot plot, there are two layers: point mode (layer 1) and line mode (layer 2). To switch between these layers, use the Page Up and Page Down keys:
+In the Scatterplot, there are two layers: point mode (layer 1) and line mode (layer 2). To switch between these layers, use the Page Up and Page Down keys:
 
 - Press Page Up to move from point mode to line mode
 - Press Page Down to move from line mode to point mode
 
 Note that this control scheme can be used by any plot with multiple types.
 
+### Segmented Bar Controls
+
+In the various segmented bar plots (stacked bar, dodged bar, and normalized stacked bar), Up Down Left Right controls function similar to a grid:
+
+- Left and Right arrows move between different bars or points on the x axis.
+- Up and Down arrows move between different layers of the same bar or point on the x axis.
+
+Note that there are also pseudo layers at the top of each layer stack: a Summary layer representing a sum of all that bar's values, and a Combined layer that plays a separated or combined run of tones of all the layers. The standard 'S' key that controls sonification now has an extra setting to play either combined tones or separated tones.
+
 ## Braille Generation
 
 maidr incorporates a Braille mode that represents the plot using Braille symbols. This allows users with visual impairments to explore and interact with the plot using a refreshable Braille display. To achieve this, our system translates the plot's visual elements and data points into a corresponding tactile representation using Braille patterns. For different plot types, such as barplot, boxplot, heatmap, and scatterplot, maidr employs unique encoding strategies tailored to effectively convey the data distribution, patterns, and trends. These tactile encodings range from using distinct Braille characters to represent value ranges, to employing characters that visually resemble the corresponding sections of a plot. By providing a comprehensive Braille representation for various plot types, maidr enables users with visual impairments to gain a deeper understanding of the underlying data and its insights.
 
 ### Barplot
 
-In the Braille representation of a barplot, data values are encoded as Braille characters based on their relative magnitude within the plot. Low values are denoted by Braille characters that have dots only along the bottom, while high values are indicated by characters that are filled with dots. Given the four height levels of Braille, the encoding is as follows:
+In the Braille representation of a barplot, data values are encoded as Braille characters based on their relative magnitude within the plot. Low values are denoted by Braille characters that have dots only along the bottom, while high values are indicated by characters that have dots along the top. Given the four height levels of Braille, the encoding is as follows:
 
 - ⣀ represents values 0 to 25%
 - ⠤ represents the 25% to 50%
@@ -318,6 +327,20 @@ In the Braille representation of a scatterplot, the encoding is performed only f
 - ⠒ represents values from 50% to 75%
 - ⠉ represents values from 75% to 100%
 
+### Segmented Bar Plots
+
+Stacked bar, dodged bar, and normalized stacked bar all share the same system:
+
+In the braille representation of segmented bar plots, braille depends on where you are. There are typically multiple levels to a segmented bar plot, and as you move (Up and Down arrow keys) between levels, the braille changes to represent your current level. At the top, there is also a Summary pseudo layer of all levels added together, and a Combined pseudo layer of each layer seperately.
+
+- Regular layers: Braille appears similar to a bar plot, with braille values corresponding to the magnitude of the layer's value for this point.
+- Summary layer: Same as regular layers, but values now reflect the combined magnitude of all layers' values for this point.
+- Combined layer: Similar to heatmap, where there are groups of magnitudes for each point separated by a ⢳ character. The first group has braille characters for each layer for the first point, then a seperator, then the second group has braille characters for each layer in the second point, then a seperator, and so on.
+
+### Lineplot
+
+In the Braille representation of a lineplot, braille is nearly identical to the above barplot: data values are encoded as Braille characters based on their relative magnitude within the plot. Low values are denoted by Braille characters that have dots only along the bottom, while high values are indicated by characters that have dots higher up.
+
 ## License
 
 This project is licensed under the GPL 3 License.