Support Unicode-16 octant characters (#8)

* Support Unicode-16 octant characters

* Update README and tests

* Add quadrant and sextant modes

* Add quadrant and sextant test cases

* Update README and CHANGELOG

* Update documentation

Author: eschnett

CHANGELOG.md

@@ -1,4 +1,10 @@
 # UnicodeGraphics.jl
+## Version `v0.2.2`
+* ![Feature][badge-feature] Added support for plotting via quadrants,
+  sextants, and octants. Octants requires Unicode 16 font support and
+  is in 2024 not yet widely available. Things will work but the result
+  will look bad. ([#8][pr-8])
+
 ## Version `v0.2.1`
 * ![Feature][badge-feature] Added support for multidimensional arrays ([#7][pr-7])
 
@@ -22,6 +28,7 @@
 
 [pr-5]: https://github.com/JuliaGraphics/UnicodeGraphics.jl/pull/5
 [pr-7]: https://github.com/JuliaGraphics/UnicodeGraphics.jl/pull/7
+[pr-8]: https://github.com/JuliaGraphics/UnicodeGraphics.jl/pull/8
 
 [badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
 [badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg

Project.toml

@@ -1,7 +1,7 @@
 name = "UnicodeGraphics"
 uuid = "ebadf6b4-db70-5817-83da-4a19ad584e34"
 authors = ["Rafael Schouten <[email protected]>"]
-version = "0.2.1"
+version = "0.2.2"
 
 [compat]
 julia = "1.6"

README.md

@@ -55,7 +55,21 @@ julia> uprint(pac, :block)
  ▀█████████████████ 
   ▀██████████████▀  
      ▀▀██████▀▀     
+
+julia> uprint(pac, :sextant)
+ 🬞🬵🬻██🬺🬱🬏
+🬞███🬕🬨███🬓
+🬻█████🬝🬆🬀
+█████🬲🬏  🬇
+🬨██████🬺🬱🬏
+ 🬬██████🬝🬀
+  🬁🬊🬎🬎🬆🬀
 ```
+Other drawing modes include `:quadrant` and `:octant`. While `:block`
+splits each character cell in two, the quadrants, sextants, and
+octants split a cell into 4, 6, or 8 "pixels". Octant mode requires
+Unicode 16 support in fonts and is not yet (as of late 2024) widely
+available.
 
 When passing a filtering function, 
 UnicodeGraphics will fill all values for which the function returns `true`, 

src/api.jl

@@ -4,8 +4,11 @@
 Write to `io` (or to the default output stream `stdout` if `io` is not given) a binary
 unicode representation of `A` , filling values that are `true` or greater than zero.
 
-The printing method can be specified by passing either `:braille` or `:block`.
-The default is `:$DEFAULT_METHOD`.
+The printing method can be specified by passing either `:braille`,
+`:block`, `:quadrant`, `:sextant`, or `:octant`. The default is
+`:$DEFAULT_METHOD`. (Note that `:octant` requires either a font or a
+terminal emulator that supports Unicode 16; otherwise the output will
+look strange.)
 
 # Example
 ```julia-repl
@@ -41,8 +44,11 @@ end
 Write to `io` (or to the default output stream `stdout` if `io` is not given) a binary
 unicode representation of `A` , filling values for which `f` returns `true`.
 
-The printing method can be specified by passing either `:braille` or `:block`.
-The default is `:$DEFAULT_METHOD`.
+The printing method can be specified by passing either `:braille`,
+`:block`, `:quadrant`, `:sextant`, or `:octant`. The default is
+`:$DEFAULT_METHOD`. (Note that `:octant` requires either a font or a
+terminal emulator that supports Unicode 16; otherwise the output will
+look strange.)
 
 # Example
 ```julia-repl
@@ -80,8 +86,11 @@ end
 Return a string containing a binary unicode representation of `A` , filling values that are
 `true` or greater than zero.
 
-The printing method can be specified by passing either `:braille` or `:block`.
-The default is `:$DEFAULT_METHOD`.
+The printing method can be specified by passing either `:braille`,
+`:block`, `:quadrant`, `:sextant`, or `:octant`. The default is
+`:$DEFAULT_METHOD`. (Note that `:octant` requires either a font or a
+terminal emulator that supports Unicode 16; otherwise the output will
+look strange.)
 
 # Example
 ```julia-repl
@@ -113,8 +122,11 @@ end
 Return a string containing a binary unicode representation of `A`, filling values for which
 `f` returns `true`.
 
-The printing method can be specified by passing either `:braille` or `:block`.
-The default is `:$DEFAULT_METHOD`.
+The printing method can be specified by passing either `:braille`,
+`:block`, `:quadrant`, `:sextant`, or `:octant`. The default is
+`:$DEFAULT_METHOD`. (Note that `:octant` requires either a font or a
+terminal emulator that supports Unicode 16; otherwise the output will
+look strange.)
 
 # Example
 ```julia-repl