webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-08-29 02:20:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
The unit of UTF-16 code units is not necessarily obvious for users of
languages that index strings by Unicode code points. Provide a pointer
to an FAQ entry as well:

https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units

Closes #1504

Signed-off-by: Stephen Brennan <stephen@brennan.io>
This commit is contained in:
Stephen Brennan 2024-04-13 11:26:15 -07:00 • committed by GitHub
parent 419beee29a
commit e5ebb732cb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
man/signal-cli.1.adoc
View file

@ -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"`

6
src/main/java/org/asamk/signal/commands/SendCommand.java
View file

@ -71,10 +71,12 @@ public class SendCommand implements JsonRpcLocalCommand {
.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.");