home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / formed2 / !FormEd2 / !Help < prev    next >
Encoding:
Text File  |  1993-04-10  |  19.0 KB  |  349 lines

  1.  
  2.  
  3. *****************************************************************************
  4.  
  5.             FormEd2 3.04  -  by Acorn Computers/RISC squad/Paul Hobbs
  6.  
  7. *****************************************************************************
  8.  
  9.                            Paul Hobbs commentary
  10.                            ---------------------
  11.  
  12. This is RISC Squad's FormEd version 2.84b enhanced to include Interface 3D
  13. icons and some extra options to make it easier to use. The template 'Filer'
  14. and the 'Handles' code were extracted from version 2.87 of Risc Squad's effort.
  15.  
  16. If I knew who 'Risc Squad' were I'd ask permission before hacking their
  17. program, but they are so modest they don't even give an address. I intend
  18. eventually to create !FormEd+ (hows that for originality) using my EvntShell
  19. library and even more features when I can get around to it.
  20.  
  21. New Features Include:
  22.  - Resizing of icons without dragging for more accuracy
  23.  - The addition of Left/Right/Top/Bottom alignment options for selected icons
  24.  - The 'Arrange' option for selected icons
  25.  - Interface style icons may be created directly from the menus, including
  26.    new borders introduced with v2.00 of the Interface module
  27.  - DragASprite solid dragging for RISC-OS 3.1 (wow!)
  28.  - Support for RISC-OS 3 boot message
  29.  - Template 'Filer' window (no more windows opening all over your desktop!)
  30.  
  31.                            RISC Squad commentary
  32.                            ---------------------
  33.  
  34. Completed 21st September 1990 to version 2.80. Here's a list of all the
  35. things I did, as far as I can remember - I didn't make a list as I went
  36. along.
  37.  
  38.         i) Icons can now be selected/deselected by clicking the menu button
  39.                on them whilst holding the SHIFT key down.
  40.        ii) The icon dragging procedure - with the left button - now moves
  41.                all of the selected icons in the window.  Dragging with the
  42.                right button (re-sizing) is unchanged.
  43.       iii) The main menu structure has been split into an Icon menu and a
  44.                Window menu - for convenience and for speed.  Previous
  45.                releases of FormEd were notoriously slow at creating their
  46.                menus. Each of the two menus includes an option for calling
  47.                up the other, which will then be opened as default on each
  48.                subsequent occasion.
  49.        iv) The Window menu is largely unaltered, but does include a 'save'
  50.                option for saving only one template at a time. Be warned,
  51.                font freaks - the save routine will check for anti-aliased
  52.                fonts in all other windows too, so I don't know what will
  53.                happen in that situation. Whatever it is, it shouldn't be
  54.                fatal.
  55.         v) The Icons menu is now far more versatile than before.  Many
  56.                choices are now available for all selected icons (in that
  57.                window only) including specific choices from the EDIT ICONS
  58.                submenu structure - notably BUTTON TYPE !!
  59.        vi) The RENUMBER option is virtually as before, but the renumbering
  60.                process can be optimised by the use of the MENU button whilst
  61.                depressing the CONTROL key. This is identical to choosing the
  62.                'Renumber #nn' option directly.
  63.       vii) The DESELECT ALL option deselects all the icons in the current
  64.                window.
  65.      viii) The COPY and MOVE choices may now be performed on either single
  66.                icons or on all the selected icons.
  67.        ix) The WIPE option may now be on selected icons, on a single icon or
  68.                on any icon number specified. I find this useful in two
  69.                instances - (i) When I import templates which have 'missing'
  70.                icons that aren't used - see Paint's 'save' box, icon #1 is
  71.                to the right and is '<CRAP>'  (ii) If I can't find one of my
  72.                own icons !!
  73.         x) Note that any options which are either on 'selected' icons or on
  74.                a specific icon can be controlled by clicking MENU over a
  75.                specific icon for the latter, or on no icons (the window's
  76.                work area) for the former. In such a case, if no icons are
  77.                selected, you will be informed, eg. 'Wipe No Icons' - which
  78.                will also be 'shaded out'.
  79.  
  80.   All in all, the lesson to be learned from this is - if you want any icons
  81. to be selected (in the finished template) - leave them to the end, so they
  82. don't screw up your work !
  83.  
  84. PS   I also put in an 'Info' box and attached it to the icon bar menu as
  85.      expected. Plus, while checking up on the 'Save one template' job I
  86.      re-enabled the facility to save off the entire file merely by choosing
  87.      the 'Save templates' option on the icon bar menu. - this had been
  88.      REMd out !
  89.  
  90. *****************************************************************************
  91.  
  92.                     Updates, Version 2.81 - 24/11/90
  93.  
  94.   The main problem bugging those people I knew of who were using this was
  95. that of the un-named windows not being saved. I have therefore included a
  96. new error in the 'save' routine such that the error 'Only the named windows
  97. were saved' occurs if any of the templates were un-named.
  98.   I also fixed the 'Move Selected' option from the 'Icons' menu, which did
  99. absolutely nothing in version 2.80.
  100.  
  101. *****************************************************************************
  102.  
  103.                     Updates, Version 2.82 - 02/12/90
  104.  
  105.   Oops, version 2.81 was chronically buggered ! The aforementioned error
  106. occurred on every occasion, without exception. This is now completely
  107. fixed ! The extra features are as follows :
  108.  
  109.         i) It is now impossible to create un-named templates.
  110.        ii) The identifiers of windows must be different on a non
  111.                case-sensitive basis, i.e. It is not now possible to call one
  112.                template 'Save' and a different template 'save' even though
  113.                the names, strictly speaking, are distinct.
  114.       iii) Clicking on the icon bar icon opens a dialogue box, prompting the
  115.                user to enter the identifier of the new template. Press ENTER
  116.                or click on OK to confirm; press ESCAPE or close the box to
  117.                cancel.
  118.        iv) Alternatively, a new template may still be created by the use of
  119.                the icon bar menu structure. The normal rules for identifiers
  120.                still apply.
  121.         v) Any new template has its title bar icon set to text as before,
  122.                but the text defaults to the identifier at the time of
  123.                creation. This allows easy reference on a set of newly
  124.                created templates.
  125.        vi) As a result of all this, the errors such as 'Only named windows
  126.                can be saved' and 'Only the named windows were saved' are now
  127.                a thing of the past !
  128.       vii) On a completely different point : newly created icons now appear
  129.                directly underneath the pointer rather than a small distance
  130.                above it.
  131.  
  132. *****************************************************************************
  133.  
  134.                     Updates, Version 2.83 - 23/12/90
  135.  
  136.   Aha, welcome back to all template designers. It's been exactly three weeks
  137. since v2.82 and in such a short time I found a lot to do to the program, it
  138. wan't hard. Have you noticed how all of these have been issued at weekends,
  139. i.e. Friday, Saturday, then Sunday twice ?
  140.   I suppose I should tell you what I've done to it again - well, in order of
  141. appearance . . .
  142.         
  143.         i) The icon bar menu is restructured so that the templates and the
  144.                sprites are handled independently. This also makes the main
  145.                menu less tall, which looked very silly.
  146.        ii) You will of course have noticed an unfamiliar option on this menu
  147.                as soon as you tried it out after you'd read through part (i)
  148.                i.e. the new 'Clear' option. Fairly self-explanatory, all it
  149.                does is asks for confirmation, then clears all templates from
  150.                memory. This is mainly useful for loading a new file etc.
  151.            For example, if you want to pinch the save box from Edit, then
  152.                you would load the templates from Edit, save off just the one
  153.                template you wanted, clear the templates then re-load the old
  154.                file, eg from RAM:. This saves either (a) deleting all of the
  155.                templates in the file 'by hand' or (b) quitting FormEd and
  156.                waiting for another copy to load and initialise (very slow)!
  157.       iii) The next idea I had was to add a facility for certain 'default'
  158.                icons, rather than the <Untitled> icon as before. This became
  159.                a thorough restructure of the icons menu, to become a more
  160.                filer-type menu tree. Here's how the new 'icons' menu looks.
  161.        iv) Create icon - On its own, this creates the old <Untitled> icon,
  162.                almost. The submenu has a variety of goodies on offer ;
  163.                Text      - Colour 12 bordered text icon   (Click/Drag)
  164.                Sprite    - 'Free-standing' sprite icon    (Click/Drag)
  165.                Arrow     - Colour 12 bordered arrow icon  (Click/Drag)
  166.                Option    - Normal 'Optoff,Opton' icon     (Radio)
  167.                Radio     - Normal 'Radiooff,Radioon' icon (Radio)
  168.                Writeable - Normal text entry icon         (Write/Click/Drag)
  169.                Menu      - Normal menu icon, eg 'OK' box  (Menu)
  170.                Comment   - 'Free-standing' text icon      (Click/Drag)
  171.                             e.g. the 'Name:' icon in a
  172.                                  ProgInfo window.
  173.  
  174.         v) This is where the similarities to the Filer start. The third
  175.                choice is either 'No Icons' or 'Selected Icons' or 'Icon #0'
  176.                for example. The submenu yields to present the choices :
  177.                Edit, Copy, Move, Wipe, and Renumber - all as in v2.82
  178.        vi) By the way, the 'Button type' menu has been rigged to disallow
  179.                types 12 & 13 (reserved) and type 11 is once again referred
  180.                to as 'Radio'
  181.       vii) Back to the filer, the next two choices are 'Select All' and
  182.                'Deselect All'
  183.      viii) Lastly, 'Tidy Icons' removes any spurious icons that lie wholly
  184.                outside the window's Work Area. Note that this is NOT the
  185.                same as outside the opened window space. For example, in
  186.                Paint's notorious SaveBox [see v2.80, (ix),(i)] the CRAP icon
  187.                is within the Work Area, but the lack of scroll bars on these
  188.                windows sometimes makes it seem to lie beyond these bounds.
  189.  
  190.    NB when using the default icons on the 'Create' submenu, make sure that
  191.       you remember to set the button types of the icons, particularly the
  192.       arrow icons (usually Auto-Repeat). The icons default to Click/Drag
  193.       because they rarely appear in exactly the right place, so need moving.
  194.  
  195.                               Happy templating ! !
  196.  
  197. *****************************************************************************
  198.  
  199.                     Updates, Version 2.84 - 07/02/91
  200.  
  201.   Thought for the day :
  202.   When I use this - and I do, despite the bugs - I nearly always use the
  203. icons menu rather than the windows menu, but this poses an annoying problem.
  204. How does a lazy programmer (contradiction ?) like me delete a window without
  205. using the other menu ? Answer - put the 'Delete window' choice on BOTH.
  206. Completely against the idea of separating the two menus, but I don't care.
  207.   I was quite stunned when I happened to notice how Acorn handled their icon
  208. indirection workspace - it goes like this. (i) DIM a large block of memory.
  209. (ii) Set a pointer to the start of this area. (iii) Whenever workspace is
  210. needed, use the memory at the pointer, and move the pointer on. (iv) When
  211. the pointer reaches the end of the buffer, annoy the user by generating
  212. errors. Actually, (iv) might have been 'by crashing without explanation' -
  213. but if it was, I've already 'corrected' this.
  214.   To counteract this problem, the pointer is moved back to the beginning
  215. when the last template is deleted, or if 'Clear' is chosen from the icon bar
  216. menu. Crude, but still better than Acorn.
  217.   I've been hassled a lot recently by my friend Anonymous 'Rabbit' Unknown
  218. 'cos he was getting worked up about the indirection buggy bits - apparently,
  219. when large, multi-indirected templates are used (waffle) the indirection
  220. buggers up so the icons start to contain bits of the !RunImage, i.e. it
  221. points to the WRONG BIT of application workspace. As a result, when you wipe
  222. it, bits of your (still running) program go missing, and crashes ensue.
  223. Alternatively, all the icons are inter-connected, so when you delete the
  224. unwanted bit of one, the other one does spurious things too.
  225.   I think I've sussed it though; I looked at the code, changed a few things
  226. and now it seems to work, so to quote the ISV docs, 'Everyone is happy'.
  227.   Rabbit was also whining about the way that the files were saved
  228. 'backwards' so that the window stacking is reversed. Big template files have
  229. to be kept tidy in this respect, it was annoying !
  230.   I've just done another detail - when a single template was saved before,
  231. the 'Original' filename, as appears off the icon bar 'save' box, was changed
  232. to become that of the single template just saved. It was wrong, it's not
  233. now.
  234.   The other (trivial) bug was that the colours menus did odd things;
  235. sometimes the icon colours menu was in monochrome, and always there were
  236. problems with mobile tick on the currently selected colour - particularly if
  237. a menu choice was made with ADJUST. This is fixed too. Acorn were previously
  238. reading the palette each time the tick moved, to decide which colours
  239. contrasted with which others - this is now, of course, done on the WIMP
  240. message which has something to do with palette changes, and it's faster too.
  241.   Typical.
  242.  
  243. *****************************************************************************
  244.  
  245.                     Updates, Version 2.84b  - 01/03/91
  246.  
  247.   Nothing fascinating, as usual - a minor bug fix to do with the
  248. 'Icon #nn.Edit.Text' bit of a submenu, from where the text sometimes goes
  249. walkies. The usual un-recreatable bug sort of idea, the icon would contain
  250. text, but the menu would suggest that it had a null text string.
  251.   Also I added a new choice to the icon bar menu, 'Finish', which is exactly
  252. equivalent to 'Save Templates' then 'Clear Templates'. Some choices, i.e.
  253. 'Finish', 'Clear' and 'Save' are now shaded whenever there are no templates
  254. loaded into FormEd.
  255.   I thought it would be a nice idea to be able to load an application's
  256. 'Templates' file by merely dragging the application to FormEd, so it now
  257. attempts to load the file '!ApplName.Templates', failing if it is not found,
  258. or if it does not have the file type &FEC (Templates). I was right about the
  259. nice idea, it's very convenient ! The slight fib is that the normal error
  260. 'This application has no Templates file' occurs even if it exists, but with
  261. the wrong file type. So who cares anyway ? Not my problem.
  262.   Lastly, the general icons menu now opens such that the pointer is usually
  263. over the 'Selected icons' jobbie, making editing slightly easier, ta very
  264. much Mister WIMP, see you on the next version of FormEd.
  265.  
  266. *****************************************************************************
  267.  
  268.   For those interested, here's Acorn's crap on the subject, as found in my
  269. application directory. Anything subsequently in this text file is unedited,
  270. excepting the last few lines (blanks and asterisks).
  271.  
  272. *****************************************************************************
  273.  
  274. Notes on using FormEd, 16-May-89
  275.  
  276. FormEd is an editor of Template files. To understand this you need to
  277. understand the program interface of the Window System, as described in the
  278. Programmer's Reference Manual. The description here assumes an understanding
  279. of template files.
  280.  
  281. FormEd is started by double-clicking on a template file after the FormEd
  282. icon has been "seen". This will cause FormEd to be loaded, and to display
  283. all of the windows in the template file. Alternatively, double-click on
  284. FormEd itself and it will be loaded with no current windows. If a template
  285. file does not appear to load properly, give more memory to FormEd before it
  286. starts using the Task Manager window.
  287.  
  288. A template file is often constructed with reference to a specific set of
  289. sprites. A sprite file can be dragged onto the FormEd icon on the icon bar
  290. to set the available sprites. These are displayed in a window. Some previous
  291. versions of FormEd used to provide facilities for editing sprites, these are
  292. now provided only in the Paint application.
  293.  
  294. Clicking on the FormEd icon creates a new window in the current template
  295. file, and displays it on the screen.
  296.  
  297. The menu provided from the icon on the icon bar provides the following
  298. functions:
  299.  
  300. Create window - similar to clicking on the FormEd icon, except that a name
  301. may be specified for the template.
  302.  
  303. Load templates - allows you to type in the filename of a template file to be
  304. loaded, instead of dragging an icon from the Filer.
  305.  
  306. Save templates - a save box for the templates being edited.
  307.  
  308. Quit - quit FormEd. Beware that this has no "confirm" option, so any edits
  309. will be discarded instantly if you choose this menu entry.
  310.  
  311. The template windows displayed by FormEd mirror precisely the size, position
  312. and properties of the windows in the Template file. The following actions
  313. directly affect the stored values:
  314.  
  315. Close the window - deletes it from the template file.
  316.  
  317. Move/scroll/resize the window - moves the default setup of the window in the
  318. template file.
  319.  
  320. Clicking MENU on a template window produces a menu tree that allows a wide
  321. variety of alterations to the menu structure, based on the various control
  322. fields of a window structure as described in the Wimp documentation. It also
  323. allows you to create icons in the window. An icon, once created, can be
  324. moved and resized using drag-SELECT and drag-ADJUST. It can also have its
  325. properties adjusted by pointing at it and then clicking MENU, and following
  326. the "amend icon" submenu.
  327.  
  328. The best way to experiment is to examine and update the template files
  329. belonging to the Applications Suite (saving the original first!). It's also
  330. possible to update the template files used by ROM utilities. These reside in
  331. the deskfs: filing system in the ROM. They are accessed via the environment
  332. variable Wimp$Path, so by updating this to search a directory of your own
  333. first where your updated template files reside, you can replace the window
  334. templates used by the utilities in the ROM.
  335.  
  336. Your ability to drag and resize icons may be affected by a button type
  337. affixed to an icon: only those button types which generate the appropriate
  338. Wimp events can be dragged and resized directly. It's interesting to note
  339. that FormEd keeps no data structures describing each template window,
  340. relying on the Wimp to keep and manipulate each structure.
  341.  
  342. FormEd keeps a file of sprites in memory which can be used in icons in the
  343. template being edited. The default sprite file used is the file Default
  344. inside !FormEd, which is in fact a copy of the sprites found in the RISC OS
  345. ROM. To load in a separate sprite file to use with your template file, drag
  346. the sprite file onto the FormEd icon.
  347.  
  348. *****************************************************************************
  349.