Markup changes for survey Entry page

[brew]

The survey Entry page, available once an entry has been approved after review, needs mark up changes based on the mockup http://okfnlabs.org/census-mockup/entry/. This is related to the general issue about markup #785.

[pwalsh]

• Breadcrumbs (Add breadcrumb nav to dataset and place pages #971)
• Dataset title (links to dataset page)
• Place name (links to place page)
• Social media section
• Explainer for open data symbol (Explain what the open data symbol means in a dataset #975)
• Data quality (Add data quality indicators to the UI #873) [DO NOT DO]
  • Badge (status, last checked)
  • Badge is clickable link to a Good Tables description, in popup
• Data Usability (label as beta section) (Add 'Data Usability' section to entry page. #972) [Remove from page, make to a blog post]
  • "The submitter assessed the usability of the data as follows (3 - little to no effort needed, 1 - extensive effort needed):" 3-point likert scale.
  • add explainer what usability means, e.g. in popup when hovering over question text
• What data is expected? [Explain what data are we looking for behind a dataset #976]
  • dataset description incl. 2-3 sentences why GODI assesses this data (to be included)
  • dataset characteristics
    • list all characteristics
    • add note which characteristics are required or optional
• What data is available (change title to "How open is the data?")
  • Change title to "How open is the data?" (Add question popover explanations #974)
  • icon list, icon colour green = yes, red = no.
    • icon list for following six elements: "The data is collected by government" (single data file - icon); "The data are available online without the need to register or request access to the data (eye-icon)"; "The data is available for free" (dollar icon); "The data is downloadable at once" (formerly bulk icon); "The data is timely and up-to-date" (clock-icon); "The data is openly licensed/in public domain" (lock-icon); The data has an open and machine-readable format" (keyboard-icon) (Write short description for the Icon list #978)
  • icon is a clickable link to question description in popup (Add question popover explanations #974)
  • name icons using abridged survey question texts
  • design for
    • URL and array of URLs (where is data found & where is open license found) (Make sure that URLS for the data and the license are prominently displayed #977)
    • choice from select list (format) (Display data formats on entry page #979)
    • displaying conditional information. This includes: "Following government agency / organisation collects the data: Submitter's response"; "The data are not collected by government for following reasons: Submitter's response")
• discoverability section (out something together from the following fields, and label this as a "BETA" section)
  • "The data was found at:" & list of URLs (1 URL or array of URLs) (Make sure that URLS for the data and the license are prominently displayed #977)
  • 1 explaining comment per URL (available from "source description" box associated with URL)
  • "The submitter(s) took following steps to find the data:" plus text field
  • "The submitter assessed data discoverability as follows: (1= It was not easy at all to find the data, 4= It was very easy to find the data)" plus likert-scale
• metadata section - must cover all additional questions, inc. scaled questions (e.g.: 2/3, 3/5), and inlined comment section. some sections can be labeled as "beta", such as "findability of data"
  • date of submission / review
  • Names of submitter, reviewer
• Details section (submitter and reviewer comment box)
• Link from entry page to the relevant discourse page to see government feedback (highlight this link) [Link from entry page to the relevant discourse discussion on discuss.okfn.org #980]

[pwalsh]

@dannylammerhirt can you please explain:

"displaying conditional information. This includes: "Following government agency / organisation collects the data: Submitter's response"; "The data are not collected by government for following reasons: Submitter's response")"

I'm trying to understand how it fits with the "question list" under what data is available

[dannylammerhirt]

So our first survey question is whether data is collected by government. Submitters have to provide explanations why they answer with "Yes" or "No" (this is what is meant by conditional information).

In the case of a yes answer, they have to tell us the name of the government agency (in a blank text field). It would be good to display somewhere which government agency provides the data.

In the case of a "no" answer, submitters necessarily have to provide info why government does not collect this data (in a blank text field). Assuming that all icons are red (indicate "no") it would help to interpret the results to have this explainer displayed somewhere.

Both info does not have to be displayed under the "What data is available" header. It can also be presented under a standalone header.

[pwalsh]

@brew is there a general pattern here was can rely on of "yes/no question with conditionally required explanation"?

[dannylammerhirt]

@pwalsh can you explain again what is meant in the metadata section

("must cover all additional questions, inc. scaled questions (e.g.: 2/3, 3/5), and inlined comment section. some sections can be labeled as "beta", such as "findability of data"")

I tried to remember how this relates to the question which info to display here? Or was this rather a general note for you and @brew?

[brew]

@brew is there a general pattern here was can rely on of "yes/no question with conditionally required explanation"?

@pwalsh Not really, no. The questions are related in the Question Set Schema but only so the explanation question will be displayed depending on the yes/no answer.

[morchickit]

@brew to implement this and then Sam will design

[dannylammerhirt]

Explanation of discoverability section:

The discoverability section should explain (I) where data was found, (II) what data was found, (III) how data was found, and (IV) how submitters assess findability.

The discoverability section will include the following fields labelled as "BETA":

Where was what data found?
"The data was found at: [List of URLs]" (#977)
We will also add a comment describing the content of this URL (This is a string which can be retrieved from the "source description" field on the survey page. See survey question B2.2 in the survey page)

How was data found?
The discoverability section should also include how submitters found data online. To present this I propose to implement a sentence like: "The submitter(s) took following steps to find the data: [INSERT STRING]". The string can be retrieved from the survey question B2.4.

How do submitters assess findability?
Also the section should contain an assessment of the findability of data. I propose to implement following sentence: "The submitter assessed data discoverability as follows (1= It was not easy at all to find the data, 4= It was very easy to find the data): [INSERT LIKERT-SCALE]".

[morchickit]

@smth to advise how to organise the page better