icon-themes/README.md

   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 ## Icon naming convention
  18
  19 sc_* icons are 16x16 px (small)
  20 lc_* icons are 24x24 px (large)
  21 There is also an 32px folder at cmd/ with 32 px icons
  22
  23 16x16 px icons are used in the menus
  24 24x24 px icons are used in toolbars and sidebar
  25 Notebook bar use 24x24 px icons when there is only one icon, and 16x16 px everywhere else
  26
  27 sc_ and lc_ icon are followed by the .uno:CommandName (see below)
  28
  29
  30 ## How to Add a New Image Set
  31
  32 - Create a directory for it here (let's call it e.g. `new_set`)
  33
  34     FIXME: It is important to use an underscore `_` to delimit more words.
  35          `scp2` compilation crashes when using a dash `-`.
  36          It evidently splits the name into two strings.
  37
  38     + It's probably not true anymore with filelists.
  39     + if this gets changed, `IconThemeSelector::SetPreferredIconTheme` needs to change too
  40
  41 - Add its name (`new_set`) to `WITH_THEMES` variable in `configure.ac`
  42
  43 - The fallback for particular icons is defined be `packimages_CUSTOM_FALLBACK_1`
  44   in `packimages/CustomTarget_images.mk`
  45
  46
  47 ## How to Add a New Icon for a New Command
  48
  49 - Assume you defined a dispatch command in officecfg like the following:
  50
  51 in `officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu`
  52
  53     <node oor:name=".uno:OpenFromCalc" oor:op="replace">
  54         <prop oor:name="Label" oor:type="xs:string">
  55             <value xml:lang="en-US">~Open...</value>
  56         </prop>
  57         <prop oor:name="Properties" oor:type="xs:int">
  58             <value>1</value>
  59         </prop>
  60     </node>
  61
  62   Here, you need to define a property named "Properties", with its value set
  63   to 1 so that the icons show up.
  64
  65 - Now, you need to add 2 new icon images under `icon-themes/colibre/cmd/`, one
  66   for the large size and one for the smaller size.  The name of each image
  67   must be `lc_<command name>.png` and `sc_<command name>.png`.  Here, the command
  68   name is the name given in the above `.xcu` file without the `.uno:` prefix and
  69   all its letters lower-cased.  In this example, the file names will be
  70   `lc_openfromcalc.png` and `sc_openfromcalc.png`.  Note that you need to add new
  71   images to the colibre theme for them to show up in any themes at all.
  72
  73 ## How to Call optipng to Optimize Size
  74
  75 8 bit palettes are on the slow path for `quartz/svp/gtk3` so avoid using palettes with...
  76
  77     $ optipng -nc <file>