Okay/Spec: Difference between revisions

No edit summary
Line 156: Line 156:


== initiation ==
== initiation ==
A client <span class="must">must</span> register itself with a space before it can send messages to rooms.  
A client <span class="must">must</span> register itself with a space before it can perform most actions.  


=== keys ===
=== keys ===
Line 167: Line 167:
The '''Room Directory''' is a list of every room contained within the space. This list <span class="may">may</span> be [[Okay/Spec#pagination|paginated]].
The '''Room Directory''' is a list of every room contained within the space. This list <span class="may">may</span> be [[Okay/Spec#pagination|paginated]].


The URI of the space's room directory <span class="must">must</span> be linked in its [[Okay/Spec#ok-space|ok-space]] element using the <code>ok-rooms</code> rel value.
The URI of the space's room directory <span class="must">must</span> be linked in its [[Okay/Spec#ok-space|ok-space]] element using the <code>ok-rooms</code> rel value. Rooms <span class="mustnt">must not</span> be included inline.
 
 


Here's an example of what a room directory might look like:<syntaxhighlight lang="html"><main class="ok-rooms">
Here's an example of what a room directory might look like:<syntaxhighlight lang="html"><main class="ok-rooms">
   <h1>Rooms on This Server</h1>
   <h1>Rooms on This Server</h1>
   <ul>
   <ul>
     <li><a href="/rooms/1" class="ok-room">General</a></li>
     <li><a href="/rooms/1" rel="ok-room">General</a></li>
     <li><a href="/rooms/evil" class="ok-room">Evildoing Room (evil)</a></li>
     <li><a href="/rooms/evil" rel="ok-room">Evildoing Room (evil)</a></li>
   </ul>
   </ul>
</main></syntaxhighlight>A room directory is still just a rat in a cage.
</main></syntaxhighlight>A room directory is still just a rat in a cage.