home *** CD-ROM | disk | FTP | other *** search
/ PC go! 1995 September / Image.iso / pcgo / programm / online / mediaplx / terminat / manual / manual.doc < prev    next >
Encoding:
Text File  |  1994-09-23  |  6.8 KB  |  146 lines
  1.  
  2. ┌───────────────────────────────────────────────────────────────────────────┐
  3. │ ░░░░ Terminate manuals ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  4. └───────────────────────────────────────────────────────────────────────────┘
  5.  
  6.  This simple program will compile all *.HLP files into TERMINAT.DOC.
  7.  While doing this, it will remove all color codes, insert a table of
  8.  contents at the top and formfeeds.
  9.  
  10. ┌───────────────────────────────────────────────────────────────────────────┐
  11. │ ░░░░ Translation information ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  12. └───────────────────────────────────────────────────────────────────────────┘
  13.  
  14.  When modifying the help menu files, you must note that Terminate will use
  15.  some search strings that are found in the default help files. You should
  16.  not remove those entries or put similar strings in other places in the
  17.  help file. You risk that a subject will then be located in the wrong place
  18.  when displaying the help files. If you don't understand the rest of this
  19.  document, you should not try to modify the helpfiles.
  20.  
  21.  Maximum help file size is 1000 lines of 255 characters.
  22.  
  23. ┌───────────────────────────────────────────────────────────────────────────┐
  24. │ ░░░░ Formfeeds are important ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  25. └───────────────────────────────────────────────────────────────────────────┘
  26.  
  27.  You can insert an ascii #12 ( ) anywhere to force a new page on the
  28.  printer, the #12 will be ignored when showing the help online. This should
  29.  only be done as a very last resort. What you do is to go through the
  30.  compiled TERMINAT.DOC and find the menues that are broken. Place a #12
  31.  just before the menu and compile again. Remember the last line location
  32.  and jump in your editor (Ctrl-J in Qedit). Use STRIPFF.EXE ro remove old
  33.  #12 first. The mainreason for doing this is to avoid broken boxes on two
  34.  printed pages.
  35.  
  36. ┌───────────────────────────────────────────────────────────────────────────┐
  37. │ ░░░░ Installing local language files ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  38. └───────────────────────────────────────────────────────────────────────────┘
  39.  
  40.  When Terminate is first installed it will look for a file called
  41.  T-LOCAL.EXE (or T_LOCAL.EXE) in the same path as the installation files
  42.  and unpack this file to a directory named LANGUAGE\.
  43.  
  44.  When running Terminate for the first time, Terminate will look for a file
  45.  called LANGUAGE\LANGUAGE.TXT and read the first line. This line should
  46.  contain the language name, like 'Dansk' for Danish or 'German' for
  47.  Germany. If the file does not exist, Terminate will say local language
  48.  files.
  49.  
  50. ┌───────────────────────────────────────────────────────────────────────────┐
  51. │ ░░░░ Colour codes ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  52. └───────────────────────────────────────────────────────────────────────────┘
  53.  
  54.  code  Description                Default colour
  55.  ─────────────────────────────────────────────────────────────────────────
  56.   ^n   Normal text colour         Gray
  57.   ^h   Highlighted text colour    Cyan
  58.   ^b   Bold text colour           Yellow
  59.   ^r   Menu bar colour            Blue on grey background
  60.   ^m   Menu colour                Bright cyan
  61.   ^t   Menu head colour           Yellow on blue background
  62.   ^f   Toggle flash/blink         No flash, always after a color command
  63.  
  64. ┌───────────────────────────────────────────────────────────────────────────┐
  65. │ ░░░░ Keywords ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  66. └───────────────────────────────────────────────────────────────────────────┘
  67.  
  68.  Terminate has a lot of keywords inside the TERMINAT.EXE file. These
  69.  words are used for placing the cursor bar in the helpfiles, so you will
  70.  get faster access to help for the current item. Generally do not change the
  71.  text inside headlines or highlighted text like: ^hConfiguration^n
  72.  Note that the search word will have a ^ appended so it won't stop in the
  73.  menu. Example:
  74.  
  75.  Menu:
  76.  
  77.  ^m┌────────────────────┐
  78.  │ Configuration      ^m│
  79.  │ Exit               ^m│
  80.  └────────────────────┘^n
  81.  
  82.  Information:
  83.  
  84.    ^hConfiguration^n
  85.  
  86.  If the menubar is placed on configuration, then the actual search word
  87.  will be: CONFIGURATION^ in uppercase and with a ^ appended. This will
  88.  result in the menubar being placed at the information instead of at the
  89.  menu. That is why you should not place the ^ right after a menu option. In
  90.  general do not change color except right in front of where the colour
  91.  change is needed.
  92.  
  93.  Terminate will show which keyword you are missing when calling the
  94.  help menu. Then look at the keyword and change it back in the .HLP file.
  95.  
  96. ┌───────────────────────────────────────────────────────────────────────────┐
  97. │ ░░░░ MANUAL.EXE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  98. └───────────────────────────────────────────────────────────────────────────┘
  99.  
  100.  This tool compiles all the .HLP files into a file called TERMINAT.TMP and
  101.  simultaneously creates a table of contents in TERMINAT.IDX. Then the files
  102.  will be copied together into one big TERMINAT.DOC:
  103.  
  104.  FRONTPGE.HLP  (The Terminate logo and copyright)
  105.  TERMINAT.IDX  (The table of contents with page numbers)
  106.  TERMINAT.TMP  (The actual text, now including line feeds and page numbers)
  107.  
  108.  Use MANUAL /850 to transform this manual into codepage 850
  109.  (Use correct box-corners)
  110.  Upon installation Terminate will try to detect the codepage and if codepage
  111.  850 is detected then MANUAL.EXE will be started with a /850.
  112.  
  113. ┌───────────────────────────────────────────────────────────────────────────┐
  114. │ ░░░░ The archive ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  115. └───────────────────────────────────────────────────────────────────────────┘
  116.  
  117.  With the manual files you must create a FILE_ID.DIZ which should look like
  118.  the one that comes with the english manuals in MANUAL\FILE_ID.DIZ: Do
  119.  NEVER use more than 39 chars and 10 lines. Use the same header and frame
  120.  like the below example and never use any highbit characters #128-#255 -
  121.  they may look nice, but many sysops complain and some systems will mess it
  122.  up.
  123.  
  124.  ----======< TERMINATE x.xx >======-----
  125.  -         The Final Terminal          -
  126.  -      Documentation in Danish        -
  127.  -   Translated by Carsten Milling     -
  128.  _______________________________________
  129.  
  130.  Only *.HLP files, MANUAL.DOC and MANUAL.EXE should be placed in the archive.
  131.  
  132.  For example to pack the Danish language archive (XX=version):
  133.  
  134.  PKZIP T-DAN-XX *.HLP MANUAL.* FILE_ID.DIZ
  135.  
  136.  Result:
  137.  
  138.  T-DAN-XX.ZIP  The finished archive. Good luck.
  139.  
  140. ┌───────────────────────────────────────────────────────────────────────────┐
  141. │ ░░░░ THE END ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
  142. └───────────────────────────────────────────────────────────────────────────┘
  143.  
  144.                              - Bo Bendtsen -
  145.  
  146.