home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / i / imagine / !Imagine / !Help < prev    next >
Text File  |  1995-12-24  |  20KB  |  640 lines
  1.  
  2.  
  3. IIIII  M   M   AAA    GGG   IIIII  N   N  EEEEE
  4.   I    MM MM  A   A  G        I    NN  N  E
  5.   I    M M M  AAAAA  G  GG    I    N N N  EEEEE
  6.   I    M   M  A   A  G   G    I    N  NN  E
  7. IIIII  M   M  A   A   GGG   IIIII  N   N  EEEEE
  8.  
  9. Project Management Utility
  10.  
  11.  
  12. Imagine is
  13.  
  14. S H A R E W A R E
  15.  
  16. (c) 1995 R.F.Windley & The Really Small Software Company
  17.  
  18. Version 1.10 (26th November 1995)
  19.  
  20.  
  21. If you continue to use it for more than 28 days then you
  22. must send £10.00 to the address at the end of this file.
  23. This entitles you to keep using the package after this period.
  24. Cheques drawn against a UK bank are preferred and should be
  25. made payable to 'R.F.Windley'. Failing this £10 cash will be
  26. accepted.
  27.  
  28. Note that this software is supplied 'as is'. The author takes no
  29. responsibility for any problems or data loss resulting from the
  30. use or misuse of this software.
  31.  
  32.  
  33. Requirements
  34.  
  35. In order to use Imagine the following is required:
  36.  
  37. RISC OS 3.1 or above
  38. 2M memory or above
  39. A compiler of some sort (eg gcc/Acorn C/C++)
  40. A linker of some sort   (eg link/drlink)
  41. BorderUtil module if RISC OS 3.1
  42.  
  43. In addition the following are recommended:
  44.  
  45. An ALF generator of some sort (eg libfile/makealf)
  46. DDEUtils module
  47. A template editor (eg FormEd/TemplEd)
  48. Programmers Reference Manuals
  49.  
  50. Note that if you are not using DDEUtils then any generated
  51. command lines must be kept under 256 characters. Also, the CSD
  52. will be altered from time to time and only one project can be
  53. built at once. See the section on Include paths for a way of
  54. keeping command line lengths to a minimum.
  55.  
  56.  
  57. Software used
  58.  
  59. The following was used in the creation of Imagine:
  60.  
  61. DeskLib
  62. Zap
  63. TemplEd
  64. Acorn Desktop C Release 4 & 5
  65. Make
  66. link/drlink
  67. libfile
  68.  
  69.  
  70. What is Imagine?
  71.  
  72. There has been a lot of criticism of the quality of
  73. programming tools available for RISC OS. Imagine has been
  74. written in response to some of these criticisms and although
  75. it does not pretend to be the ultimate application
  76. generation tool, it is hoped that it goes some way towards
  77. making programs easier to write.
  78.  
  79. The Make utility supplied with Desktop C allows the
  80. programmer to specify the code and libraries that make up a
  81. project. Imagine also allows the resources that make up an
  82. application to be specified and maintained. All code and
  83. resources are accessed through Imagine so there is no more
  84. searching through directories to find a piece of code.
  85.  
  86. Imagine splits projects into different types.
  87.  
  88. Applications are normally RISC OS WIMP applications. As well
  89. as source code they have a number of resources associated
  90. with them such as a Messages file or window Templates.
  91.  
  92. Libraries are pieces of code that can be grouped together
  93. into useful blocks. They are not tied to any one application
  94. and may be used many times. For example, you might have a
  95. dates library that is used to manipulate dates in a number
  96. of different ways.
  97.  
  98. Utilities are like applications except they don't have any
  99. resources. They are programs that will most likely be
  100. invoked from the command line. An example of a utility is
  101. the C compiler.
  102.  
  103. Classes are C++ specific. They may perhaps be thought of as
  104. an object oriented version of libraries. Using the dates
  105. example above, you would have a date object on which a
  106. number of actions could be performed.
  107.  
  108.  
  109. Note that it is assumed that the reader is familiar with
  110. developing applications on the RISC OS platform. As it is
  111. necessary for you to have a compiler and linker I do not
  112. believe this is an unreasonable assumption.
  113.  
  114.  
  115. Getting started
  116.  
  117. To load Imagine simply double click on the !Imagine icon in
  118. the directory viewer. After a few seconds Imagine will load.
  119.  
  120. Note that if you do not have the DDEutils module you must first
  121. edit the !Run file. Simply comment (|) out the first RMEnsure
  122. that mentions DDEUtils. Imagine will then load.
  123.  
  124.  
  125. The icon bar menu
  126.  
  127. Clicking Menu over the icon bar icon displays the icon bar
  128. menu. This allows access to the different parts of Imagine.
  129.  
  130. Info
  131. Choosing the Info option displays a standard About this
  132. program information box. 
  133.  
  134. Open
  135. Choosing this item leads to the Open submenu.
  136.  
  137. This shows the way in which Imagine separates different
  138. types of project. Selecting one of these options will
  139. display a list of projects that fall into that category.
  140.  
  141. Preferences
  142. This item leads to another submenu.
  143.  
  144. This menu allows the setup of Imagine to be changed and new
  145. languages to be supported.
  146.  
  147. Quit
  148. The final item on the menu causes Imagine to finish.
  149.  
  150.  
  151. Managing Projects
  152.  
  153. Much of the functionality of Imagine is the same whatever
  154. type of project you are writing. Unless otherwise specified
  155. the following applies equally to all project types.
  156.  
  157. Choosing Open->Applications from the icon bar menu produces
  158. a project list window.
  159.  
  160. This lists all the projects that are defined for this
  161. project type.
  162.  
  163. In order to perform any operation on a project it must be
  164. highlighted by clicking Select or Adjust. Clicking Adjust
  165. will add to the selection of projects currently highlighted.
  166. Clicking one of buttons down the right of the window will
  167. then perform the action specified.
  168.  
  169. It is also possible to double click on a project. This will
  170. produce the code window and, for applications, the resources
  171. window.
  172.  
  173.  
  174. Application resources
  175.  
  176. Clicking on the Resources button in the Applications window
  177. will display the resources for the currently highlighted
  178. application. This button does not appear for Libraries,
  179. Utilities or Classes.
  180.  
  181. Editing resources
  182. Application resources can be edited in a
  183. couple of different ways. Either highlight the resource or
  184. resources that you want to edit and click on the Edit button
  185. or double click on the resource. It will be loaded into the
  186. relevant editor for you.
  187.  
  188. Creating resources
  189. To create a new resource click on the Create button.
  190.  
  191. In order to create a resource it must already have been
  192. defined as a valid resource type. To get a list of valid
  193. resource types click on the help menu icon. Choose the
  194. resource type that you want and click on the Create button.
  195. The resource will appear in the resource window.
  196.  
  197. Deleting resources
  198. Resources can be deleted from an application by highlighting them
  199. and clicking on the Delete button. You will be prompted to confirm
  200. this is what you wanted to do.
  201.  
  202.  
  203. Project code
  204.  
  205. Choosing the Code button in the project list window will
  206. display the Project code window.
  207.  
  208. This window allows all of the code for a project to be
  209. managed.
  210.  
  211. The top part of the window shows all of the code for a
  212. project. This can be a mixture of different languages such
  213. as C, C++ or assembler. In fact, as long as the object file
  214. produced by the relevant compiler follows standards, any
  215. compiled language can be used.
  216.  
  217. The bottom part of the window shows the header files that
  218. form part of the project.
  219.  
  220. Double clicking on a code name or header file name will load
  221. it into a text editor ready for you to edit.
  222.  
  223. There are a number of buttons down the side which work as
  224. follows:
  225.  
  226. Create
  227. Clicking on the Create button produces a small
  228. dialogue which lets you create a new piece of source code.
  229.  
  230. The Name field must contain a valid filename. Note that it
  231. is possible to type up to 32 characters into this field in
  232. anticipation of filing system improvements. It is the
  233. responsibility of the programmer to ensure that the name
  234. entered is compatible with the underlying file system. The
  235. Type field can be filled in by clicking on the help menu
  236. icon which will produce a list of valid code types.
  237.  
  238. Clicking on the Create button will create the new code. A
  239. default template will be supplied with some details filled
  240. in.
  241.  
  242. Clicking the Cancel button will close the window.
  243.  
  244. It is possible to 'create' code in another way. If you
  245. already have a piece of source code that you want to include
  246. in your project it can simply be dragged to this window.
  247. Imagine will attempt to discover the type of this source
  248. code. If the source code is in a directory that matches a
  249. code type Imagine knows about such as c, cc or s then the
  250. code will be typed according to this.
  251.  
  252. Alternatively, if the code has a suffix such as _c, _cc, /c
  253. or /cc then the code will be typed according to this. This
  254. can be useful if the code is being copied from another
  255. system such as DOS or Unix which rely heavily on file
  256. suff