3.9 KiB
| title | description | menu | ||||||
|---|---|---|---|---|---|---|---|---|
| Microformats | An open data format using CSS classes to structure your already-existing HTML. |
|
{{< hint style="info" >}} As of v4.0.0, HTML permalinks for statuses and profiles have been deprecated and removed from Mastodon. As a result, Microformats are currently not used within nor generated by Mastodon. {{< /hint >}}
What are microformats?
Microformats 2.0 is a standard used to embed metadata directly within an HTML document. Rather than needing to use an API for read-only purposes, a web page can be parsed for certain CSS classes in order to extract information that you have already fetched just by viewing the page, rather than having to separately request that same information from an API. The use of microformats classes allows for semantic parsing of data within a given web page, and can be used to generate feeds, cards, or representations of that data.
Microformats classes
All microformats classes use a prefix. The prefix indicates the type of the element, independent of hierarchy. These are the microformats classes as used in Mastodon's codebase.
Root elements (h-*)
h-feed
Represents a stream of entries. Attached to a profile's statuses. Also attached to the parent thread within detailed status views.
h-entry
Represents episodic or date stamped online content. Attached to a status.
h-cite
Represents a reference to another online publication. Attached to a boost. Also attached to other statuses in the thread within detailed status views.
h-card
Represents a person or organization. Attached to the container of display name, username, and avatar. Also attached to mentions.
Plain-text properties (p-*)
p-author
Within h-entry or h-cite, represents the author of the entry, and is attached to the container of display name, username, and avatar.
p-name
Within h-feed, represents the title of the feed. Attached to data element with value attribute.
Within h-entry or h-cite, represents the title of the entry. Unused in Mastodon.
Within h-card, represents the plain-text name of a person or organization. Attached to display name.
p-in-reply-to
Within h-entry of a detailed status, represents the status that is the direct parent.
p-repost-of
Within h-entry of a detailed status, represents a post that is a reblog and also a direct parent. Currently unused, since reblogs cannot be replied to.
p-comment
Within h-entry of a detailed status, represents statuses that are direct children.
URL properties (u-*)
u-photo
Within h-card, represents the profile picture. Attached to the avatar image.
u-uid
Within h-entry or h-cite, represents a universally unique identifier. Attached to timestamp link.
u-url
Within h-entry or h-cite, represents the status permalink. Attached to timestamp link.
Within h-card, represents the profile permalink. Attached to display name link.
Datetime properties (dt-*)
dt-published
Within h-entry or h-cite, represents the date and time at which the status was published. Attached to data element with value attribute.
Element tree (e-*)
e-content
Within h-entry or h-cite, represents the content of the status. Attached to status content.
Additional classes
These elements are attached by Mastodon for parsing metadata, but are not technically part of the Microformats vocabulary.
mention
Indicates that the link should be opened in-app with the associated mention data from the API.
hashtag
Indicates that the link should be opened in-app with the associated hashtag data from the API.