Skip to content

Commit 220513d

Browse files
committed
Add an example and usage after inclusion
1 parent a7c9015 commit 220513d

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

draft-extensions-policy.html

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h1 id="title">Process for Including Extensions in Activity Streams 2.0</h1>
3939
<section>
4040
<h2>Motivation</h2>
4141
<p>
42-
Activity Streams 2.0, as described in [[[[activitystreams-core]]
42+
Activity Streams 2.0, as described in [[activitystreams-core]]
4343
and [[activitystreams-vocabulary]] is a vocabulary for representing
4444
social data. It is used by, among others, the [[activitypub]] API and protocol.
4545
It is designed to be extensible, so that new terms can
@@ -151,6 +151,30 @@ <h2>Motivation</h2>
151151
an additional line of context. It also provides an opportunity to resolve
152152
conflicts between terms in different extensions in the SocialCG.
153153
</p>
154+
<p>
155+
Thereafter, publishers will not need to include the extension's context URL
156+
in their documents. The extension's terms will be available for all documents
157+
that use the Activity Streams 2.0 context, without requiring a namespace
158+
prefix.
159+
</p>
160+
<figure>
161+
<figcaption>
162+
Theoretical example of using the favorite ice cream flavor term
163+
after it has been included in the main Activity Streams 2.0 context
164+
document.
165+
</figcaption>
166+
<div id="ex1-context" style="display: block;">
167+
<pre class="example highlight json">
168+
{
169+
"@context": "https://www.w3.org/ns/activitystreams",
170+
"id": "https://example.com/people/evan",
171+
"type": "Person",
172+
"name": "Evan Prodromou",
173+
"favoriteIceCreamFlavor": "Chocolate"
174+
}
175+
</pre>
176+
</div>
177+
</figure>
154178
<p>
155179
This inclusion does not come without a price. First, the Activity Streams 2.0
156180
context document is that much larger, which has a cost in terms of readability,
@@ -177,7 +201,7 @@ <h2>Process</h2>
177201
<li><b>Publish the extension for review.</b> Extensions can be published
178202
through the Federation Enhancement Proposal (FEP) process, as Notes of
179203
the SocialCG, through another standardisation process, or by any other
180-
organisations or individuals.
204+
organisations or individuals. See "Criteria" below for required content.
181205
</li>
182206
<li>
183207
<b>Implement the extension.</b> See "Criteria" below for implementation requirements.
@@ -190,13 +214,13 @@ <h2>Process</h2>
190214
for inclusion of the extension.
191215
</li>
192216
<li>
193-
<b></b>Vote on the extension. The SocialCG will vote on whether to include the
217+
<b>Vote on the extension.</b> The SocialCG will vote on whether to include the
194218
extension in the Activity Streams 2.0 context document.
195219
</li>
196220
<li>
197221
<b>Create a draft version of the Activity Streams 2.0 context document including
198-
the extension terms and namespace. This is the time to resolve any conflicts
199-
with existing names in the context document.</b>
222+
the extension terms and namespace.</b> This is the time to resolve any conflicts
223+
with existing names in the context document.
200224
</li>
201225
<li>
202226
<b>Test the draft version of the Activity Streams 2.0 context document.</b>

0 commit comments

Comments
 (0)