icon-themes/README

   1 Icon repository for the applications
   2
   3 All of the icons, separated by themes are included in this
   4 directory. These icons are built into .zip files, and re-ordered /
   5 packed for efficiency reasons based on our UI configuration by the
   6 postprocess/CustomTarget_images.mk.
   7
   8 An icon theme does not need to contain all images, since these can be
   9 layered one on top of another.
  10
  11 In general the layering is done like this:
  12
  13 <leaf theme>
  14 breeze
  15 colibre
  16
  17 How to add a new image set:
  18 ---------------------------
  19
  20 - Create a directory for it here (let's call it e.g. new_set)
  21
  22   FIXME: It is important to use an underscore '_' to delimit more words.
  23          scp2 compilation crashes when using a dash '-'.
  24          It evidently splits the name into two strings.
  25    ^ It's probably not true anymore with filelists.
  26    ^ if this gets changed, IconThemeSelector::SetPreferredIconTheme needs to change too
  27
  28 - Add its name (new_set) to WITH_THEMES variable in configure.ac
  29
  30 - The fallback for particular icons is defined be packimages_CUSTOM_FALLBACK_1
  31   in packimages/CustomTarget_images.mk
  32
  33
  34 How to add a new icon for a new command:
  35 ----------------------------------------
  36
  37 - Assume you defined a dispatch command in officecfg like the following:
  38
  39   in officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu
  40
  41     <node oor:name=".uno:OpenFromCalc" oor:op="replace">
  42         <prop oor:name="Label" oor:type="xs:string">
  43             <value xml:lang="en-US">~Open...</value>
  44         </prop>
  45         <prop oor:name="Properties" oor:type="xs:int">
  46             <value>1</value>
  47         </prop>
  48     </node>
  49
  50   Here, you need to define a property named "Properties", with its value set
  51   to 1 so that the icons show up.
  52
  53 - Now, you need to add 2 new icon images under icon-themes/colibre/cmd/, one
  54   for the large size and one for the smaller size.  The name of each image
  55   must be lc_<command name>.png and sc_<command name>.png.  Here, the command
  56   name is the name given in the above .xcu file without the ".uno:" prefix and
  57   all its letters lower-cased.  In this example, the file names will be
  58   lc_openfromcalc.png and sc_openfromcalc.png.  Note that you need to add new
  59   images to the colibre theme for them to show up in any themes at all.
  60
  61 How to call optipng to optimize size:
  62 ---------------------------
  63
  64 8 bit palettes are on the slow path for quartz/svp/gtk3 so avoid using palettes with...
  65
  66 $ optipng -nc <file>