Improve website in several small ways

- Mention moon hover on color tag in design explorer
- Dependency on ncurses is a technical rather than a functional change
- Document new standard tags 'color' and 'unicode'
This commit is contained in:
Thomas Jensen 2024-03-13 21:33:22 +01:00
parent e362ed58c5
commit b561e0ee9c
No known key found for this signature in database
GPG Key ID: A4ACEE270D0FB7DB
3 changed files with 5 additions and 2 deletions

View File

@ -4,6 +4,7 @@ tag_descriptions:
box: 'go around the input text.' box: 'go around the input text.'
color: |- color: |-
feature box shapes colored by ANSI escape codes. feature box shapes colored by ANSI escape codes.
<p>Hover with your mouse cursor over the moon icon to see a dark background.</p>
<div class="alert alert-info"> <div class="alert alert-info">
<strong>Note:</strong> In order to color the text, <i>boxes</i> will output ANSI escape codes. Usually, <strong>Note:</strong> In order to color the text, <i>boxes</i> will output ANSI escape codes. Usually,
your terminal will interpret them properly. However, many text editors cannot do that, and you may see your terminal will interpret them properly. However, many text editors cannot do that, and you may see

View File

@ -19,8 +19,6 @@ of new tests, it is still quite possible that some bugs slipped in. Please bear
- ANSI color codes are now allowed in box shapes (see - ANSI color codes are now allowed in box shapes (see
[colored box shapes]({{ site.baseurl}}/config-syntax.html#colored-shapes)). It's a bit technical, because you [colored box shapes]({{ site.baseurl}}/config-syntax.html#colored-shapes)). It's a bit technical, because you
need to write ANSI color codes, but quite powerful and versatile. need to write ANSI color codes, but quite powerful and versatile.
- In order to properly support colors in every terminal, we now depend on the
[ncurses](https://invisible-island.net/ncurses/) library.
- The new command line options `--color` and `--no-color` can be used to force whether colors are printed by *boxes*. - The new command line options `--color` and `--no-color` can be used to force whether colors are printed by *boxes*.
The default is to print colors if the terminal is color-capable. The default is to print colors if the terminal is color-capable.
- Add long options capability to command line. Every existing option stays the same, but can now also be written in - Add long options capability to command line. Every existing option stays the same, but can now also be written in
@ -36,6 +34,8 @@ of new tests, it is still quite possible that some bugs slipped in. Please bear
#### Technical / Internal Changes #### Technical / Internal Changes
- In order to properly support colors in every terminal, we now depend on the
[ncurses](https://invisible-island.net/ncurses/) library.
- Add MacOS to GitHub Actions workflow and support all test categories on MacOS - Add MacOS to GitHub Actions workflow and support all test categories on MacOS
by <span class="atmention">[@mathomp4](https://github.com/mathomp4)</span> by <span class="atmention">[@mathomp4](https://github.com/mathomp4)</span>
- Removed linker `--wrap` option so unit tests can run on MacOS by - Removed linker `--wrap` option so unit tests can run on MacOS by

View File

@ -28,6 +28,7 @@ through this list.
- `artwork` - It's an ASCII art box, not a simple thing like a box of asterisks or hash characters. When in doubt, - `artwork` - It's an ASCII art box, not a simple thing like a box of asterisks or hash characters. When in doubt,
don't use this tag. don't use this tag.
- `box` - It's a box that goes around the input text, i.e. at most one open side. - `box` - It's a box that goes around the input text, i.e. at most one open side.
- `color` - At least one box shape contains invisible ANSI escape codes for coloring.
- `comment` - A regional comment in a programming language. - `comment` - A regional comment in a programming language.
- `large` - A box intended for large content, like figlet fonts, or just lots of text. It wants to be big! - `large` - A box intended for large content, like figlet fonts, or just lots of text. It wants to be big!
- `programming` - All comments in a programming language, including boxes which are valid comments. Anything tagged - `programming` - All comments in a programming language, including boxes which are valid comments. Anything tagged
@ -35,6 +36,7 @@ through this list.
- `sign` - An ASCII art figure holding or showing a sign which contains the input text. - `sign` - An ASCII art figure holding or showing a sign which contains the input text.
- `simple` - A simple box, normally excluding `artwork`. - `simple` - A simple box, normally excluding `artwork`.
- `speech` - A box which includes a speech bubble. - `speech` - A box which includes a speech bubble.
- `unicode` - At least one box shape contains a non-ASCII character.
- **Give Credit Where Credit is Due** This point is really important. If your box is based on someone else's artwork, - **Give Credit Where Credit is Due** This point is really important. If your box is based on someone else's artwork,
the original artist must be credited in a `designer` entry, and you must make sure that the person allowed you to the original artist must be credited in a `designer` entry, and you must make sure that the person allowed you to