mentions #105

yenda · 2020-04-29T12:22:19Z

No description provided.

oskarth · 2020-05-06T07:12:27Z

docs/draft/mentions.md

+title: Mentions
+nav_order: 2
+has_children: true
+permalink: /specs/draft


Number

Also, is this a draft or is it stable? I.e. is it describing what is live already?

oskarth · 2020-05-06T07:12:45Z

docs/draft/mentions.md

+
+## Usage
+
+To mention a user, one would type a message containing `@0xpk` where `pk` is the public key of the user to be mentioned.


Refer to relevant spec for account here

oskarth · 2020-05-06T07:13:14Z

docs/draft/mentions.md

+`status-go` parses the markdown in the messages and detects mentions that follow the pattern described above. This is done in [`parser.inline.go`](https://github.com/status-im/markdown/blob/b9fe921681227b1dace4b56364e15edb3b698308/parser/inline.go#L68). When mentions are found they are added as an element to the message that is passed to the client with the following format:
+
+```
+{:type "mention" :literal "0x......"}


Refer to how this relates to e.g. PAYLOAD spec

oskarth · 2020-05-06T07:14:50Z

docs/draft/mentions.md

+
+## Future work
+
+The current implementation is cumbersome as it forces users to input the whole public key of the mentioned user. Implementing auto-completion of mentions would make the feature more appealing to users. It would allow them to mention other users in the chat by usernames or random usernames, which would be replaced by the pk before sending the message


I initially thought it autocompleted and worked with ENS names too

Does that mean this is very much a WIP feature and should remain a draft for the time being?

cc @andremedeiros @hesterbruikman

yes actually mentions is my next assignment so I'm going to update this draft afterward

oskarth · 2020-05-07T11:22:44Z

docs/draft/mentions.md

+
+The `status-react` client uses specific styling for the following elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.
+`mentions` will be displayed in a color that sets it apart from regular text and tapping it will open the chat with the mentioned user.
+


Copyright

Copyright and related rights waived via CC0.

oskarth · 2020-05-14T04:56:03Z

Ping @yenda

oskarth · 2020-05-25T05:18:38Z

Ping @yenda whats the state of this? It'd be great if we can merge it and create follow up issues where things still need to be done.

oskarth · 2020-06-08T12:37:39Z

@status-im/status-core @status-im/status-protocol review

cammellos

Currently I think we are overspeccing things,
for example: tapping it should open the chat with the mentioned user is completely an UI concern.
I would not have a separate document for mentions, probably one describing the markdown supported and how is parsed is enough.
Having said that, if we are ok with the amount of information, this looks ok to me.

docs/stable/14-mentions.md

Samyoul · 2020-06-08T13:02:49Z

docs/stable/14-mentions.md

+`status-go` currently parses the following markdown elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.
+`mentions` should be displayed in a color that sets it apart from regular text and tapping it should open the chat with the mentioned user.


Is there a dedicated section to markdown? Are the other markdown elements documented?

Suggested change

`status-go` currently parses the following markdown elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.

`mentions` should be displayed in a color that sets it apart from regular text and tapping it should open the chat with the mentioned user.

`status-go` currently parses the following markdown elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.

A `mention` tag SHOULD be displayed in a color that sets it apart from regular text and tapping it should open the chat with the mentioned user.

If there isn't a dedicated section documenting status-go markdown can we at least create an issue to track that markdown needs to be documented?

There is no mentions tag, as far as I can see there is only the mention tag.

On reflection this section should probably be a UI implementation recommendation.

Example:

This specification RECOMMENDs that mention tags:

are displayed in a colour that sets it apart from regular text

open the chat with the mentioned pk when tapped or clicked

Samyoul · 2020-06-08T13:10:50Z

docs/stable/14-mentions.md

+`status-go` currently parses the following markdown elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.
+`mentions` should be displayed in a color that sets it apart from regular text and tapping it should open the chat with the mentioned user.


and tapping it should open the chat with the mentioned user.

This seems to be how it is implemented now, but should this be some thing that is detailed as a specification for all implementations?

Samyoul · 2020-06-08T13:13:07Z

docs/stable/14-mentions.md

+
+## Usage
+
+To mention a user, one would type a message containing `@0xpk` where `pk` is the public key of the [user account](https://specs.status.im/spec/2) to be mentioned. The message is sent as a [regular message with `TEXT_PLAIN` content type](https://specs.status.im/spec/6#content-types).


Would the user manually enter the pk manually or does the application enter the pk in place of a pseudonym?

Clarification is needed on this section

Who is one? Is this the user or the application in the background?

Recommendations need to be given for how the one entity enters the pk.

Examples

This specification RECOMMENDs that the application does not require the user to enter the entire pk.

This specification RECOMMENDs that the application allows the user to create a mention by typing @ followed by the related ENS or 3-word pseudonym.

This specification RECOMMENDs that the application provides the user auto-completion functionality to create a mention.

oskarth · 2020-06-09T05:46:47Z

Currently I think we are overspeccing things,
for example: tapping it should open the chat with the mentioned user is completely an UI concern.
I would not have a separate document for mentions, probably one describing the markdown supported and how is parsed is enough.
Having said that, if we are ok with the amount of information, this looks ok to me.

I think that's a fair point. Perhaps it makes sense to amend existing spec and describe "mentions" / ens username there, without going into detail on how the UI should behave?

Samyoul · 2020-06-10T13:07:16Z

Hey @yenda , the fundamentals of this spec are solid. There are just a few points of clarification I've highlighted that I feel need attention. To be helpful I've written out more details to help with the implementation of these clarifications.

Also perhaps this spec could be renamed as 14-markdown.md if there isn't a dedicated markdown spec, and use the current work as the starting point for a more robust document. If it is too much work to implement this change in the scope of this PR, perhaps we could create an issue to track the need for additional documentation of markdown usage.

yenda · 2020-06-15T09:23:06Z

@cammellos @Samyoul I took both of your comments into consideration and decided to move the spec to the payloads spec, and remove the implementation details, so that it now consists only of the bare minimum + UX recommendations. Ok to merge?

Samyoul

Thank you @yenda , I appreciate your willingness to move this documentation. I can understand why you placed this into its own document at the beginning, and I think you've made a good choice to move this information into the payloads spec.

rachelhamlin mentioned this pull request Apr 30, 2020

Protocol specs status-im/status-mobile#10384

Closed

8 tasks

oskarth self-requested a review April 30, 2020 10:13

hesterbruikman mentioned this pull request May 4, 2020

Core Dev Call 29 Agenda status-im/pm#51

Closed

yenda self-assigned this May 4, 2020

oskarth requested a review from decanus May 6, 2020 06:51

oskarth suggested changes May 6, 2020

View reviewed changes

oskarth requested a review from andremedeiros May 6, 2020 07:15

oskarth reviewed May 7, 2020

View reviewed changes

hesterbruikman mentioned this pull request May 28, 2020

Core Dev Call 31 Agenda status-im/pm#56

Closed

yenda force-pushed the mentions branch from 624b258 to a0e2f4b Compare June 1, 2020 11:45

oskarth approved these changes Jun 2, 2020

View reviewed changes

cammellos approved these changes Jun 8, 2020

View reviewed changes

Samyoul requested changes Jun 8, 2020

View reviewed changes

oskarth requested a review from Samyoul June 10, 2020 09:13

hesterbruikman mentioned this pull request Jun 10, 2020

Agenda Core dev call #32 status-im/pm#57

Closed

yenda force-pushed the mentions branch from da6acc9 to bf6842a Compare June 15, 2020 09:22

yenda force-pushed the mentions branch from bf6842a to bcb86ee Compare June 15, 2020 09:26

Samyoul approved these changes Jun 15, 2020

View reviewed changes

yenda force-pushed the mentions branch from bcb86ee to 47b74ef Compare June 15, 2020 12:34

mentions

c394f12

yenda force-pushed the mentions branch from 47b74ef to c394f12 Compare June 15, 2020 12:41

yenda merged commit 046f865 into master Jun 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mentions #105

mentions #105

yenda commented Apr 29, 2020

oskarth May 6, 2020

oskarth May 6, 2020

oskarth May 6, 2020

oskarth May 6, 2020

yenda May 6, 2020

oskarth May 7, 2020

oskarth commented May 14, 2020

oskarth commented May 25, 2020

oskarth commented Jun 8, 2020

cammellos left a comment

Samyoul Jun 8, 2020

Samyoul Jun 8, 2020

Samyoul Jun 10, 2020

Samyoul Jun 8, 2020

Samyoul Jun 8, 2020

Samyoul Jun 10, 2020

oskarth commented Jun 9, 2020

Samyoul commented Jun 10, 2020

yenda commented Jun 15, 2020

Samyoul left a comment


		## Usage

		To mention a user, one would type a message containing `@0xpk` where `pk` is the public key of the user to be mentioned.


		## Future work

		The current implementation is cumbersome as it forces users to input the whole public key of the mentioned user. Implementing auto-completion of mentions would make the feature more appealing to users. It would allow them to mention other users in the chat by usernames or random usernames, which would be replaced by the pk before sending the message


		The `status-react` client uses specific styling for the following elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.
		`mentions` will be displayed in a color that sets it apart from regular text and tapping it will open the chat with the mentioned user.

		`status-go` currently parses the following markdown elements: `code`, `emph`, `strong`, `link`, `status-tag` and `mention`.
		`mentions` should be displayed in a color that sets it apart from regular text and tapping it should open the chat with the mentioned user.

mentions #105

mentions #105

Conversation

yenda commented Apr 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Copyright

oskarth commented May 14, 2020

oskarth commented May 25, 2020

oskarth commented Jun 8, 2020

cammellos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oskarth commented Jun 9, 2020

Samyoul commented Jun 10, 2020

yenda commented Jun 15, 2020

Samyoul left a comment

Choose a reason for hiding this comment