backdrop-contrib / footnotes

Add automatically numbered footnotes to your content.
GNU General Public License v2.0
2 stars 2 forks source link

footnotes_field: Document node context limitation #10

Closed olafgrabienski closed 5 years ago

olafgrabienski commented 5 years ago

The footnotes_field submodule exposes a block with the footnotes used in a node and can be placed in a Layout. That's a great feature in my opinion, it allows you for instance to place the footnotes of a text in the sidebar of a page.

I've tested footnotes_field, and it works fine. As @docwilmot points out in #9, the submodule has a required context of 'node', that is a Layout with a path like node/%. That's fine for me but using the submodule without having to use a separate Layout would be more easy for people. So my questions are:

If we can't or don't want to change the node context limitation, let's add it to the documentation.

docwilmot commented 5 years ago

I suppose the block only makes sense being displayed on a node page. Is there any other page or entity where it is likely to be used? If not then it requires a node, and it makes sense to require the node context so people dont wonder why it doesnt show up.

olafgrabienski commented 5 years ago

I see, thanks for your feedback! To answer your question, I don't know of other than node pages or node entities where I would place the footnotes block.

My question came up because on some Backdrop sites I don't use use a node context Layout at all. If I need a block which makes only sense for nodes on these sites, I just set a visibility condition for the block. This approach doesn't work always, e.g. not for node content field blocks, but I tend to forget that.

If we can't or don't want to change the node context limitation, let's add it to the documentation.

So, let's not change the node context limitation but add it to the documentation. I'll change the title of the issue respectively.

olafgrabienski commented 5 years ago

I've documented the node context limitation in the README file:

To use the Footnotes block, enable the submodule, check the permission Administer footnotes fields, and place the block in a Layout with a 'node' context, i.e. with a path like node/%.