Skip to content

Commit

Permalink
Add user guide for field guide
Browse files Browse the repository at this point in the history
Signed-off-by: Kyle Corry <kylecorry31@gmail.com>
  • Loading branch information
kylecorry31 committed Feb 5, 2025
1 parent f86d88c commit 3285724
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ object FieldGuideToolRegistration : ToolRegistration {
ToolCategory.Books,
isExperimental = true,
isAvailable = { isDebug() },
additionalNavigationIds = listOf(R.id.fieldGuidePageFragment)
additionalNavigationIds = listOf(R.id.fieldGuidePageFragment),
guideId = R.raw.guide_tool_field_guide
)
}
}
23 changes: 23 additions & 0 deletions app/src/main/res/raw/guide_tool_field_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
The Field Guide tool can be used to identify plants, animals, and other objects in the wild.

## Pages
Pages are organized into categories, such as plants and animals. You can click on a category to view the pages. The name, image, and the first sentence of the page's notes are displayed for each item. Click on an item to view the full page. On pages that you created, you will see a menu button that allows you to edit or delete the page.

You can search for pages by name, notes, or tags. The search results will be displayed as you type.

## Built-in pages
Trail Sense includes a set of built-in pages that cover common plants, animals, mushrooms, and rocks that are beneficial for wilderness survival. You can not edit or delete these pages.

## Create a page
To create a new page, click the add button in the bottom right corner of the screen. You can add a name, image, notes, and tags to the page. The image can be taken with the camera or selected from the gallery. You can click the check button in the top right corner to save the page.

If you had a category selected when you created the page, the new page will be pre-filled with that category. Pages without a category will be displayed in the "Other" category.

## Edit a page
To edit a page, click the menu button on a page row and select "Edit". You can change the name, image, notes, and tags of the page. You can click the check button in the top right corner to save the changes.

## Delete a page
To delete a page, click the menu button on a page row and select "Delete". You will be asked to confirm the deletion. Deleting a page is permanent and cannot be undone.

## Disclaimer
This tool is intended for educational purposes only. Always use caution when identifying plants, animals, or mushrooms. Some species may be dangerous or protected. If you are unsure about an identification, consult a professional.
6 changes: 3 additions & 3 deletions app/src/main/res/values/strings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1579,9 +1579,9 @@
<string name="freshwater">Freshwater</string>
<string name="cave">Cave</string>
<string name="tundra">Tundra</string>
<string name="diurnal">Diurnal</string>
<string name="nocturnal">Nocturnal</string>
<string name="crepuscular">Crepuscular</string>
<string name="diurnal">Diurnal (day)</string>
<string name="nocturnal">Nocturnal (night)</string>
<string name="crepuscular">Crepuscular (dusk / dawn)</string>
<string name="edible">Edible</string>
<string name="inedible">Inedible</string>
<string name="dangerous">Dangerous</string>
Expand Down
3 changes: 2 additions & 1 deletion site/guides.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const guides = [
"tool_clouds",
"tool_convert",
"tool_diagnostics",
"tool_field_guide",
"tool_flashlight",
"tool_light_meter",
"tool_lightning_strike_distance",
Expand All @@ -37,7 +38,7 @@ const guides = [
"tool_water_boil_timer",
"tool_weather",
"tool_whistle",
"tool_white_noise"
"tool_white_noise",
];

// Populate the guide list
Expand Down

0 comments on commit 3285724

Please # to comment.