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.

Sign up for GitHub

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

Document the unit of "start" and "length" for mentions and text styles #1505

Merged
merged 1 commit into from
Apr 13, 2024
Merged

Document the unit of "start" and "length" for mentions and text styles #1505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion man/signal-cli.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,11 @@ e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`

*--mention*::
Mention another group member (syntax: start:length:recipientNumber) In the apps the mention replaces part of the message text, which is specified by the start and length values.
The units of start and length should be UTF-16 code units, NOT Unicode code points. For more information, see https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units
e.g.: `-m "Hi X!" --mention "3:1:+123456789"`

*--text-style*::
Style parts of the message text (syntax: start:length:STYLE).
Style parts of the message text (syntax: start:length:STYLE). Like `--mention`, the units are UTF-16 code units.
Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE

e.g.: `-m "Something BIG!" --text-style "10:3:BOLD"` or for a mixed text style `-m "Something BIG!" --text-style "0:9:ITALIC" "10:3:BOLD"`
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/org/asamk/signal/commands/SendCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,12 @@ public void attachToSubparser(final Subparser subparser) {
.action(Arguments.storeTrue());
subparser.addArgument("--mention")
.nargs("*")
.help("Mention another group member (syntax: start:length:recipientNumber)");
.help("Mention another group member (syntax: start:length:recipientNumber). "
+ "Unit of start and length is UTF-16 code units, NOT Unicode code points.");
subparser.addArgument("--text-style")
.nargs("*")
.help("Style parts of the message text (syntax: start:length:STYLE)");
.help("Style parts of the message text (syntax: start:length:STYLE). "
+ "Unit of start and length is UTF-16 code units, NOT Unicode code points.");
subparser.addArgument("--quote-timestamp")
.type(long.class)
.help("Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.");
Expand Down
Loading