Sommerregen/grav-data-smileys-simple-smileys

Simple Smileys is a cohesive collection of smileys and emoticons designed to work well alongside text on websites or in applications.

Simple Smileys is a cohesive collection of smileys and emoticons designed to work well alongside text on websites or in applications.

About

Simple Smileys is a collection of simple and still expressive smileys for the Grav Smileys Plugin in a GetGrav.org installation. It includes more than 50 smileys, each one having its own textual representation as can been seen below .

Installation

To install this data pack, just download the zip version of this repository and unzip it under user/data/smileys. Then, rename the folder to simple_smileys.

You should now have all the data pack files under

user/data/smileys/simple_smileys

NOTE: This data pack is a modular component for Grav Smileys Plugin which requires Grav, Grav Smileys Plugin and a theme to be installed in order to operate.

Usage

To activate and use Simple Smileys the best process is to copy the smileys.yaml file from the Grav Smileys Plugin into your users/config/plugins/ folder (create it if it doesn't exist), and set the smileys package option to

pack: simple_smileys

You can then use any of the below smiley acronyms in your pages and Grav Smileys Plugin will automatically convert them to their icon graphic file equivalent. As an example

I love you <3

will then transform to

I love you

Contents

Simple Smileys comes pre-configured with each smiley entry having the format

<your-smiley-file-without-extension>:
	enabled: true | false
	acronyms: "<your space separated acronyms e.g. :-) :)>"
	description: "<your description>"

In other words, smilies can be disabled separately by setting enabled: false or modified by setting your own description and/or smiley acronyms.

By default many smiley acronyms are supported. For a detailed list, please open the configuration file simple_smileys.yaml.

Contributing

You can contribute at any time! Before opening any issue, please search for existing issues and review the guidelines for contributing.

After that please note:

• If you find a bug, would like to make a feature request or suggest an improvement, please open a new issue. If you have any interesting ideas for additions to the syntax please do suggest them as well!
• Feature requests are more likely to get attention if you include a clearly described use case.
• If you wish to submit a pull request, please make again sure that your request match the guidelines for contributing and that you keep track of adding unit tests for any new or changed functionality.

If you directly want to contribute an addition to Simple Smileys, be it a new smiley/emoticon or a package for an IM client, please send it to contribute@simplesmileys.org.

Support and donations

If you like my project, feel free to support me via or by sending me some bitcoins to 1HQdy5aBzNKNvqspiLvcmzigCq7doGfLM4.

Thanks!

License

Copyright (c) 2015 Benjamin Regler. See also the list of contributors who participated in this project.

1. Grav Smileys Data Pack - Simple Smileys is dual-licensed for use under the terms of the MIT or GPLv3 licenses.

   

2. Simple Smileys is released into the public domain, meaning it is free (as in freedom) for any purpose.

   Created by Leo Bolin.