OrgGo
/
tcell
mirror of https://github.com/gdamore/tcell.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
tcell/CHANGESv2.md

82 lines
3.3 KiB
Markdown
Raw Normal View History

Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
## Breaking Changes in _Tcell_ v2
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
A number of changes were made to _Tcell_ for version two, and some of these are breaking.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Import Path
Update documentation for V2.
2020-10-16 15:05:26 +08:00
Fix CHANGESv2.adoc Import Path The import path in CHANGESv2.adoc was wrong and didn't match README.adoc. This fixes that.
2020-10-07 23:33:43 +08:00
The import path for tcell has changed to `github.com/gdamore/tcell/v2` to reflect a new major version.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Style Is Not Numeric
Update documentation for V2.
2020-10-16 15:05:26 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
The type `Style` has changed to a structure, to allow us to add additional data such as flags for color setting,
more attribute bits, and so forth.
Update documentation for V2.
2020-10-16 15:05:26 +08:00
Applications that relied on this being a number will need to be updated to use the accessor methods.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Mouse Event Changes
Update documentation for V2.
2020-10-16 15:05:26 +08:00
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
The middle mouse button was reported as button 2 on Linux, but as button 3 on Windows,
and the right mouse button was reported the reverse way.
_Tcell_ now always reports the right mouse button as button 2, and the middle button as button 3.
To help make this clearer, new symbols `ButtonPrimary`, `ButtonSecondary`, and
`ButtonMiddle` are provided.
(Note that which button is right vs. left may be impacted by user preferences.
Usually the left button will be considered the Primary, and the right will be the Secondary.)
Applications may need to adjust their handling of mouse buttons 2 and 3 accordingly.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Terminals Removed
Update documentation for V2.
2020-10-16 15:05:26 +08:00
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
A number of terminals have been removed.
Update documentation for V2.
2020-10-16 15:05:26 +08:00
These are mostly ancient definitions unlikely to be used by anyone, such as `adm3a`.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### High Number Function Keys
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Historically terminfo reported function keys with modifiers set as a different
Update documentation for V2.
2020-10-16 15:05:26 +08:00
function key altogether. For example, Shift-F1 was reported as F13 on XTerm.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
_Tcell_ now prefers to report these using the base key (such as F1) with modifiers added.
Update documentation for V2.
2020-10-16 15:05:26 +08:00
This works on XTerm and VTE based emulators, but some emulators may not support this.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
The new behavior more closely aligns with behavior on Windows platforms.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
## New Features in _Tcell_ v2
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
These features are not breaking, but are introduced in version 2.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Improved Modifier Support
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
For terminals that appear to behave like the venerable XTerm, _tcell_
automatically adds modifier reporting for ALT, CTRL, SHIFT, and META keys
when the terminal reports them.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Better Support for Palettes (Themes)
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
When using a color by its name or palette entry, _Tcell_ now tries to
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
use that palette entry as is; this should avoid some inconsistency and respect
terminal themes correctly.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
When true fidelity to RGB values is needed, the new `TrueColor()` API can be used
Update documentation for V2.
2020-10-16 15:05:26 +08:00
to create a direct color, which bypasses the palette altogether.
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Automatic TrueColor Detection
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
For some terminals, if the `Tc` or `RGB` properties are present in terminfo,
_Tcell_ will automatically assume the terminal supports 24-bit color.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### ColorReset
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Update documentation for V2.
2020-10-16 15:05:26 +08:00
A new color value, `ColorReset` can be used on the foreground or background
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
to reset the color the default used by the terminal.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### tmux Support
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
_Tcell_ now has improved support for tmux, when the `$TERM` variable is set to "tmux".
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Strikethrough Support
Add CHANGESv2 to track important changes for V2 (breaking changes).
2020-08-31 14:40:01 +08:00
Update documentation for V2.
2020-10-16 15:05:26 +08:00
_Tcell_ has support for strikethrough when the terminal supports it, using the new `StrikeThrough()` API.
Convert documentation to Markdown. While asciidoc is probably technically more flexible, some sites (such as pkg.go.dev) do not support it well. For the basic docs we have here, the extra richness from asciidoc is not needed, and we would prefer not to sacrifice the broader support that MarkDown enjoys. While here the text was cleaned up, made consistent, with grammar and spelling fixes. The Tutorial was revised somewhat to provide more accurate guidance for readers.
2021-07-18 02:04:43 +08:00
### Bracketed Paste Support
Update documentation for V2.
2020-10-16 15:05:26 +08:00
_Tcell_ provides the long requested capability to discriminate paste event by using the
bracketed-paste capability present in some terminals. This is automatically available on
terminals that support XTerm style mouse handling, but applications must opt-in to this
by using the new `EnablePaste()` function. A new `EventPaste` type of event will be
delivered when starting and finishing a paste operation.