Okay/Spec: Difference between revisions
No edit summary |
No edit summary |
||
| Line 52: | Line 52: | ||
If multiple discovery elements are present on a page, the client may ask the user to choose which server it should connect to. | If multiple discovery elements are present on a page, the client may ask the user to choose which server it should connect to. | ||
=== | === the element thereof === | ||
A discovery element is a micro-format for informing Okay clients where they should be looking for certain information. They look like this: | A discovery element is a micro-format for informing Okay clients where they should be looking for certain information. They look like this: | ||
| Line 90: | Line 90: | ||
== the directory == | == the directory == | ||
The '''Room Directory''' is a list of every room on the server. This list may be [[Okay#pagination|paginated]]. | The '''Room Directory''' is a list of every room on the server. This list may be [[Okay#pagination|paginated]]. | ||
The path to the server's room directory must be defined in the its [[Okay#the element thereof|discovery element]] using the <code>ok-rooms</code> rel value. | |||
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> | |||
<ul> | |||
<li><a href="/rooms/1" class="ok-room">General</a></li> | |||
<li><a href="/rooms/evil" class="ok-room">Evildoing Room (evil)</a></li> | |||
</ul> | |||
</main> | |||
</syntaxhighlight> | |||
=== groups & sections === | === groups & sections === | ||