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.

Sign up for GitHub

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

Added section labels and fixed some typos #194

Merged
merged 5 commits into from
Sep 23, 2017
Merged

Added section labels and fixed some typos #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d079049
added section labels
ankita240796 Sep 23, 2017
bbd28a4
fixed some typos
ankita240796 Sep 23, 2017
a9d10d2
fixed typos
ankita240796 Sep 23, 2017
d02625d
fixed bad formatting
ankita240796 Sep 23, 2017
6f23525
minor fix
ankita240796 Sep 23, 2017
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
18 changes: 11 additions & 7 deletions briefcase-forms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ Pushing forms to ODK Aggregate
Pulling forms from Collect
---------------------------

Pulling from Android 2.x or earlier device
.. _pull-from-android2.x:

Pulling from Android 2.x and earlier device
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Ensure all filled-in forms are finalized. Either delete the forms which are not finalized or delete them after making a backup copy of :file:`/sdcard/odk` directory on your device and restore that later.
Expand All @@ -74,6 +76,8 @@ Pulling from Android 2.x or earlier device
.. warning::
ODK Briefcase cannot discriminate between duplicates of the same filled-in form. After you pull the data into ODK Briefcase, it is important that you delete it from ODK Collect. Otherwise, the next time you follow this process, you will end up with two copies of the filled-in forms from the first pull, etc.

.. _pull-from-android4.x:

Pulling from Android 4.x and later device
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -120,32 +124,32 @@ In Briefcase v1.4.4 and later, there is a scriptable command line interface.

Pulling form data from Aggregate Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
.. code-block:: console

$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --aggregate_url https://my_server.appspot.com --odk_username my_username --odk_password my_password
$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --aggregate_url https://my_server.appspot.com --odk_username my_username --odk_password my_password

This command pulls form data with id market_prices from Aggregate server at `https://my_server.appspot.com` and stores data in Briefcase's storage directory on the :file:`~/Desktop`
This command pulls form data with id market_prices from Aggregate server at `https://my_server.appspot.com` and stores data in Briefcase's storage directory on the :file:`~/Desktop`

Pulling form data from ODK Collect
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console

$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --odk_directory ~/Desktop/odk
$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --odk_directory ~/Desktop/odk

This command pulls form data with id market_prices from Collect's odk folder at :file:`~/Desktop/odk` and store data in Briefcase's storage directory on the :file:`~/Desktop`

Export form data
~~~~~~~~~~~~~~~~~~~~
.. code-block:: console

$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --export_directory ~/Desktop --export_filename market_prices.csv
$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --export_directory ~/Desktop --export_filename market_prices.csv

This command exports form data with id market_prices from Briefcase's storage directory on the :file:`~/Desktop` and write CSV file to :file:`~/Desktop/market_prices.csv`


To get help about the command line operation type `java -jar path_to_jar -help`.

.. code-block:: console
.. code-block:: console

$ java -jar "/home/pc123/Desktop/ODK Briefcase v1.8.0 Production.jar" -help

Expand Down
2 changes: 1 addition & 1 deletion collect-forms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Once you have at least one form :ref:`loaded into ODK Collect <loading-forms-int

- Select :guilabel:`Fill Blank Form` from the app home screen.
- Select the form you would like to fill out from the form list.
- Typically, you will :gesture:`Swipe Left` to advance forward through the question, and :gesture:`Swipe Right` to backup.
- Typically, you will :gesture:`swipe left` to advance forward through the question, and :gesture:`swipe right` to back up.

- You can switch from :gesture:`Swipe` navigation to Forward/Backward buttons in :menuselection:`⋮ -> General Settings -> User Interface`
- Some questions will :ref:`auto-advance <autoadvance-widget>` after being answered.
Expand Down
12 changes: 6 additions & 6 deletions form-widgets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ GeoTrace

A line or polygon of GPS coordinates tracking actual device movement. The user can specify one of two location-recording modes:

- Manual Mode — The user taps the device to place a marker as desired, while moving.
- Manual Mode — The user taps the device to place a marker as desired while moving.
- Automatic Mode — The app creates a marker on a regular time interval (default: 20 seconds) as the user moves.


Expand All @@ -319,7 +319,7 @@ A line or polygon of GPS coordinates tracking actual device movement. The user c
:alt: The same map as displayed previously, but now a series of red markers form a line across the map.

.. image:: /img/form-widgets/geotrace6.*
:alt: The same map as previously, with a new modal popup. The headlines of the modal is "Save GeoTrace as" followed by two options: Save as Polygon and Save as Polyline. In the bottom-right is a Cancel button.
:alt: The same map as previously, with a new modal popup. The headline of the modal is "Save GeoTrace as" followed by two options: Save as Polygon and Save as Polyline. In the bottom-right is a Cancel button.

.. image:: /img/form-widgets/geotrace7.*
:alt: The Geotrace form widget, as shown previously. The question text is "Where have you been?" and the button label is "View or Change GeoTrace." Below that is a list of lat/long GPS coordinates.
Expand Down Expand Up @@ -501,7 +501,7 @@ XForm XML
Image
----------

An image collector. The user can choose to select an image stored on the device, or take a new picture. The example includes :term:`hint` text.
An image collector. The user can choose to select an image stored on the device or take a new picture. The example includes :term:`hint` text.

.. image:: /img/form-widgets/image-start.*
:alt: The Image widget as displayed in the ODK Collect App on an Android phone. The question text is "Please take a self portrait." Below the question is the hint text, "A 'selfie.'" There are two buttons: Take Picture and Choose Image.
Expand Down Expand Up @@ -540,7 +540,7 @@ Audio
An audio recording collector.

.. image:: /img/form-widgets/audio-start.*
:alt: The Audio form widget as displayed in the ODK Collect App on an Android phone. The question text is "Please record your name." There are three buttons: Record Sound, Choose Sound, and Play Sound. The "Play Sound" button is disabled.
:alt: The Audio form widget as displayed in the ODK Collect App on an Android phone. The question text is "Please record your name." There are three buttons: Record Sound, Choose Sound and Play Sound. The "Play Sound" button is disabled.

.. need to complete the audio widget sequence of images

Expand Down Expand Up @@ -1162,7 +1162,7 @@ Annotate Widget
Allows user to take or select an image and then draw on it.

.. image:: /img/form-widgets/annotate-start.*
:alt: The Annotate form widget, as displayed in the ODK Collect app on an Android phone. The question text is, "Annotate widget." The hint text is, "image type with anotatr appearance." There are three buttons: "Take Picture," "Choose Image," and "Markup Image." The Markup Image button is disabled. Above the question text is the form group name "Image widgets."
:alt: The Annotate form widget, as displayed in the ODK Collect app on an Android phone. The question text is, "Annotate widget." The hint text is, "image type with annotate appearance." There are three buttons: "Take Picture," "Choose Image," and "Markup Image." The Markup Image button is disabled. Above the question text is the form group name "Image widgets."

.. image:: /img/form-widgets/annotate-1.*
:alt: The camera view on an Android phone. In the viewer is a picture of a small saucer. Below the viewer is a blue checkmark button.
Expand Down Expand Up @@ -1790,7 +1790,7 @@ A set of radio buttons with text labels and accompanying images.
See :ref:`image-options` to learn more about including images in surveys.

.. image:: /img/form-widgets/default-single-image-select.*
:alt: The Single Select form widget with images, as displayed in the ODK Collect app on an Android phone. The question text is, "Grid select one widget." The hint text is, "select_one type with no appearance, 4 image choices (a.jpg, b.jpb, c.jpg, d.jpg)." Below that is a set of radio buttons labeled A, B, C, and D. Below each radio button is a small icon of an animal: A - whale, B - frog, C - aligator, D - eagle. Above the question text is the form group name "Select one widgets."
:alt: The Single Select form widget with images, as displayed in the ODK Collect app on an Android phone. The question text is, "Grid select one widget." The hint text is, "select_one type with no appearance, 4 image choices (a.jpg, b.jpb, c.jpg, d.jpg)." Below that is a set of radio buttons labeled A, B, C, and D. Below each radio button is a small icon of an animal: A - whale, B - frog, C - alligator, D - eagle. Above the question text is the form group name "Select one widgets."

XLSForm Rows
""""""""""""""
Expand Down