1.\"
  2.\" Copyright (c) 2019 Ted Unangst
  3.\"
  4.\" Permission to use, copy, modify, and distribute this software for any
  5.\" purpose with or without fee is hereby granted, provided that the above
  6.\" copyright notice and this permission notice appear in all copies.
  7.\"
  8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 15.\"
 16.Dd $Mdocdate$
 17.Dt ACTIVITYPUB 7
 18.Os
 19.Sh NAME
 20.Nm activitypub
 21.Nd notes about the honk implementation
 22.Sh DESCRIPTION
 23The
 24.Xr honk 1
 25utility processes status updates and other microblog activities using the
 26.Nm ActivityPub
 27protocol to exchange messages with other servers.
 28The specification is subject to interpretation, and not all implementations
 29behave in the same way.
 30This document attempts to clarify honk's behavior.
 31It is not intended to be a complete description of
 32.Nm ActivityPub ,
 33but may be useful as a guide to other implementors looking to interoperate.
 34.Ss OBJECTS
 35The following object or document types are supported.
 36.Bl -tag -width tenletters
 37.It Vt Note
 38Fully supported.
 39The default object type for honk.
 40.It Vt Article
 41Fully supported.
 42.It Vt Page
 43Supported.
 44.It Vt Question
 45Read only support.
 46Appears similar to a Note.
 47.It Vt Event
 48Supported.
 49Appears similar to a Note.
 50Can be both created and received, but
 51.Vt Invite
 52activities are ignored.
 53.It Vt Video
 54Limited support.
 55.It Vt Audio
 56Limited Support.
 57.El
 58.Pp
 59Honk primarily supports HTML content, not markdown or other formats,
 60with a wide range of permitted HTML tags in object
 61.Fa content
 62fields.
 63The following tags are supported.
 64.Bd -literal -offset indent
 65a, img, span,
 66div, h1, h2, h3, h4, h5, h6, hr,
 67table, thead, tbody, th, tr, td, colgroup, col,
 68p, br, pre, code, blockquote, q,
 69samp, mark, ins, dfn, cite, abbr, address,
 70strong, em, b, i, s, u, sub, sup, del, tt, small,
 71ol, ul, li, dl, dt, dd
 72.Ed
 73.Pp
 74The following tag attributes are permitted.
 75.Bd -literal -offset indent
 76href, src, alt, colspan, rowspan
 77.Ed
 78.Pp
 79The following class names are used for syntax highlighting code blocks.
 80.Bd -literal -offset indent
 81kw, bi, st, nm, tp, op, cm, al, dl
 82.Ed
 83.Ss ACTIVITIES
 84The following activities are supported.
 85.Bl -tag -width tenletters
 86.It Vt Create
 87Fully supported.
 88.It Vt Announce
 89Supported with share semantics.
 90.It Vt Read
 91Supported.
 92Primarily used to acknowledge replies and complete threads.
 93Can be interpreted to mean reply is approved, if not endorsed.
 94.It Vt Add
 95Works with collections.
 96.It Vt Follow
 97Supported.
 98Can follow both actors and collections.
 99.Vt Accept
100and
101.Vt Undo
102require that the original request be quoted, not referred to by URI.
103.It Vt Update
104Supported.
105Honk sends and receives
106.Vt Update
107activities.
108.It Vt Delete
109Does what it can.
110.It Vt Like
111Don't be ridiculous.
112.El
113.Ss METADATA
114The following additional object types are supported as
115.Fa tag
116or
117.Fa attachment .
118.Bl -tag -width tenletters
119.It Mention
120Pretty @ machine.
121.It Emoji
122Inline text :emoji: with image replacement.
123.It Place
124Attached as a
125.Fa tag
126to
127.Vt Note
128and
129.Fa location
130to
131.Vt Event .
132Supports
133.Fa name ,
134.Fa url ,
135.Fa latitude ,
136and
137.Fa longitude .
138.It Document
139Plain text and images in jpeg, gif, png, and webp formats are supported.
140Other formats are linked to origin.
141.El
142.Pp
143The
144.Fa replies
145array will be populated with a list of acknowledged replies.
146.Ss EXTENSIONS
147Honk also supports a
148.Vt Ping
149activity and will respond with a
150.Vt Pong
151activity.
152This is useful for debugging networking connectivity issues without
153visible side effects.
154See ping.txt for details.
155.Ss SECURITY
156Honk uses http signatures.
157.Ss WEBFINGER
158Honk implements the
159.Vt webfinger
160end point and will use it for @mention resolution.
161It is not required for federation.
162.Ss LD-JSON
163Not really.
164.Sh SEE ALSO
165.Xr intro 1 ,
166.Xr honk 1
167.Sh STANDARDS
168.Pp
169.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
170.Pp
171.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
172.Sh CAVEATS
173The ActivityPub standard is subject to interpretation, and not all
174implementations are as enlightened as honk.