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

updating media tags in docs and gifs from media::image to image #30

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
18 changes: 9 additions & 9 deletions source/add_logo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

Adding a custom logo to the top of your form is a simple process and primarily follows the same steps as [adding media content to your forms](media.md).

To begin:
To begin:

1. Start by creating your logo image file and save it with a short file name.

2. In your XLSForm, make the first question a Note question type, leave the label blank, and add a column titled `media::image` with your logo file name in the cell. As shown below:
2. In your XLSForm, make the first question a Note question type, leave the label blank, and add a column titled `image` with your logo file name in the cell. As shown below:

![image](/images/add_logo/xls.png)
![image](/images/add_logo/xls_updated.png)

3. When you're done editing the form, upload the XLSForm to either a new or existing project.
3. When you're done editing the form, upload the XLSForm to either a new or existing project.

4. Deploy or redeploy your form, depending on whether it's a new project or it's replacing an existing form.
4. Deploy or redeploy your form, depending on whether it's a new project or it's replacing an existing form.

5. In your project page go to SETTINGS and click on '+Add Document'. Then chose your logo file and click 'Upload'

## Tips:

* Keep your image small.
* Your logo image will not appear in the form preview, only when the form is opened.
* Skipping the final step will mean that your form will be displayed without the media files. Make sure the media files are uploaded before downloading the form to your devices when using the Android app.
* If you open the Formbuilder after deploying your XLSForm with the logo image file, it will automatically give the question a text label and you'll need to delete it for the automated text not to appear next to your logo in your form.
- Keep your image small.
- Your logo image will not appear in the form preview, only when the form is opened.
- Skipping the final step will mean that your form will be displayed without the media files. Make sure the media files are uploaded before downloading the form to your devices when using the Android app.
- If you open the Formbuilder after deploying your XLSForm with the logo image file, it will automatically give the question a text label and you'll need to delete it for the automated text not to appear next to your logo in your form.
Binary file added source/images/add_logo/xls_updated.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 source/images/media/media_updated.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions source/media.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Adding Various Types of Media

In addition to text questions or responses, you can also include visual or audio media in your forms and have it play or display inside the questionnaire. This works both on the Android app as well as in the Web forms (Enketo).
In addition to text questions or responses, you can also include visual or audio media in your forms and have it play or display inside the questionnaire. This works both on the Android app as well as in the Web forms (Enketo).

We are going to use the below example to demonstrate the steps.

![image](/images/media/example.gif)

**To add images, videos or audio in your form, you need to make changes in Excel using the XLSForm format.**
**To add images, videos or audio in your form, you need to make changes in Excel using the XLSForm format.**

**Step 1**: If you started your project by creating a new form on KoboCollect or the Web version, you need to export your form to the XLSForm format first.

![image](/images/media/download_xls.gif)

**Step 2**: Create the media files and save them with short file names.
**Step 2**: Create the media files and save them with short file names.

![image](/images/media/media_file.gif)

**Step 3**: Open the downloaded XLS form and add media columns in both the survey and choices tabs. Depending on if you want the images to be paired with choices or just be displayed under the question, you can then add the image files in the survey or/and choices tabs.

![image](/images/media/media.gif)
![image](/images/media/media_updated.gif)

**Note: The file names added to the XLS form must match the file names you gave to your images.**

**Step 4**: Upload your XLS form file into the existing project or create a new project. If you preview the form after uploading the XLS form, you will not see the images because we have not uploaded those yet.
**Step 4**: Upload your XLS form file into the existing project or create a new project. If you preview the form after uploading the XLS form, you will not see the images because we have not uploaded those yet.

![image](/images/media/upload_xls.gif)

Expand All @@ -34,10 +34,10 @@ We are going to use the below example to demonstrate the steps.

![image](/images/media/setting.gif)

**Step 7**: Once you uploaded all image files, you don't need to redeploy the project. You can go back to Form, Collect Data, and then click Open to check if the images are properly displayed.
**Step 7**: Once you uploaded all image files, you don't need to redeploy the project. You can go back to Form, Collect Data, and then click Open to check if the images are properly displayed.

![image](/images/media/upload_image.gif)

**Note: Skipping the final step will mean that your form will be displayed without the media files. Make sure the media files are uploaded before downloading the form to your devices when using the Android app.**
**Note: Skipping the final step will mean that your form will be displayed without the media files. Make sure the media files are uploaded before downloading the form to your devices when using the Android app.**

Animated GIF files are not currently supported by Enketo or KoBoCollect.