diff --git a/app/src/main/java/com/kylecorry/trail_sense/tools/turn_back/TurnBackToolRegistration.kt b/app/src/main/java/com/kylecorry/trail_sense/tools/turn_back/TurnBackToolRegistration.kt index 2422349f4..1a58eafd3 100644 --- a/app/src/main/java/com/kylecorry/trail_sense/tools/turn_back/TurnBackToolRegistration.kt +++ b/app/src/main/java/com/kylecorry/trail_sense/tools/turn_back/TurnBackToolRegistration.kt @@ -19,6 +19,7 @@ object TurnBackToolRegistration : ToolRegistration { R.drawable.ic_undo, R.id.turnBackFragment, ToolCategory.Time, + guideId = R.raw.guide_tool_turn_back, notificationChannels = listOf( ToolNotificationChannel( TurnBackAlarmReceiver.NOTIFICATION_CHANNEL_ID, diff --git a/app/src/main/res/raw/guide_tool_turn_back.md b/app/src/main/res/raw/guide_tool_turn_back.md new file mode 100644 index 000000000..b27451ae6 --- /dev/null +++ b/app/src/main/res/raw/guide_tool_turn_back.md @@ -0,0 +1,12 @@ +The Turn Back tool can be used to alert you when to turn back on a hike to return at a specific time. + +## Return time +You can set the return time by clicking the input field and selecting a time from the time picker. The return time is the time that you want to return back to your current location if you start the hike now. + +Once the return time has been set, an alert will be displayed a little before halfway through the hike to remind you to turn back if you want to return on time. The time until the turn back time is displayed at the top of the screen. + +### Return before dark +If you click the "Return before dark" button, the return time will be set to sunset. This is useful if you want to make sure you return before it gets dark. + +## Cancel the alert +You can cancel the alert by clicking the "Cancel" button at the bottom of the screen. This will clear the return time and the alert. diff --git a/guides/en-US/guide_tool_turn_back.txt b/guides/en-US/guide_tool_turn_back.txt new file mode 100644 index 000000000..b27451ae6 --- /dev/null +++ b/guides/en-US/guide_tool_turn_back.txt @@ -0,0 +1,12 @@ +The Turn Back tool can be used to alert you when to turn back on a hike to return at a specific time. + +## Return time +You can set the return time by clicking the input field and selecting a time from the time picker. The return time is the time that you want to return back to your current location if you start the hike now. + +Once the return time has been set, an alert will be displayed a little before halfway through the hike to remind you to turn back if you want to return on time. The time until the turn back time is displayed at the top of the screen. + +### Return before dark +If you click the "Return before dark" button, the return time will be set to sunset. This is useful if you want to make sure you return before it gets dark. + +## Cancel the alert +You can cancel the alert by clicking the "Cancel" button at the bottom of the screen. This will clear the return time and the alert. diff --git a/site/guides.js b/site/guides.js index ae75de0a0..97ce42c95 100644 --- a/site/guides.js +++ b/site/guides.js @@ -28,10 +28,11 @@ const guides = [ "tool_sensors", "tool_settings", "tool_solar_panel_aligner", - "tool_tools", "tool_temperature_estimation", "tool_tides", + "tool_tools", "tool_triangulate_location", + "tool_turn_back", "tool_water_boil_timer", "tool_weather", "tool_whistle",