README.org

Table of Contents

1 What is this?

Emotion-iconous is a minor mode for Emacs 23 (or earlier I suppose).

This minor mode changes every "emoticon text" like :-) and :-P into its image respectively.

For doing this impressive and amazing thing, you need a theme. This theme can be created or downloaded from the Internet.

If you like to create a theme, is all explained in the file theme-format.html.

Also, this library works with Emacs-jabber, not only with text files or scripts.

For installing and make everything run, keep reading. This README is not too long.

2 Compatibility

You can use this library with Emacs 23. However, I haven't tested with other versions.

Also, this works with Emacs-jabber 0.8.90. As I said, I haven't tested with other versions.

You can use Pidgin themes if you like. You just need to copy the theme directory with all its images and the "theme" file, and configure the variable "emoicon-theme".

You can use Pidgin themes if you like. You just need to copy the theme directory with all its images and the "theme" file, and configure the variable "emoicon-theme".

3 Download the Library

You can download the latest stable version at:

http://download.gna.org/emoicon-mode/

It is in tarball format(tar.bz2), so you need bzip2 and tar programs to uncompress the file.

Also, you can find them at subversion:

http://svn.gna.org/viewcvs/emoicon-mode/trunk/

4 Loading the Library into Emacs

To manually load the library you just need to type

M-x load-library 

and then write the path of the library, like:

~/my-emacs-stuff/emotion-iconous-mode.el

.

For using with Emacs-jabber you have to do the same:

M-x load-library

and then:

~/my-emacs-stuff/jabber-emoicon.el

.

5 Installing

If you are tired to load the library manually, just insert this into your ~/.Emacs file:

                                        ; ******************************
                                        ; *** Emotion-Iconous 
;; Change to where is the path to emotion-iconous mode:
(setq load-path (cons "~/PathToWhereIsEmotionIconousModeFiles" load-path))

(require 'emotion-iconous-mode)

;; To use with jabber:
(require 'jabber-emoicon)

This will do enough to load the library and go with the next step: starting the minor mode.

6 Using this Library

6.1 In a Text or Script File

Just starting the minor mode is enough, you do this typing:

M-x emotion-iconous-mode

For Emacs-jabber, you do not need to do this.

6.2 With Emacs-Jabber

After loading the "jabber-emoicon.el" library, or installing all (see 5), just do nothing! :)

You don't need to call the minor mode.

7 I Want to Help!

If you like to help with this project, just search for this at http://gna.org.

You can send themes or recommend one. Remember that everything you like to share must be according with the Free Software Philosophy and GNU General Public License (GPL).

At least, images, poetry, and text must have Creative Commons license.

For documentation about how to make themes, see theme-format.html.

Please, read a summary of GPL at this sites:

I like freedom, so this software must be free software :-)

8 Thanks

Thanks to Claudio Vaucheret to teaching me how to use Emacs and Emacs-Lisp

Thanks to my girlfriend Romina Otte. She helps me to test Emotion-iconous-mode… a kiss to her :-*

9 License

README.org Copyright (C) 2011 Giménez, Christian N.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Miércoles 09 De Noviembre Del 2011

Date: 2011-11-09 mié

Author : Christian Giménez

Generated by Org mode 7.9.3f in Emacs 24.2.1.

Validate XHTML 1.0