home *** CD-ROM | disk | FTP | other *** search
/ Computer Club Elmshorn Atari PD / CCE_PD.iso / mac / 1000 / CCE_1067.ZIP / CCE_1067 / JML_SNAP / SNAP_ENG.DOC < prev    next >
Text File  |  1995-04-17  |  18KB  |  591 lines
  1.                                 Documentation to
  2.                                 JML-Snapshot 5.00
  3.  
  4. Contents
  5.  
  6.   1.      Introduction
  7.  
  8.      1.1. Features
  9.  
  10.      1.2. Legal things
  11.  
  12.      1.3. JML-Snap is shareware!
  13.      
  14.   2.      Installation
  15.  
  16.      2.1. Registration
  17.  
  18.   3.      How to use...
  19.      
  20.      3.1  Drag&Drop
  21.      
  22.   4.      If something doesn't work...  
  23.  
  24.   5.      Some common things
  25.  
  26.   6.      Known bugs
  27.  
  28.   7.      History
  29.  
  30.   8.      Preview
  31.  
  32.   9.      Updates
  33.   
  34.  10 .     Thanks to...
  35.  
  36.  11.      My adress
  37.  
  38.  
  39. 1. Introduction
  40.  
  41. It was one day after the 1992 ATARI trade-fair. I just had connected my 
  42. new graphiccard to my ST and needed a hardcopy.
  43.  
  44. "No Problem! I've got lot's of these programms on disk", I thought to myself.
  45. But none of them was able to support more than 16 colors; the most of them 
  46. couldn't even handle other resolutions than 320x200.
  47.  
  48. So I decided to write it by myself. I think, most of all shareware-
  49. programms were born like this.
  50.  
  51. When using JML-Snapshot first, please klick on the button "Sprache". The 
  52. language will switch to English!
  53.  
  54. 1.1 Features
  55.  
  56. JML-Snapshot allowes you to save any desired part of the screen to disk.
  57. You can choose between following options:
  58.  
  59. - Free choice of the clipping via rubberband or direct cut of a window, 
  60.   the contents of a window or the whole screen.
  61.  
  62. - Output format IFF, (X)IMG or TIFF
  63.  
  64. - Free choice of path and name of the snapshot or use of a standard-folder
  65.  
  66. - Copy the whole screen via Alt-Help
  67.  
  68. The size of the snapshot is not limited at all. Only if you want to save 
  69. the snapshot under a free chosen name, you maust have enough memory left.
  70. JML-Snapshot can save any amount of colors, even Hi and TrueColor.
  71.  
  72.  
  73. 1.2. Legal things
  74.  
  75. JML-Snapshot may be copied and distributed in the unregistred form. 
  76.  
  77. Any distribution of the key or the registred version is strictly 
  78. forbidden!
  79.  
  80. JML-Snapshot is copyrighted, with all rights reserved.
  81.  
  82. There's no liability for any possible damages, that may be caused by 
  83. JML-Snapshot. I just can't even imagine, which damage this may be. 
  84.  
  85.  
  86. 1.3.  JML-Snapshot is shareware
  87.  
  88. JML-Snapshot may be tested by anybody. If you like it, you have to pay
  89. a fee of DM 20,- (or $15,- or £7,-). 
  90.  
  91. To give you a little motivation, there are some features not available in 
  92. the unregistred version:
  93.              - (X)IMG saving only
  94.              - No Hi/TrueColor support
  95.              - no 'Window-snap'
  96.              - no Alt-Help support
  97.  
  98. To register your copy, you just have to pay your fee and send your name 
  99. and adress to the author. Read chapter 2.1 for more information
  100.  
  101.  
  102. 2.      Installation
  103.  
  104. New users of Versions > 3.30:
  105.   If you like to use JML-Snapshot as a programm (PRG, APP), then you may 
  106.   copy it anywhere you like. If you want to use it as an accessory (ACC), 
  107.   JML-Snapshot has to reside on your bootpartition/bootdisk.
  108.  
  109.   The name should always be JML_SNAP! Only the extenders ACC, ACX, APP and 
  110.   PRG are supported. If you can resign to save the options, you can name 
  111.   the programm as you please.
  112.  
  113.  
  114. "Updater" from a version > 3.30:
  115.   Simply start SNAPINST.PRG. It has to be in the same folder, as 
  116.   JML_SNAP.ACC!
  117.  
  118.   After starting, the well known fileselector appears and you can choose 
  119.   the namen and path for JML-Snapshot; JML-Snapshot will automaticly be 
  120.   copied there.
  121.  
  122.   If SNAPINST has found an old version of JML-Snapshot the old parameters 
  123.   will be taken over.
  124.  
  125.  
  126.  
  127. 2.1     Registration
  128.  
  129. People who have payed the fee for JML-Snapshot, will recieve a personal 
  130. key. For that I need the user's name and adress.
  131.  
  132. When you've recieved your key, just click on 'Info' in the maindialog and 
  133. then click on 'register'. Now you may enter your name, adress and the key.
  134. If the click on 'OK' causes an alert, there must be something wrong. 
  135. Please check your data and try again. Otherwise you should have returned 
  136. to the maindialog. Now you have to click on 'Save' and you're owner of a 
  137. registred version. A distribution of this version or the key is striktly 
  138. forbidden!
  139.  
  140.  
  141. 3.      How to use...
  142.  
  143. JML-Snapshot consists of two parts. The snapshotroutine and a dialog to 
  144. configure. 
  145.  
  146. If you start JML_SNAP as a programm under standard-TOS (no multitaking), 
  147. you can only use the dialog. Started under a multitasking OS nothing will 
  148. happen first. You can work with other applications, as you're used to.
  149.  
  150. JML-Snapshot will be activated (under multitasking or as accessory) after 
  151. you've chosen the item in the menu (if you use MagiC! you can find the 
  152. item in MagiC's popup).
  153.  
  154. If you press down one of the shift keys while activating JML-Snapshot, the 
  155. dialog appears. You should do this when using JML-Snapshot first, to 
  156. configure it to your preferencies.
  157.  
  158. When working with a desktop, which can send VA_START, you may doubleclick 
  159. again on JML_SNAP to reach the dialog.
  160.  
  161.  
  162. The dialog:
  163.  
  164. - The checkboxes
  165.  
  166.   Field "Snapshot parameters":
  167.   
  168.      Rubberband:
  169.           
  170.           While "Rubberband" is crossed, the snapshot can freely be chosen. 
  171.           Otherwise, the "window-snap" is active. More of this later.
  172.  
  173.      Fileselector:
  174.  
  175.           While active (and enough memory free) you can choose name and 
  176.           path of your snapshot via fileselector. Otherwise JML-Snapshot 
  177.           will use standard name and path.
  178.  
  179.     Fix IFF:
  180.  
  181.           Unfortunately, there are programms, which expect a word-aligned 
  182.           width. You can blow up your snapshot, to satisfy these 
  183.           programms.
  184.  
  185.    Delay:
  186.           
  187.           If active, you can delay the action of JML-Snapshot. After 
  188.           activating JML_SNAP, nothing will happen, until you press down 
  189.           both shift keys.
  190.           This might be usefull, for bringing up windows, because some 
  191.           OS' always backdrop the upper window when switching to JML_SNAP.
  192.           
  193.    Field "Extra":
  194.  
  195.      Alt-Help:
  196.           
  197.           TOS was always able to print out a hardcopy by pressing 
  198.           Alt-Help. Sometimes, you'd like to have the hardcopy as a file, 
  199.           instead of printing out.
  200.           
  201.           The advantage of this method is, to save a screencopy to disk, 
  202.           while having a dialog open or dropped down a menu.
  203.           
  204.           If you switch off Alt-Help support, your computer will behave as 
  205.           usual, just as if JML-Snapshot wasn't installed.
  206.           
  207.           IMPORTANT!!! Please read SECURE.TXT!
  208.           
  209.       Overwrite:
  210.  
  211.           You can instruct JML-Snapshot to overwrite existing files.
  212.           When using the fileselctor, JML-Snapshot will always ask befor 
  213.           overwriting!
  214.  
  215.       Drag&Drop:
  216.       
  217.           If your OS supports Drag&Drop you can instruct JML-Snapshot to 
  218.           use this feature.
  219.           More of this in chapter "Drag&Drop".
  220.  
  221. - The radiobuttons (Field "Format"):
  222.      
  223.      Choose your favorite output format.
  224.  
  225. - The standardpath:
  226.  
  227.      If you do a snaphot with filelector disabled, JML-Snapshot will save 
  228.      the file to the standardpath, which you can define here. Click on the 
  229.      field containing the path and the fileselector will appear, so you can 
  230.      choose your standardpath.
  231.  
  232.      The arrows on the left and right are for scrolling the path if it's 
  233.      too long for the box.
  234.  
  235.      If not chosen, the path will be used, JML_SNAP was started from.
  236.  
  237. - The buttons:
  238.  
  239.      Info:
  240.  
  241.           The usual infobox appears. From here you can reach the dialog 
  242.           for the registration.
  243.  
  244.      Save:
  245.  
  246.           All parameters will be saved. If JML-Snapshot isn't able to find 
  247.           itself, you may locate it via fileselector.
  248.  
  249.      Language:
  250.           
  251.           You can switch between German and English
  252.           
  253.      Quit:
  254.  
  255.           Quits JML_Snapshot. If you use JML_SNAP as an accessory, this 
  256.           function will be disabled.
  257.      
  258.      Cancel:
  259.  
  260.           Leaves the dialog and abandons all changes.
  261.  
  262.      OK:
  263.           
  264.           Leaves the dialog and takes over all changes.
  265.  
  266.      
  267. If you use JML-Snapshot as a programm under a singletasking TOS, Cancel 
  268. and OK will quit JML-Snapshot! 
  269.  
  270.  
  271. The snapshotroutine:
  272.  
  273. The essential function of JML-Snapshot, which depends strongly on 
  274. "Rubberband". 
  275.  
  276. If you start JML-Snapshot with rubberband active, the mousepointer changes 
  277. to a thin cross. Pressing the right mousebutton cancels.
  278. Pressing the left mousebutton sets the mouseposition as the first corner 
  279. of the snapshot rectangle. The mousepointer changes to a pointing hand and 
  280. you can now set the second corner. When you relseae the button, the 
  281. snapshot will be saved.
  282.  
  283. If rubberband is not active, the pointing hand will appear immediately.
  284. Pressing the left mousebutton will activate the "window-snap", which 
  285. means, that the contents of the window under the mousepointer will be 
  286. saved. If there's no window, JML-Snapshot will save the whole screen!
  287.  
  288. Beware, that you can only save the visible clipping of the window!
  289.  
  290. If you've clicked on a window-gadged, the whole window (including the 
  291. gadgeds) will be saved.
  292.  
  293.  
  294. The snapshot will be saved as "SNAP_xx.ext". "xx" represents a number, 
  295. which will be increased for every snapshot. "ext" represents the 
  296. extension "IFF", "IMG" or "TIF", which depends on the output-format.
  297.  
  298. If you have selected "Fileselector", the bitmap will be saved under your 
  299. chosen name and path. The extension will be set automaticly.
  300.  
  301. Because of TOS-specific internals, you maust have enough memory to freely 
  302. choose a name and path. If there isn't enough memory free, JML-Snapshot 
  303. will save to the standard-path and inform you with an alertbox.
  304.  
  305.  
  306. 3.1.    Drag&Drop
  307.  
  308. This is a new way of data-exchange between paralell running applications.
  309. It's available while using
  310.  
  311.   MultiTOS 1.08 (Beta-version only)
  312.   MagiC!3
  313.   Magic!Mac
  314.  
  315. D&D works like this:
  316. You can click on an object (icon, text-clipping, picture-clipping) and 
  317. drag it to an other window, where you drop it. The object will be placed.
  318.  
  319. If you have activated D&D for JML-Snapshot (and there's enough memory 
  320. left) you can only save your snapshot via D&D.
  321.  
  322. Just operate as usual! JML-Snapshot will not save directly or open the 
  323. fileselector; it'll open a small window, including a camera-icon, which 
  324. you can drag&drop to any other window.
  325.  
  326. Anything else depends on your destination-application
  327.  
  328. - The destination doesn't know Drag&Drop:
  329.   JML-Snapshot informs you using an Alertbox
  330.  
  331. - The destination can not use bitmapdata (e.g. CAT or RUFUS):
  332.   JML-Snapshot informs you using an Alertbox
  333.   
  334. - The destination can use bitmapdata (e.g. Zeig's mir or STELLA):
  335.   JML-Snapshot sends the data directly to the destination as a (X)IMG 
  336.   Picture
  337.  
  338. - The destination window represents a path (eg. some deskops)
  339.   The snapshot will be saved as SNAP.xxx (xxx means IFF, IMG or TIF) 
  340.  
  341. - The destination was a printer-icon (e.g. some deskops):
  342.   JML-Snapshot informs you, using an Alertbox, that it isn't able to print
  343.  
  344. - The destination was the clipboard (e.g. some deskops):
  345.   The snapshot will be saved as SCRAP.IMG
  346.  
  347. - The destination was the trashcan (e.g. some deskops):
  348.   JML-Snapshot asks with an alertbox, if you like to abandon the picture 
  349.   (delete) or if you've made a mistake and wish to keep it (go on).
  350.  
  351. If you can't find a destination, able to use the data, you have to close 
  352. the window. JML-Snapshot asks what you want to do now.
  353. The alert is similar to "trashcan" with the option to save via 
  354. fileselector (save).
  355.  
  356.  
  357. 4.      If something doesn't work...  
  358.  
  359. Unfortunately, it's nearly impossible to find all bugs in a programm.
  360. If you find any, please inform me!
  361.  
  362. I need an exact description of the bugs, to reproduce them. 
  363. Please inform me about
  364.  
  365. - Computer (ST, STE, TT, Falcon, etc.)
  366. - Amount of memory
  367. - TOS version
  368. - Multitasking (MTOS, MagiC!, MultiGem)
  369. - installed accessories
  370. - Programms in your AUTO-folder
  371. - Procedure which led to the occured error
  372.  
  373. It's usefull to always send me a disk and the money for P&P. When I've 
  374. fixed the bug, I'll send you a new version immediately.
  375.  
  376.  
  377. 5.      Some common things...
  378.  
  379. A snapshot can take a "long" time, when using 256 or more colors. The VDI has
  380. to transform the data to the "standard-format" which takes it's time. When 
  381. using TIFF output, JML-Snapshot has to transform the data by itself; but 
  382. the assembler-routines are not too slow.
  383.  
  384. Because of this, I do not support data-compression, to save time. In most 
  385. cases you will use the snapshot in an other application, so this won't be 
  386. too bad.
  387.  
  388. JML_SNAP saves the parameters to itself, so you must not use JML-Snapshot 
  389. in compressed form!
  390.  
  391. JML-Snapshot need the AES even when using Alt-Help. It's not possible to 
  392. save a screencopy, when there's no AES! This happens when using TOS or TTP 
  393. programms under single-TOS or when using the MagiC!-Single-mode.
  394.  
  395. If you like to use JML-Snapshot under MagiC! in single-mode, you have to 
  396. unfreeze JML_SNAP. To do so, you have to switch to the task-manager (press 
  397. Ctrl-Alt-Escape) choose JML_SNAP using the cursor-keys and press 'u'.
  398.  
  399.  
  400.  
  401. 6.      Known bugs
  402.  
  403. If you use TOS 1.04 you have to use a patchprogramm or NVDI, because there 
  404. is a bug in the vr_trnsform - routine of TOS 1.04.
  405.  
  406.  
  407. JML-Snapshot was tested under following condition:
  408.  
  409. - Nearly all ST models, ever built by ATARI
  410.   all STE models
  411.   TT 030 
  412.   FALCON 030
  413.   JANUS
  414.   Macintsoh using MagiC!Mac
  415.   
  416. - Turboboards Hypercache, HBS, PAK/2 und PAK/3
  417.   
  418. - TOS 1.04, 2.06, 3.06 and 4.01
  419.  
  420. - MultiTOS 1.01, 1.08, MagiC!2 and MagiC!3
  421.  
  422. - 68000, 68010, 68020 and 68030 CPU
  423.  
  424. - NVDI 2.01, 2.5
  425.  
  426. - With GDOS (NVDI, ATARI-GDOS, AMC-GDOS, FontGDOS)
  427.  
  428. - in ATARI ST Hi, ST Mid, ST Lo, TT Mid, TT Lo and all FALCON graphic modes 
  429.  
  430. - with the following graphiccards
  431.      
  432.      NOVA MEGA 256
  433.      NOVA VME 32k
  434.      NOVA MEGA 16M
  435.      Crazy Dots 
  436.      Crazy Dots II
  437.      MATRIX TC1006     
  438.      Spektrum TC
  439.  
  440.  
  441. 7.      History
  442.  
  443. v <1.0 Internal versions, lots of bugs
  444.  
  445. v1.0   The first public version!
  446.  
  447. v1.1   JML-Snapshot did not restore the mousepointer!
  448.  
  449. v1.2   JML Snapshot is now independant from free memory
  450.        No fileselector.
  451.        The path can be saved in "JML_SNAP.INF"
  452.        Added an install programm
  453.  
  454. v1.3   The path for saving can now be changed and saved.
  455.  
  456. v1.4   JML_SNAP.INF canceled. The standard-path is now saved directly in 
  457.        the accessory.
  458.  
  459. v1.5   vq_color now gives the real, not the desired value
  460.  
  461. v1.6   Fixed a bug concerning multitasking;
  462.        Last PD-version
  463.  
  464. v2.0   JML-Snapshot is shareware! Multitasking supported, the install 
  465.        programm disappeared.
  466.  
  467. v3.00  Internal version of the MK3 series. Lots of bugs.
  468.  
  469. v3.01  First version for registrated users
  470.  
  471. v3.02  Approved recognizing the pressing of the right mousebutton, no more 
  472.        LINE-A calls
  473.  
  474. v3.10  First version written in 'C'. 
  475.  
  476. v3.11  Fixed a bug in the (X)IMG-version
  477.  
  478. v3.12  Internal version, since now, a COOKIE is installed
  479.  
  480. v3.13  Internal version, Hi and TrueColor supported
  481.  
  482. v3.14  First public TC-version, 256-color TIFF are saved much faster
  483.  
  484. v3.15, 
  485. v3.16  Internal version, little bugfixes 
  486.  
  487. v3.17  Changed internal structures
  488.  
  489. v3.18,  
  490. v3.19  Changed internal structures again
  491.  
  492. v3.20  Window-snap was always with gadgets
  493.  
  494. v3.21  Alertboxes for write-error for (X)IMG and TIFF,  too
  495.        Under MagiC! windows will keep their 'topped' status
  496.        While using the fileselector:
  497.         - "SNAP.ext" used as filename, if none is declared
  498.         - Included warning for overwriting existing files
  499.  
  500. v3.30  Included registration.
  501.  
  502. v3.31  Changed internal structures
  503.  
  504. v4.00  New:       - Alt-Help support
  505.                   - Snap-delay
  506.                   - dialogs in English 
  507.       
  508.        Changed:   - Look of the dialogs
  509.                   - Window-Snap now activated while clicking on the 
  510.                     gadgets of a window.
  511.  
  512. v4.01 The unregistred version always saved the whole screene
  513.        
  514. v4.02 Installed as an accessory it was impossible to use Alt-Help 
  515.       directly after reboot
  516.        
  517. v4.03 The snapshot started one line too deep, while using some VDIs
  518.  
  519. v4.04 (X)IMG is now the only outputformat, instead of IFF
  520.  
  521. v5.00 included Drag&Drop
  522.  
  523.  
  524. 8.      Preview
  525.  
  526. I'd like to hear suggestions anytime. If I find it usefull, I'll implement 
  527. it. But beware, that JML-Snapshot is a small utility and no OS or drawing 
  528. programm!
  529.  
  530.  
  531. 9. Updates
  532.  
  533. Updates for JML-Snapshot are free!
  534.  
  535. How do I get an update?
  536. I'll upload every new version to the MAUS WI2. Uploads to other 
  537. non-commercial BBS' are allowed.
  538.  
  539. You can ask me for an update, too of course
  540.  
  541. Just send me a letter inclusive a disk and money for P&P. That's it.
  542.  
  543.  
  544. 10.      Thanks to...
  545.  
  546. - all betatesters (I can not name all of them)
  547.  
  548. - the authors of the `Profibuch'
  549.  
  550. - Laurenz Prüssner, for some articles in the ST-Magazin
  551.  
  552. - Mike Steffl fot testing, MEMOHELP and lot of PMs
  553.  
  554. - Reiner Rosin for a little assembler-help, "Zeig's mir" and the first bugreport
  555.   since month'.
  556.  
  557. - *MHG* from "Computer Insel" for their great support.
  558.  
  559. - Dieter Fiebelkorn for GEMView
  560.  
  561. - Theo for BANG 2082
  562.  
  563. - Pink Floyd for `The Dark Side Of The Moon'
  564.  
  565. - you, dear reader, because my English is so bad.
  566.  
  567. - last, but not least, thanks to my lady. I'm sitting much too long in 
  568.   front of my computer. Sorry for that babe...
  569.  
  570.  
  571. 11.      My adress 
  572.  
  573. John McLoud
  574. Mozartstraße 1a
  575. 65439 Flörsheim am Main 
  576. Germany
  577.  
  578. via E-Mail:
  579.  
  580.     john_mcoud@wi2.maus.de    (internet)
  581.     John Mcloud @ WI2         (MAUSNET)
  582.  
  583.  
  584.  
  585. Account:
  586.  
  587. Taunussparkasse  BLZ 512 500 00
  588.                  Kto. Nr.: 9 45 02 97
  589.  
  590.  
  591.