Skip to content

Sommerregen/grav-data-smileys-tango

Repository files navigation

Grav Smileys Data Pack - Tango

Release Issues Dual license Flattr PayPal

Tango is a collection of smileys and emoticons from the Tango Desktop Project.

About

Tango is a lightweight collection of simple smileys extracted from the from the Tango Desktop Project. It includes more than 16 smileys, each one having its own textual representation as can been seen below.

Screenshot Tango

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 tango.

You should now have all the data pack files under

user/data/smileys/tango

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 Tango 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: tango

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 :-*

will then transform to

I love you :-*

Contents

Tango 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 tango.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.

Support and donations

If you like my project, feel free to support me via Flattr 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 - Tango is dual-licensed for use under the terms of the MIT or GPLv3 licenses.

    GNU license - Some rights reserved

  2. Tango is licensed for use under the terms of the GPL v2 license.