Add better documentation for Font Awesome Field

[philsward]

Can we get a better explanation for the "Font Awesome Field"?

It took me a while to figure out where to set it, then it took me a min to figure out what to actually put into the field.

Here's something to start from:

Also included with the Font Awesome module is the Font Awesome Field module which is a field formatter used in the Manage Display area of an entity.

The easiest way to get an icon going is to first create a new Text Field (short) for the entity where you want the icon. Next, navigate to Manage Display and set the Format to Font Awesome Icon. Save the display settings and create a new entity that uses this icon field and put in the designator for the font awesome icon you want. For example: fas fa-star is all you need to put into the field to show an icon of a solid star.

The Font Awesome Icon formatter takes the value you enter and inserts it into a CSS class for that field.

Note that you can only add one icon selector per field.

[philsward]

Looks like we would also need some documentation for lists? I noticed a recent commit added the formatter for lists. I'm not sure how this would be accomplished at this point (key|value|fontawesome ?) so it's worth pointing out that more than just the text field needs documentation on how it is supposed to work.

[yorkshire-pudding]

Hi @philsward I've opened up the Wiki to add more documentation. I've just taken over maintainer-ship of this module and will try to give it some attention over the next few months. I'll leave this open until it the documentation for what you've identified here is complete. Feel free to add the documentation yourself or others can add, or failing that I will.