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

Clarify "Download Data" text #156

Closed
jpmckinney opened this issue Jul 17, 2019 · 1 comment
Closed

Clarify "Download Data" text #156

jpmckinney opened this issue Jul 17, 2019 · 1 comment

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Jul 17, 2019

The below was written for OC4IDS. For OCDS, replace "OC4IDS project package" with the appropriate OCDS text (e.g. "OCDS release package").


From open-contracting/cove-oc4ids#20 and open-contracting/cove-oc4ids#23

Original text: "We have tried to convert your JSON into a spreadsheet format. ¶ The results can be seen below."

Proposed text: "Download the data you submitted in either its original or alternative format. If you are investigating an error, you might find the Excel format easier to use."

PR text: "Alternative formats for reviewing your data ¶ Conversion of your (JSON) data into a spreadsheet format. The results can be seen below"

@michaelwood: "Hope this is OK, this keeps it open and short whilst still allowing for the error case where the results section becomes a list of errors"


Instead of having a prompt that is expected to do double duty (i.e. work in both the context of successful and unsuccessful conversion, it'd be better to simply check if conversion_error first, before rendering any text. Proposed changes:

  • if conversion_error
    • if conversion == 'flatten'
      • "The [JSON data you submitted] (link to original) could not be converted to an Excel file due to this error:"
    • if conversion == 'unflatten'
      • This apparently never occurs?
  • else
    • if conversion == 'flatten'
      • if validation_errors or additional_closed_codelist_values
        • "We converted the [JSON data you submitted] (link to original) to an Excel file. The Excel file might be easier to use to review your data or investigate an error."
        • Only put the converted file in the list.
      • else
        • "We converted the [JSON data you submitted] (link to original) to an Excel file. The Excel file might be easier to use to review your data."
        • Only put the converted file in the list.
    • if conversion == 'unflatten'
      • if file_type == 'xlsx'
        • "We converted the [Excel file you submitted] (link to original) to an OC4IDS project package JSON file."
        • Only put the converted file in the list.
      • elif file_type == 'csv'
        • "We converted the [CSV file you submitted] (link to original) to an OC4IDS project package JSON file."
        • Only put the converted file in the list.

The original file is linked from the paragraph text, because (1) it is much less interesting than the converted file (the user already has the original file, after all) and (2) converted files are semantically different from original files, and it is easier on the user to not mix them together in one list (the user is more likely looking for either original files or converted files, but unlikely looking for both). If we later add other formats (e.g. CSV conversion for JSON files), they can be added to that list.

Also, all text should place the final stop (.) inside the string to translate, not outside; not all languages use the period.

@jpmckinney jpmckinney transferred this issue from open-contracting/cove-oc4ids Apr 21, 2021
@jpmckinney
Copy link
Member Author

This feature is removed in the draft wireframes for the frontend update, as a rarely used feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant