NeoIconer
Version 0.8.3

What is this thing?
This is intended as a developer tool to allow NeoOffice icon developers an easy way to test icons. It is my hope that eventually this tool will allow people to easily create and package OOo themes.

This program began as a port of Rohit Kaul's KDE script for OpenOffice.org. His contact information at the end of this document. Special thanks to Oscar for working out the more-complete slotlist we now use.

 

How to set up (as easy as 1,2,3...):

1) Test it

   I strongly encourage you to test it before modifying it, to ensure that this will work on your system. It's much harder to debug issues after the configuration is modified.

   a) Open a Terminal window (/Applications/Utilities)
   b) In the Terminal. change to the directory this is installed in.
   if you downloaded this to your desktop, you would type 'cd ~/Desktop/Neo-Iconer Ver 0.8.3/'
   c) Type './NeoIconer'
   The ./ is necessary because by default OS X will not search the directory you are in for executables.
   The program put a bunch of dot and asterix's on your screen and then returns a command prompt.

   d) Launch NeoOffice and see if it worked.
   The default pattern uses the included 'KDE' theme, The icons from that theme will appear normally, icons not in that set will have a thick blue border.

2) Modify config.tcl

You need to open the file config.tcl in a standard text editor.'TextEdit' ( under Applications ) is perfect. Word or NeoOffice is not.
Important note about how this configuration file works: Any line that begins with a pound sign ( # ) is ignored. This is very useful because you can enter multiple configurations and easily switch between them. If you'd like to see this in action, just delete the pound sign at the front of the line:
# set ThemeDir "Noia/22x22/"
and add one in front of the line
set ThemeDir "Aqua/22x22/"
Save the file and run the script. When you relaunch NeoOffice, you'll notice that many of the icons have changed, because now it's pulling from the Noia directory instead of the Aqua one.

There are four variables in the configuration file:

1) Choose your theme.
Set this to point to the path of the directory you're creating the icons in. For example:
set ThemeDir "YourIcons/"

2) Set the understudy color
If you specify a color, Neo-Iconer will create a border around all of the icons that you haven't replaced. This allows you to easily keep track of which icons are done and which icons are being worked on. The color can be any RGB color in the format #RRGGBB. Don't forget to include the # at the beginning.
NOTE: To reduce the size of the package, understudy icons are no longer included in the package. Teh script will build the colors on the fly. Example:
set uColorOption "#0000FF"

3) Background color
This is the color that will replace the transparent parts of your icon (as well as a single-pixel border.) The color can be any RGB color in the format #RRGGBB. NeoOffice's background is #C0C0C0. Don't forget to include the # at the beginning. Example:
set bg "#C0C0C0"

4) NeoOffice Version
This is the version of NeoOffice you want NeoIconer to update. The default is for NeoOffice 1.2, but set it to 1.0 if that's what you have installed. You can also flip between them easily. Example:
set ver "Preferences/NeoOffice-1.x"

3) Run it.

Run the script (as described in 'Test it') to insert your icons into Neo/J

 

NeoIconer Command Line Options:

New to version 0.8 is the ability to run command line options. There are simple and meant to save you just a little bit of time and confusion.

-n   --normal
./NeoIconer --normal
Replaces the toolbar icons in NeoOffice to simple, vanilla ones.
Between this and the 'unnormal' option, it should be easy to switch back and forth between a developers environment and a useable one. Especially if, like me, you make use of the border colors to figure out which icons aren't being replaced (which sadly make the icons hard to read.)



-u  --unnormal
./NeoIconer --unnormal
Restores the last-built icon set from NeoIconer.
NOTE: This only works after you've run the normal command


-c  --changenormal
./NeoIconer --changenormal
Changes the icons that are brought in during 'normal' mode to the last set built by NeoIconer.
Because who am I to say what normal is.


-r    --restore
./NeoIconer --restore
Removes all the changes to the NeoOffice directories and leaves it the way NeoIconer originally found it.

-h   --help
./NeoIconer --help
Seemed obligatory, it lists the available command line options

 

How to name icons:

This is going to be the ongoing battle. For the short time, you can open the file 'slotlist.csv' in TextEdit and get the name of the current icon naming convention. Getting this in better shape is really the next big task.

 

How get your icons included:

There's no formal process just yet, just send me icons you think should be included and I will. I reserve the right not to if they seem to me to be in good taste, but so it goes.

Please don't send me anything copyrighted, either by yourself or others. That's in bad taste, too.

 

How to uninstall NeoIconer:
----------
Run NeoIconer with the 'Restore' Command and then delete the Neo-Iconer directory.

 

To-dos:
(as with most to-do lists, ideas will always out pace development. Feel free to let me know what is important to you and what is missing.)

  • better handling of non-replaced icons in sizes that are not 22x22.
  • speed up repititious functions by keeping a .lastsetting file, to compare if anything has been changed, so I might use a common image strip as the basis for successive runs (maybe even compare dates of the files themselves and only update what is necessary, and then have a commandline for 'clean' build)
  • list of files and folders and what they do. (maybe a publisher function for yours truly)
  • packager function - to share Icon sets with less technical folks.
  • Figure out why some icons aren't being replaced.
  • GUI (Tk based?).
  • Ability to replace Lightbulb and Application icon.
  • Ability to add toolbar xml control files.
  • Ability to clean up old understudy directories
  • Axe a bunch of Rohit's code I never use.
  • Clean or fix the useless icons in some of the sample directories / better organized sample directories.
  • Visual tool that compares icons based on comments in Slotlist, with examples from baseicons and shows what custom icons have been built. Sections by comments.
  • 'build' command - To add icons to the CVS repository

 

Versions:
0.8.3
-now has it's own, stripped-down version of ImageMagick included (ver 6.2.5), so now has no dependencies and hopefully no more blacken icons issues.
-autosizing: icon size no longer determined by directory name, instead, determines it from the first icon it finds (search order by slotlist.)
-both of the above changes allow me to eliminate installation steps, which reduces startup time.
-cleaned out some unnecessary subroutines.


0.8.2
-Added ability to switch between 1.0 and 1.2, set the default to 1.2
-Added new grey background for new java, made this color default

0.8.1
-Added indicator of how many custom icons found.
-Changed normal to just copy a pre-existing imagestrip instead of wasting time building it.
-Added unnormal command to toggle back and forth between normal and not normal mode.
-Added changenormal command so you can use an imagestrip of your own creation for 'normal' mode.


0.8

- 525 Icons image slots, up from 171. Now complete, AFAIK (be warned, four times the icons, one fourth the speed.)

- Added command line options: help, normal, and restore.
- Made program executable without manually evoking tclsh.
- Changed executable name to NeoIconer.
- Made it a little more intellegent about finding ImageMagick package.
- Removed some of the smaller, more pitiful icon packages.

NOTE: In this release, we've changed from the incomplete KDE icon naming scheme to the complete GTK one. If you've created icon set with 0.7 and before, you'll have to change the names. I have hacked something up to do automatically, so contact me if that would make your life easier.

0.7
-Removed Icons to reduce package size
-Changed understudy to add border and allow any RGB color.

 

Brett the James (NeoIconer porty-head) contact info:
-------
email: neooffice@brettisangry.com
webpage: http://brettisangry.com/NeoOffice/

Rohit Kaul (Original author) contact info:
-------
email: rohitkaul@sbcglobal.net
webpage: http://www.kde-look.org/content/show.php?content=7131

 

License
-------
GPL
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 2 of the License, or
(at your option) any later version.

See ImageMagick licence in that program's directory for license details.

Warranty
--------
Absolutely none! Use at your own risk!