Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v6 docs #1152

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

v6 docs #1152

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,47 @@ consumer-grade technology to be used in environments where cost and
inflexibility have been limiting factors. The source code for Field Book
is available on [GitHub](https://github.com/PhenoApps/Field-Book).

<figure align="center" class="image">
<img src="_static/images/collect/collect_framed.png" width="350px">
<figcaption><i>Field Book collect screen</i></figcaption>
</figure>

Getting Started
---------------

Field Book can be downloaded from the [Google Play
Store](https://play.google.com/store/apps/details?id=com.tracker.fieldbook)
or can be installed manually from the latest [GitHub
Release](https://github.com/PhenoApps/Field-Book/releases). After
installing the app, all permissions should be accepted and sample data
consisting of three fields and traits can be optionally loaded. The
images in the documentation utilize the sample data.
Release](https://github.com/PhenoApps/Field-Book/releases).

Field Book will display a brief set of slides to introduce you to the app when you open it for the first time.

<figure align="center" class="image">
<img src="_static/images/intro/intro_slides_joined.png" width="1100px">
<figcaption><i>Field Book intro slides</i></figcaption>
</figure>

During this intro you must set choices for the required permissions, and choose a storage location for app files. You also have the option to enable a tutorial and/or load a set of three sample fields and sample traits. The images in this documentation will make use of this sample data.

Structure
---------
When the intro finishes, Field Book will open to its home screen. This screen is divided into sections that can be pressed to access each of the major functions of the app.

<figure align="center" class="image">
<img src="_static/images/home_framed.png" width="400px">
<figcaption><i>Primary Field Book screen</i></figcaption>
<img src="_static/images/home_framed.png" width="350px">
<figcaption><i>Field Book home screen</i></figcaption>
</figure>


Field Book contains a home screen with links to the major sections of
the app. To use Field Book:
Navigate between these to:

1. Import your <a href="fields.md"><img style="vertical-align: middle;" src="_static/icons/home/view-module.png" width="20px"></a> [Fields](fields.md)

2. Create <a href="traits.md"><img style="vertical-align: middle;" src="_static/icons/home/format-list-bulleted.png" width="20px"></a> [Traits](traits.md)

3. Optionally modify any <a href="settings.md"><img style="vertical-align: middle;" src="_static/icons/home/cog.png" width="20px"></a> [Settings](settings.md)
3. <a href="collect.md"><img style="vertical-align: middle;" src="_static/icons/home/barley.png" width="20px"></a>[Collect](collect.md) data

4. Navigate to <a href="collect.md"><img style="vertical-align: middle;" src="_static/icons/home/barley.png" width="20px"></a>[Collect](collect.md)

5. <a href="export.md"><img style="vertical-align: middle;" src="_static/icons/home/save.png" width="20px"></a> [Export](export.md) data to a CSV (comma
separated value) file
4. And <a href="export.md"><img style="vertical-align: middle;" src="_static/icons/home/save.png" width="20px"></a> [Export](export.md) collected data to a file or database.

In addition to these main functions you can customize Field Book <a href="settings.md"><img style="vertical-align: middle;" src="_static/icons/home/cog.png" width="20px"></a> [Settings](settings.md), view summaries of your usage <a href="statistics.md"><img style="vertical-align: middle;" src="_static/icons/home/chart-bar.png" width="20px"></a>[Statistics](statistics.md), or learn more about the app in the <a href="about.md"><img style="vertical-align: middle;" src="_static/icons/home/information.png" width="20px"></a>[About](about.md) section at any time.

The <img ref="changelog" style="vertical-align: middle;" src="_static/icons/home/history.png" width="20px"> Changelog can be accessed from the top toolbar to see new features and
additions to the app.
10 changes: 6 additions & 4 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,21 @@
* [GoPro](trait-gopro.md)
* Settings
* [Settings](settings.md)
* [General](settings-general.md)
* [Profile](settings-profile.md)
* [Features](settings-features.md)
* [Appearance](settings-appearance.md)
* [Behavior](settings-behavior.md)
* [Geonav](settings-geonav.md)
* [Location](settings-location.md)
* [Sounds](settings-sounds.md)
* [BrAPI](settings-brapi.md)
* [Database](settings-database.md)
* [Beta](settings-beta.md)
* [System](settings-system.md)
* [Storage](settings-storage.md)
* [Experimental](settings-experimental.md)
* Extra
* [Barcodes](barcodes.md)
* [BrAPI](brapi.md)
* [Datagrid](datagrid.md)
* [Geonav](geonav.md)
* [Training Resources](training-resources.md)
* [Statistics](statistics.md)
* [About](about.md)
Binary file added docs/_static/icons/collect/equal-box.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/fields/check-all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/fields/delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/fields/file-export-outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/fields/menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/icons/fields/sort-ascending.png
Binary file not shown.
Binary file added docs/_static/icons/fields/sort.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/fields/sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/home/chart-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/traits/sort.png
Binary file modified docs/_static/images/about/about_framed.png
Binary file modified docs/_static/images/collect/collect_framed.png
Binary file modified docs/_static/images/collect/collect_summary_framed.png
Binary file modified docs/_static/images/collect/collect_trait_menu_framed.png
Binary file modified docs/_static/images/datagrid/datagrid_edit_rows_joined.png
Binary file modified docs/_static/images/datagrid/datagrid_view_framed.png
Binary file modified docs/_static/images/export/export_framed.png
Empty file added docs/_static/images/fields/a
Empty file.
Binary file added docs/_static/images/fields/a-0
Binary file not shown.
Binary file added docs/_static/images/fields/add_field_framed.png
Binary file modified docs/_static/images/fields/fields_framed.png
Binary file modified docs/_static/images/fields/fields_import_joined.png
Binary file modified docs/_static/images/fields/fields_list_item.png
Binary file modified docs/_static/images/home_framed.png
Binary file added docs/_static/images/intro/features_framed.png
Binary file added docs/_static/images/intro/intro_slides_joined.png
Binary file added docs/_static/images/intro/new_folder_framed.png
Binary file added docs/_static/images/intro/welcome_framed.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified docs/_static/images/traits/formats/collect_audio_framed.png
Binary file modified docs/_static/images/traits/formats/collect_boolean_framed.png
Binary file modified docs/_static/images/traits/formats/collect_counter_framed.png
Binary file modified docs/_static/images/traits/formats/collect_date_framed.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified docs/_static/images/traits/formats/collect_gnss_framed.png
Binary file modified docs/_static/images/traits/formats/collect_numeric_framed.png
Binary file modified docs/_static/images/traits/formats/collect_percent_framed.png
Binary file modified docs/_static/images/traits/formats/collect_photo_framed.png
Binary file modified docs/_static/images/traits/formats/collect_text_framed.png
Binary file modified docs/_static/images/traits/single_trait_menu_framed.png
Binary file modified docs/_static/images/traits/traits_create_joined.png
Binary file modified docs/_static/images/traits/traits_framed.png
Binary file modified docs/_static/images/traits/traits_menu_framed.png
Loading