1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

Add missing properties from toot: namespace (#1617)

* Add missing properties from toot: namespace
* Fix memorial heading and anchor
This commit is contained in:
a 2025-03-20 05:57:59 -05:00 committed by GitHub
parent 04ecf2677c
commit 88f633594a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -261,6 +261,9 @@ manuallyApprovesFollowers
discoverable discoverable
: Will be shown in the profile directory. See [Discoverability flag](#discoverable). : Will be shown in the profile directory. See [Discoverability flag](#discoverable).
indexable
: Posts by this account can be indexed for full-text search. See [Indexable flag](#indexable).
publicKey publicKey
: Required for signatures. See [Public key](#publicKey). : Required for signatures. See [Public key](#publicKey).
@ -276,6 +279,12 @@ alsoKnownAs
published published
: When the profile was created. : When the profile was created.
memorial
: Whether the account is a memorial account.
suspended
: Whether the account is currently suspended.
attributionDomains attributionDomains
: Domains allowed to use `fediverse:creator` for this actor in published articles. : Domains allowed to use `fediverse:creator` for this actor in published articles.
@ -287,18 +296,20 @@ attributionDomains
Base URI: `http://joinmastodon.org/ns#` Base URI: `http://joinmastodon.org/ns#`
Contains definitions for Mastodon features. Contains terms used for Mastodon features.
- toot:Emoji (`http://joinmastodon.org/ns#Emoji`) - toot:Emoji (`http://joinmastodon.org/ns#Emoji`)
- toot:IdentityProof (`http://joinmastodon.org/ns#IdentityProof`) - toot:IdentityProof (`http://joinmastodon.org/ns#IdentityProof`)
- toot:attributionDomains (`http://joinmastodon.org/ns#attributionDomains`)
- toot:blurhash (`http://joinmastodon.org/ns#blurhash`) - toot:blurhash (`http://joinmastodon.org/ns#blurhash`)
- toot:focalPoint (`http://joinmastodon.org/ns#focalPoint`) - toot:discoverable (`http://joinmastodon.org/ns#discoverable`)
- toot:featured (`http://joinmastodon.org/ns#featured`) - toot:featured (`http://joinmastodon.org/ns#featured`)
- toot:featuredTags (`http://joinmastodon.org/ns#featuredTags`) - toot:featuredTags (`http://joinmastodon.org/ns#featuredTags`)
- toot:discoverable (`http://joinmastodon.org/ns#discoverable`) - toot:focalPoint (`http://joinmastodon.org/ns#focalPoint`)
- toot:indexable (`http://joinmastodon.org/ns#indexable`)
- toot:memorial (`http://joinmastodon.org/ns#memorial`)
- toot:suspended (`http://joinmastodon.org/ns#suspended`) - toot:suspended (`http://joinmastodon.org/ns#suspended`)
- toot:votersCount (`http://joinmastodon.org/ns#votersCount`) - toot:votersCount (`http://joinmastodon.org/ns#votersCount`)
- toot:attributionDomains (`http://joinmastodon.org/ns#attributionDomains`)
### ActivityStreams extensions (`as:`) {#as} ### ActivityStreams extensions (`as:`) {#as}
@ -643,7 +654,7 @@ Mastodon supports integration with identity providers to prove that a profile is
### Discoverability flag {#discoverable} ### Discoverability flag {#discoverable}
Mastodon allows users to opt-in or opt-out of discoverability features like the profile directory. This flag may also be used as an indicator of the user's preferences toward being included in external discovery services, such as search engines or other indexing tools. If you are implementing such a tool, it is recommended that you respect this property if it is present. This is implemented using an extra property `discoverable` on objects. Mastodon allows users to opt-in or opt-out of discoverability features like the profile directory. This flag may also be used as an indicator of the user's preferences toward being included in external discovery services. If you are implementing such a tool, it is recommended that you respect this property if it is present. This is implemented using an extra property `discoverable` on objects mapping to profiles.
```json ```json
{ {
@ -659,6 +670,24 @@ Mastodon allows users to opt-in or opt-out of discoverability features like the
} }
``` ```
### Indexable flag {#indexable}
Mastodon allows users to opt-in or opt-out of indexing features like full-text search of public statuses. If you are implementing such a tool, it is recommended that you respect this property if it is present. This is implemented using an extra property `indexable` on objects mapping to profiles.
```json
{
"@context": [
"https://www.w3.org/ns/activitystreams",
{
"indexable": "http://joinmastodon.org/ns#indexable"
}
],
"id": "https://mastodon.social/users/Gargron",
"type": "Person",
"indexable": true
}
```
### Suspended flag {#suspended} ### Suspended flag {#suspended}
Mastodon reports whether a user was locally suspended, for better handling of these accounts. Suspended accounts in Mastodon return empty data. If a remote account is marked as suspended, it cannot be unsuspended locally. Suspended accounts can be targeted by activities such as Update, Undo, Reject, and Delete. This functionality is implemented using an extra property `suspended` on objects. Mastodon reports whether a user was locally suspended, for better handling of these accounts. Suspended accounts in Mastodon return empty data. If a remote account is marked as suspended, it cannot be unsuspended locally. Suspended accounts can be targeted by activities such as Update, Undo, Reject, and Delete. This functionality is implemented using an extra property `suspended` on objects.
@ -677,6 +706,24 @@ Mastodon reports whether a user was locally suspended, for better handling of th
} }
``` ```
### Memorial flag {#memorial}
Mastodon reports whether a user's profile was memorialized, for better handling of these accounts. Memorial accounts in Mastodon return normal data, but are rendered with a header indicating that the account is a memorial account. This functionality is implemented using an extra property `memorial` on objects.
```json
{
"@context": [
"https://www.w3.org/ns/activitystreams",
{
"memorial": "http://joinmastodon.org/ns#memorial"
}
],
"id": "https://example.com/@alice",
"type": "Person",
"memorial": true
}
```
### Hashtags {#Hashtag} ### Hashtags {#Hashtag}
Similar to the `Mention` subtype of Link already defined in ActivityStreams, Mastodon will use `Hashtag` as a subtype of Link in order to surface posts referencing some common topic identified by a string key. The Hashtag has a `name` containing the #hashtag microsyntax -- a `#` followed by a string sequence representing a topic. This is similar to the @mention microsyntax, where an `@` is followed by some string sequence representing a resource (where in Mastodon's case, this resource is expected to be an account). Mastodon will also normalize hashtags to be case-insensitive lowercase strings, performing ASCII folding and removing invalid characters. Similar to the `Mention` subtype of Link already defined in ActivityStreams, Mastodon will use `Hashtag` as a subtype of Link in order to surface posts referencing some common topic identified by a string key. The Hashtag has a `name` containing the #hashtag microsyntax -- a `#` followed by a string sequence representing a topic. This is similar to the @mention microsyntax, where an `@` is followed by some string sequence representing a resource (where in Mastodon's case, this resource is expected to be an account). Mastodon will also normalize hashtags to be case-insensitive lowercase strings, performing ASCII folding and removing invalid characters.