formatting

This commit is contained in:
Wyatt Johnson
2017-10-20 13:14:00 -06:00
parent c1b954965f
commit a9cb206415
4 changed files with 184 additions and 76 deletions
@@ -9,134 +9,192 @@ There are 2 ways that newsrooms can support signup/login functionality with Talk
Use Talks auth plugin out of the box (supports account registration with username and password, as well as features like forgot password)
Create their own auth plugin (you can use ours as a template) to integrate with your own auth systems
Create their own auth plugin to integrate with your own auth systems
We also provide a Facebook auth plugin that supports logging in with Facebook (you must provide your own Facebook App ID and Secret, which you can read more about here: https://developers.facebook.com)
We also provide a Facebook auth plugin that supports logging in with Facebook (you must provide your own Facebook App ID and Secret, which you can read more about here: [https://developers.facebook.com](https://developers.facebook.com){:target="_blank"})
## Comments and Replies
Talk supports a standard comment hierarchy. There are top-level (or parent) comments, and then replies to that comment (or children comments).
Talk supports a standard comment hierarchy. There are top-level (or parent) comments, and then replies to that comment (or children comments).
### Permalinks
All levels of comments and replies are able to be linked to via permalink. Permalinks are structured using a `commentId` query param:
https://domain.com/article-asset-slug/?commentId=0879edd7-1c4f-4918-abd2-a770db446b75
```text
https://<your asset url>?commentId=<the comment id>
```
{:.no-copy}
### Threading
Talk supports by default 3 levels of threading, meaning each top-level comment has a depth of 3 replies; replies beyond that are not nested below the 3rd level. You can adjust this using the [`TALK_THREADING_LEVEL`]({{ "/advanced-configuration/#talk_threading_level" | relative_url }})configuration variable. We dont recommend deep threading because it can cause issues with styling, especially on mobile.
Talk supports by default 3 levels of threading, meaning each top-level comment
has a depth of 3 replies; replies beyond that are not nested below the 3rd
level. You can adjust this using the
[TALK_THREADING_LEVEL]({{ "/advanced-configuration/#talk_threading_level" | relative_url }}){:.param}
configuration variable. We dont recommend deep threading because it can cause
issues with styling, especially on mobile.
You can style threaded comments using these CSS classes:
```
talk-stream-comment-wrapper-level-${depth}
talk-stream-comment
talk-stream-comment-level-${depth}
talk-stream-highlighted-comment
talk-stream-pending-comment
```
talk-stream-comment-wrapper-level-${depth}
talk-stream-comment
talk-stream-comment-level-${depth}
talk-stream-highlighted-comment
talk-stream-pending-comment
```
{:.no-copy}
### Automatic Updates
Talk supports real-time loading and updating of comments, via subscriptions (specifically GraphQL Subscriptions); this enables us to not have to refresh to see new comments on a given comment stream.
Talk supports real-time loading and updating of comments, via subscriptions
(specifically GraphQL Subscriptions); this enables us to not have to refresh to
see new comments on a given comment stream.
Talk enables this via “Load More” buttons for both top-level comments (this button appears at the top of the stream), and within conversation threads (this button appears in situ for replies).
Talk enables this via “Load More” buttons for both top-level comments (this
button appears at the top of the stream), and within conversation threads (this
button appears in situ for replies).
Weve decided to go this route in order to make the viewing experience as smooth as possible, so that the feed of comments doesnt change as youre reading just because new comments are coming in. This could be especially disruptive on breaking news and/or controversial stories with very active discussions.
Weve decided to go this route in order to make the viewing experience as smooth
as possible, so that the feed of comments doesnt change as youre reading just
because new comments are coming in. This could be especially disruptive on
breaking news and/or controversial stories with very active discussions.
### Comment Character Limits
You can enable Talk to limit the character length for comments, for example, some newsrooms weve worked with prefer a limit between 2000 and 5000 characters. Commenters will be alerted that they have gone over that number and wont be able to submit their comment until theyve edited it. This can be a useful tool to ensure commenters are concise with their comments.
You can enable Talk to limit the character length for comments, for example,
some newsrooms weve worked with prefer a limit between 2000 and 5000
characters. Commenters will be alerted that they have gone over that number and
wont be able to submit their comment until theyve edited it. This can be a
useful tool to ensure commenters are concise with their comments.
## Comment Reactions
Talk comes with a `respect` button out of the box. Why a “respect” button, you ask? [Read more here](https://mediaengagement.org/research/engagement-buttons/){:target="_blank"}.
Talk comes with a `respect` button out of the box. Why a “respect” button, you
ask?
[Read more here](https://mediaengagement.org/research/engagement-buttons/){:target="_blank"}.
We also have 2 more plugins, `like` and `love`, that you can turn on and experiment with on your own Talk install.
We also have 2 more plugins, `like` and `love`, that you can turn on and
experiment with on your own Talk install.
And our plugin architecture makes it easy to create your own custom reaction buttons too.
And our plugin architecture makes it easy to create your own custom reaction
buttons too.
## Reporting Comments
Readers can report comments if they feel theyre unsuitable. They can choose one of the following reasons:
Readers can report comments if they feel theyre unsuitable. They can choose one
of the following reasons:
* This comment is offensive
* This looks like an ad/marketing
* I dont agree with this comment
* Other
They can also include more information and this shows for moderators in the Flag Detail area on the comments in the moderation queues.
They can also include more information and this shows for moderators in the Flag
Detail area on the comments in the moderation queues.
Comments that are reported go to the Reported queue, with the exception of “I dont agree with this comment”. This option is a useful way to let other readers vent their frustration, but since just disagreeing with something doesnt mean its not suitable, we leave it be.
Comments that are reported go to the Reported queue, with the exception of “I
dont agree with this comment”. This option is a useful way to let other readers
vent their frustration, but since just disagreeing with something doesnt mean
its not suitable, we leave it be.
## Reporting Usernames
Usernames can also be reported by readers, if the username is inappropriate or offensive. They can choose one of the following reasons:
Usernames can also be reported by readers, if the username is inappropriate or
offensive. They can choose one of the following reasons:
* This username is offensive
* I don't like this username
* This user is impersonating
* This looks like an ad/marketing
Reported usernames go to the Reported Usernames queue which is located in the Community tab. If a username is rejected by a moderator, the commenter is prompted to change their username and they are suspended from commenting, replying or reacting to comments until they do so. They receive an email, and also a message at the top of their comment streams that lets them know theyre suspended.
Reported usernames go to the Reported Usernames queue which is located in the
Community tab. If a username is rejected by a moderator, the commenter is
prompted to change their username and they are suspended from commenting,
replying or reacting to comments until they do so. They receive an email, and
also a message at the top of their comment streams that lets them know theyre
suspended.
If the commenter changes their username, it goes back to the Reported Usernames queue for approval. If the updated username is accepted by a moderator, the commenter is no longer suspended and continue interacting with the community. If the username is rejected, the commenter remains suspended until they change their username to something appropriate.
If the commenter changes their username, it goes back to the Reported Usernames
queue for approval. If the updated username is accepted by a moderator, the
commenter is no longer suspended and continue interacting with the community. If
the username is rejected, the commenter remains suspended until they change
their username to something appropriate.
Approved usernames that are reported do not show up in the Reported Usernames queues any longer, since they have been specifically OKed by a moderator.
Approved usernames that are reported do not show up in the Reported Usernames
queues any longer, since they have been specifically OKed by a moderator.
## Ignoring Users
Commenters can ignore other commenters and essentially mute them entirely from the comment platform. Commenters can manage their ignored users list in their My Profile tab.
Commenters can ignore other commenters and essentially mute them entirely from
the comment platform. Commenters can manage their ignored users list in their My
Profile tab.
## Featured Comments
Moderators can feature comments that they want to highlight and recommend to their community. Featured comments show up on a separate tab, that is the default for the comment stream. Featured comments within the stream show a Featured badge.
Moderators can feature comments that they want to highlight and recommend to
their community. Featured comments show up on a separate tab, that is the
default for the comment stream. Featured comments within the stream show a
Featured badge.
## Sorting the Stream
Readers can sort the stream in 4 ways based on their viewing preferencet:
Readers can sort the stream in 4 ways based on their viewing preferences:
* Oldest first
* Newest first
* Most respect first (or most liked, most loved, etc., depending on what reactions you use)
* Most respect first (or most liked, most loved, etc., depending on what
reactions you use)
* Most replied first
We also make it easy to add more sorts via custom plugins.
## Badges
Badges differentiate users and comments on the stream. By default, Talk has two badges.
Badges differentiate users and comments on the stream. By default, Talk has two
badges.
The Staff user badge that shows when a commenter has an Admin, Moderator, or Staff role.
The Staff user badge that shows when a commenter has an Admin, Moderator, or
Staff role.
The Featured comment badge shows when a comment has been featured.
Another optional badge is the Subscriber badge (which is available as a [Recipe]({{ "/plugin-recipes/#recipe-subscriber" | relative_url}}).
Another optional badge is the Subscriber badge (which is available as a
[Recipe]({{ "/plugin-recipes/#recipe-subscriber" | relative_url}}).
Badges are another easy part of Talk to customize by creating a new `tag`, then setting some rules for when it should show, and how the badge should be styled.
Badges are another easy part of Talk to customize by creating a new `tag`, then
setting some rules for when it should show, and how the badge should be styled.
## My Profile
The My Profile tab is where commenters can go to see their comment history, as well as reactions and replies to their comments. They can also see their email address associated with Talk, and manage their Ignored Users list here.
The My Profile tab is where commenters can go to see their comment history, as
well as reactions and replies to their comments. They can also see their email
address associated with Talk, and manage their Ignored Users list here.
## Notifications & Error Messaging
Talk leverages notification and messages on the stream to alert users to important information about their comment or their account.
Talk leverages notification and messages on the stream to alert users to
important information about their comment or their account.
### Pre-moderation of comments
If a stream is set to Pre-mod, or a commenters Trust karma score has fallen to negative, or if for any other reason their comment is being pre-moderated, they will get a notification letting them know this when they post a comment.
If a stream is set to Pre-mod, or a commenters Trust karma score has fallen to
negative, or if for any other reason their comment is being pre-moderated, they
will get a notification letting them know this when they post a comment.
### Suspension because of Username
When a commenter has been suspended because their username is inappropriate, they will see a message at the top of their streams stating this.
When a commenter has been suspended because their username is inappropriate,
they will see a message at the top of their streams stating this.
### Timed Suspension
When a commenter has been suspended for a block of time (aka a “time-out”), they will see a message at the top of their streams stating this.
When a commenter has been suspended for a block of time (aka a “time-out”), they
will see a message at the top of their streams stating this.
### Ban
When a commenter has been banned, they will see a message at the top of their streams staging this.
When a commenter has been banned, they will see a message at the top of their
streams staging this.
@@ -5,15 +5,21 @@ permalink: /moderator-features/
## The Talk Admin
The Admin is your moderators will moderate your comments, and your Admins will configure and manage the different parts of Talk.
The Admin is your moderators will moderate your comments, and your Admins will
configure and manage the different parts of Talk.
### Dashboard
The Dashboard provides real-time information to moderators so they know at a glance where they should direct their attention. It shows what articles are receiving the most reports and where the most active conversations are happening.
The Dashboard provides real-time information to moderators so they know at a
glance where they should direct their attention. It shows what articles are
receiving the most reports and where the most active conversations are
happening.
### Moderate
This is the tab where Moderators will spend the majority of their time. They can choose (via the dropdown) which story they would like to moderate, or moderate site-wide.
This is the tab where Moderators will spend the majority of their time. They can
choose (via the dropdown) which story they would like to moderate, or moderate
site-wide.
#### Default Mod Queues
@@ -31,13 +37,15 @@ The Approved queue contains all approved comments.
**Rejected**
The Rejected queue contains all comments that have been rejected, either manually by moderators or automatically, e.g. they have used a banned word.
The Rejected queue contains all comments that have been rejected, either
manually by moderators or automatically, e.g. they have used a banned word.
**All**
The All queue contains all comments that have been submitted either article or site-wide.
The All queue contains all comments that have been submitted either article or
site-wide.
#### Moderation Badges
#### Moderation Badges
**Pre-mod**
@@ -49,11 +57,14 @@ The User badge signifies comments that have been reported by another user.
**History**
The History badge signifies comments that have been flagged because of a users history.
The History badge signifies comments that have been flagged because of a users
history.
**Toxic**
The Toxic badge signifies comments that are above the set Toxicity Probability Threshold. Note you must have `talk-plugin-toxic-comments` enabled. [Read more about Toxic Comments here]({{ "/toxic-comments/" | relative_url}}).
The Toxic badge signifies comments that are above the set Toxicity Probability
Threshold. Note you must have [talk-plugin-toxic-comments]({{ "/additional-plugins/#talk-plugin-toxic-comments" | relative_url }}){:.param} enabled.
[Read more about Toxic Comments here]({{ "/toxic-comments/" | relative_url}}).
**Suspect**
@@ -61,11 +72,13 @@ The Suspect badge signifies comments that contain a Suspect Word.
**Contains Link**
The Contains Link badge signifies a comment that contains a link, which can sometimes mean it is a spam or ad comment.
The Contains Link badge signifies a comment that contains a link, which can
sometimes mean it is a spam or ad comment.
**Flag Details View**
At the bottom of each comment in the moderation queues, you can see more information about a comments flags by clicking on More Detail.
At the bottom of each comment in the moderation queues, you can see more
information about a comments flags by clicking on More Detail.
#### Moderator Actions
@@ -79,19 +92,25 @@ Rejecting a comment removes the comment from the stream.
**Feature**
Featuring a comment adds that comment to the Featured Comments tab on the stream.
Featuring a comment adds that comment to the Featured Comments tab on the
stream.
**Suspend User**
Suspending a user allows a moderator to give a commenter a “time-out”; during that time they wont be allowed to post comments or react to comments.
Suspending a user allows a moderator to give a commenter a “time-out”; during
that time they wont be allowed to post comments or react to comments.
**Ban User**
Banning a user allows a moderator to permanently disallow a commenter to interact with their community. The commenters previous comments will remain on the site. This action can only be un-done manually by a moderator.
Banning a user allows a moderator to permanently disallow a commenter to
interact with their community. The commenters previous comments will remain on
the site. This action can only be un-done manually by a moderator.
#### Viewing a Users Comment History
In order to get an idea of what sort of a commenter someone is, moderators can click on the commenters username in any moderation queue and see details about their history.
In order to get an idea of what sort of a commenter someone is, moderators can
click on the commenters username in any moderation queue and see details about
their history.
**Username, Email and Member Since Date**
@@ -99,23 +118,27 @@ This shows the basic details about a commenter.
**Total Comments**
This shows the number of comments that a commenter has made that currently display on the site.
This shows the number of comments that a commenter has made that currently
display on the site.
**Reject Rate**
This shows the % of comments a commenter has had rejected by moderators, or automatically.
This shows the % of comments a commenter has had rejected by moderators, or
automatically.
**Reports**
This shows if a commenter is a reliable flagger, an unreliable flagger, or a neutral flagger. [Read more about reliable and unreliable flaggers here]({{ "/trust/#reliable-and-unreliable-flaggers" | relative_url }}).
This shows if a commenter is a reliable flagger, an unreliable flagger, or a
neutral flagger. [Read more about reliable and unreliable flaggers here]({{"/trust/#reliable-and-unreliable-flaggers" | relative_url }}).
**Moderating from this View**
Talk also allows you to moderate a commenters recent comments from this view.
Talk also allows you to moderate a commenters recent comments from this view.
#### Keyboard Shortcuts
Talk also supports a number of keyboard shortcuts that moderators can leverage to moderate quickly:
Talk also supports a number of keyboard shortcuts that moderators can leverage
to moderate quickly:
| Shortcut | Action |
| -------- | ------------------------------- |
@@ -130,23 +153,36 @@ Talk also supports a number of keyboard shortcuts that moderators can leverage t
### Stories
In the Stories tab moderators can view all the stories that have Talk comments embedded on them, as well as be able to Open or Close comment streams on stories.
In the Stories tab moderators can view all the stories that have Talk comments
embedded on them, as well as be able to Open or Close comment streams on
stories.
### Community
The Community tab houses everything having to do with your team and your commenters.
The Community tab houses everything having to do with your team and your
commenters.
#### Moderating Usernames
Any usernames that have been reported will show in the Reported Usernames sub-tab. Moderators can approve usernames if theyre suitable, or reject a username. If a username is rejected, the commenter will be notified that they need to change their username; until they do, they will be suspended from Talk. The updated username then again appears in this queue for a decision by moderators.
Any usernames that have been reported will show in the Reported Usernames
sub-tab. Moderators can approve usernames if theyre suitable, or reject a
username. If a username is rejected, the commenter will be notified that they
need to change their username; until they do, they will be suspended from Talk.
The updated username then again appears in this queue for a decision by
moderators.
#### Managing People & Roles
All your team and commenters show in the People sub-tab. From here, you can manage your team members roles (Admins, Moderators, Staff), as well as search for commenters and take action on them (e.g. Ban/Un-ban, Suspend, etc.).
### Configure
All your team and commenters show in the People sub-tab. From here, you can
manage your team members roles (Admins, Moderators, Staff), as well as search
for commenters and take action on them (e.g. Ban/Un-ban, Suspend, etc.). ###
Configure
See [Configuring Talk]({{ "/configuring-talk/" | relative_url }}).
## Moderating via the Comment Stream
Moderators can also choose to moderate comments in situ. If you are logged in as a Moderator or Admin, you will see a caret dropdown on each comment that allows you to Approve, Reject, or Feature comments, or Ban a User directly from the comment stream.
Moderators can also choose to moderate comments in situ. If you are logged in as
a Moderator or Admin, you will see a caret dropdown on each comment that allows
you to Approve, Reject, or Feature comments, or Ban a User directly from the
comment stream.
@@ -5,7 +5,8 @@ permalink: /configuring-talk/
## Configuring an Individual Stream
There are two ways Admins can configure Talk - the first is via the Configure tab on the comment stream.
There are two ways Admins can configure Talk - the first is via the Configure
tab on the comment stream.
### Enable Pre-moderation
@@ -17,18 +18,23 @@ Allows toggling of pre-moderating comments that have links.
### Ask Readers a Question & Question Icons
Admins can choose to Ask Readers a Question in order to help guide the discussion. [Read more about why this is important on our blog](https://blog.coralproject.net/the-empty-box/){:target="_blank"}.
Admins can choose to Ask Readers a Question in order to help guide the
discussion. [Read more about why this is important on our blog](https://blog.coralproject.net/the-empty-box/){:target="_blank"}.
There are a selection of icons to display different messaging other than a question on a particular stream, like an announcement, or general information about the story.
There are a selection of icons to display different messaging other than a
question on a particular stream, like an announcement, or general information
about the story.
### Closing a Stream
Closing a stream will prevent new comments. Previous comments will remain displayed on the stream for readers to view.
Closing a stream will prevent new comments. Previous comments will remain
displayed on the stream for readers to view.
## Global Configuration
Global configuration settings are available via Admin > Configure. These settings are site-wide and will affect all of your comment streams.
Global configuration settings are available via Admin > Configure. These
settings are site-wide and will affect all of your comment streams.
### Stream Settings
@@ -38,7 +44,8 @@ A maximum comment length across the site.
#### Comment Stream Description
Description text that will appear above every comment stream site-wide. We recommend linking to your Code of Conduct or Community Guidelines. [Read tips on how to write a Code of Conduct here](https://guides.coralproject.net/create-a-code-of-conduct/){:target="_blank"}.
Description text that will appear above every comment stream site-wide. We
recommend linking to your Code of Conduct or Community Guidelines. [Read tips on how to write a Code of Conduct here](https://guides.coralproject.net/create-a-code-of-conduct/){:target="_blank"}.
#### Closed Stream Message
@@ -60,11 +67,13 @@ Require new users to verify their email address prior to commenting.
#### Enable Pre-moderation
Turn on pre-moderation across the site, meaning all comments will need to be moderated before they will be displayed.
Turn on pre-moderation across the site, meaning all comments will need to be
moderated before they will be displayed.
#### Pre-moderate Comments Containing Links
Turn on pre-moderation for comments with links across the site, meaning all comments with links will need to be moderated before they will be displayed.
Turn on pre-moderation for comments with links across the site, meaning all
comments with links will need to be moderated before they will be displayed.
#### Banned Words List
@@ -72,12 +81,15 @@ A list of words that will trigger a comment to be automatically Rejected.
#### Suspect Words List
A list of words that will trigger a comment to be automatically Reported. Comments with suspect words will display until a moderator takes action on them.
A list of words that will trigger a comment to be automatically Reported.
Comments with suspect words will display until a moderator takes action on them.
### Technical Settings
#### Permitted Domains
A list of domains where your Talk instance is allowed to be embedded. Typical use is `localhost`, `staging.yourdomain.com`, `yourdomain.com`, etc.
A list of domains where your Talk instance is allowed to be embedded. Typical
use is `localhost`, `staging.yourdomain.com`, `yourdomain.com`, etc.
#### Embed Script
@@ -85,4 +97,5 @@ This is the unique Talk script that is to be used to embed Talk on your website.
#### Custom CSS URL
The link to your custom stylesheet for Talk. This will override any default styles, so you can make Talk your own!
The link to your custom stylesheet for Talk. This will override any default
styles, so you can make Talk your own!
+2 -1
View File
@@ -5,7 +5,8 @@ permalink: /faq/
## How can I get help integrating Talk into my newsroom?
We're here to help with newsrooms of all sizes. Email our Integration Engineer (jeff@mozillafoundation.org) to set up a meeting.
We're here to help with newsrooms of all sizes. Email our Integration Engineer
([jeff@mozillafoundation.org](mailto:jeff@mozillafoundation.org)) to set up a meeting.
## How do I request a feature or submit a bug?