ftp.nice.ch/Attic/openStep/tools/workspace/TheShelf.0.3.3.README

This is the README for TheShelf.0.3.3a.m.NIS.bd.tgz [Download] [Browse] [Up]

Release 0.3.3, 6.9.1997 by Tomi Engel (tomi@shinto.nbg.sub.org)

1			TheShelf Application



This application tries to imitate the workspace feeling that was proposed for OpenStep/MachOS 4.0 at ObjectWorld '95. I liked the idea so much that I sat down and hacked the first verion of this small app the night after I returned from the USA.
Two years after the NeXTSTEP version has seen the light of day, I rewrote the application for the OpenStep API in an three day, four nights move. So...

Beware: 		
...this is just a "fun prototype" app which turned out to be quite useful. But don't expect it to be a full featured hyper cool shelf. There are many things which are still missing.

Note: 		
In order to run this application you need OPENSTEP 4.x  (only tested on 4.2) and must have MiscKit 2.0.4 and IconKit 4.2.1 installed (or a later version). Both frameworks are not part of this distribution. The application should compile on Windows NT and Rhapsody DR1 too...but it was not yet tested on these platforms.
Please read the release notes since compiling MiscKit 2.0.4 is tricky.



Using the Shelf


At this time you can create different shelf levels, switch between them, drag files onto them and either have the files opened or selected by the workspace.

By default the app will start with a set of predefined shelfs which usually get stored in the ~/Library/TheShelf folder. To create another shelf level just click the small tab symbol (  ) on the left side of the shelfs main tab. This will create the default icon shelf.
You can also use one of the "New" menu items to add different types of shelfs.

To swap between levels just click on the tabs. Tabs can be resorted, renamed and deleted.
The tab view also acts as a drag area. Use it to lower or raise the shelfs window.
Alt clicking this area with toggle the level of TheShelf's window between three predefined positions. It can either lay infront or behind all windows or reside in the regular window level. 
If "auto hiding/raising" is activated the shelf window should pop up when the mouse reaches the bottom of the screan and should hide again once the mouse leaves the window.

Currently there are three more or less useful shelf bundles available:

*	The "Icon shelf page" is also refered to as the "shelf page". It accepts drag & dropped 
	file and application references. Applications inside the shelf open files which get 
	dropped on them.
*	A "Processes page" which shows all running applications.
*	The "Log page" which tracks the contents of a file (usually /tmp/console.log).

The contents of all the page is stored automatically as the application quits or if the users switches to a different page. Each level uses a ".aShelf" file wrapper to store its information.



The Package

Version 0.3.3 comes in two packages. The main TheShelf.0.3.3.m.I.bd.tgz 
archive includes:

*	TheShelf.app. An OPENSTEP 4.x binary for Intel hardware.
*	The documentation including the Release Notes.


The source package TheShelf.0.3.3.sd.tgz comes with:

*	Full sourcecode
*	And also the documentation with Release Notes to free you from having to download both packages.


Attention: 	
You need gnutar and gzip und unpack those files. Both programs are bundled with NeXTSTEP since version 3.2.

On where to find the latest releases please see the 'About this Project' section.



About this Project


Development will continue ± but I can't promiss how fast. The current version of OPENSTEP does make it quite difficult (impossible ?) to implement all the cool ideas (transparent shelf tabs, animated app icons, etc.) . Since I am not planning to waste too much of my time running against walls or closed doors (APIs), it might take some time until we will be able to enjoy the really good ideas of a Shelf.

The intended future includes more loadable bundles and a more polished behavior. Something like Pastry right inside the shelf would be really nice. Support for generic pasteboard contents is high on the list as well (URLs, colors, images, etc.)

In the end it might turn out that this app can reach its final feature richness only under other OpenStep implementations like e.g. the GNUstep project. There it might be possible to put the right hooks into the Workspace so I don't have to hack around too much. Who knows...let's wait and see.

Or, perhaps NeXT and Apple will revitalize this idea for Rhapsody. Fingers crossed. This would be the real killer.

The latest version of this application will be available at the ftp.cs.tu-berlin.de, peanuts.leo.org or ftp.next.peak.org anonymous ftp servers. There is a WWW page were you can find out more about the status of this...and all the other projects I'm working on:
	
	http://www9.informatik.uni-erlangen.de/~tsengel/Projects/Projects.html


Compiling

This version includes all the source code needed to compile the program from scratch but it does not include objects that are part of the MiscKit or IconKit distribution. So in order to run this application you will need to get the MiscKit project from the archives (version 2.0.4 or higher). Additionally you will need H. Scott Roys really cool IconKit (version 4.2.1 or higher) in your LocalLibrary/Frameworks area.

For more details on the MiscKit or IconKit collection check out the servers mentioned below or get the Objective-C or NeXT FAQs. If you would like to submit something to the MiscKit collection you should contact: Don Yacktman <don@misckit.com>

	http://peanuts.leo.org/
	ftp://ftp.cs.tu-berlin.de/pub/NeXT/
	ftp://ftp.next.peak.org/pub/openstep/
	http://www.misckit.com/

Beware: 		
Please read the release notes since compiling MiscKit 2.0.4 is tricky and does not work out of the box


In Case of Trouble

If you have any questions you might contact me. But don't send any suggestions and expect them to get implemented in the near future. This definitly won't happen. Sorry.


	Tomi Engel
	Netpunstr. 9
	D-90522 Oberasbach
	Germany
	
	E-mail:	tsengel@immd9.informatik.uni-erlangen.de
		tomi@shinto.nbg.sub.org
		(NeXTMail welcome)



Warranty and copyright


Copyleft

All source code is distributed under the GNU General Public License.
This does not apply to the ObjectWare used, which most likely comes with its own licensing rules (e.g. code that belongs to the MiscKit or IconKit project).

You are free to extend and modify this application. But don't redistribute a modified version under the same name unless I gave you the permission.
I don't want to have different, confusingly incompatible versions running around the world.


No Warranty

This software is provided 'as is' and the programmer is not responsible for any harm this program may cause.
You -- the user -- are responsible for everything that may happen to your business, hardware, software, car, CD collection or what ever may be worth your attention or money.
Using this product is at your own risk and your private fun.

There should be no serious bugs inside but remember that a carbon-based unit did the coding.


Travelware

Like all my projects this app is free and should be considered as travelware.

   	Let it travel to as many people as you know. 

	Send me an E-mail or postcard if you use it. I will try to keep you informed about new releases.

	If you have a free bed or some free space on your floor...give me a hint. 
	I might come and visit you on my next trip to the US...locations on Hawaii, 
	near Seattle or WhistlerMnt. (Canada) preferred.



Enjoy it.

	Tomi

These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.