Wiki source code of The XWiki Icon Set
Last modified by Lucas Charpentier on 2026/02/05 17:22
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 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>>doc:documentation.xs.admin.icons.icon-themes.WebHome]] work. | ||
| 2 | |||
| 3 | Those icon names are what is used through XWiki to access icons. | ||
| 4 | |||
| 5 | === Icon naming convention === | ||
| 6 | |||
| 7 | 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. | ||
| 8 | |||
| 9 | * Use kebab-case. | ||
| 10 | * For composite icon names, the main noun is the first in the name. | ||
| 11 | * Remove hyphens from compound nouns. | ||
| 12 | |||
| 13 | Examples: | ||
| 14 | |||
| 15 | * ##file-add## and not ##add-file## because the main noun is ##file## here ##add## is the action | ||
| 16 | * ##pdf-export## and not ##export-pdf## because the main noun is ##pdf## and ##export## is the action. | ||
| 17 | * ##bullet-black## and not ##black-bullet## because the main noun is ##bullet## and ##black## is an adjective | ||
| 18 | * ##emoticon-smile## and not ##smile-emoticon## because the main noun is ##emoticon## and ##smile## is a complementary noun. | ||
| 19 | * ##fastforward## is a compound noun from which we removed the hyphen. | ||
| 20 | * ##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##. |
