dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

Change how UI shows compound fields

Open kamil386 opened this issue 5 years ago • 10 comments

Actually Dataverse compound fields are "flatten" in Dataverse UI:

image

Please add more detailed output of compund fields, at least include title of fields in the UI.

kamil386 avatar Jan 29 '20 12:01 kamil386

@kamil386 It is possible to do this via the displayFormat column of the datasetFieldType table (and therefore in the .tsv file that defines the blocks). See for example "Time Period Covered" that adds "Start:" and "End:".

In specific regard to Geographic Coverage, we did also make a recent change that comma separates these values. This is available in 4.19.

scolapasta avatar Jan 29 '20 21:01 scolapasta

In specific regard to Geographic Coverage, we did also make a recent change that comma separates these values. This is available in 4.19.

@kamil386 if you're interested in the discussion that took place on this, please see #6345.

pdurbin avatar Jan 29 '20 22:01 pdurbin

@scolapasta It's not enough to format it via displayFormat column in TSV, especially for the big schema like DwC where i.e one parent field has 21 subfields, and another has 44

@pdurbin So I will continue the discussion on #6345

kamil386 avatar Jan 30 '20 11:01 kamil386

One note, there is no issue while editing big schema like DwC:

image

But the issue is how it is printed out:

image

Maybe is it worth consider to print in different way, including headers and create some table?

kamil386 avatar Jan 30 '20 12:01 kamil386

I agree, that's hard to read.

Just suggesting another idea using the displayFormat column in the TSV. Would it be possible to add a <br> tag at the end of each value so that there's a line break and each subfield would be on its own line?:

1234 Catalog Number: 1234 Record Number: 1234 Recorded by: Kamil ...

jggautier avatar Jan 30 '20 16:01 jggautier

Excellent idea, simple and straightforward. I'll check now if it's working as expected. I'll also try to add bold to headers. In the meantime I could suggest adding hints on headers which is now not possible via displayFormat.

kamil386 avatar Jan 31 '20 11:01 kamil386

Unfortunately, it doesn't work as expected

image

kamil386 avatar Jan 31 '20 12:01 kamil386

Also be careful with labels: currently you will probably get "Occurence Occurence Status" or "Occurence Occurence Remarks" in advanced search and facets.

wfenrich avatar Jan 31 '20 15:01 wfenrich

This issue is mainly about how the things people enter in child fields are displayed in the user interface. But @wfenrich's last comment about the display of names of child fields is something that we hope to resolve as part of https://github.com/IQSS/dataverse/issues/8127, which includes writing and using guidelines for naming fields.

And https://github.com/IQSS/dataverse/issues/6573 is also very related.

jggautier avatar Feb 09 '22 16:02 jggautier

This issue came up again when using a metadatablock for a specific collection in the Harvard Dataverse Repository.

The "Study Design" field is made up of four child fields, one of which expects a lot of text:

Screen Shot 2022-05-16 at 8 42 53 PM

When the metadata is displayed, it's pretty hard to parse, even when we try to use delimiters that include the name of each child field:

Screen Shot 2022-05-16 at 8 42 32 PM

Luckily, as this "Study Design" field doesn't need to be repeatable, the child fields don't need to be kept together as a compound field, so we're planning to separate the child fields into their own fields (and get rid of the "Study Design" "field"). That way what's entered in those four fields are on their own lines when displayed.

But I think this illustrates that compound fields don't even need 44 or 21 subfields to run into this design problem. It's obvious when a compound field has just one field that uses a large text box and multiple lines of text are entered into it.

jggautier avatar May 17 '22 00:05 jggautier

For bounding box, I made an issue and PR:

  • #9593
  • #9595

before: what do these field mean?

Screen Shot 2023-05-15 at 10 38 05 AM

after: I know what I'm looking at

Screen Shot 2023-05-15 at 10 55 32 AM

pdurbin avatar May 15 '23 15:05 pdurbin