home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / t / tex / !DaTeX / !Help next >
Text File  |  1994-06-02  |  18KB  |  644 lines
  1.                    Help file for DaTeX
  2.                    ===================
  3.  
  4.                       Version 3.10
  5.  
  6.                  © Vampire Products 1994
  7.                  
  8. This product is FreeWare. You are free to copy it
  9. providing all accompanying files are included and no
  10. charge, other than to cover costs, is made.
  11.  
  12. 0. Contents
  13. -----------
  14. 1 What is DaTeX?
  15. 2 Starting DaTeX
  16. 3 Using DaTeX
  17.    3.1 The Control Window
  18.       3.1.1 Editing a TeX document
  19.       3.1.2 Viewing a DVI file
  20.       3.1.3 Printing the DVI file
  21.       3.1.4 Viewing the last log
  22.       3.1.5 Opening the directory viewer
  23.       3.1.6 Tidying the directory
  24.       3.1.7 Processing the document
  25.    3.2. The Choices window
  26.       3.2.1 The Save icon
  27.       3.2.2 The Apply icon
  28.       3.2.3 The Multi-task option
  29.       3.2.4 The Virtual option
  30.       3.2.5 Memory allocation
  31.          3.2.5.1 The sliding bar
  32.          3.2.5.2 The < and > arrows
  33.          3.2.5.3 The writable icon
  34.       3.2.6 The Auto Run option
  35.       3.2.7 The Auto Edit option
  36.       3.2.8 The Print to file option
  37.       3.2.9 The Printer menu icon
  38.    3.3 The Create as Window
  39.       3.3.1 Creating LaTeX documents
  40.    3.4 The Task Output Window
  41.       3.4.1 Pausing the task
  42.       3.4.2 Resuming the task
  43.       3.4.3 Killing the task
  44. 4 Printers
  45. 5 The DaTeX$Options system variable
  46. 6 ArMaTuReS support
  47. 7 Problems
  48.    7.1 !Virtual
  49.    7.2 DVI converter names
  50.    7.3 Task input
  51. 8 Acknowledgements
  52. 9 Disclaimer
  53. 10 Contacting me
  54.  
  55.  
  56. 1. What is DaTeX?
  57. -----------------
  58.  
  59.   DaTeX is a WIMP front-end to the ArmTeX suite of
  60. programs ported by Mark Sinke. It assumes that you
  61. already have ArmTeX installed and set up how you
  62. like it.
  63.  
  64. So why should you use DaTeX if TeX already exists?
  65. The answer to this is that it allows you to do
  66. things that running TeX from the command line does
  67. not letyou do easily.
  68.  
  69.   1 - View the DVI file automatically when finished
  70.       processing.
  71.  
  72.   2 - Multi-task whilst processing a document.
  73.  
  74.   3 - Process the DVI file and send it to the
  75.       printer
  76.  
  77.   4 - Easy creation of new TeX documents with a set
  78.       of customizable default files.
  79.  
  80.   5 - Automatic re-processing of LaTeX documents
  81.       with cross-references when necessary.
  82.  
  83.   6 - Support for Virtual (See problems below)
  84.  
  85.   7 - Support for ArMaTuReS
  86.  
  87. N.B. DaTeX is heavily biased towards using LaTeX
  88.      since that is the format I use most often.
  89.  
  90. 2. Starting DaTeX
  91. -----------------
  92.  
  93.   To start DaTeX double click on the !DaTeX icon in
  94. the directory viewer. The application will load and
  95. appear on the right side of the icon bar.
  96.  
  97. You can use some of the available options without
  98. having TeX "visible" to the system but it isn't all
  99. that useful. I suggest that you add the line
  100.   Filer_Run <your apps directory path>.!DaTeX
  101. to the TeXPaths file, inserting the appropriate
  102. path name to automatically load DaTeX when using
  103. TeX.
  104.  
  105.  
  106. 3. Using DaTeX
  107. --------------
  108.  
  109.   To inform DaTeX which file to process drag either
  110. the directory containing the TeX file, or the TeX
  111. file itself to the DaTeX icon on the icon bar.
  112. Double-clicking on TeX or LaTeX files will also
  113. achieve the same effect but only if DaTeX is running.
  114. What happens next depends on the options you have
  115. selected (see Choices window below).
  116.  
  117. One of four things will happen :-
  118.  
  119.   1 - The document will be processed
  120.   2 - The document will be loaded into an editor
  121.   3 - Both of the above
  122.   4 - The Control window will appear
  123.  
  124. The default is for the Control window to appear.
  125.  
  126.   To process the current document either use the
  127. Control window, or click the Left mouse button on
  128. the DaTeX icon.
  129.  
  130.   To view the DVI file either use the Control
  131. window or click the Right mouse button on the DaTeX
  132. icon.
  133. When using the DaTeX icon, if the TeX file has been
  134. updated it is automatically re-processed before
  135. viewing.
  136.  
  137.  
  138. 3.1 The Control Window
  139. ----------------------
  140.  
  141.   This is the main DaTeX control area. The current
  142. document is displayed in the box.
  143.  
  144. This window is opened when the Control menu option
  145. is selected or if no Auto options are set.
  146.  
  147. There are a number of available options :-
  148.  
  149.   1 - Edit the document
  150.   2 - View the document
  151.   3 - Print the document
  152.   4 - View the last log for the document
  153.   5 - Open a directory viewer containing the
  154.       document
  155.   6 - Remove all the non-essential files from the
  156.       document directory
  157.   7 - Process the document
  158.   
  159. 3.1.1 Editing a TeX document
  160. ----------------------------
  161.  
  162.   When the Edit Document icon is selected, or if
  163. the Auto Edit option is set, DaTeX will attempt to
  164. load the the TeX file into an editor. If an editor
  165. is already loaded it will pass it to that editor,
  166. if not the default editor is loaded and the TeX
  167. file is passed to that.
  168.  
  169.  
  170. 3.1.2 Viewing a DVI file
  171. ------------------------
  172.  
  173.   If a DVI viewer is already loaded, DaTeX will
  174. pass that the DVI file, otherwise the default
  175. viewer will be loaded and the file passed to it.
  176.  
  177. If the View Document icon was selected, the current
  178. DVI file will be viewed, however if the DaTeX icon
  179. was clicked with the Right mouse button a check
  180. will first be made to see if the TeX file has been
  181. altered since the DVI file was created. If it has
  182. been then the TeX file will be re-processed and the
  183. resulting DVI will be viewed.
  184.  
  185.  
  186. 3.1.3 Printing the DVI file
  187. ---------------------------
  188.  
  189.   If the Print Document icon is selected then the
  190. DVI file will be passed to the currently selected
  191. DVI converter (See Printers below). The resulting
  192. file will then be sent to the !Printers application,
  193. unless the Print to file option has been set (see
  194. Choices window below).
  195.  
  196. DaTeX does not check whether the correct printer
  197. type has been activated, it relies on the !Printers
  198. application to do any necessary checks.
  199.  
  200.  
  201. 3.1.4 Viewing the last log
  202. --------------------------
  203.  
  204.   Whenever TeX processed a document it stores a
  205. log of the files included and any errors that occur.
  206. Choosing the View Last Log icon will load this into
  207. a editor for perusal should you wish to refer to
  208. something, e.g. how you corrected an error.
  209.  
  210.  
  211. 3.1.5 Opening the directory viewer
  212. ----------------------------------
  213.  
  214.   Selecting the Open Directory icon will open the
  215. directory viewer which contains the current TeX
  216. document.
  217.  
  218.  
  219. 3.1.6 Tidying the directory
  220. ---------------------------
  221.  
  222.   Selecting the Tidy Directory icon will remove the
  223. TeX information files such as 'aux','log','toc',
  224. from the current TeX documents directory.
  225.  
  226.  
  227. 3.1.7 Processing the document
  228. -----------------------------
  229.  
  230.   The bottom line of icons determine how TeX should
  231. process the document. Choosing the LaTeX icon
  232. processes the file as a LaTeX document, choosing
  233. the SliTeX icon processes it as a SliTeX document,
  234. etc.
  235.  
  236. This determines how the document will be processed
  237. when clicking on the DaTeX icon.
  238.  
  239.  
  240. 3.2 The Choices window
  241. ----------------------
  242.  
  243.   This window allows you to configure how DaTeX
  244. works. It is opened by selecting the Choices menu
  245. option. If the window is closed without selecting
  246. the Save or Apply icons then any changes made are
  247. discarded.
  248.  
  249.  
  250. 3.2.1 The Save icon
  251. -------------------
  252.  
  253.   Selecting the Save icon will close the Choices
  254. window, save the current options as the default
  255. options on start up, and apply the changes for the
  256. rest of the session.
  257.  
  258.  
  259. 3.2.2 The Apply icon
  260. --------------------
  261.  
  262.   Selecting the Apply icon will close the Choices
  263. window and apply the changes made to the rest of
  264. the session.
  265.  
  266.  
  267. 3.2.3 The Multi-task option
  268. ---------------------------
  269.  
  270.   If the Multi-task option is set then when
  271. processing a TeX document it will be run in a 
  272. TaskWindow, allowing you to continue using the
  273. desktop while it is running. You do not have to
  274. have a TaskWindow providing editor loaded to use
  275. this facility.
  276.  
  277. If this option is not selected then when processing
  278. a TeX document it takes over control from the
  279. desktop and only returns it when the processing is
  280. complete.
  281. This is faster than running in a TaskWindow.
  282.  
  283.  
  284. 3.2.4 The Virtual option
  285. ------------------------
  286.  
  287.   If the Virtual option is set then DaTeX will
  288. attempt to use the !Virtual application to enable
  289. larger documents to be processed. When set the
  290. amount of memory allocated is in terms of Mb of
  291. disc swap space rather than Kb of RAM.
  292.  
  293. If this option is set then all processing will be
  294. multi-taskin