Display Grants to Individuals codelist values on the Grant page

[michaelwood]

Suggested method of displaying this is to put the string/human readable version of the code in brackets:

[mariongalley]

Oh yes I like this. What do you think @KDuerden ?

[KDuerden]

I like it! But I think this will also cause confusion for publishers because our guidance is very strictly - codes only - but it will seem like other publishers are including the text & codes.

I don't think this is a barrier to this approach, but we need to be able to explain in situ and also in our guidance why these things look different in our tools.

This is also raising a question in my mind about the impact on the data in GrantNav downloads - eg is this bringing together two separate sources of data and visualising - and so in the Additional data it will just be the names - or would it be this code + name data?

[michaelwood]

We could also do something more like:

Option 2

With the link going to https://standard.threesixtygiving.org/en/latest/technical/codelists/#the-codelists-used-in-the-standard

Option 3

(with or without the parenthesis)

If we had bootstrap I'd probably be suggesting a https://getbootstrap.com/docs/5.3/components/popovers/ . Possibly something we could get added to the 360ds for "small hints/help" for future type things

[mariongalley]

@michaelwood Thanks for thinking further about this - I don't think any of the options fully mitigate the issue of us adding information that wasn't shared by the publisher, but I really like option 2 because it explains where we got the codelist values from. It would be even better if it could link to the specific codelist in the guidance (this will become increasingly useful as we proliferate codelists).

I think we can address for former issue by updating the teal 'where is this data from' box to say something like:

"This data was originally published by [publisher]. You can hover over codes from standard codelists to see the user-friendly name provided by 360Giving. If you need to report a problem in the data please contact [publisher] directly, see their GrantNav publisher page for more information."

[michaelwood]

Great, have implemented that, example (test data) http://grantnav.360dev1.vs.mythic-beasts.com/grant/360G-FoundationScotland-A377940

[KDuerden]

Thanks for developing this alternative approach - which is really nice!

Could this be implemented for regranting and location scope as easily? I think we could limit this function to our managed codelists, eg we don't need to start pulling the human readable names for currency or countries (not least because I don't think they are included in our standard - it's just the enum codes)

[mariongalley]

@KDuerden Agree - the only place I can see it being an issue is the geocode types list, which isn't validated - this means there will be codes that don't appear in the hyperlinked list. Maybe that's fine?

[KDuerden]

I had the same thought, it would be fine if only the properly used ones have the hyperlink!

But can we hold off on that, because I'm just noticing that there is at least one non-unique code with different names WD is named 'Electoral Divisions' and 'Electoral Wards'. Might need to do some housekeeping before we start integrating the names to avoid confusion.

[michaelwood]

I had a similar thought too! we can expand this for older codelists, (regrantType is already in there, just wasn't any test data showing it).

The code is ready for future codelist friendly name work when we have resolved the two issues with the other codelists files. I added a comment in the code . ThreeSixtyGiving/standard#349 and ThreeSixtyGiving/standard#348

[mariongalley]

Question about: "You can hover over codes from standard codelists to see the user-friendly name provided by 360Giving." - I assume that will appear on all grants rather than just ones that include codes?

I think this is probably fine if so, just want to check @michaelwood

[michaelwood]

Question about: "You can hover over codes from standard codelists to see the user-friendly name provided by 360Giving." - I assume that will appear on all grants rather than just ones that include codes?

I think this is probably fine if so, just want to check @michaelwood

Yes currently that is the behaviour. It is possible to make that conditional but it's a bit gnarly (it would need to be a hard-coded list of all the possible fields that could be codelists and then a check on each to see if they have values.