home *** CD-ROM | disk | FTP | other *** search
/ A.C.E. 2 / ACE CD 2.iso / FILES / UTILS / JACOSUB.LHA / JACOsub / documentation / QuickRef.doc < prev    next >
Encoding:
Text File  |  1995-03-19  |  9.6 KB  |  304 lines
  1. JACOsub Quick Reference
  2. =======================
  3.  
  4. This document serves as a brief summary to JScripts.doc.  Refer to
  5. JScripts.doc for complete details.
  6.  
  7.  
  8. SCRIPT COMPILER COMMANDS
  9. ------------------------
  10.  
  11. #  (followed by a space) Comment.  The line will be ignored.
  12.  
  13. #C[LOCKPAUSE] <time>
  14.    Force clock to pause at time specified while playing.  Keypress resumes.
  15.  
  16. #D[IRECTIVE][n] <directive string>
  17.    Change default directive n.  n=0 (overall directive) if n omitted.
  18.    n may range from 0 to 9.
  19.  
  20. #F[ONT] <n> <fontname.font> <h> [CLEAN or QUICK&DIRTY]
  21.    Set font n to fontname.font, h pixels tall.  n may range from 0 to 9.
  22.    Mono fonts are always QUICK&DIRTY (rendered fast).
  23.    For face colors other than 3, color fonts default to CLEAN (rendered
  24.    one character at a time), unless QUICK&DIRTY is specified.
  25.  
  26. #I[NCLUDE] <time> <filename>
  27.    Include script file <filename> into the current script, offsetting
  28.    the new script's start time by the time specified.  Offset cannot be
  29.    negative.  Offset units depend on time units set by #TIMERES.
  30.    #F, #P, #Q, and #R in an included script will be ignored.
  31.    The effects of #D, #S, and #T are passed down into included scripts.
  32.  
  33. #P[ALETTE] <color> <r> <g> <b> [palette]
  34.    For specified color register, set RGB intensities (0 to 15).  palette
  35.    defaults to 0 (primary palette), but may be 0 through 9.  Use palettes
  36.    1 - 9 with the CP directive.
  37.  
  38. #Q[UANTIZE][n]
  39.    Eliminate timing gaps between subtitles of less than n time units.
  40.    Number of time units per second is specified by #TIMERES.
  41.  
  42. #R[AMP] <seconds.units>
  43.    Adjust script play for time drift by changing the script's overall
  44.    running time.  Positive ramp adjustments lengthen the play, negative
  45.    adjustments shorten it.  Time units are determined by #TIMERES.
  46.  
  47. #S[HIFT] <seconds.units>
  48.    Shift all times in script by the amount specified.  Positive shifts
  49.    delay time events, negative shifts advance them.
  50.  
  51. #T[IMERES] <n>
  52.    Set time resolution of script to n units per second.  Default is 30
  53.    if this command does not appear in the script.
  54. ESCAPE CODES TO EMBED IN TITLES
  55. -------------------------------
  56.  
  57. \   Concatenate.  Assume next line in script continues current title.
  58.     Leading and trailing spaces in concatenated lines are ignored.
  59.  
  60. \n  Newline.  Use to split a title text into multiple lines.  \n codes
  61.     override wordwrapping, but the resulting text substrings might still
  62.     be individually wordwrapped if needed.
  63.  
  64. \{  Display a left brace, which is normally used to begin a non-displaying
  65.     comment embedded in the title.
  66.  
  67. \~  Display a tilde, which is normally used to create a "hard" non-
  68.     wrappable space.
  69.  
  70. \\  Display a backslash, which is normally used to begin an escape code.
  71.  
  72. \N  Normal.  Display text that follows in "normal" style.  Equivalent to
  73.     the SN directive.
  74.  
  75. \I  Italics. Display text that follows in italics.  Equivalent to the SI
  76.     directive.
  77.  
  78. \B  Boldface.  Display text that follows in boldface (sometimes useful).
  79.     Equivalent to the SB directive.
  80.  
  81. \U  Underline.  Underline text that follows (not useful).  Equivalent to
  82.     the SU directive.
  83.  
  84.     Note: /N, /I, /B, and /U are mutually exclusive.
  85.  
  86. \Cn Color n.  Use face color n for text that follows.  n is a hexadecimal
  87.     digit ranging from 0 to 9 and A to F (or a to f).  Equivalent to the
  88.     CF directive.
  89.  
  90. \Fn Font n.  Use font n (0 to 9) for text that follows.  Equivalent to the
  91.     F directive.
  92. TITLE DIRECTIVES
  93. ----------------
  94. Directives occur after the stop time is specified.  You may omit the title
  95. directive if you title begins with a non-alphabet character (such as a left
  96. brace for a {comment}), in which case the directive defaults to D.
  97.  
  98. Vertical positioning
  99. --------------------
  100.  
  101.   VB[n]
  102.      Vertical Bottom, offset from bottom of display by n pixels.  n may
  103.      be omitted (default n, usually 16, can be set with the #D command).
  104.  
  105.   VHn
  106.      Vertical line Height n% of normal.  VH200 makes double-spaced lines.
  107.  
  108.   VLn
  109.      Vertical Line position n.  Line height depends on font size.
  110.  
  111.   VM
  112.      Vertical Middle.  Equal blank space above and below the text.
  113.  
  114.   VPn
  115.      Vertical Pixel position n.  Baseline of font will be n pixels from
  116.      top of display.
  117.  
  118.   VSn
  119.      Not yet implemented; doesn't do anything yet.  Don't ask.
  120.  
  121.   VT[n]
  122.      Vertical Top, offset from top of display by n pixels.  n may be
  123.      omitted (default n, ususally 16, can be set with the #D command).
  124.  
  125.   VU
  126.      Vertical continuation Under previous title, using previous title's
  127.      vertical positioning setting.
  128.  
  129. Horizontal positioning
  130. ----------------------
  131.  
  132.  Margins:
  133.  
  134.   HLn
  135.      Horizontal Left margin n% of display width from left edge.
  136.  
  137.   HRn
  138.      Horizontal Right margin n% of display width from right edge.
  139.  
  140.  Text justification:
  141.  
  142.   JC
  143.      Justify Center.  Text is centered within H constraints.
  144.  
  145.   JL
  146.      Justify Left.  Align left edge of text at the HLn margin position.
  147.  
  148.   JR
  149.      Justify Right.  Align right edge of text at the HRn margin position.
  150.  
  151.  Block justification:
  152.  
  153.   JBC
  154.      Justify Block Center.  Position the text, after wordrwapping, so that
  155.      it is centered within the margins, preserving the text justification.
  156.      To get "AnimEigo" positioning, use JBC with JL.
  157.  
  158.   JBF
  159.      Justify Block Full.  Cancel the effect of any JB directive if one
  160.      happens to be in use as a default directive.
  161.  
  162.   JBL
  163.      Justify Block Left.  Position the text block at the left margin.
  164.  
  165.   JBR
  166.      Justify Block Right.  Position the text block so that the right
  167.      edge is at the right margin, preserving the text justification.
  168.  
  169.  Word wrapping:
  170.  
  171.   W0
  172.      Disable automatic word wrapping.  Warning: text may overflow screen
  173.      boundaries.
  174.  
  175.   W1
  176.      Automatic "smart" word wrapping (default).  Wrap text so that the
  177.      screen area consumed by the title is minimized.
  178.  
  179.   W2
  180.      Automatic "stupid" (generally known as "greedy") word wrapping.
  181.      Fit as much text into a line as possible without regard to appearance
  182.      or screen space consumed.
  183.  
  184. Fonts
  185. -----
  186.  
  187.  Font rendering:
  188.  
  189.   Fn
  190.      Use font n (0 - 9) for the title text.
  191.  
  192.   FQ
  193.      Force title to be rendered Quick&Dirty.  Mono-color fonts and
  194.      colorfonts using color 3 are always quick anyway.
  195.  
  196.   FC
  197.      Force title to be rendered Clean (1 character at a time) to avoid font
  198.      shadow overlap interference problems.rendering.  Mono-color fonts and
  199.      colorfonts using color 3 will still be rendered fast.
  200.  
  201.   FD
  202.      Force Default text rendering.  Used to override a global #DFC or #DFF
  203.      command.
  204.  
  205.   FOn[:a]
  206.      Generate Font Outline n pixels wide, optionally use antialias color a.
  207.      Warning:  This slows the program down considerably.
  208.  
  209.   FSdn
  210.      Generate Font Shadow in direction d (one of 8 compass directions
  211.      N, S, E, W, NW, NE, SW, SE), n pixels deep.
  212.  
  213.  Font style (may also be set with \ codes in the title text):
  214.  
  215.   SN
  216.      Normal style (typical default).
  217.  
  218.   SI
  219.      Italic.
  220.  
  221.   SB
  222.      Bold (using the JACOsub font, this looks best with color 3).
  223.  
  224.   SU
  225.      Underline (ugly!  Not recommended).
  226.  
  227.  Font color
  228.  
  229.   CFn
  230.      Color Fontface n.
  231.  
  232.   CBn
  233.      Color Background n.  Screen is cleared to color n prior to rendering
  234.      anything to it.  Useful for creating a genlock-opaque background if
  235.      n is nonzero.
  236.  
  237.   CPn
  238.     Load Color Palette n (0 to 9, set with #PALETTE command) at the start
  239.     time of this title.  If you can see the palette change after the
  240.     display is updated, precede your alternate palette lines with a "dummy"
  241.     short-duration blank screen (containing a hard space) using your
  242.     alternate palette.
  243.  
  244.   CS[L]n[:s[:c]]
  245.     Color Shaded box with n-pixel margin around text, using shade style s
  246.     (0=pattern, 1=solid color), using optional color c (normal default is 2
  247.     [black], can be re-set with a #D command).  Titles that overlap in time
  248.     AND use the CS directive will be surrounded by a SINGLE box; if CSL is
  249.     used, a box will appear around individual lines (including segments
  250.     resulting from wordwrapping).  n=0 disables shading.
  251.  
  252. Genlock fader control
  253. ---------------------
  254.  
  255.   GBn[Tm]
  256.     Genlock Background n% of saturation in m/60 seconds.  m=0 if Tm is
  257.     omitted.  n=0 is a transparent background.
  258.  
  259.   GGn[Tm]
  260.     Genlock Graphics n% of saturation in m/60 seconds.  m=0 if Tm omitted.
  261.     n=100 is full-on graphics.
  262.  
  263.   Note:  Do not use the G directives in the global #D command.
  264.  
  265. IFF graphic files
  266. -----------------
  267.  
  268.   IL <ILBM file name> [<x offset %> <y offset %>]
  269.     Load an IFF ILBM bitmap into the video screen for the time interval
  270.     specified by this line's start and stop time.  Current screen colors
  271.     will be used; the IFF colors will be ignored.  x and y are percents of
  272.     screen width and height to offset the center of the bitmap from the
  273.     center of the screen.  Through overlapping time ranges, as many as
  274.     40 images may be loaded onto a single screen, memory permitting.
  275.     Text can appear concurrently with the bitmaps.
  276.  
  277.   IS <ILBM file name>
  278.     Load an IFF ILBM file into its own screen, using the file's own
  279.     resolution and colors.  Text cannot appear concurrently.
  280.  
  281.   Note:  Do not use the I directives in the global #D command.
  282.  
  283. ARexx communications
  284. --------------------
  285.  
  286.   RX <ARexx script name>
  287.     Execute the ARexx script name that follows the RX directive.  Do not
  288.     specify other directives on the same line, and have no more than one
  289.     RX directive per time event.
  290.  
  291.   Note:  Do not use the RX directive in the global #D command.
  292.  
  293. Default directives
  294. ------------------
  295.  
  296.   D or D0
  297.     Default 0verall.  To be used if no other directives are used.  The
  298.     behavior of D can be set with the #D command.
  299.  
  300.   Dn
  301.     Default alternate n (1 - 9).  Use these for "shortcuts" to long
  302.     directive strings that you like to use repeatedly.  Set with the #D
  303.     command.
  304.