Okay/Spec: Difference between revisions
Tags: Mobile edit Mobile web edit |
|||
| Line 112: | Line 112: | ||
==== metadata ==== | ==== metadata ==== | ||
Spaces < | Spaces can provide metadata about themselves to help users identify them.<syntaxhighlight lang="html"><nav class="ok-space"> | ||
<h1 class="ok-title"></h1> | |||
<p class="ok-subtitle"></p> | |||
<p class="ok-description"></p> | |||
<img class="ok-icon" src=""> | |||
<!-- ... --> | |||
</nav></syntaxhighlight>Space metadata can be declared anywhere within the ok-space element, using the class names given below: | |||
{| class="wikitable" | |||
|+ | |||
!Class Name | |||
!Tag | |||
!Purpose | |||
|- | |||
|<code>ok-icon</code> | |||
|<code><img /></code> or <code><picture /></code> | |||
|An image to represent the space visually. These are typically square and rendered at small sizes. | |||
|- | |||
|<code>ok-title</code> | |||
|any non-void element, <code><nowiki><h1 /></nowiki></code> preferred. | |||
|What the space is called in common parlance. | |||
|- | |||
|<code>ok-subtitle</code> | |||
|any non-void element, <code><nowiki><p /></nowiki></code> preferred. | |||
|An extra bit of text that is displayed alongside the title in certain contexts. | |||
|- | |||
|<code>ok-description</code> | |||
|any non-void element, <code><nowiki><p /></nowiki></code> preferred. | |||
|A long description of what the space is about. | |||
|} | |||
Clients may strip out child elements for some or all of the metadata elements, but should retain the text contained within those elements. | |||
todo: class name bikeshedding | |||
== initiation == | == initiation == | ||
| Line 131: | Line 153: | ||
When registering with a space, a client <span class="should">should</span> transparently generate a key pair (TODO: what type(s)?) and store it for use in subsequent requests. | When registering with a space, a client <span class="should">should</span> transparently generate a key pair (TODO: what type(s)?) and store it for use in subsequent requests. | ||
=== registration | === registration === | ||
The registration page allows clients to register their public key and [[Okay#profiles|profile]] with the space. | The registration page allows clients to register their public key and [[Okay#profiles|profile]] with the space. | ||