home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / tex / semtex / !SemTeX / !Help next >
Text File  |  1994-12-18  |  6KB  |  123 lines

  1.  
  2.  
  3.                             SemTeX User Manual
  4.                             ------------------
  5.  
  6.  
  7. About SemTeX
  8. ------------
  9. SemTeX is a utility for easy handling of files for the TeX/LaTeX document preparation package. It is of use only if you have a port of TeX for RiscOS, for example ArmTeX.
  10.  
  11. Features of SemTeX:
  12.  
  13. * Control window with history, i.e. a list of the documents that have been
  14.   loaded so far.
  15. * At the click of a button you can
  16.     + Edit a TeX document
  17.     + Run TeX/LaTeX on a document
  18.     + Load the TeX output into a DVI-previewer
  19.     + Convert the TeX output to PostScript
  20.     + Tidy a document directory
  21. * Reacts to:
  22.     + Shift-doubleclick on a document directory
  23.     + Doubleclick+hold on a document directory
  24.     + Dropping a document directory on the iconbar icon
  25.       or on the Control window
  26. * Configurable:
  27.     + How to react to the mouse operatons listed above
  28.     + What to do when running TeX, LaTeX etc.
  29.     + What files to remove when tidying a directory
  30. * Can convert file names in RiscOS format (foo.tex) to DOS format (FOO/TEX)
  31.  
  32. SemTeX is FreeWare. For conditions of use, read the copyright notice at the end of this manual.
  33.  
  34.  
  35. Starting
  36. --------
  37. The program installs itself on the icon bar. Click Select on the icon to open the Control window. (Adjust-clicking closes it again.)
  38.  
  39.  
  40. The Control window
  41. ------------------
  42. How you add files to the list in the Control window depends on how you have configured SemTeX, but let's assume you are using the default. You can add TeX/LaTeX documents to the list in the Control window by dropping the document directory on the iconbar icon, or on the Control window itself. SemTeX scans the directory for a file that looks like a TeX document, and if it finds one(*), the name of the document will be added to the list. 
  43.  
  44. (*) SemTeX assumes that a file is a TeX document if:
  45.     + It has filetype Text (&fff), TeX (&2a7) or LaTeX (&2a8), and
  46.     + It has leafname "tex", "sty", "bst" or "bib"
  47.  
  48. You can perform the various actions on a document by selecting it in the list and clicking on the appropriate button. If you click with Adjust, the Control window will be closed afterwards.
  49.  
  50. You can remove a document from the list by clicking the Menu button on the document, and clicking on "Remove". A faster way to remove it is Shift-Menu.
  51.  
  52.  
  53. Editing files
  54. -------------
  55. Select a document and then click on the "Edit" button. Alternatively, double-click on a document in the list. In the default configuration, you can also edit a file by
  56.  
  57.   * Shift-doubleclick on a directory in a Filer window
  58.   * Doubleclick+hold on a directory ("hold" means keeping the mouse button
  59.     pressed down for about 0.2 seconds after the 2nd click)
  60.  
  61. SemTeX sends broadcasts a request to edit the file. If no editor is running at the moment, SemTeX will start one.
  62.  
  63.  
  64. Running TeX/LaTeX/BibTeX/dvips
  65. ------------------------------
  66. Select a document in the Control window and click on the appropriate button. In the default configuration, SemTeX 
  67.  
  68.   * Sets the current directory to the parent directory of the document. This
  69.     may be needed if there are other input files (style files etc.) that must
  70.     be read while processing your document.
  71.   * Runs TeX/LaTeX/BibTeX/dvips in a TaskWindow.
  72.  
  73. The default configuration will work with the ArmTeX distribution that has been prepared by Robin Watts. If you have another setup, then edit the files "Messages" in the !SemTeX application directory.
  74.  
  75.  
  76. Other buttons
  77. -------------
  78. "Preview" loads the dvi file that TeX has produced into a previewer (!DVIview). If the previewer is not running, it will be started (provided it has been "seen" by the Filer).
  79.  
  80. The "Open Dir." button opens the document directory.
  81.  
  82. The "Tidy Dir." button tidies the document directory. That is, it removes a couple of files that can be regenerated easily (default: log, aux, blg, toc, ps).
  83.  
  84.  
  85. Creating new documents
  86. ----------------------
  87. To create a new document directory, popup the menu on the iconbar icon and go to the "Create =>" submenu. Fill in a name for the directory and drag it to a Filer window. SemTeX then creates a directory with an empty file "tex" in it, and starts an editor on the file.
  88.  
  89.  
  90. Configuring
  91. -----------
  92. In the Choices window you can choose how SemTeX reacts to mouse clicks. Click on a "menu" button, and select the action from the menu. "OK" activates the choices, also "Save" stores them on file.
  93.  
  94. You can edit the "Messages" files. The comments in the file explain how to change the contents. Configurable are:
  95.  
  96.   * The commands to be executed when TeX/LaTeX/etc. are run.
  97.   * The maximum number of documents in the Control window.
  98.   * What files "Tidy Dir." should remove
  99.  
  100.  
  101. Filename conversion
  102. -------------------
  103. If you want to transfer TeX files to/from a computer with another operating system, you have to convert the filenames. For instance, in RiscOS a document called 'foo' is represented as a directory 'foo', with a file named 'tex' in it; on an MSDOS floppy this file is named 'FOO/TEX'. You can rename the files by hand of course, but SemTeX can save you the trouble.
  104.  
  105. First, open the 'Convert' window, by choosing "Convert..." from the menu on the icon bar. Second, drag the stuff that you want to convert from its Filer window to the Convert window. And third, drag the icon from this window to a Filer window. You can drag an entire document directory to convert; in that case all the files in it will be converted. You can convert multiple files in one go, but the sort of conversion must be the same (i.e. from DOS -> RiscOS format or the other way around).
  106.  
  107.  
  108. Copyright notice
  109. ----------------
  110. This program is FreeWare. This means that I retain the copyright. You may freely copy and distribute it, provided that it is complete with all original files, and that you do not sell it. PD libraries may charge a nominal fee for the cost of duplication, postage etc. When you use the program, you do so entirely at your own risk. You may change the program to suit your own needs. If it's a bug fix, or if you think it's an improvement, then please send the changes to me at the address below.
  111.  
  112. The MenuUtils module is © Alex Petrov.
  113.  
  114. If you have any questions, bug reports or suggestions for improvements, you can contact me at the following address:
  115.  
  116. Lijnslagerstraat 204
  117. NL-5625BP  Eindhoven
  118. The Netherlands
  119.  
  120. or by e-mail: wsinda@win.tue.nl
  121.  
  122. Dick Alstein
  123.