cicm Files

CICM User guide
---------------

	Requirements
	------------
		Python 2.6
		Pygtk
		GTK+ 2.x
		
		Install these before using cicm. I can't provide a complete
		installer yet.
	
	Installation
	------------
		Extract the cicm_xx.tar.gz to a folder of your choice
		and you are done.
		
		You should change cicm language to the one you want to use.
		This is done from cicm.xml. Just set the <lang> node to the
		desired value(either fi for finnish or en for english)
		
	Usage
	-----
		Since cicm is a python script you can use it with 
		'python /your/install/path/cicm.py command'. The command can be
		any one of the commands described below. For the rest of the guide cicm
		will be used to refer to the part before the command.

		If you plan to use cicm a lot you should make an alias for it.
		Please refer to the documentation of your operating system for
		more information
		
		Creating a collection:
			cicm create nameOfCollection
			and follow instructions
			
		Adding images to a collection:
			cicm addImages list of images wanted to add
			and answer the questions
			
		Removing a collection:
			cicm delete nameOfCollection
			removes the collection from the database(master.xcc)
			and the collection file. Won't affect any of the images
		
		Listing all collections:
			cicm list
			Shows a list of all collections and	their tags
			
		Browse contents of a collection	
			cicm browse nameOfCollection
			Shows a table of all files in the collection nameOfCollection,
			their id(on page the actual id is much longer), tags and location. 
			You can use n and p commands to go forward and back pages.
			Cicm will print the same page until either command is given
			and if you are on the first page p will do nothing. On the last
			page n will quit the program. Command q will quit on any page.

			idOfFile is the id shown in the table printed.
			You can view a file by typing: 'v idOfFile' , 
			add tags by typing:'at idOfFile'
			remove tags by typing: 'rt idOfFile', 
			start a slideshow of the shown files with 'slide' 
			view their thumbnails by typing 'g' and
			remove files from the collection with 'rm idOfFile'
			view detailed info about the image with 'info idOfFile'
			open a file in an external application by typing 'o idOfFile'.
			If you want to open the files with another application you must
			specify the application in the cicm.xml file(external).

			You can use the keyword 'all' instead of idOfFile, if you want
			to target all images on the page.

			you can re-order the file list with these commands:
			'ro tags' the image with least tags will be on top
			'ro asc' ascending order based on name of the image
			'ro desc' descending order based on name of the image
			the last two can also be used in the settings to choose
			the default ordering of the files(without the ro)

			Please note that you have to press return(enter) before 
			anything happens.
		
		Viewing a thumbnail gallery of all the files in collection:
			cicm g nameOfCollection
			Use n and p to browse the pages.
			A label is shown on each image. It contains the page id of the image
			and its filename seperated with '::'.
			The page numbering starts from 0.The page number is shown in the 
			titlebar of the gallery window.
			Pressing q will close the gallery and when you reach the last page n
			will also close the window and on the first page p.
			
			When you hover the cursor on an image a tooltip will display its
			label, which is the same as printed on the image
			Click an image to view it over the gallery window as a bigger image
			and click anywhere on the image to close it.

		Viewing a slideshow of a whole collection:
			cicm slide nameOfCollection
			As in all the others n and p will go to next and previous image.
			Pressing q will end the slideshow.
			For now a timed slideshow is not possible.
			
			using the command rslide instead of slide will create a random
			slideshow of the collection.

		Editing collection:
			cicm edit nameOfCollection

			and follow the instructions.

		Searching files:
			cicm search listOfTagsSearched

			The tags must be seperated with ',' . The search will
			find all files with any of the tags(or atleast it should).
			It will also include the files collections tags and name.
			You can use the same commands used while browsing a collection.

		Browsing collections:
			cicm colls
			n,p,jump,q work as in browse
			ef id	edit fies in a collection(or browse it)
			at id	add tags to a collection
			rt id	remove tags from a collection
			r  id	rename the collection
			info id shows all info about the collection available

			'all' can be used instead of the id to target all collections


		For now thats all cicm can do.