
This work is provided under the terms of the CREATIVE COMMONS PUBLIC
LICENSE. This work is protected by copyright and/or other applicable
law. Any use of the work other than as authorized under this license
or copyright law is prohibited.

http://creativecommons.org/licenses/by-nc-sa/2.5/

© 2016 OX Software GmbH.

@author Daniel Rentz <daniel.rentz@open-xchange.com>

===============================================================================

This package contains icon source files and build scripts needed to create the
image sets and LESS code for all icons used in the OX Documents applications.



1 Installation
==============

ImageMagick is used to generate the image sets from the single icon source
files.

 
1.1 Install ImageMagic (Linux/Solaris/Mac)
------------------------------------------

- Use the system package manager to install the ImageMagick application.

or:

- Download the appropriate installation archive from

    ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/

- Unpack the archive to an arbitrary location:

    cd /path/to/installation/of/imagemagick
    gzip -dc /path/to/ImageMagick-***.tar.gz | tar -xf -

- Add the MAGICK_HOME environment variable with the installation path (e.g. in
/etc/profile):

    export MAGICK_HOME=/path/to/installation/of/imagemagick

 
1.2 Install ImageMagic (Windows)
--------------------------------

- Download the installation ZIP archive (!) from

    ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/

- Unpack the archive to an arbitrary location.

- Add the MAGICK_HOME environment variable with the installation path to the
system environment:

    MAGICK_HOME = C:\path\to\installation\of\imagemagick



2 Add or Change Icons
=====================

- Copy all new or changed icon files to the sub directory "images".

    * The names of sub directories and the file names must not contain any
      whitespace characters (rename new files if necessary).
    * The icons files must be in PNG image format, and must contain the ".png"
      file extension.
    * There must exist a 16 pixel version of the icon file, the file name must
      end with "_16.png".
    * There must exist a 32 pixel version of the icon file, the file name must
      end with "_32.png".

- Adjust icon definitions in the file "icons.txt". See the descriptions in the
file for syntax details.



3 Build
=======

- Open a console, change to the "icons" directory containing this README file,
and call the appropriate build script for the current operating system
(./build.sh on Linux/Solaris/Mac, build.bat on Windows).

- Copy the files generated in the "build" sub directory to the directory
ui/apps/io.ox/office/baseframework/view of this repository.

- Change version parameter of icon-sprite to prevent that browsers loads the old source
ui/apps/io.ox/office/tk/definitions.less
    Sample:
        from:   @icons-url-path: ~"v=7.6.1-3.20141008.090105/apps/io.ox/office/baseframework/view";
        to:     @icons-url-path: ~"v=7.6.2-3.20141008.090105/apps/io.ox/office/baseframework/view";

- Build the frontend.
