You are here

Home » API reference » Smiley 7.2

README.txt in Smiley 7.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

* Overview
* Features
* Requirements
* Installation
* Known problems
* Version history
* Future plans
* Similar projects
* Credits

OVERVIEW
--------

This module aims to provide an API for adding graphical smileys to Drupal "long
text" fields (e.g.: node bodies, comments) through a text filter.

The smiley_kobolok module aims to provide a basic set of smileys and serve as an
example of how to implement the Smiley API.

FEATURES
--------

* Provides a "Convert smileys to images" text filter which replaces specific
  text with a graphical smiley.
* Supports replacing text with <img> tags or <span>-tags-with-background-images.
* Provides a hook to allow other module developers to define their own smileys.

REQUIREMENTS
------------

None, besides Drupal 7!

INSTALLATION
------------

1. Download and install the smiley project.

   Install as usual, see https://drupal.org/node/895232 for further information.

2. Add the smiley filter to a text format.

   Go to Administration -> Configuration -> Content authoring -> Text formats.

   You will see one or more text formats listed, typically Filtered HTML, Full
   HTML and Plain text. Click the "configure" link in the Operations column next
   to the text format you want to enable smileys in.

   You will see the text format configuration screen. Under "Enabled filters",
   check "Convert smileys to images". In the Filter processing order section,
   ensure "Convert smileys to images" is placed below "Limit allowed HTML tags".
   Otherwise, your smileys may not show up.

KNOWN PROBLEMS
--------------

The smiley_wysiwyg module needs to be ported from smiley-1.x to smiley-2.x.

VERSION HISTORY
---------------

The 1.x branch provides a text filter which replaces text smileys with <img>
tags in long text fields. The mappings between text smileys and images is stored
in a database table. Smileys can be added by putting them into special
filesystem directories.

The 2.x branch is a full rewrite. Like the 1.x branch, it provides an text
filter to replace smileys, but it can replace them with either <img> tags or
<span>-tags-with-background-images. Both approaches use the theme layer,
allowing other modules and themes to control the output. Smiley-image mappings
can be defined by implementing hook_smiley_replacements() in a custom module and
stored by caches.

FUTURE PLANS
------------

It would be useful to display the list of available smileys as a long filter
tip.

It would be good to bring back integration with wysiwyg. Since Drupal 8 will
have CKEditor installed by default, integration with CKEditor will probably get
done first, but feel free to contribute patches for your favourite editor!

SIMILAR PROJECTS
----------------

We're not aware of any modules similar to this one.

CREDITS
-------

This module was originally written and maintained up to Drupal's 4.7 release by
unconed (Steven Wittens).

Gurpartap Singh maintained the module until Drupal 6's release.

fizk (Yonas Yanfa) and mparker17 currently maintain the module.

The kolobok smileys were contributed by Mantsurov Ivan, aka Aiwan
(http://www.en.kolobok.us).

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5. * Overview

  6. * Features

  7. * Requirements

  8. * Installation

  9. * Known problems

  10. * Version history

  11. * Future plans

  12. * Similar projects

  13. * Credits

  14. 

  15. OVERVIEW

  16. --------

  17. 

  18. This module aims to provide an API for adding graphical smileys to Drupal "long

  19. text" fields (e.g.: node bodies, comments) through a text filter.

  20. 

  21. The smiley_kobolok module aims to provide a basic set of smileys and serve as an

  22. example of how to implement the Smiley API.

  23. 

  24. FEATURES

  25. --------

  26. 

  27. * Provides a "Convert smileys to images" text filter which replaces specific

  28.   text with a graphical smiley.

  29. * Supports replacing text with  tags or -tags-with-background-images.

  30. * Provides a hook to allow other module developers to define their own smileys.

  31. 

  32. REQUIREMENTS

  33. ------------

  34. 

  35. None, besides Drupal 7!

  36. 

  37. INSTALLATION

  38. ------------

  39. 

  40. 1. Download and install the smiley project.

  41. 

  42.    Install as usual, see https://drupal.org/node/895232 for further information.

  43. 

  44. 2. Add the smiley filter to a text format.

  45. 

  46.    Go to Administration -> Configuration -> Content authoring -> Text formats.

  47. 

  48.    You will see one or more text formats listed, typically Filtered HTML, Full

  49.    HTML and Plain text. Click the "configure" link in the Operations column next

  50.    to the text format you want to enable smileys in.

  51. 

  52.    You will see the text format configuration screen. Under "Enabled filters",

  53.    check "Convert smileys to images". In the Filter processing order section,

  54.    ensure "Convert smileys to images" is placed below "Limit allowed HTML tags".

  55.    Otherwise, your smileys may not show up.

  56. 

  57. KNOWN PROBLEMS

  58. --------------

  59. 

  60. The smiley_wysiwyg module needs to be ported from smiley-1.x to smiley-2.x.

  61. 

  62. VERSION HISTORY

  63. ---------------

  64. 

  65. The 1.x branch provides a text filter which replaces text smileys with 

  66. tags in long text fields. The mappings between text smileys and images is stored

  67. in a database table. Smileys can be added by putting them into special

  68. filesystem directories.

  69. 

  70. The 2.x branch is a full rewrite. Like the 1.x branch, it provides an text

  71. filter to replace smileys, but it can replace them with either  tags or

  72. -tags-with-background-images. Both approaches use the theme layer,

  73. allowing other modules and themes to control the output. Smiley-image mappings

  74. can be defined by implementing hook_smiley_replacements() in a custom module and

  75. stored by caches.

  76. 

  77. FUTURE PLANS

  78. ------------

  79. 

  80. It would be useful to display the list of available smileys as a long filter

  81. tip.

  82. 

  83. It would be good to bring back integration with wysiwyg. Since Drupal 8 will

  84. have CKEditor installed by default, integration with CKEditor will probably get

  85. done first, but feel free to contribute patches for your favourite editor!

  86. 

  87. SIMILAR PROJECTS

  88. ----------------

  89. 

  90. We're not aware of any modules similar to this one.

  91. 

  92. CREDITS

  93. -------

  94. 

  95. This module was originally written and maintained up to Drupal's 4.7 release by

  96. unconed (Steven Wittens).

  97. 

  98. Gurpartap Singh maintained the module until Drupal 6's release.

  99. 

  100. fizk (Yonas Yanfa) and mparker17 currently maintain the module.

  101. 

  102. The kolobok smileys were contributed by Mantsurov Ivan, aka Aiwan

  103. (http://www.en.kolobok.us).