home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / textutil / jgpsuite / Docs / RdmeDoc < prev   
Encoding:
Text File  |  1993-05-11  |  17.7 KB  |  411 lines
  1. .setu 10 :arc:
  2. .// Source for !jgp.Info.!clickme; revised Tue,20 Apr, 1993
  3. .//
  4. .// This text is designed for Arc Desktop users; MSDos and Commandline users
  5. .// may find some information irrelevant and other needed information
  6. .// requiring imaginative interpretation.
  7. .//
  8. .// Some control directives help with character positioning in the line when
  9. .// this is printed in proportional spacing; ignore them. (.\ \Q, .usel), .setst
  10. .//  and .nost organise undenting.
  11. .sp 0      Comment this line out (.//) for paged output (66 lpp)
  12. .hd
  13. /.col
  14. |JGP Introduction v1.20|Fri,03 Jul 1992
  15.  
  16. /
  17. .ft
  18. /
  19.  
  20. .col
  21. |-\p-
  22. /
  23. .ht 18
  24. .marg 2 79
  25.  
  26. .\ \Q
  27. .col
  28. |JGPrograms
  29. .col
  30. |==========
  31. .usel base
  32.  
  33. The application !jgp makes available the Jolly Good Programs Tools. These are:
  34.  
  35. .setst :\t:
  36.  
  37. .nost
  38. JGEd:     \t}a very powerful editor;
  39. .nost
  40. JGPrint:  \t}a text formatting and printing program;
  41. .nost
  42. JGConfig: \t}Builds or modifies Printer Configuration files;
  43. .nost
  44. JGPCopy: \t}Desktop Handler to copy to screen, Dump or print JGPCopy files;
  45. .nost
  46. JGPrSlave \t}Prints for JGPCopy via !Printers if required.
  47. .nost
  48. !runimage: \t}Desktop Handler for JGPrint-JGConfig desktop icon and options;
  49. .nost
  50. JG<misc>:  \t}various miscellaneous JGUtilities to go in the library.
  51. .setst ::
  52.  
  53. NB icons on the icon bar will change, perhaps unexpectedly; see 'Icon
  54. transmutation' below.
  55.  
  56. The usual !boot, !run, !runimage, !Sprites and Templates live in !jgp.
  57. JGEd-JGPrSlave live in the Tools subdirectory of !jgp; various auxiliary files
  58. (see below) must also live in the Info subdirectory of the !jgp directory for
  59. the application to work, and, in particular, to provide online documentation in
  60. JGEd and JGConfig; the pa and q subdirectories contain configuration and font
  61. files.
  62.  
  63. Except for JGEd and JGPrint, for which licence fees are payable, all programs
  64. are distributed without charge subject to the conditions specified in JGLiceDoc,
  65. JGCopydoc and derivatives thereof. The shareware disk holds JGSharED and
  66. JGSharePr: substitutes with restrictions (see below) for JGEd and JGPrint,
  67. which, unlike those on some demo disks I have seen, are by no means totally
  68. useless. All programs are copyright (C) JGLaski, 1992.
  69.  
  70. JGPrint/JGSharepr can be put into JGDoc(ument) mode, and in this mode JGSharePr
  71. loses its shareware restrictions; I distribute the system in this mode. See
  72. discussion below.
  73.  
  74. The directory Docs contains JGPrint files that document JGEd, JGPrint, JGPCopy,
  75. JGConfig, JG<misc> and detail licensing rules. Start with JGDocdoc for the doc
  76. mode of JGPrint (JGDoc). These files are themselves JGPrint files, and,
  77. although, as ascii files, they can be read in any editor (e.g. drag them to the
  78. JGEd icon), to obtain well\-laid out texts, apply JGDoc/Print to them by double
  79. clicking on their own icons. For JGDoc, these will be JGPcopy files in a
  80. directory docs.doc, and double clicking on these will, via a menu, show them on
  81. screen or send them to your printer.
  82.  
  83. [The 'Learner Driver's Manual' in the directory Driman is designed to provide a
  84. beginner's guide to JGEd/JGPrint for people without much computing or
  85. word\-processing  experience.]
  86.  
  87. What follows details the operation of the JGP suite, explains how the files
  88. should be installed and documents desktop operation that may not be obvious from
  89. the menus; I recommend you skim it, at least, on first reading.
  90.  
  91. In principle, throughout these programmes, when textual prompts occur, the keys
  92. for the various responses are shown in brackets. Any other key denies the
  93. suggested responses; on the mouse, Select is usually equivalent to the first
  94. suggested response and Adjust to the second (often a denial). In principle, the
  95. usual way through each dialogue is obtained  by a sequence of Select clicks.
  96.  
  97. In the desktop, JGEd/Print/Config all engage the user in a dialogue. Therefore,
  98. they use the whole screen, but while waiting for user input, enable the
  99. processor to get on with any concurrently active desktop task. Moreover, they
  100. can be 'hidden' in a latent desktop window in order to have full access to the
  101. desktop; thence, clicking on their window brings up a menu to continue their
  102. user dialogue, or other appropriate actions.
  103.  
  104. As soon as the !jgp application is opened in a filer viewer on the desktop, it
  105. sets the system variable jgp$dir to <path>.!jgp and defines and provides icons
  106. for four types of files, JGPrint, JGEd, JGPConfg and JGPCopy. It also sets
  107. Tools.JGPcopy to print any files of type JGPCopy for the printer manager. If the
  108. JGPCopy standalone application is active, this latter will be caused to quit
  109. without, of course, losing any files that are being printed or viewed. (NB. as
  110. at 1/93 a potential bug, and how to get round it, is reported.)
  111.  
  112. .col
  113. |The Icon bar Icons & their Transmutation
  114.  
  115. Double clicking on !jgp will register a JGEd icon on the icon bar. Double
  116. clicking on any file of type JGEd, JGPrint or JGPCopy will apply, respectively,
  117. JGEd, JGPrint or JGPCopy to that file; if an icon bar icon has not yet been
  118. registered, a JGEd icon will also be registered on the icon bar, irrespective of
  119. which type of file was double clicked.
  120.  
  121. In the normal case,  dragging a file to the icon bar icon will apply
  122. JGEd, JGPrint or JGPCopy to it, according to which icon is on the icon bar.
  123.  
  124. However, the choice Settype in the icon bar icon menu, if ticked, will, once
  125. only, unless " + hold" below it is also ticked, set a file's type to whichever
  126. of JGEd, JGPrint, JGPCopy has its icon on the icon bar when the file is dragged
  127. to the icon bar icon.
  128.  
  129. In the icon bar menu, and its options submenu, those choices that do not
  130. relate to the icon on the icon bar are shaded.
  131.  
  132. Clicking select on the icon bar icon transmutes it to a JGEd icon, unless, of
  133. course, it already is, in which case it transmutes to a JGPrint icon. Choosing
  134. Jgpcopy in the icon bar icon's menu transmutes the icon to a JGPCopy icon,
  135. unless, of course it already is, in which case it transmutes to a JGEd icon.
  136. These rules give priority to JGEd, then JGPrint, then JGPCopy, which reflects
  137. what the user will find most convenient. Clicking with adjust acts equivalently,
  138. but also opens the menu.
  139.  
  140. Dragging a file to the JGPCopy icon, in addition to applying JGPCopy to the
  141. file, transmutes the icon bar icon to JGEd; this transmutation can be cancelled
  142. if " + hold" below JGPCopy is ticked.
  143.  
  144. ,col
  145. |Options
  146.  
  147. If the JGEd icon is on the icon bar, you can, from the main menu, arrange
  148. to create a new file for editing. From the option menu you can, roughly, set the
  149. size of the buffer within which JGEd will edit. You can also set JGEd to use
  150. whatever screen mode you require, (NB it uses VDU4 characters), to operate in
  151. view rather than edit mode, to accept rather than query vdu characters, and not
  152. to engage its backup facilities.
  153.  
  154. If the JGPrint icon is on the icon bar, you can, from the main menu, run
  155. JGConfig, a program to edit configuration files. From the option menu, you can
  156. set which configuration JGPrint and JGonfig will first offer you. In either
  157. program,, you may, of course, reject this first choice, and you will be shown
  158. the choices available. Configuration files and proportionally spacing files are
  159. held in the directories ...!jgp.pa and ...!jgp.q; the file !jgp.AJGCdnames is
  160. used by JGConfig.
  161.  
  162. If the JGPCopy icon is on the icon bar, you can, from the main menu, arrange to
  163. hold it on the icon bar as described above.
  164.  
  165. Please explore the various option menus to see what flexibility is provided.
  166.  
  167. .col
  168. |Screen Modes
  169.  
  170. All the JG programs will work in all screen modes. Howver, 16 colour modes are
  171. recommended, particularly for JGEd. JGEd starts in the desktop mode unless
  172. another mode were chosen from the option submenu of the JGEd iconbar icon menu;
  173. this menu, as the JGPCopy run menu accesses a window whose icon enables you to
  174. cycle through the available 16 colour modes.
  175.  
  176. JGEd allows a more detailed control via its extended command md<n>.\|
  177.  
  178. JGPrint's initial dialogue takes place in its own window; so can its operation.
  179. However, depending on what you choose to JGPrint To, you most probably will be
  180. offered the choice of running in the desktop; if so, via JGPrint's menu, you may
  181. swap between the two ways of running as you wish.
  182.  
  183. .col
  184. |From the commandline
  185.  
  186. JGEd, JGPrint, and JGConfig work equally well from the commandline. You have
  187. to set jgp$dir to <path>.!jgp by hand. I recommend putting the files (J)ed and
  188. (J)print in the library, together with JGExist, which they call on. Then
  189. JGEd/SharEd and JGPrint/JGSharePr are available irrespective of what
  190. directory you are in. The JGPrograms no longer use the other JG<misc> programs,
  191. but I have not wiped them in case they can be useful elsewhere. JGEd has a
  192. switch -b <n> to choose your editing buffer size. If you do not give JGEd a file
  193. argument, you will see a list of the switches available.
  194.  
  195. All the JGPrograms will work without extra arguments on the commandline,
  196. engaging the user in a dialogue to evoke those they need; personally, I usually
  197. give JGEd the name of the file it is to work on from the commandline, but not
  198. JGPrint or JGConfig.
  199.  
  200. If the desktop is not present programs run with bright colours on a dark
  201. background (which I prefer) rather than dark colours on a white background.
  202.  
  203. Without the desktop and unnecessary modules present, JGEd can grab a bigger
  204. buffer, and therefore edit enormous files. I doubt that this will concern
  205. people with more than 1Mb of store.
  206.  
  207. NB under Riscos 2 running from the F12 window is fine. but Riscos 3.1 gives a
  208. "Wimp is currently active" complaint; you can successfully click on j(ed) in the
  209. library or on Tools.JGEd.
  210.  
  211. .col
  212. |JGDoc v. JGPrint Mode
  213.  
  214. JGDoc mode provides a cut-down use of JGPrint that avoids the need for
  215. configuration files, simply producing a laid\-out JGPCopy file that can be
  216. clicked on either to view or to pass to the printer. Printer commands are not
  217. produced. JGPrint capabilities that depend on auxiliary files can be used
  218. except for initialising user variables from a file. Applied to a JGPrint file
  219. <path>.foo, JGDoc yields a well\-laid out JGPCopy file <path>.doc.foo, which can
  220. be double clicked for JGPCopy to show on screen or pass to printer. In JGDoc
  221. mode JGSharePr has no restrictions relative to JGPrint.
  222. .if 1
  223. !Clickme in !jgp.Info was produced by applying JGDoc to this file.
  224. .fi
  225.  
  226. If the desktop is active, JGDoc works entirely in the desktop in RisCOS2
  227.  
  228. See JGDocDoc/Info for details of how the user can arrange to get the page size
  229. she wants and to get £ to print out correctly on her printer.
  230.  
  231. JGDoc also provides a range of powerful tools for  documenters to organise and
  232. structure their material. The JGFooDoc files provide a range of examples; in
  233. particular, JGDocDoc is organised in a quasi-tutorial fashion. All texts
  234. prepared for JGPrint mode will be accepted and treated sensibly in JGDoc mode.
  235. (NB. those directives such as changing inter\-line spacing or italicising that
  236. depend on issuing printer commands will be ignored.)
  237.  
  238. The file !jgp.Info.JGPStrings lists the strings with which !JGPrint engages you
  239. in dialogue. See xmp.EXAlien for how to enable it to speak in alien tongues.
  240. (This will be replaced by Messages in due course.)
  241.  
  242. The presence/absence of the character '*' as the first character in JGPStrings
  243. determines whether JGPrint/JGSharePr runs in JGDoc or JGPrint mode. I distribute
  244. with the * included for JGDoc mode and request that the shareware disk should be
  245. so passed on. (When Messages have been implemented, an analogous facility will
  246. be provided.
  247.  
  248. In JGDoc mode, the printer configuration files in !jgp.pa and !jgp.q are not
  249. used, and printer codes are not sent to the JGPrinted file. (You can use JGEd
  250. to edit in the bytes you need, but I think this could only be worth it to
  251. initialise the printer to the font and line\-spacing you require; on most
  252. printers you can get the same effect from the front panel.) JGDoc runs without
  253. an initial dialogue and you can specify auxiliary files for merging or indexing
  254. when they are needed in the run. (Included files (qv.) work fine.)
  255.  
  256. The exact interpretation of Hatty directives (^^<char>) in JGPrint mode depends
  257. on the configuration file used; in JGDoc mode an ad\-hoc convention is used, so
  258. that is unlikely that you will get the non\-ascii special characters you want
  259. unless you prepare the text specifically for JGDoc mode.
  260.  
  261. JGPrinDoc/JGPrintInf documents the JGPrint facilities that depend on auxiliary
  262. files or configuration files and printer directives. These, of course, are only
  263. available in JGPrint mode without the initial star in JGPStrings.
  264.  
  265. .col
  266. |JGPCopy
  267.  
  268. This program manages the copying of files to screen and printer, and, through
  269. its menus, is virtually self\-documenting. One option determines the mode in
  270. which the file should be seen on the screen, another how many copies of the file
  271. should be printed. It is entered either by double clicking on a JGPCopy file or
  272. by dragging any file to a JGPCopy icon on the bar, obtained from a JGEd icon as
  273. described above. On engaging, it registers a JGPCopy icon with the filename on
  274. the icon bar, and opens its menu; it also enables a dump of a file to be seen on
  275. the screen and spooled to a file.
  276.  
  277. See JGCopyDoc/!ClickJGPC in !jgpcopy for further information'
  278.  
  279. JGPCopy may also be run from the application !jgpcopy, and, for this use I do
  280. not charge a licence fee. However, see JGCopyDoc/!ClkmeJGPC for detailed rules
  281. of the game.
  282.  
  283. .col
  284. |!jgMkakeCh
  285.  
  286. This application builds character definition files for use in JGEd or elsewhere.
  287. For documentation see JGCharDoc.
  288.  
  289. .\ \Q
  290. .col
  291. |Shareware restrictions
  292. .col
  293. |======================
  294. .usel base
  295.  
  296. JGSharEd will, as detailed in JGEdDoc, after a few autosaves, refuse to make
  297. further edits and refuse to save the edited text (a recently updated version
  298. will be found in autosave>). A user can work out a way to use it without losing
  299. any editing, but the discipline is a nuisance.
  300.  
  301. JG(Share)Pr will, after a very few pages, except in JGDoc mode or when
  302. JGPrinting to screen, insert a random amount of white space and a message
  303. between the header and the body of the text on the page.
  304.  
  305. I hope these nuisances will encourage you to buy licences.
  306.  
  307. .\ \Q
  308. .col
  309. |Documentation
  310. .col
  311. |=============
  312. .usel base
  313.  
  314. Primary documentation is in the directory Docs and consists of:
  315. .nofj
  316. .\ \Q
  317. JGCfgDoc;   JGCodeInfo;     JGdocdoc;       JGEddoc;    JGEddoc1;   JGLicedoc;
  318. JGPCopydoc; JGPDiscuss      JGPrintdoc;     JGPrPrmdoc; Rdmedoc;    JGCharDoc
  319.  
  320. Additional documentation, also available online, is in !jgp.info is:
  321. !ClickmeJG; Halp_JGEdL;     Halp_JGPrn;     Help_JGEdI; Help_JGEdK; Help_JGEdL
  322. Help_JGEdM; Help_JGPrn;     jgcfginfo;      JGPStrings
  323.  
  324. In the directory xmp are some examples of advanced uses of JGPrint:
  325. EXALIEN;    ExChars;        EXDIARY;        exlayout;   EXLBL;      EXLBLM;
  326. EXLONGD;    EXMERGE;        EXMERGM;        EXNOTE;     EXTAB;      EXTIME;
  327. EXTIMELAY;
  328. .usel base
  329.  
  330. After applying JGPrint/Doc to these files, I call them JGDocInfo etc.
  331.  
  332. !ClickmeJG in !jgp.info is this file Rdmedoc, JGDocced. You should JGDoc the
  333. others and rename the JGDocced versions JGEdInfo etc. JGCodeInfo is excerpts
  334. from JGPrint's code that may interest programmers. JGCfgDoc is the source of the
  335. online file JGCfginfo in !Jgp.info. JGCopyDoc is the source of !ClickJGPC in
  336. !jgpcopy.
  337.  
  338. Exlblm and exmergm are merge files for exlbl and exmerge; extimelay is an
  339. included file for extime; oxdiary is an illustration of the use of exdiary.
  340. The reader is warned that the directives in these example files, and their
  341. effects, take quite some thinking out. I reccommend having both the source text
  342. and the JGDocced text to compare.
  343.  
  344. !jgp.Tools contains JGEd, JGSharEd, JGPrint, JGSharePr, JGConfig, JGPCopy and
  345. JGPrSlave; JGEd and JGPrint are not included in the shareware disk.
  346.  
  347. !jgp.pa and !jgp.q contain printer configuration files used by JGPrint and
  348. examinable/updateable by JGConfig, as is info.Ajgcdnames. JGPrint requires
  349. !jgp.pa.default to be present unless used in JGDoc mode.
  350.  
  351. For running from the command line your Library should contain JEd, JPrint and
  352. JGExist; The first two are simple scripts which you may find you want to rename.
  353.  
  354. .col
  355. |**************
  356.  
  357. .\ \Q
  358. .col
  359. |Licence
  360. .col
  361. |=======
  362. .usel base
  363.  
  364. JGSharePr, JGSharEd, JGPCopy and all documentation is Copyright JGLaski 1991
  365. and may be freely used subject to the rules and obligations specified in
  366. JGLiceDoc, or those texts derived from it.
  367.  
  368. Jed, JGArcsel, JGBusel, JGExist, JGFtop, JGLength, JGPrepare, JPrint, JGQuery,
  369. and JGshort are Copyright JGLaski, 1990, and have been put in the public
  370. domain Nov 1990.
  371.  
  372. Subject to the conditions detailed in JGCopyDoc, a free licence is available for
  373. the application !jgpcopy.
  374.  
  375. A licence for one machine for JGEd is obtainable for £45, for JGPrint for £45;
  376. the most uptodate versions will, of course, be provided. A combined licence
  377. forthe pair is £80. A Handling charge of £5 is normally made; for my address,
  378. see below. See JGLicedoc, for more details.
  379.  
  380. This disk (without JGED or JGPrint) should be distributed as widely as
  381. possible.
  382.  
  383. The use of JGDoc/print for distributed material is subject to licence. See
  384. JGLiceDoc for details.
  385.  
  386. No responsibility is taken for the accuracy of these programs, or for any
  387. consequences of using them, though, of course, every effort has been made to
  388. ensure their reliability and usefulness.
  389.  
  390. You are obligated, when passing on this shareware, not to remove any files or
  391. text.
  392.  
  393. .col
  394. |**************
  395.  
  396. Please tell me of any problems with, or suggest any improvements to, JGDoc,
  397. JGPrint, JGEd and JGPCopy, and their documentation. See JGLicedoc for the rules
  398. of the game.
  399.  
  400.  
  401. .\ \Q
  402. .col
  403. | |J.G.Laski      |
  404. .col
  405. | |18 Ebury Street|
  406. .col
  407. | |London         |
  408. .col
  409. | |SW1W OLU       |
  410. .col
  411. | |JGPrinted on \d