Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update console-virtual-terminal-sequences.md with Cursor Shape #261

Merged
merged 5 commits into from
May 4, 2022

Conversation

pizzaz93
Copy link
Contributor

@pizzaz93 pizzaz93 commented May 4, 2022

Fixes #140
Fixes #108

I've filled in the parts of the chart I can populate based on the report in this issue.
I'm not sure if <n> or ? are the equivalent of SP?

@ghost
Copy link

ghost commented May 4, 2022

CLA assistant check
All CLA requirements met.

@opbld33
Copy link

opbld33 commented May 4, 2022

Docs Build status updates of commit e98cee0:

✅ Validation status: passed

File Status Preview URL Details
docs/console-virtual-terminal-sequences.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Copy link

@KalleOlaviNiemitalo KalleOlaviNiemitalo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, SP is not equivalent to ? or <n>. See ECMA-48 (June 1991) clause 5.4 (Control sequences).

SP q here means 0x20 as an Intermediate Byte, followed by 0x71 as a Final Byte. ? is 0x3F and is generally used as the first Parameter Byte, where it means private or experimental use. <n> in this documentation means an integer parameter, consisting of Parameter Bytes in the range 0x30 to 0x39.

This could be documented as ESC [ <n> SP q followed by a separate table of supported values of <n>. I don't know offhand whether there is a "Code" for this control sequence.

@opbld33
Copy link

opbld33 commented May 4, 2022

Docs Build status updates of commit f1788cb:

✅ Validation status: passed

File Status Preview URL Details
docs/console-virtual-terminal-sequences.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@pizzaz93 pizzaz93 marked this pull request as draft May 4, 2022 15:50
@pizzaz93 pizzaz93 marked this pull request as ready for review May 4, 2022 15:50
@pizzaz93
Copy link
Contributor Author

pizzaz93 commented May 4, 2022

I added the clarification for SP q and the DECSCUSR code.

I also added an edit for another repo issue that concerns this documentation.

@opbld32
Copy link

opbld32 commented May 4, 2022

Docs Build status updates of commit 23b1731:

✅ Validation status: passed

File Status Preview URL Details
docs/console-virtual-terminal-sequences.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@pizzaz93 pizzaz93 requested a review from DHowett May 4, 2022 17:30
@opbld32
Copy link

opbld32 commented May 4, 2022

Docs Build status updates of commit ec95920:

✅ Validation status: passed

File Status Preview URL Details
docs/console-virtual-terminal-sequences.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld32
Copy link

opbld32 commented May 4, 2022

Docs Build status updates of commit e1d1841:

✅ Validation status: passed

File Status Preview URL Details
docs/console-virtual-terminal-sequences.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Copy link
Collaborator

@DHowett DHowett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pizzaz93
Copy link
Contributor Author

pizzaz93 commented May 4, 2022

@DHowett should we add #259 into this PR?

@DHowett
Copy link
Collaborator

DHowett commented May 4, 2022

Nah. If we merge both of them, Git will handle making sure the final product contains both changes. No need to pre-combine them!

@DHowett DHowett merged commit c4dba4d into MicrosoftDocs:main May 4, 2022
@pizzaz93 pizzaz93 deleted the patch-4 branch May 4, 2022 18:22

| Sequence | Code | Description | Behavior |
|---------------|---------|------------------------------|---------------------------|
| ESC \[ 0 SP q | DECSCUSR | User Shape | Default cursor shape configured by the user |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elsewhere on this page, the Description column shows how the control sequence is defined by the industry, and the Behavior column shows how Windows Terminal implements it. Did DEC define DECSCUSR with parameter 0 as activating the cursor shape preferred by the user, or is that specific to Windows Terminal?

Page 5-127 of http://boundlessterminals.com/manuals/VT520-VT525ProgrammerInformation.pdf lists "0, 1 or none" as selecting the "Blink Block (Default)" cursor style. That suggests to me that the number 1 means this style specifically, and 0 or none means the default style, which in those DEC terminals is hardcoded rather than a user preference. So the pull request looks OK in that respect.

Does Windows Terminal support DECSCUSR without a parameter? Perhaps that too should be documented here, something like the paragraph in another section of this page:

For each of the sequences, the default value for &lt;n&gt; if it is omitted is 0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants