home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / epmtfe30.zip / source.zip / source / compile.txt next >
Text File  |  2000-05-12  |  8KB  |  228 lines
  1. ========================================================================
  2.                   Compiling the EPM TeX Front End v3.0
  3. ========================================================================
  4.                                                               2000-04-19
  5.  
  6. Contents
  7. --------
  8.    Module vs. "Pro" version
  9.    Compiling the EPM TeX Front End module
  10.    Compiling the TeX Front End "Pro"
  11.    emTeX vs. VTeX version
  12.    Configuration constants and extra features
  13.    Sample EPM configuration files
  14.    Special features of the "Pro" version
  15.    Debugging
  16.  
  17.  
  18.  
  19. Module vs. "Pro" version
  20. --------------------------
  21. The E language source code of the EPM TeX Front End is provided, so that
  22. you can generate either
  23.  
  24. * a module texfe.ex (as shipped with the distribution), or
  25.  
  26. * a complete EPM with integrated TeX Front End, the "Pro" version".
  27.  
  28.  
  29.  
  30. Compiling the EPM TeX Front End module
  31. --------------------------------------
  32. Compiling the file texfe.e by
  33.  
  34.         ETPM texfe
  35.  
  36. generates the module texfe.ex.
  37.  
  38.  
  39.  
  40. Compiling the TeX Front End "Pro"
  41. ---------------------------------
  42. Creating an EPM with integrated TeX Front End requires the following
  43. steps:
  44.  
  45. 1) add the contents of MYSTUFF.ADD to your file MYSTUFF.E
  46.  
  47. 2) add the contents of MYMNUINI.ADD to your file MYMNUINI.E
  48.  
  49.    (In case one of the above .E files does not exist, you just have to
  50.    rename the .ADD file.)
  51.  
  52. 3) provide a suitable configuration file MYCNF.E.  (See the sample
  53.    MYCNF.SMP that comes with the distribution.)
  54.  
  55. 4) Compile the EPM, including the settings defined in MYCNF.E:
  56.  
  57.         ETPM epm
  58.  
  59. Caution:  Do not link texfe.ex or tex.ex with the Pro version!
  60.  
  61.  
  62.  
  63. emTeX vs. VTeX version
  64. ----------------------
  65. This is controlled by the compile-time variable vtex, which may or may
  66. not be defined in the general EPM configuration file MYCNF.E.
  67.  
  68. The statement
  69.  
  70.         define vtex = 1 
  71.   
  72. causes the EPM TeX Front End for VTeX/2 to be generated.  Without this
  73. variable, the `classical' TeX Front End for use with emTeX or Web2c will
  74. be compiled.
  75.  
  76.  
  77.  
  78. Configuration constants
  79. -----------------------
  80. The following const's are read from the file MYCNF.E:
  81.  
  82. NLS_LANGUAGE
  83.  
  84.     Set this const to 'DEUTSCH' in order to generate a German version.
  85.     Languages other than English (default) and German are currently not
  86.     supported.  Caution:  In order to compile a German version of the
  87.     full EPM you need the file DEUTSCH.E which is NOT part of the free
  88.     EPM package!
  89.  
  90. WANT_TEX_MENU
  91.  
  92.     Define const WANT_TEX_MENU = 0 in MYCNF.E to omit the TeX menu.  Do
  93.     _not_ add the contents of MYMNUINI.ADD to MYMNUINI.E in case you
  94.     compile the Pro version without the menu!  The default value is 1, 
  95.     so that the menu is usually included.
  96.     
  97. LATEX_SYNTAX_INDENT
  98.  
  99.     Indentation within LaTeX environments.  The default value is 2 (not 
  100.     depending on SYNTAX_INDENT).
  101.     
  102. WANT_STREAM_INDENTED
  103.  
  104.     This const applies to the the basic EPM, not to the TeX Front End.
  105.     Setting it to 1 makes the <enter> key move the cursor always to the
  106.     starting column of the previous line.  This is useful in conjunction
  107.     with EPM's syntax assist for LaTeX and other `languages'.  Defining
  108.     WANT_STREAM_INDENTED requires, however, compilation of the full EPM,
  109.     either with or without built-in texfe.
  110.     
  111. WANT_CTRLA
  112.  
  113.     const WANT_CTRLA = 1 will map the bracket matching facility of the
  114.     EPM, which is usually triggered by Ctrl-[, to the Ctrl-a key, too.
  115.     This is particularly useful with, e.g., the German keyboard, where
  116.     the original key assignment would require pressing Ctrl-AltGr-[.
  117.     The German versions were compiled with this feature turned on.
  118.  
  119. WANT_INCLUDEONLY_SUPPORT
  120.  
  121.     const WANT_INCLUDEONLY_SUPPORT = 1 will enable a special facility
  122.     related with master file support:  When master file support is ON
  123.     and TeXing is requested while an included file is being edited, then
  124.     the EPM will search the master file for an \includeonly command and
  125.     will replace its argument with the name of the file being edited.
  126.     If there is no \includeonly command found, or if it has been
  127.     commented out, all dependent files will be included, as usual.  The
  128.     facility is also disabled when a marked region is to be typeset.
  129.     There are, however, some important restrictions:
  130.     
  131.     * Only the stem of the filename (neither the path nor the extension)
  132.     is passed to the \includeonly command.  As a result, the included
  133.     file must reside in the same directory as the master file, it must
  134.     be of type '.tex', and the path must not be specified.
  135.     
  136.     * The filename is passed in lowercase to the \includeonly command,
  137.     so you have to use lowercase in the corresponding \include command,
  138.     too.
  139.     
  140.     * The \includeonly command must not be split into two or more lines.
  141.     
  142.     * The \includeonly command must be the only one on its line.
  143.  
  144. EXTENDED_LATEX_ASSIST
  145.     
  146.     const EXTENDED_LATEX_ASSIST = 1 forces Juan J. G. Ripoll's
  147.     experimental auto-indentation and reflowing package for LaTeX to be
  148.     included.  LATEX_SYNTAX_INDENT is ignored then, and the settings
  149.     menu will provide an item for specifying the right margin.  The
  150.     syntax assist facility will slightly differ from the one of the
  151.     original TFE.  See <http://www.arrakis.es/~worm> or
  152.     <mailto:worm@arrakis.es> for the source code of this package.
  153.     
  154.     This package cannot be added to the EPM TeX Front End for VTeX.
  155.     
  156.  
  157.  
  158. Sample EPM configuration file
  159. -----------------------------
  160. The free EPM differs very much from the version shipped with Warp 4,
  161. most noticeably as far as the menu structure is concerned. 
  162. Unfortunately the help texts and the User's Guide reflect the Warp 
  163. version, and there is no configuration file included with the "BBS"
  164. package to create the latter.  Besides, there are some features missing
  165. in the BBS version.
  166.  
  167. I have provided a configuration file MYCNF.SMP, which includes all the
  168. information required to create the "Warp 4 EPM".  Rename it to MYCNF.E
  169. to make the compiler include it.  The file contains information how and
  170. where personal settings and useful extras like syntax assist can be
  171. added.  I recommend including this file for compiling the "Pro" version.
  172. Re-compile the spell-checking module EPMLEX, too, using this MYCNF.E!
  173.  
  174. Please, note the changes to MYCNF.SMP introduced with v2.2:  Syntax
  175. assist for C and Java is now enabled, and a bug with the TAGS facility
  176. has been fixed.  As with v2.4, the EPM will be configured so as to 
  177. auto-convert Unix-style line endings to DOS style.
  178.  
  179. ***   Use of this file does not depend on the texfe being linked!   ***
  180.  
  181. ***   Notice that the file MYKEYS.SMP is no longer provided!        ***
  182.  
  183.  
  184.  
  185. Special features of the "Pro" version
  186. -------------------------------------
  187. * The menu items "Folder" and "Shell" are put into the existent "File"
  188. and "Command" submenus (in German:  "Datei" and "Befehl") if the
  189. standard menu layout STDMENU.E is included upon compilation; otherwise
  190. an additional "OS/2" submenu is provided for them.
  191.  
  192. * Master file support can be toggled either in the settings window or
  193. via a separate item in the TeX submenu.
  194.  
  195. * The actions of the TeX menu are disabled, when the related files are
  196. missing.
  197.  
  198.  
  199.  
  200. Debugging
  201. ---------
  202. The TeX Front End provides the EPM command
  203.  
  204.         tex_debuglevel
  205.  
  206. Enter this command to see the current debug level, initially 0. Enter
  207.  
  208.         tex_debuglevel 1|2|3
  209.  
  210. to get debugging information in the EPM message line:
  211.  
  212. Debug level  | Action 
  213. --------------------------------------------------------------
  214.              |
  215. > 0          | trace all 'cd' commands
  216.              |
  217. = 1          | display the external commands to be launched
  218.              |
  219. > 1          | trace parsing of the TeX transcript file
  220.              |
  221. > 2          | ditto, but lots of information (don't use it!)
  222.  
  223.  
  224. The debug level is set to 0, when the EPM starts up.
  225.  
  226. -- finis
  227.  
  228.