Skip to content

Commit

Permalink
add formating and debug info
Browse files Browse the repository at this point in the history
  • Loading branch information
woodthom2 committed Dec 7, 2023
1 parent 41ee966 commit 87123a1
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 0 deletions.
Binary file added assets/images/formatting-min.jpg
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 assets/images/troubleshooting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions content/en/blog/file-formatting-guidance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Formatting help
description: How to fix problems in Harmony
date: 2023-12-07
image: /images/formatting-min.jpg
---

# How should I format my file for Harmony?

Harmony supports the following file types:

* Word - [download an example Word doc formatted for Harmony](/gad7example.docx)
* Excel - [download an example Excel spreadsheet formatted for Harmony with two tabs for two questionnaires](/gad7scaredexample.xlsx)
* CSV - [download an example tab separated CSV file formatted for Harmony](/gad7example.csv)
* PDF - [download an example tabular PDF document formatted for Harmony](/gad7example.pdf)

If you want to upload multiple questionnaires in a single file, you can use Excel format and put them in separate tabs.

In all cases we recommend clearly supplying question numbers, question texts, and removing extraneous information such as copyright disclaimers for best results.

If you are having trouble parsing a document in Harmony, you can [raise an issue](https://github.com/harmonydata/harmony/issues) or [try our troubleshooting tips](/troubleshooting).
29 changes: 29 additions & 0 deletions content/en/blog/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Troubleshooting Harmony
description: How to fix problems in Harmony
date: 2023-12-07
image: /images/troubleshooting.png
---

# Troubleshooting Harmony

## Harmony didn't find anything in my PDF

Harmony tends to perform better if you upload a file with item numbers.

If there are are no question numbers in the instrument, it's very hard for Harmony to distinguish question text from other content such as the copyright information. [Click here](/gad7example.pdf) to see an example PDF with question numbers included.

Also, if your PDF is a scanned document, please see if you can find a fully digitised (OCR'ed) version of the document.

We suggest either finding a file with question numbers or better quality content. Or try a different file format such as Word, Excel or CSV. [We have guidance on formatting your files for Harmony](/file-formatting-guidance).

Harmony supports:

* Word
* Excel
* CSV
* PDF - however if you are having problems parsing PDFs please try another format.

Finally, feel free to [raise an issue](https://github.com/harmonydata/harmony/issues) to let us know that your PDF isn't being parsed. Please also share the PDF in question.


1 change: 1 addition & 0 deletions static/.~lock.gad7example.docx#
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
,thomas,tw,07.12.2023 12:26,file:///home/thomas/.config/libreoffice/4;
8 changes: 8 additions & 0 deletions static/gad7example.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Question number Question text Options
1 Feeling nervous, anxious, or on edge Not at all/Several days/More than half the days/Nearly every day
2 Not being able to stop or control worrying Not at all/Several days/More than half the days/Nearly every day
3 Worrying too much about different things Not at all/Several days/More than half the days/Nearly every day
4 Trouble relaxing Not at all/Several days/More than half the days/Nearly every day
5 Being so restless that it is hard to sit still Not at all/Several days/More than half the days/Nearly every day
6 Becoming easily annoyed or irritable Not at all/Several days/More than half the days/Nearly every day
7 Feeling afraid, as if something awful might happen Not at all/Several days/More than half the days/Nearly every day
Binary file added static/gad7example.docx
Binary file not shown.
Binary file added static/gad7example.pdf
Binary file not shown.
Binary file added static/gad7scaredexample.xlsx
Binary file not shown.

0 comments on commit 87123a1

Please sign in to comment.