Explanation

XWiki supports one icon set. It is often referenced in the documentation as The XWiki Icon Set or the Icon Set. This is a list of icon names. This Icon Set abstraction is used to make the Icon Themes work.

Those icon names are what is used through XWiki to access icons.

Icon naming convention

In order to keep long term consistency on the icon names, a set of rules have been discussed. Those must be followed when introducing a new icon to the XWiki Icon Set.

• Use kebab-case.
• For composite icon names, the main noun is the first in the name.
• Remove hyphens from compound nouns.

Examples:

• file-add and not add-file because the main noun is file here add is the action
• pdf-export and not export-pdf because the main noun is pdf and export is the action.
• bullet-black and not black-bullet because the main noun is bullet and black is an adjective
• emoticon-smile and not smile-emoticon because the main noun is emoticon and smile is a complementary noun.
• fastforward is a compound noun from which we removed the hyphen.
• file-pdf and not pdf-file because in the meaning of this icon, the main meaning is file, while pdf only helps to refine the meaning. On the contrary, pdf-file would mean that we want a file variation on the main concept of pdf.