summaryrefslogtreecommitdiff
path: root/icon-themes
diff options
context:
space:
mode:
Diffstat (limited to 'icon-themes')
-rw-r--r--icon-themes/README.md52
1 files changed, 25 insertions, 27 deletions
diff --git a/icon-themes/README.md b/icon-themes/README.md
index 79ca0ed54b87..81230417501a 100644
--- a/icon-themes/README.md
+++ b/icon-themes/README.md
@@ -1,42 +1,41 @@
-Icon repository for the applications
+# Icon Repository for the Applications
All of the icons, separated by themes are included in this
-directory. These icons are built into .zip files, and re-ordered /
+directory. These icons are built into `.zip` files, and re-ordered `/`
packed for efficiency reasons based on our UI configuration by the
-postprocess/CustomTarget_images.mk.
+`postprocess/CustomTarget_images.mk`.
An icon theme does not need to contain all images, since these can be
layered one on top of another.
In general the layering is done like this:
-<leaf theme>
-breeze
-colibre
+ <leaf theme>
+ breeze
+ colibre
-How to add a new image set:
----------------------------
+## How to Add a New Image Set
-- Create a directory for it here (let's call it e.g. new_set)
+- Create a directory for it here (let's call it e.g. `new_set`)
- FIXME: It is important to use an underscore '_' to delimit more words.
- scp2 compilation crashes when using a dash '-'.
+ FIXME: It is important to use an underscore `_` to delimit more words.
+ `scp2` compilation crashes when using a dash `-`.
It evidently splits the name into two strings.
- ^ It's probably not true anymore with filelists.
- ^ if this gets changed, IconThemeSelector::SetPreferredIconTheme needs to change too
-- Add its name (new_set) to WITH_THEMES variable in configure.ac
+ + It's probably not true anymore with filelists.
+ + if this gets changed, `IconThemeSelector::SetPreferredIconTheme` needs to change too
-- The fallback for particular icons is defined be packimages_CUSTOM_FALLBACK_1
- in packimages/CustomTarget_images.mk
+- Add its name (`new_set`) to `WITH_THEMES` variable in `configure.ac`
+- The fallback for particular icons is defined be `packimages_CUSTOM_FALLBACK_1`
+ in `packimages/CustomTarget_images.mk`
-How to add a new icon for a new command:
-----------------------------------------
+
+## How to Add a New Icon for a New Command
- Assume you defined a dispatch command in officecfg like the following:
- in officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu
+in `officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu`
<node oor:name=".uno:OpenFromCalc" oor:op="replace">
<prop oor:name="Label" oor:type="xs:string">
@@ -50,17 +49,16 @@ How to add a new icon for a new command:
Here, you need to define a property named "Properties", with its value set
to 1 so that the icons show up.
-- Now, you need to add 2 new icon images under icon-themes/colibre/cmd/, one
+- Now, you need to add 2 new icon images under `icon-themes/colibre/cmd/`, one
for the large size and one for the smaller size. The name of each image
- must be lc_<command name>.png and sc_<command name>.png. Here, the command
- name is the name given in the above .xcu file without the ".uno:" prefix and
+ must be `lc_<command name>.png` and `sc_<command name>.png`. Here, the command
+ name is the name given in the above `.xcu` file without the `.uno:` prefix and
all its letters lower-cased. In this example, the file names will be
- lc_openfromcalc.png and sc_openfromcalc.png. Note that you need to add new
+ `lc_openfromcalc.png` and `sc_openfromcalc.png`. Note that you need to add new
images to the colibre theme for them to show up in any themes at all.
-How to call optipng to optimize size:
----------------------------
+## How to Call optipng to Optimize Size
-8 bit palettes are on the slow path for quartz/svp/gtk3 so avoid using palettes with...
+8 bit palettes are on the slow path for `quartz/svp/gtk3` so avoid using palettes with...
-$ optipng -nc <file>
+ $ optipng -nc <file>