search

propertyshelf / ps.plone.realestatefont

Real Estate icon font.
2 stars 1 forks source link

Use better class names #3

Open thomasmassmann opened 9 years ago

thomasmassmann commented 9 years ago

Currently the used prefix is icon_re which is not very meaningful. Instead, there should be a prefix of psf (for Propertyshelf Font), followed by psf-realestate-[icon name]. The class names in HTML would than look like this:

<i class="psf psf-realestate-airport"></i>

This results in a slightly more "complex" markup (or more markup because more characters are used), but it's way more readable and meaningful.

Solomonic commented 9 years ago

The standard solution we would like to use is:

<i class="icon icon-airport"></i>

Since the bootstrap icon-set used in our themes produces an css-selector conflict in combination with this packages icon-set we couldn't stick with the standard. For an easy re-use it is seen as a better solution to extend the standard in an minimal way and keep the icon class as a clear icon-identifier. The font-specific appendix should be shorter then proposed but is open for discussion. See old vs. new:

<i class="icon icon_re-property-management">current state</i>
<i class="psf psf-realestate-property-management">new proposed</i>

I don't see more meaning in the new proposal and several drawbacks, so I disagree with it.

thomasmassmann commented 9 years ago

Bootstrap uses another schema (not icon):

<span class="glyphicon glyphicon-align-left" aria-hidden="true"></span>

Re-using the icon prefix from a theme is a bad idea. This way you don't add the required CSS for the icon class to the font. And if you do so (which would be the preferred way to use the icon set without a theme you are referring to, e.g. the Propertyshelf MLS) you will get into trouble because then you can end up with 2 different definitions for the default icon stuff and this icon font.

Every icon font I know uses it's own prefix to not get into conflicts with existing solutions (e.g. http://getbootstrap.com/components/#glyphicons, http://fortawesome.github.io/Font-Awesome/icons/).

I'm fine with having a different prefix, so instead of psf-realestate we could use psf-???.

thomasmassmann commented 9 years ago

Btw, the bootstrap team renamed the icon- prefix used in bootstrap 2 (http://getbootstrap.com/2.3.2/base-css.html#icons) in bootstrap 3 for the glyphicons because there were a lot of problems which were the result of this too common namespace.