]> scripts.mit.edu Git - autoinstalls/wordpress.git/blob - wp-content/themes/twentyfifteen/genericons/README.md
WordPress 4.7.2-scripts
[autoinstalls/wordpress.git] / wp-content / themes / twentyfifteen / genericons / README.md
1 ## Genericons
2
3 Genericons are vector icons embedded in a webfont designed to be clean and simple keeping with a generic aesthetic.
4
5 Use genericons for instant HiDPI, to change icon colors on the fly, or even with CSS effects such as drop-shadows or gradients!
6
7
8 ### Usage
9
10 To use it, place the `font` folder in your stylesheet directory and enqueue the genericons.css file. Now you can create an icon like this:
11
12 ```
13 .my-icon:before {
14         content: '\f101';
15         font: normal 16px/1 'Genericons';
16         display: inline-block;
17         -webkit-font-smoothing: antialiased;
18         -moz-osx-font-smoothing: grayscale;
19 }
20 ```
21
22 This will output a comment icon before every element with the class "my-icon". The `content: '\f101';` part of this CSS is easily copied from the helper tool at http://genericons.com/, or `example.html` in the `font` directory.
23
24 You can also use the bundled example.css if you'd rather insert the icons using HTML tags.
25
26
27 ### Notes
28
29 **Photoshop mockups**
30
31 The `Genericons.ttf` file found in the `font` directory can be placed in your system fonts folder and used Photoshop or other graphics apps if you like.
32
33 If you're using Genericons in your Photoshop mockups, please remember to delete the old version of the font from Font Book, and grab the new one from the zip file. This also affects using it in your webdesigns: if you have an old version of the font installed locally, that's the font that'll be used in your website as well, so if you're missing icons, check for old versions of the font on your system.
34
35 **Pixel grid**
36
37 Genericons has been designed for a 16x16px grid. That means it'll look sharp at font-size: 16px exactly. It'll also be crisp at multiples thereof, such as 32px or 64px. It'll look reasonably crisp at in-between font sizes such as 24px or 48px, but not quite as crisp as 16 or 32. Please don't set the font-size to 17px, though, that'll just look terrible blurry.
38
39 **Antialiasing**
40
41 If you keep intact the `-webkit-font-smoothing: antialiased;` and `-moz-osx-font-smoothing: grayscale;` CSS properties. That'll make the icons look their best possible, in Firefox and WebKit based browsers.
42
43 **optimizeLegibility**
44
45 Note: On Android browsers with version 4.2, 4.3, and probably later, Genericons will simply not show up if you're using the CSS property "text-rendering" set to "optimizeLegibility.
46
47 **Updates**
48
49 We don't often update icons, but do very carefully when we get good feedback suggesting improvements. Please be mindful if you upgrade, and check that the updated icons behave as you intended.
50
51
52 ### Changelog
53
54 **3.2**
55
56 A number of new icons and a couple of quick updates. 
57
58 * New: Activity
59 * New: HTML anchor
60 * New: Bug
61 * New: Download
62 * New: Handset
63 * New: Microphone
64 * New: Minus
65 * New: Plus
66 * New: Move
67 * New: Rating stars, empty, half, full
68 * New: Shuffle
69 * New: video camera
70 * New: Spotify
71 * New: Twitch
72 * Update: Fixed geometry in Edit icon
73 * Update: Updated Foursquare icon
74
75 Twitch and Spotify mark the last social icons that will be added to Genericons.
76 Future social icons will have to happen in a separate font. 
77
78 **3.1**
79
80 Genericons is now generated using a commandline tool called FontCustom. This makes it far easier to add new icons to the font, but the switch means the download zip now has a different layout, fonts have different filenames, there's now no .otf font included (but the .ttf should suffice), and the font now has slightly different metrics. I've taken great care to ensure this new version should work as a drop-in replacement, but please be mindful and test carefully if you choose to upgrade.
81
82 * Per feedback, the baked-in 16px width and height has been removed from the helper CSS. It wasn't really necessary (the glyph itself has these dimensions naturally), and it caused some headaches.
83 * Base64 encoding is now included by default in the helper CSS. This makes it drop-in easy to get Genericons working in Firefox even when using a CDN. 
84 * Title attribute on website tool.
85 * New: Website.
86 * New: Ellipsis.
87 * New: Foursquare.
88 * New: X-post.
89 * New: Sitemap.
90 * New: Hierarchy.
91 * New: Paintbrush.
92 * Updated: Show and Hide icons were updated for clarity.
93
94 **3.0.3**
95
96 Bunch of updates mostly.
97
98 * Two new icons, Dropbox and Fullscreen.
99 * Updates to all icons containing an exclamation mark.
100 * Updates to Image and Quote.
101 * Nicer "Share" icon.
102 * Bigger default Linkedin icon.
103
104 **3.0.2**
105
106 A slew of new stuff and updates.
107
108 * Social icons: Skype, Digg, Reddit, Stumbleupon, Pocket.
109 * New generic icons: heart, lock and print.
110 * New editing icons: code, bold, italic, image
111 * New interaction icons: subscribe, unsubscribe, subscribed, reply all, reply, flag.
112 * The hyperlink icon has been updated to be clearer, chunkier.
113 * The "home" icon has been updated for style, size and clarity.
114 * The email icon has been updated for style and clarity, and to fit with the new subscribe icons.
115 * The document icon has been updated for style.
116 * The "pin" icon has been updated for style and clarity.
117 * The Twitter icon has been scaled down to fit with the other social icons.
118
119 **3.0.1**
120
121 Mostly maintenance. 
122
123 * Fixed an issue with the example page that showed an old "top" icon instead of the actual NEW "refresh" icon.
124 * Added inverse Google+ and Path.
125 * Replaced tabs with spaces in the helper CSS.
126 * Changed the Genericons.com copy/paste tool to serve span's instead of div's for casual icon insertion. It's being converted to "inline-block" anyway.
127
128 **3.0**
129
130 Mainly maintenance and a few new icons.
131
132 * Fast forward, rewind, PollDaddy, Notice, Info, Help, Portfolio
133 * Updated the feed icon. It's a bit smaller now for consistency, the previous one was rather big.
134 * So, the previous version numbering, 2.09, wasn't very PHP version compare friendly. So from now on it'll be 3.0, 3.1 etc. Props Ipstenu.
135 * Genericons.com now has a mini release blog.
136 * The CSS has prettier formatting, props Konstantin Obenland.
137
138 **2.09**
139
140 Updated Facebook icon to new version. Updated Instagram logo to use new one-color version. Updated Google+ icon to use same radius as Instagram and Facebook. Added a bunch of new icons, cog, unapprove, cart, media player buttons, tablet, send to tablet.                                            
141
142 **2.06**
143
144 Included Base64 encoded version. This is necessary for Genericons to work with CDNs in Firefox. Firefox blocks fonts linked from a different domain. A CDN (typically s.example.com) usually puts the font on a subdomain, and is hence blocked in Firefox.
145
146 **2.05**
147
148 Added a bunch of new icons, including upload to cloud, download to cloud, many more.
149
150 **2.0**
151
152 Initial public release