Differences

This shows you the differences between two versions of the page.

--- smileys [2009-09-07 10:39] – 89.103.36.88
+++ smileys [2022-07-31 23:09] – Klap-in
@@ Line 1: / Line 1: @@
 ====== Smileys ======
-[[DokuWiki]] can convert text smileys to their graphically equivalent. Smileys images are stored in the ''lib/images/smileys/'' directory and configured in the ''conf/smileys.conf'' file.  You can add your own smileys by creating a ''conf/smileys.local.conf'' file and placing your additional smileys in there. Make sure the images are readable by the webserver. It is possible to add smileys to ''conf/smileys.conf file'', however this could result in your changes being overwritten when upgrading Dokuwiki. Note that you can't use ''#'' or ''$'' in the configuration file.
+[[DokuWiki]] can convert text smileys to their graphically equivalent. The [[wiki:syntax#text_to_image_conversions|default images]] and the user defined images are automatically shown in the Smiley picker of the [[toolbar]].
-If your newly added smiley does not appear in your edit toolbar popup, you may have to search for the cached js file in your data/cache directory and remove it, then refresh your page. FIXME Which file exactly to delete from the cache folder?
+The default smileys images are stored in the ''lib/images/smileys/'' directory and configured in the ''[[devel:smileys.conf|conf/smileys.conf]]'' file. Wiki admins can configure their own smileys, see below.
+Instead of using .gif based pixel graphics DokuWiki versions since Igor 2022 release use SVG smileys based on the [[https://twemoji.twitter.com/|Twemoji]] project.
+===== Customize smileys =====
+To add your own smileys, and make them upgrade-safe as well, you should follow these instructions instead of mixing them with the default-smileys from Dokuwiki-package:
+  - Create a new folder called ''local'' inside the smileys-dir <code>lib/images/smileys/local</code> and put the imagefiles into it (make sure the images are readable by the webserver). The default dokuwiki smileys are about 24 pixels tall.
+  - Create a custom smiley-config file at <code>conf/smileys.local.conf</code> and prefix each image filename with "''local/''..."
+An example configuration file could look like this: <code - conf/smileys.local.conf>
+# Custom Smileys
+# Images are seen relatively from the smiley directory lib/images/smileys/
+# TEXT_TO_REPLACE       FILENAME_OF_IMAGE
+#
+:MYFACE:                local/i_am_so_pretty.png
+# or eventually disable a smiley by mentioning the key, without image path.
+DELETEME
+</code>
+===== Notes and hints =====
+  * It is good practice to surround your own text macros with colons (":"), like "'':REPLACEME:''"
+  * Because it is reserved to mark a comment line, a hash (''#'') needs to be escaped by a backslash (''\#''). You can't use ''$'' in the configuration file.
+  * If your newly added smiley does not appear in your edit toolbar popup, it is almost always a problem of [[caching]]. You may have to [[devel:caching|purge the cache]], then refresh your page.
+  * Make sure to have a space before and after the smiley when adding to a wiki article (e.g. Test :NEW: smiley).
 ===== User provided additional smileys =====
-The following smileys were created by DokuWiki users, using a similar style the default ones. If you like them place them in your smiley directory and adjust the config file.
+The following smileys were created by DokuWiki users, using a similar style to the default ones. If you like them place them in your smiley directory and adjust the config file.
 ^ Smiley image                                    ^ created by ^
@@ Line 25: / Line 53: @@
 | {{wiki:usersmileys:button-todo-red.png}}        | [[kwl7@cornell.edu|Kevin Locke]] |
 | {{wiki:usersmileys:button-warning-red.png}}     | [[kwl7@cornell.edu|Kevin Locke]] |
+| {{http://img845.imageshack.us/img845/9170/buttondraftyellow.png?80x15|}} | [[jjasghar@gmail.com|JJ Asghar]] |
+| {{http://wiki.guug.de/lib/images/smileys/local/todo.gif?80x15}} | [[http://www.unixwitch.de|Hella Breitkopf]]|
+| {{http://wiki.guug.de/lib/images/smileys/local/done.gif?80x15}} | [[http://www.unixwitch.de|Hella Breitkopf]]|
+| {{http://img213.imageshack.us/img213/1667/buttontodo2yellow.png}} | Kevin, modded by [[user>schamane|Andreas]] |
+| {{http://savoirscom1.comptoir.net/lib/images/smileys/todo_button.png}} | [[user>cyrille37|Cyrille37]] |
+| Different sets: [[https://github.com/davidjimenez75/dokuwiki-smileys-local|dokuwiki-smileys-local]] | [[user>davidjimenez75|Davidjimenez75]]|
+===== User provided additional smileys packs =====
+The following smileys packs were created by DokuWiki users, using a similar style to the default ones. If you like them place them in your local smiley directory (lib/images/smileys/local) and create/copy/adjust the config file (conf/smileys.local.conf). Remember to touch "conf/local.php" to refresh WYSIWYG editor cache.
+^ Smileys pack image                                    ^ url ^ created by ^
+| {{https://raw.githubusercontent.com/davidjimenez75/dokuwiki-smileys-local/master/dokuwiki-tags-en/folder.jpg?450}} | [[https://github.com/davidjimenez75/dokuwiki-smileys-local|dokuwiki-tags-en]] | [[user>davidjimenez75|Davidjimenez75]]|
+| {{https://raw.githubusercontent.com/davidjimenez75/dokuwiki-smileys-local/master/emojione-faces/folder.jpg?450}} | [[https://github.com/davidjimenez75/dokuwiki-smileys-local|emojione-faces]] | [[user>davidjimenez75|Davidjimenez75]]|
+| {{https://raw.githubusercontent.com/davidjimenez75/dokuwiki-smileys-local/master/github-tags-en/folder.jpg?450}} | [[https://github.com/davidjimenez75/dokuwiki-smileys-local|github-tags-en]] | [[user>davidjimenez75|Davidjimenez75]]|
+| {{https://raw.githubusercontent.com/davidjimenez75/dokuwiki-smileys-local/master/openmoji32-faces/folder.jpg?450}} | [[https://github.com/davidjimenez75/dokuwiki-smileys-local|openmoji32-faces]] | [[user>davidjimenez75|Davidjimenez75]]|
+More examples at https://github.com/davidjimenez75/dokuwiki-smileys-local
+=====See also=====
+  * [[config|Configuring DokuWiki]]