Add DE-9IM graphics to Web Documentation

[DenisCarriere]

Add DE-9IM graphics to Web Documentation

I was attempting to explain what @turf/boolean-disjoint was to someone and even I got confused on what that module was meant to do, I then decided to go to ESRI's docs and look at the disjoint graphic for more help.

We should try to include at least 1 info graphic to each module (optional) which helps better understand what the module does in a conceptual way.

http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm

These infographics are very useful

equal

disjoint

[rowanwins]

Yeah that would be nice @DenisCarriere , there may be some newer graphics somewhere on the ESRI site so might be worth a quick dig around.

[stebogit]

👍 👍

[DenisCarriere]

👍 We just need to find a consistent naming convention for these infographics.

Maybe we can include a collection of images to create a sort of Photo Gallery of maps/graphics which derive from that particular Module.

Image Folder Structure

• images/*.png
• images/*.jpg

Example: ./packages/turf-center/images/infographic.jpg

[rowanwins]

Do we put in the images in the turf-www repo instead?

[DenisCarriere]

No, we should keep the images in the dedicated module repo, that way we can also include those images when executing scripts/generate-readmes

The turf-www repo already has turf built inside as a sub module, so we can easily reach those images with our current webpack config.

I've done the same thing for the documentation.yml config which resides in the main turf repo but shared between turf-www & turf.

[rowanwins]

yeah ok, no worries. Well if that's the case then I reckon your proposed above looks good.

Slightly newer Esri image here http://desktop.arcgis.com/en/arcmap/10.3/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm Although not sure if we can steal them due to licensing...

The postgis images are a bit more complicated because they are split into lots of portions. https://postgis.net/docs/ST_Contains.html

That said I probably whip something up

[DenisCarriere]

We can create our own diagrams to prevent any ESRI image licensing complications.

I'll set up the scripts/generate-readmes to work with images/*.(png|jpg)

[muziejus]

I can spruce up some of the images from Esri, etc., but I think I'm generally a bit better off building on something that already exists.

It would make sense to come up w/ a standardized visual language, also, much like Esri has for its various geoprocessing images:

[rowanwins]

First attempt at a unified style. Graphic on the left, and some brand guidance on the right.

[DenisCarriere]

Very cool! I like the style guide

[DenisCarriere]

We should try to find a clever spot for this on the website, maybe we could add it to a contribution section.

[ppKrauss]

Hi, I was maintaining the Wikipedia page DE-9IM, perhaps we can join forces to maintain didactic content for Turf and for Wikipedia... The main problem as you see are the good illustrations.

DE-9IM Wikpedia's article is stable and is is complete in terms of subjects and links... Now needs a big review do be "accessible". Even for people with a mathematics background, they found to hard to follow. All here are invited to review or suggest enhancements there.

---

Joining forces with Wikipedia

Many good guides and softare documentation are interlinking Wikipedia. For example the DE-9IM illustration of PostGIS was used by Wikipedia, and PostGIS linked Wikipedia's DE-9IM article here and here.

[rowanwins]

Hi @ppKrauss

Thanks for your work on the wikipedia page, it looks great! It's certainly a tricky subject to get your head around and it seems like there are lots of little pitfalls.

As you can see this issue hasn't been touched in quite a while as there have been other priorities that have taken my attention.

I'd be keen to support creating some high quality graphics, perhaps we can create a github repo and create them as SVG and then export them as png for use. Half the battle is setting up a half-decent template, but once we had something it could be a collaborative effort to create them using something like InkScape. Although there are probably some challenges in that certain projects will want to include certain details on the grahpics and others wont, so I'm not sure how reusable they would really be in reality... Although theoretically with an svg in inkscape you can export only the bits of the artboard that you are interested in.

Thoughts?