Open topic with navigation

You are here: Other topics > Plotting > Format of Title Block definition file
GEOVIA Surpac

Format of Title Block definition file

The plotting title blocks are defined in the SSI_PLOTTING:titles.ssi file. A sample of the file is shown below. A description of the keywords and their parameters can be found here.

# "ssi.plotting.title_blocks" :Version 6
(title_block "NMA3"
  (purpose "Title block for A3 map sheet. Lower right corner of the map sheet at a normal orientation.")
  (protect 
    (angle 0.0)
    (size 10.00 3.15)
    (rel_position lr 0.00 0.00)
    (priority 124)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 0.00 0.00)
    (position 10.00 0.00)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 10.00 0.00)
    (position 10.00 3.15)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 10.00 3.15)
    (position 0.00 3.15)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 0.00 3.15)
    (position 0.00 0.00)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 0.00 2.35)
    (position 10.00 2.35)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 0.00 0.65)
    (position 10.00 0.65)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 6.40 0.00)
    (position 6.40 0.65)
  )
  (line
    (pen 2)
    (line_type 1)
    (priority 124)
    (position 3.30 0.00)
    (position 3.30 0.65)
  )
  (label
    (position 1.20 2.55)
    (pen 3)
    (priority 124)
    (height 0.33)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (text "GEOVIA")
  )
  (label
    (position 0.20 0.20)
    (pen 1)
    (priority 124)
    (height 0.20)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (text "Scale: 1:")
  )
  (label
    (position 3.50 0.20)
    (pen 1)
    (priority 124)
    (height 0.20)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (text "Plan No.")
  )
  (label
    (position 6.70 0.20)
    (pen 1)
    (priority 124)
    (height 0.20)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (text "Date:")
  )
  (user_label
    (prompt "Title Line 1")
    (maxlength 5.00)
    (position 0.01 1.91)
    (pen 1)
    (priority 124)
    (height 0.30)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "Arial")
    (angle 0.0)
    (justify "Centre")
  )
  (user_label
    (prompt "Title Line 2")
    (maxlength 5.40)
    (position 1.25 1.35)
    (pen 1)
    (priority 124)
    (height 0.25)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (justify "Centre")
  )
  (user_label
    (prompt "Title Line 3")
    (maxlength 5.40)
    (position 1.25 0.85)
    (pen 1)
    (priority 124)
    (height 0.25)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
    (justify "Centre")
  )
  (scale
    (position 2.20 0.20)
    (pen 1)
    (priority 124)
    (height 0.20)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
  )
  (date
    (date_format "DD-MMM-YY")
    (position 7.80 0.20)
    (pen 1)
    (priority 124)
    (height 0.20)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "DefaultFixed")
    (angle 0.0)
  )
  (autoplot_section 
    (northing_prefix "Northing: ")
    (northing_suffix "")
    (easting_prefix "")
    (easting_suffix " E")
    (elevation_prefix "")
    (elevation_suffix " ELEV")
    (oblique_prefix "Oblique dist: ")
    (oblique_suffix "")
    (num_decimals 1)
    (position 2.50 1.61)
    (pen 1)
    (priority 124)
    (height 0.18)
    (font_bold 0)
    (font_italic 0)
    (font_underline 0)
    (font_name "Default")
  )
)
            

Title Block Keyword Summary

The first line of the file is a unique file header to distinguish this file to prevent errors when working with the file. This line also identifies the version for the format of the file so that future compatibility issues can be resolved easily.

The file uses a number of keywords each with appropriate arguments to define the structure of a title block definition.

All keywords and their arguments are contained in enclosing parentheses as shown in the example above. A number of the keywords for a title definition are used in many of the different components of the title. For brevity, these repeated keywords will only be described once. A title block definition begins with the (title keyword and contains the following keywords:

  • title

    • Describes the name of the title enclosed in " characters

  • purpose

    • Permits a verbose description, enclosed in " characters, for the title to be defined

  • protect

    • Defines an area that will be protected so that map components such as lines and text will not be drawn inside the protected area.

    • angle

      • The angle of orientation of the protected area. This parameter is not used at this time.

    • size

      • Defines the dimensions in the order X then Y for the protected area.

    • rel_position

      • Defines the position for the origin of the protected area relative to a corner of the map sheet by having a corner code and X and Y offsets respectively from the default position for the origin of the protected area. Valid corner codes and their meaning are listed below.

      The origin of the protected area is at the lower left corner of the protected area and with offsets of 0.0 for both the X and Y directions, this origin point is positioned such that the protected area fits exactly into the specified corner of the map sheet.

      • ll

        • The lower left corner

      • ul

        • The upper left corner

      • ur

        • The upper right corner

      • lr

        • The lower right corner

    • priority

      • Defines the priority of the line so that symbol/line clashing is performed correctly when processing a map. The priority is an integer that must be between 0 and 125 inclusive.

  • line

    • Defines a line that will be drawn in the title block. To completely define a line the following keywords are also required.

    • pen

      • Defines the pen number that will be used to draw the line. The pen number is a positive integer. Valid values are 1 and 999 inclusive.

    • line_type

      • Defines the type of line that will be drawn. The type of line is described using an integer, at this time the only valid value is 1, which represents a solid line, that is, no dashes or dots.

    • priority
    • position

      • Defines a position, relative to the origin of the title block, the lower left corner of the title block that is, for the line, text, symbol, etc. within the title block. The coordinates of the point are defined in the order X then Y.

  • label

    • Defines a label, 1 or more characters in a word or phrase, that is to placed in the title block. To completely define a label the following keywords are also required.

    • position
    • pen
    • priority
    • height

      • This is the height, in centimeters, of the characters of the label text.

    • font_bold

      • This is the bold option for the font. The value must be 1 to turn bold on, or 0 to turn it off.

    • font_italic

      • This is the italic option for the font. The value must be 1 to turn italics on, or 0 to turn it off.

    • font_underline

      • This is the underline option for the font. The value must be 1 to turn underline on, or 0 to turn it off.

    • font_name

      • This is the name of the font to use for the label. This must be a known system font, Default or DefaultFixed. If the given font is not known to Surpac, it will be substituted with the Default font.

    • angle

      • This is the angle of orientation, in decimal degrees, for the characters that are to be drawn in the title block. An angle of 0 degrees gives text that is readable from the bottom edge of the map sheet. An angle of 90 degrees gives text that is readable from the right edge of the map sheet.

    • text

      • This is the string of characters, enclosed in " characters, that is to be plotted in the title block.

  • user_label

    • This defines a prompt that will be presented to the user when the map is processed to elicit input from the user so that different text may be drawn in the title block each time the map is processed. To completely define a user, or prompting, label the following keywords are also required.

    • prompt

      • This is the prompt that will be presented to the user when the map is processed to obtain the value that is to be drawn in the title block.

    • maxlength

      • This is the maximum length in centimetres of space available for text entered in response to this prompt when the map is processed. If the entered text is larger than the maximum length, it is truncated to fit.

    • position
    • pen
    • priority
    • height

      • This is the height, in centimetres, of the characters of the text produced by the prompt during map processing.

    • font_bold

      • This is the bold option for the font. The value must be 1 to turn bold on, or 0 to turn it off.

    • font_italic

      • This is the italic option for the font. The value must be 1 to turn italics on, or 0 to turn it off.

    • font_underline

      • This is the underline option for the font. The value must be 1 to turn underline on, or 0 to turn it off.

    • font_name

      • This is the name of the font to use for prompting lines. This must be a known system font, Default or DefaultFixed. If the given font is not known to Surpac, it will be substituted with the Default font.

    • angle
  • date

    • This keyword ensures that the date on which the map is processed will be placed in the title block. To completely define a date item the following keywords are also required.

     

    position

    pen

    priority

    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name
    • angle

      • As per label.

  • scale

    • This keyword ensures that the map scale (the X scale value) will be placed in the title block at the required location. The scale is drawn as the numerical value of the map scale, i.e. as the text 1000 for a map at a scale of 1 is to 1000 if using metric or 1 inch = 1000 feet if using imperial. To present the scale appropriately, you must also use the label keyword to prefix some text such as Scale 1 :. To completely define a scale item the following keywords are also required.

     

    • position
    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name 
    • angle

      • As per label.

  • xscale

    • This keyword ensures that the X map scale will be placed in the title block at the required location. The scale is drawn as the numerical value of the map scale, i.e. as the text 1000 for a map at a scale of 1 is to 1000 if using metric or 1 inch = 1000 feet if using imperial. To present the scale appropriately, you must use the label keyword to prefix some text such as Scale 1 :. To completely define a scale item the following keywords are also required.

    position

    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name 
    • angle

      • As per label.

  • yscale

    • This keyword ensures that the Y map scale will be placed in the title block at the required location. The scale is drawn as the numerical value of the map scale, i.e. as the text 1000 for a map at a scale of 1 is to 1000 if using metric or 1 inch = 1000 feet if using imperial. To present the scale appropriately, you must use the label keyword to prefix some text such as Scale 1 : . To completely define a scale item the following keywords are also required.

    • position
    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name
    • angle

      • As per label.

  • sheet

    • This keyword ensures that the name of the sheet on which the map is being drawn will be placed in the title block at the required location. To completely define a scale item the following keywords are also required.

    • position
    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name
    • angle

      • As per label.

  • plot_file

    • This keyword ensures that the name of the plot file in which the map is created will be placed in the title block at the required location. To completely define the plot_file item the following keywords are also required.

    • position
    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name
    • angle

      • As per label.

  • image

    • This keyword will place an image on the map. Images occupy a fixed position and size on the map, with respect to the title block.

    • position
    • position2

    The image is defined by coordinates, relative to the title block origin, of the lower left (position) and upper right corner (position2) of the image rectangle.

  • file_name

    • The name of the image file to be displayed..

    • priority
  • scale_bar

    • This keyword will place a graphical scale bar on the map as an aid to depicting the map scale. Scale bars occupy a fixed position and size on the map, with respect to the title block. The values that are annotated on the scale bar or dependent upon the scale that is chosen when the map is processed. Furthermore, the map X scale is used to determine these annotation values. To completely define a scale bar, the following keywords are also required.

    • position
    • position2

      • The scale bar is defined by coordinates, relative to the title block origin, of the lower left (position) and upper right corner (position2) of the scale bar rectangle. The dimensions in the X and Y directions of the scale bar determine its orientation. If X is the longer dimension that the scale bar will be horizontal. If Y is the greater dimension the scale bar is vertical.

    • pen
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name
    • angle

      • As per label.

  • symbol

    • This keyword ensures that a special symbol from the SSI_PLOTTING: directory will be placed in the title block at the required location. To completely define the symbol item the following keywords are also required.

    • position
    • pen
    • priority
    • height
    • angle
    • name

      • This is the name of the symbol. These symbols are defined in string files in the SSI_PLOTTING: directory.

  • pattern_legend

    • Pattern legends define a rectangular region, relative to the title block origin, within which 1 or more patterns, occupying areas of equal size will be drawn. Beside each pattern a label will be drawn to describe what the pattern represents in the context of the map.

    The legend may be horizontal or vertical in alignment with the longer dimension determining the alignment. To completely define the pattern legend, the following keywords are required.

    size

      This is the size, in the order X then Y of the pattern legend.

    • position
    • priority
    • height
    • font_bold
    • font_italic
    • font_underline
    • font_name 

      • As per label.

    • pattern_elem

      • This keyword defines a pattern, and its associated descriptive label in the pattern legend. There may be at most 100 distinct patterns in any pattern legend. There may however be any number of pattern legends in a title block. To completely define a pattern element, the following keywords are required.

      • name

        • This is the name of the pattern that will be used. Patterns are defined in the SSI_PLOTTING:patterns.ssi file and a summary of the available patterns can be found here.

      • text

        • This is the label that will be drawn beside the pattern.

      • pen
      • angle

        • This is the angle through which the basic pattern will be rotated to draw it in the pattern legend.

      • scale_factor

        • This is the scale factor that will be used to adjust the spacing between the lines that comprise the pattern.

Open topic with navigation