documentation/mention.md at ac0d551ada8429a95d0bb5ff28f79d69af06cc91

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

Replace and fix broken links with hugos relref (#801 )

As discussed in #764 there are quite a lot of outdated links in the
mastodon documentation. In basically all cases this was resolved by
simply wrapping the old plain markdown link in hugos `relref`
function[^0].

While quite a lot of links on the `/zh-cn/` also appear to be broken,
these can not be fixed by just wrapping them in `relref`[^0]. Those are
all links to `/spec/` subpages which are just not translated to `/zh-cn/`
version. Therefore, `/zh-cn/spec/` has been excluded from the automated
checking as described in the next section.

The page has been checked using the linkchecker[^1] utility. One process
is running `hugo serve` in order to see all changes in real time and
notice errors directly in your browser. In a separate command prompt the
command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is
being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just
not existing parts of the page as mentioned in the previous paragraph.

There still is some ToDo on the table since quite a lot of the anchors
appear to not be set or at least differ from previous versions. One
example: on `/client/authorized/` is a link to
`/client/token/#creating-our-application` while the id of referenced
heading is `app`. These changes **do not** fix those Issues as it would
require way more time.

[^0]: https://gohugo.io/functions/relref/
[^1]: https://github.com/linkchecker/linkchecker

Close #764

2020-08-10 23:01:50 +02:00

1.4 KiB

Raw Blame History

title

description

Mention

Represents a mention of a user within the content of a status.

docs

parent
entities

Example

{
  "mentions": [
    {
      "id": "952529",
      "username": "alayna",
      "url": "https://desvox.es/users/alayna",
      "acct": "alayna@desvox.es"
    },
    {
      "id": "14715",
      "username": "trwnh",
      "url": "https://mastodon.social/@trwnh",
      "acct": "trwnh"
    }
  ]
}

Required attributes

`id`

Description: The account id of the mentioned user.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history: Added in 0.6.0

`username`

Description: The username of the mentioned user.
Type: String
Version history: Added in 0.6.0

`acct`

Description: The webfinger acct: URI of the mentioned user. Equivalent to username for local users, or username@domain for remote users.
Type: String
Version history: Added in 0.6.0

`url`

Description: The location of the mentioned user's profile.
Type: String (URL)
Version history: Added in 0.6.0

1.4 KiB Raw Blame History