search

codeforIATI / iati-ideas

đŸ’¡ Ideas for new codeforIATI projects and blogs
https://ideas.codeforiati.org
0 stars 0 forks source link

[PROJECT IDEA] IATI by Example #18

Open andylolz opened 4 years ago

andylolz commented 4 years ago

Rationale

The IATI reference documentation provides example usage, but these examples are frequently quite contrived.

That’s a shame, because many people prefer to learn through examples (rather than solely reading descriptions).

Proposal

A website that provides more realistic example usage per element.

notshi commented 4 years ago

https://xriss.github.io/D-Portal-Logs/xpath.html has been useful for us to find examples of element usage in published activities (sorry, it's a huge page so loading is slow).

This could help source real examples for the project idea?

andylolz commented 3 years ago

@notshi Sorry, I think I must have missed this! Thanks for sharing, that’s very cool! Locating real-life examples sounds exactly what we need, so I am sure this will be handy!

stevieflow commented 3 years ago

Yes to this

The IATI reference documentation provides example usage, but these examples are frequently quite contrived.

Sorry about that :) When I wrote that (in 2013, I think) , the aim was to not cite real examples, certainly - given how many different use cases there could be. But, certainly agree - it could now do with plenty of context

Deep down in the results element, I also just spotted a draw back of the example, in terms of multi-dimensional indicators: https://github.com/devinit/D-Portal/issues/597 (thanks @notshi !) - which strikes me as a good example of this

Having access to the XML snippet, an overview of the challenge, and even how this looks in a platform like d-portal, would be really useful