@@ -8,7 +8,7 @@ title: Hall interface
9# Hall interface
9# Hall interface
11−This document describes the different interfaces Hall provides and the data that is accessible and modifyable through them. Knowledge of the Urbit application model (including [new gall](gall.md)) and #[Hall's architecture](architecture.md) is assumed.
11+This document describes the different interfaces Hall provides and the data that is accessible and modifiable through them. Knowledge of the Urbit application model (including [new gall](new-gall)) and [Hall's architecture](architecture) is assumed.
13While the structures here are given in Hoon, they match fairly closely to their JSON equivalent. Most important to note is that `$%({$x y/z})` becomes accessible as `json.x.y`.
13While the structures here are given in Hoon, they match fairly closely to their JSON equivalent. Most important to note is that `$%({$x y/z})` becomes accessible as `json.x.y`.
@@ -75,7 +75,7 @@ Contains a map of glyphs and the audiences they map to, as well as a map of ship
76#### /client rumor
76#### /client rumor
78−Contains either a bound or unbound glyph and its target, or a ship with its new ncikname. A `nic`kname of `''` means the associated ship no longer has a nickname set for it.
78+Contains either a bound or unbound glyph and its target, or a ship with its new nickname. A nickname of `''` means the associated ship no longer has a nickname set for it.
81++ rumor :> query result change
81++ rumor :> query result change
@@ -179,9 +179,9 @@ Contains a ship and a query, and a flag to indicate whether that subscription ha
180### /circle
180### /circle
182−Circle queries allow for the retrieving of data from stories. Their messages, configuration, presences, can all be accessed. Since this is a lot of data, there are lots of possibilities for filtering it built in to the query itself.
182+Circle queries allow for the retrieving of data from stories. Their messages, configuration, and presences can all be accessed. Since this is a lot of data, there are lots of possibilities for filtering it built in to the query itself.
184−A quick refresher on the difference between "local" and "remote" presence and configuration: "local" means it pertains to the circle itself, "remote" means it pertains to one of its configured sources. The latter is primarily useful to clients when using a circle for aggregation, like the `%inbox`.
184+A quick refresher on the difference between "local" and "remote" presence and configuration: "local" means it pertains to the circle itself; "remote" means it pertains to one of its configured sources. The latter is primarily useful to clients when using a circle for aggregation, like the `%inbox`.
187++ query ::
187++ query ::
@@ -245,7 +245,7 @@ Valid paths include:
246#### /circle prize
246#### /circle prize
248−Contains (where applicable) messages in envelopes (with message numbers), local and remote configurations and presences.
248+Contains (where applicable) messages in envelopes (with message numbers), as well as local and remote configurations and presences.
251++ prize :> query result
251++ prize :> query result
@@ -377,7 +377,7 @@ When the user makes any changes to shared UI elements (elements that should pers
380−`%glyph`: Adds or removed a binding of a glyph to an audience.
380+`%glyph`: Adds or removes a binding of a glyph to an audience.
382`%nick`: Sets a local nickname for a ship. An empty nickname `''` means the ship has no nickname.
382`%nick`: Sets a local nickname for a ship. An empty nickname `''` means the ship has no nickname.