What is a "Region"?

[guettli]

https://feincms3.readthedocs.io/en/latest/ref/regions.html

Please start with the bird-eye-perspective on this page: What is a Region?

[matthiask]

Do you think the first paragraph on https://feincms3.readthedocs.io/en/latest/guides/templates-and-regions.html is clearer? If yes I should at least add links referencing the "guides" part of the documentation from the autogenerated API docs.

[guettli]

Sorry, your link talks about Regions, but it does not explain what a Region is.

[sha-red]

A region is a concept which allows to structure a single web page (or: the template for a single web page) into parts which then can be filled with arbitrary 'plugins'. As a second aspect regions have additional configuration options, e.g. you can restrict which plugins are avaible in the backend per region.

We also used regions to implement filtering of plugins or other kinds of preparations. E.g. a special case for a "references" region:exclude any plugins of type "footnote", also make a virtual region named "footnotes".

[matthiask]

What @sha-red said is absolutely correct.

The Region class is described a here https://django-content-editor.readthedocs.io/en/latest/#parts but unfortunately this document doesn't explain what a Region should be either, just what its attributes are.