From 9db49fae2e1a8de2ce2f2727311ef28c1e521ab3 Mon Sep 17 00:00:00 2001 From: Matthew Petroff Date: Tue, 5 Jul 2016 20:21:57 -0400 Subject: [PATCH] Clarify configuration parameter documentation. --- doc/json-config-parameters.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/json-config-parameters.md b/doc/json-config-parameters.md index 7d413b1..00de27c 100644 --- a/doc/json-config-parameters.md +++ b/doc/json-config-parameters.md @@ -121,7 +121,8 @@ viewer can be set to. Defaults to `50` / `120`. ### `compass` (boolean) -If `true`, a compass is displayed. Defaults to `false`. +If `true`, a compass is displayed. Normally defaults to `false`; defaults to +`true` if heading information is present in Photo Sphere XMP metadata. ### `northOffset` (number) @@ -149,12 +150,12 @@ information, or external links. Each array element has the following properties. #### `pitch` (number) -Specifies the pitch portion of the hot spot's location. +Specifies the pitch portion of the hot spot's location, in degrees. #### `yaw` (number) -Specifies the yaw portion of the hot spot's location. +Specifies the yaw portion of the hot spot's location, in degrees. #### `type` (string) @@ -180,15 +181,15 @@ for `info` hot spots. #### `targetPitch` (number) -Specifies the pitch of the target scene. +Specifies the pitch of the target scene, in degrees. #### `targetYaw` (number) -Specifies the yaw of the target scene. +Specifies the yaw of the target scene, in degrees. #### `targetHfov` (number) -Specifies the HFOV of the target scene. +Specifies the HFOV of the target scene, in degrees. ### `hotSpotDebug` (boolean)