EarthSystemCoG / COG

COG source code
BSD 3-Clause "New" or "Revised" License
8 stars 16 forks source link

Do NOT process metadata fields in search results page #1364

Closed LucaCinquini closed 6 years ago

LucaCinquini commented 7 years ago

Who: Alan

I have a comment about the way that CoG maps metadata in search results by substituting underscores with spaces and changing words to have initial upper case. No doubt this is done for sake of a more "human readable" format, but does anyone agree with me that it causes too many unwanted side-effects? I am talking here in particular about what is seen under "view metadata" in the results, not necessarily the faceted search menus on the left.

Examples of what I think is problematic behaviour are when filenames contain underscores, and the view of the "id" or "url" fields in the file metadata ends up containing spaces instead, which breaks the ID or the URL concerned.

Because of this, I would suggest as a minimum that the metadata values are presented unmodified, even if the keys are modified.

There is also a good argument for not modifying the keys either. In particular, consider the fact that in the free text search one can usefully use the metadata fields for searching for things that are not necessarily available via the search menus on the left, just by using a search string of the format "name:value". (This is particularly useful with the fields "master_id" or "instance_id", which gives a way to search for a known dataset ID, with or without the version.) If the field names are presented in a mapped form which differs from what one would search for (such as "Instance Id"), then the end user is far less likely to make this useful association.

What do people think?

LucaCinquini commented 6 years ago

The same feature was requested by Karl in relation to the CF Standard Name facet. At this point we should implement it in the metadata display - but not in the left menus since having very_long_names makes the option not wrappable, with the side effect that the rest of the string is not displayed.