@database ProRen.guide @author "Michael Praschl" @(c) "Copyright © 1996 by Michael Praschl" @$VER: ProRen.guide 1.32 (8/12/96) @node Main "ProRen V1.32 - English documentation" @{b}@{u}ProRen V1.32@{uu} @{fg shine}Author: Michael Praschl Copyright © 1996 by Michael Praschl @{fg shadow} @{"EMailWare " link EMailWare} - Please register (for free) @{ub} @{" Introduction " link Introduction} What is ProRen ? @{" Installation " link Installation} How to install @{" Requirements " link Requirements} What do I need ? @{" Usage " link Usage} What shall I do ? @{" Warranty " link Warranty} No chance, man ! @{" Distribution " link Distribution} Distribution @{" Copyright " link Copyright} BGui, ReqTools, ... @{" Bugreports " link BugReports} ...and suggestions @{" Updates " link Updates} Aminet & Homepage @{" Features " link Features} cool things @{" ToDo " link ToDo} What's still to do @{" Thanks " link Thanks} and to all who use Proren @{" Autor " link Author} My address @endnode @node Introduction "Introduction" @{fg shine}What's Proren ?@{fg shadow} ProRen was developed to replace the "rename" command. Everyone who has to deal with larger animation will surely like it. It offers you the ability to rename thousands of frames with different filenames into one single format containing the Basename (not necessary) plus an Index (up to 6 digits). Short example: @{fg shine}old name@{fg shadow} @{fg shine}new Name@{fg shadow} Hansi.iff framenumber.001 UlrichsKopf.br framenumber.002 Petra framenumber.003 Logo1 framenumber.004 Logo2 framenumber.005 Portrait_von_mir framenumber.006 Here "framenumber" is the basename, "001" to "004" is Index. Second possibility: @{fg shine}old name@{fg shadow} @{fg shine}new Name@{fg shadow} Pic.000 Anim.010 Pic.001.iff Anim.011 Picture.2.jpg Anim.012 Bild.0003 Anim.013 Pic.5 Anim.014 or Anim.015 (choosable) Here the index was moved up 10 digits. Any filename except the following could be used as source * If ther's a digit on every filename, no digit must exist twice. * The digit must not be bigger than 999999. * Negative digits become positive. As a concequence that all changes are saved you can of course undo them. That's why following possibilities exist: The single frames of an animation exist of BASENAME and DIGIT: * You're using different basenames (for different scenes). Using ProRen gives you the possibility to rename them all the same without doing it by hand. * If you want to insert another sequence after a frame Proren does it for you. * You've many pictures using different resolutions. Wanna have them in one single format? Using Proren it's very easy. Proren r enames them, an arexx-script hands them in order over to ADPro or ImageFX, they convert them into the right format and save them under the same name. Now ProRen restores the old names using the @{"undo" link UndoGadget}-Gadget. There will be an own arexxPort in future versions. * You will have other useful ideas, what to do with this tool. @endnode @node Usage "Usage" ProRen uses an easy-to-use GUI. Any Input is done by Intuition-@{"gadgets" link Gadgets} and @{"menus" link Menus}. The window is fontsensitiv and resizeable. You may set additional settings via the @{"tooltypes" link ToolTypes} and you may drop an icon into the window to change the directory. @endnode @node Gadgets "Gadgets" Gadgets in the mainwindow: @{" ProRen " link About} @{"Basename " link BaseNameGadget} @{" Start " link NumberGadget} @{"Extension " link ExtensionNameGadget} @{" Drawer " link DrawerGadget} @{" Fileliste " link FileListGadget} @{" Drives " link DrivesGadget} @{" " link FileListGadget} @{" Parent " link ParentGadget} @{" " link FileListGadget} @{" Pattern " link PatternGadget} @{" " link FileListGadget} @{" Invert " link InvertGadget} @{" " link FileListGadget} @{" None " link NoneGadget} @{" " link FileListGadget} @{" All " link AllGadget} @{" Quit " link Quit} @{" Undo " link UndoGadget} @{" Start " link StartGadget} Gadgets in the settingswindow: #========# +-----+ +----+ +------------+ #Progress# |Error| |Misc| |Registration| #========#----+-----+-------+----+-----------+------------+ |@{"TempName" link TempNameGadget} @{"ErrorName" link ErrNameGadget} @{"Search Index" link SearchGadget} @{"UserName " link UserName}| |@{"Digits " link DigitsGadget} @{"On Error " link ErrModeGadget} @{"Undo active " link UndoActiveGadget} @{"Reg. Code " link RegCode}| |@{"On Gap " link GapModeGadget} @{"Show Request" link RequestGadget} | +---------------------------------------------------------+ @{" Use " link UseSetGadget} @{" Cancel " link CancelSetGadget} @endnode @node About "About" A small window provides you with some info about ProRen. @endnode @node UndoGadget "Restoring the previous filenames" You start the restoring with the undogadget. Before you click undo you have to select all files you want to undo in the @{"filelist" link FileListGadget}. @endnode @node DrawerGadget "Drawer" This is the drawer where the files to be renamed are. These files are shown in the @{"filelist" link FilelistGadget}. All files to be renamed have to be in the same drawer, they also do not move to another drawer. @endnode @node PatternGadget "FilePattern" The Pattern describes all files that are shown in the @{"filelist" link FileListGadget}. e.g. @{fg shine}#?[a-z]@{fg shadow} any filename which terminates with a letter. @{fg shine}#?[0-9]@{fg shadow} any filename which terminatees with a digit. @{fg shine}Anim-[1-2][0-9][0-9]@{fg shadow} any file with the @{"basename" link BaseNameGadget} "Anim-" and a number between 100 and 299. @endnode @node BaseNameGadget "The basename" The basename is the first part of the new names which does not change. e.g. @{fg shine}Anim.@{fg shadow} @{fg shine}Picture.@{fg shadow} @{fg shine}Frame_@{fg shadow} In conection with an @{"index" link NumberGadget} it is one of the new names. @endnode @node ExtensionNameGadget "The Extension" The optional Extension is appended to the new Filenames, behind the Index: "Frame.001.jpg". But pay attention: If these Files shall be renamed another time, you will have to enable @{"Search Index" link SearchGadget} in the @{"Settings" link Gadgets}. Otherwise the files will be renamed without index (this will be told you by request) and the order would be destroyed (they would be sorted alphabetically). @endnode @node NumberGadget "Startnumber" In connection with the @{"basename" link BaseNameGadget}, the startnumber is the first new filename. Therefore it is appended to the basename. With the digits-gadget you may specify the minimum amount of @{"digits" link DigitsGadget} the index is built of. The next index is the old one increased by one, except if there was a gap. In this case the @{"GapMode" link GapModeGadget} gadget decides if the gap will be kept or deleted. @endnode @node TempNameGadget "Temporary Basename" ProRen makes it possible to renumber the indices from <000-009> to <005-014>, but also from <010-019> to <005-014>. To prevent any problems with already existing files while renaming, the files are renamed to a temporary basename for example "tmp.". When this is done, the files are renamed a second time, to the basename specified. The temporary name may also be specified. See also: @{"Turbomode" link TurboMode} @endnode @node ErrNameGadget "ErrorName" If it happens that a file can not be renamed, because "file already exists", the existing file is renamed. It's basename is specified in the ErrName gadget. @endnode @node GapModeGadget "Gaps" If you just want to give unnumbered files a number, the GapMode-gadget will not be of further interest. It's only of interest, if you REnumber files, and some of the numbers are left out (gaps). Pic.xxx (xxx = <000-009>) Pic.yyy (yyy = <020-024>) Pic.zzz (zzz = <030-039>) You can see that files with the numbers <010-019> and <025-029> aren't existing, these are gaps. When ProRen starts to rename the files, it depends on the GapMode-Gadget, how ProRen reacts when it comes to rename the files Pic.020 and Pic.030. If GapMode shows @{fg shine}Abort@{fg shadow} ProRen will not start renameing files, it will stop immediately. No single file will be renamed. In the examples for @{fg shine}Keep@{fg shadow} and @{fg shine}Delete@{fg shadow} the @{"Startnummer" link NumberGadget} is 100. @{fg shine}Keep{fg shadow} means that <000-009 will be renamed to <100-109>, <020-024> to <120-124> and <030-039> to <130-139>. The gaps and their sizes are kept. Delete kills the gaps. This means that the files <000-009> will be renamed to <100-109>, <020-024> to <110-114> and <030-039> to <115-124>. After the gaps have been killed, you have one single "Chunk" of numbered files. If the GapMode-Gadget shows @{fg shine}Request@{fg shadow}, you will be asked via requester for every gap, if it should be kept or deleted. You also may abort the renaming procedure at such requester. This can be @{"undo" link UndoGadget}ne, though some files already have been renamed. @endnode @node ErrModeGadget "Errorhandling" When ProRen can not rename a file, it enters the errorhandling-routine. What exactly ProRen does, you may specify in the ErrorMode-Gadget. You may chose between the options @{fg shine}Rename@{fg shadow}, @{fg shine}Abort@{fg shadow} and @{fg shine}Request@{fg shadow}. Let's say, "tmp.123" could not be renamed to "Pic.123", course Pic.123 already exists: If you specified @{fg shine}Abort@{fg shadow}, the renaming is canceled immediately, but all changes that were already done can be @{"Undo" link UndoGadget}ne. If you specified @{fg shine}Rename@{fg shadow}, "Pic.123" will be renamed to "err.123" (iff the @{"ErrName" link ErrNameGadget}-Gadget says "err."). Now ProRen makes another try to rename "tmp.123" to "Pic.123". If you specified @{fg shine}Request@{fg shadow}, you will be asked via requester, if you want to abort or if you want to rename "Pic.123". If you want to rename "Pic.123", you may enter the new name for "Pic.123", "err.123" would be a suggestion. If a file could not be renamed, though no file with the same name existed, a requester with the errormessage will appear. You may try to continue or you may abort. If you continue, you should first try to fix the problems. What exactly you have to do, depends on the error and may be read in the doc to the Rename-Command (shell). @endnode @node DigitsGadget "Number of Digits" The new name of a file is build from the basename and an index-number. How many digits this number has, you may specify with the Digits-Gadget. If the actual number has less digits, than you specified, it will be extended with leading zeroes (326 -> 0326). If it has too many digits, the setting will be ignored and the number will be appended to the basename, as is. The following examples should make this more clear Basename | Number | Digits | New Name --------------------------------------- Anim. | 83 | 4 | Anim.0083 Pic_ | 123 | 3 | Pic_123 Frame- | 4321 | 2 | Frame-4321 @endnode @node Quit "How to quit ProRen" ProRen may be quited via @{fg shine}CloseGadget@{fg shadow}, @{fgshine}Menu@{fg shadow} and @{fg shine}Quit-Gadget@{fg shadow}. @endnode @node StartGadget "Start the renaming-procedure" To rename files, select them in the FileList and click the StartGadget or select start from the menu. Now ProRen checks, if there are files, which do not have a number appended to their name. If there is such file, you have to confirm another requester. If any file has a number, and there are 2 different files with the same number, ProRen aborts the procedure with an error-message. If there are gaps between numbers, you will also have to confirm a requester. If you answered all this annoying requesters, ProRen starts with the proper work it was designed for. At first, all files are renamed to tmp.xxx, to avoid conflicts. While ProRen is doing this it may draw your attention to the existing gaps, you willbe asked, if you want to keep or kill the gap. This question is answered automatically, if the @{"GapMode-Gadget" link GapModeGadget} shows any other value than "Request". In a second pass all the tmp.xxx files are renamed to the names you specified. Course every file has to be renamed twice, the procedure lasts twice as long, as if every file would have to be renamed only once. Though ProRen is much faster as you doing all this renaming by hand. If there are no gaps, the @{"turbomode" link TurboMode} will be activated automatically, which is twice as fast, because every file has to be renamed only once. @endnode @node Menus "The Menus" ProRen also provides you with a small pull-down-menu. @{"Start" link StartGadget} (same as StartGadget) @{"About" link About} (same as ProRen-Gadget) @{"Quit" link Quit} (same as QuitGadget) @{"Clear Comments" link ClearComments} @{"Change Settings" link Gadgets} @{"Save Settings" link SaveSettings} @endnode @node SaveSettings "Save Settings" To make ProRen even more comfortable, anything you enter with a gadget may be saved to a prefs-file. Whenever you want to save the settings, just select "Save Settings" from the menu, and a file called "ProRen.prf" will be created (or changed). This file is a normal ascii-textfile which may be changed with an editor like Ed. See also: @{"ToolTypes" link ToolTypes} @endnode @node Installation "Installation" The installation is done with the Commodore - Installer and should not be a problem. @endnode @node Requirements "Requirements" Kickstart/Workbench Version 39+ External libraries: · reqtools.library V38+ · bgui.library V41.5+ (not included => @{"Aminet & Homepage" link Updates}) · asl.library · commodities.library (should be available on OS3.0) A minium of 512kB of free memory is needed. If you want to rename 1 mio. files you will need a bit more. So to say ~10 MB (8-O), if a filename consists of 10 letters. (I've never tried it out!). So for 1000 files you will only need 10kB of additional mem, what should be available anytime. @endnode @node Warranty "Warranty" The author will not be liable for any damage arising from the failure of this program to perform as described, or any destruction of other programs or data residing on a system attempting to run the program. While the author knows of no damaging errors, the user of this program uses it at his or her own risk. See also @{"Bugreports" link BugReports} @endnode @node BugReports "Bugreports" If you find any bug in ProRen, please send me a message with a description about what happened and what you entered in the gadgets. Also provide some info about the system you use. Send the bugreport to @{"me" link Author}. I will try to fix the problem as soon as possible. I am also grateful for Hints and constructive criticism. @endnode @node Author "My address" Send anything you want to: Michael Praschl Hohe Warte 7-1-5 1190 Wien AUSTRIA (no kangaroos, MOUNTAINS!) or better, if you have access to: EMail: e9525802@student.tuwien.ac.at @endnode @node EMailWare "EMailWare" This programm is EMailWare. This means that you may freely distribute it as long as you do not modify the archive or the directories/files it contains. Besides you should @{"register" link Register} (free)! Any commercial use is prohibited unless you have a written permission from the @{"Author" link Author}. @endnode @node Distribution "Distribution" This piece of software is @{"FreeWare" link FreeWare}. It may only be distributed unchanged. You may neither add nor delete any file(s) from this archive. Please @{"register" link Register} (free)! @endnode @node Features "Features" ProRen · uses the bgui.library and the reqtools.library Therefore it is font-sensitive and resizeable · renames up to 1 000 000 files in one go · is faster than you · all changes can be undone · german documentation is included, too · automatised error-handling · has an easy-to-use GUI · does NOT use MUI New features in V1.3: · LOCALISED (+ german catalog, send translations to me, please) · AppWindow, you may change dir by dropping icons into ProRen · automatic TURBOMODE, up to 2x faster · tooltypes · easier file selection (in main window) · some gadgets are now in the new settingswindow · windowpos is saveable New in V1.31: · ProRen is now EMailWare, please register (for free) · directories in the filelist are highlighted · you can cancel each action at any time (undo nevertheless possible) @endnode @node ToDo "Todo" What I'd like to do in future versions: · arexx-port (write me, if you want it included!) · Settings- and Progresswindows should be centralized in the Mainwindow, i just don't get it. @endnode @node Copyright "Copyright" Copyrights BGUI Copyright © 1993 - 1996 by Jan van den Baard 1996 by Ian J. Einman (* "Cause it's for free, free at last" :-) *) Reqtools Copyright © 1991 - 1996 by Nico François MagicWB Icons Copyright © 1992 - 1996 by Martin Huttonloher Installer Copyright © 1990 - 1991 by Commodore Amiga, Inc. @endnode @node Thanks "Thanks" Whom I want to say thank you · @{b}Georg "Golmo" Leitner@{ub} for logo, icons constructive criticism and beta testing · @{b}Andreas "Baal" Berger@{ub} for destructive criticism · @{b}Andreas Seebacher@{ub} for idea, suggestions and beta testing · @{b}all the other beta testers@{ub} · @{b}Jabba Development@{ub} for the bgui.library · @{b}Ian J. Einman@{ub} for continuing the developement of BGUI · @{b}Nico François@{ub} for the reqtools.library · @{b}Wouter van Oortmerssen@{ub} for the AmigaE Compiler · @{b}Santa Clause@{ub} and all the others I've forgotten. @endnode @node FileListGadget "The Filelist" This list shows all files of the current @{"directory" link DrawerGadget} which match the @{"pattern" link PatternGadget}. Here you can select all the files you want to rename (or the files which you want to give their old names). Further you get a list of drives and assigns by clicking the @{"Drives" link DrivesGadget}-Gadget. @endnode @node DrivesGadget "Show drives and assigns" You can get a list of the available drives and assigns by clicking the Drives-Gadget. @endnode @node ParentGadget "Parent directory" Click this gadget to go to the parent-directory. @endnode @node InvertGadget "Invert selection" By clicking this gadget, all selected entries of the filelist will be deselected and vice versa. @endnode @node NoneGadget "Select None" Click this gadget to deselect all entries of the filelist. @endnode @node AllGadget "Select All" Click this gadget to select all entries of the filelist. @endnode @node UndoGadget "Undo" If you want to give files that have been renamed their old names, you just select them in the @{"filelist" link FileListGadget} and click the Undo-Gadget. If this function was @{"disabled" link UndoActiveGadget} while the files were renamed, it is not possible to give the files their old names. @endnode @node SearchGadget "Search for the index" If the Search-Gadget is checked, the filename may have an additional extension after the index (*.jpeg). This extension will be truncated and may be different from file to file. If there are more numbers in the filename. the last one will be used: in "Anim-12_34.iff" the index would be 34. @endnode @node UndoActiveGadget "Enable undo" To make it possible to @{"undo" link UndoGadget} the change of filenames, the old names are stored as a comment (filenote) in the according file (the file itself is not changed, but any old filenotes will be changed). If you do not want to change the filenotes, you may disable this function by deselecting the undo-gadget in the settingswindow. The filenotes will then be keept, but it will not be possible to give the their old names (easily). @endnode @node RequestGadget "Saftyrequest" After you clicked the StartGadget, you will be asked (depening on the situation), if you want to rename files without index or if you want to continue though gaps were found. If none of these situations is the case, you will simply be asked if you want to continue. This question can be switched off with the Request-Gadget. @endnode @node UseSetGadget "Use the settings" Click this gadget to use the settings. @endnode @node CancelSetGadget "Cancel the settings" Click this gadget to cancel the settings and undo all changes. The CloseGadget of the settingswindow does the same. @endnode @node ClearComments "Clear all filenotes" If you want to clear the filenotes, select the wanted files and choose Clear Comments from the tools-menu. @endnode @node ToolTypes "Supported tooltypes" When ProRen is started from Workbench, it reads the tooltypes from the icon to setup. These tooltypes are only alternatives to the prefs-file, you can setup anything in the setup-window. The following tooltypes are supported: · PREFSFILE=name Path and name of the prefsfile. This file will be read first, then any additional tooltypes will overwrite the according settings. The one and only tooltype that has no according command in the prefsfile Default: "PROGDIR:ProRen.prf" · UNDO= This (de-)activates the @{"Undo" link UndoActiveGadget}-Gadget in the settings-window Default: yes · SEARCH= This (de-)activates the @{"Search" link SearchGadget}-Gadget Default: no · REQUEST= this (de-)activates the @{"Request" link RequestGadget}-Gadget Default: yes · START=<0-999999> this sets the preferred number for the @{"Start" link NumberGadget}-Gadget Default: 0 · GAPMODE= this sets the state of the @{"GapMode" link GapModeGadget}-Gadget dieses Merkmal legt den Zustand des @{"Lücken" link GapModeGadget}-Gadgets fest. Default: request · ERRORMODE= this sets the state of the @{"ErrorMode" link ErrModeGadget}-Gadget dieses Merkmal legt den Zustand des @{"Fehler" link ErrModeGadget}-Gadgets fest. Default: request · PATTERN=dateimuster here you can set the preferred file-@{"pattern" link PatternGadget} Default: "#?[0-9]" (all files that end with a digit) · BASENAME=name here you can set the preferred @{"Basename" link BasenameGadget} Default: "Anim." · DRAWER=verzeichnis here you can set the @{"directory" link DrawerGadget} which is read by ProRen after it has been started. Default: "SYS:" · TEMPNAME=name this sets the text in the @{"Tempname" link TempNameGadget}-Gadget Default: "tmp." · ERRORNAME=name this sets the text in the @{"Errorname" link ErrNameGadget}-Gadget dieses Merkmal bestimmt den @{"Fehlernamen" link ErrNameGadget}. Default: "err." · DIGITS=<1-6> here you can set the preferred number of @{"digits" link DigitsGadget} Default: 3 · USERNAME= here you can set your name which is important for your registration Default: NULL :-) · REGCODE once you are registered, enter your registrationcode here Default: 0 · WINDOWX=0, WINDOWY=0 These tooltypes set the position of the ProRen-window on the screen. Default: 0,0 · WINDOWW=300, WINDOWH=400 These tooltypes set the width and height of the ProRen-window. If these values are too small or too big, they will be corrected. Default: 300,400 @endnode @node TurboMode "automatic turbomode" The automatic turbomode will always be activated, when no gaps are in the files to be renamed. Then, every file will not be renamed twice (to tmp. and then to it's real new name), but only once (immediately to it's real name). In this case ProRen will only take half the time to rename files. If there are Gaps between the files to be renamed, the files are renamed twice, because it's not to 100% decideable, if there will be a collision or not. It's even harder to decide, if the user shall be asked for each gap. @endnode @node Register "Registration" ProRen is EMailWare. If you use this program, please register. Registering is simple and for free. You just have to write a small email to me. Don't write kilobytes, just write "I am Michael Jackson and I want to register for ProRen". You will get an email with you personal registrationcode which you enter in the @{"settingswindow" link Gadgets}. Once you are registered, you will not be annoyed by requesters anymore. If you don't have email, you may write a normal letter, but try to ask a friend to write an email for you (stamps are very expansive in Austria :-( ). Here is the list of reg'd users (thanks): Marcel Halbeisen CH (the first registered user ever!) Pat Kushko CA Maurice Powell AU Colin Thompson COM San Diego Michael Ulbrich DE @endnode @node UserName "UserName" In this field you should enter your name, this is important for the @{"registration" link Register}. @endnode @node RegCode "RegistrationCode" In this field you enter the 6-digits-code, which you get for registering. @endnode @node Updates "Where do I get new versione from?" New versions of ProRen can be found on aminet (gfx/misc) or on the ProRen HomePage: http://stud3.tuwien.ac.at/~e9525802/proren/ Both required libs can be found on the homepage! @endnode