Commit 9bf28653 authored by Sean Hammond's avatar Sean Hammond Committed by Robert Knight

Edit the `services` config setting docs

- Clarify that if any service is specified it's used _instead of_, not
in addition to, the default hypothes.is service

- Add note that services settings are still experimental

- Edit the text for clarity

I still don't think the `authority` setting is very well described here,
but I think that setting may be going away in the future, so I'm not
going to try and document it better right now.

The `grantToken` setting could still do with much better docs as well.
parent 660d902a
...@@ -63,33 +63,46 @@ _Boolean_. Controls whether the in-document highlights are shown by default. ...@@ -63,33 +63,46 @@ _Boolean_. Controls whether the in-document highlights are shown by default.
### Annotation services ### Annotation services
These settings configure which annotation services the client connects to and where The `services` setting configures which annotation services the client
it loads assets from. By default, the client will connect to the public connects to (for example to login, retrieve annotations, and save annotations).
Hypothesis service at [hypothes.is](https://hypothes.is). By default, if no `services` setting is given, the client connects to the
public Hypothesis service at [hypothes.is](https://hypothes.is).
#### `services` #### `services`
_Array_. A list of additional annotation services which the client should _Array_. A list of alternative annotation services which the client should
retrieve annotations from, optionally including information about the identity connect to instead of connecting the the public Hypothesis service at
of the user on that service. This list is in addition to the public [hypothes.is](https://hypothes.is/).
[Hypothesis](https://hypothes.is/) service. May optionally include information (in the form of a grant token) about the
identity of the user accounts that the client is logged in to on those
services.
**N.B.** Currently only one additional annotation service is supported - only **N.B.** These settings are currently still experimental and may change without
the first item in this `services` array is used, and any further items in the warning.
array are ignored.
**N.B.** Currently only one alternative annotation service at a time is
supported - only the first item in this `services` array is used, and any
further items in the array are ignored.
Each item in the array should be an object describing an annotation service, Each item in the `services` array should be an object describing an annotation
with the following keys: service, with the following keys:
* `authority` _String_. The domain name which the annotation service is associated with. * `authority` _String_. The domain name which the annotation service is
associated with.
* `grantToken` _String|null_. An OAuth grant token which the client can exchange for an access token in order to make authenticated requests to the service. If _null_, the user will only be able to read rather than create or modify annotations. (Default: _null_) * `grantToken` _String|null_. An OAuth 2 grant token which the client can
exchange for an access token in order to make authenticated requests to the
service. If _null_, the user will be able to read but not create or modify
annotations. (Default: _null_)
* `icon` _String|null_. The URL to an image for the annotation service. This image will appear to the left of the name of the currently selected group. The image should be suitable for display at 16x16px and the recommended format is SVG. * `icon` _String|null_. The URL to an image for the annotation service. This
image will appear to the left of the name of the currently selected group.
The image should be suitable for display at 16x16px and the recommended
format is SVG.
* `onLoginRequest` _function_. A JavaScript function that the Hypothesis client * `onLoginRequest` _function_. A JavaScript function that the client will
will call in order to login (for example, when the user clicks a login button call in order to login (for example, when the user clicks a login button in
in the Hypothesis client's sidebar). the Hypothesis client's sidebar).
This setting can only be [set using window.hypothesisConfig](#configuring-the-client-using-javascript). This setting can only be [set using window.hypothesisConfig](#configuring-the-client-using-javascript).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment