This chapter describes the different Print dialogs in Telelogic Tau and the printing differences between the Organizer, ORCA1 and SDT and ITEX.
In the beginning of the chapter you can also find some introductory examples of how to print.
You can print from virtually all Telelogic Tau tools that provide a graphical user interface. It is possible to print the information that is managed by an individual tool, such as a graphical editor or a viewer, or to print all (or parts of) information that is related to a document structure, from the Organizer.
You specify the print options in Print and Print Setup dialog. These dialogs have different appearances, depending on where they are invoked from -- the Organizer, ITEX or an ORCA or SDT tool. ITEX in Windows also provides a print preview.
The following output formats are provided:
When you print a TTCN document, only PostScript output is available. However, in ITEX in Windows, it is also possible to export a document to HTML, see Exporting to HTML.
It is also possible to set the default print options. For more information, see Print Preferences.
This section is a brief guide to how to print some types of documents. The remaining sections of this chapter contains more detailed reference information about the print function and the Print dialogs.
You can print documents either from the Organizer or from within an individual Telelogic Tau tool.
This is an example of how to print a table of contents, one or more SDL interaction diagrams and type views from the Organizer. It is assumed that you have SDL interaction diagrams included in the Organizer and that a Type Viewer is running. The example describes how to print specific diagrams, but what is explained here may of course apply to other types of diagrams.
To print from the Organizer:
|
|
Figure 83 : The Organizer Print dialog
|
|
You will start by changing the options in the Contents area:
|
|
|
Figure 84 : The Print Setup dialog
|
|
.
You may also want to specify the options in the Document area and the Destination area of the Print dialog:
|
|
|
Figure 85 : Setting the margins
|
|
lpr. (It is possible to enter any post-processing command, such as a PostScript pre-viewer like ghostview.)For more information on how to use advanced printing features, see Advanced Print Facilities.
In these examples you will learn how to print from the MSC Editor and the Type Viewer. As most settings in those print dialogs are similar to the ones in the Organizer dialog, described above, the explanations below will be quite brief.
Figure 86 : The MSC Editor Print Setup dialog
|
|
In this section you will find information on what will be printed by default if you do not change any settings. It may also be possible to select what documents -- of parts of documents -- to print. See Print Setup Dialogs for more information on how to include more in the printout or how to restrict it.
|
Note: Link endpoints are never shown in a printed document. |
The default printout in the Organizer depends on selections and which tools are running:
If no item is selected in the Organizer, all documents that are managed by the Organizer (i.e. are visible in the Organizer view) will by default be included in the printout. If an item is selected in the Organizer, only the document(s) included in that item, and their sub-structure (if any), will by default be included in the printout.
Coverage files cannot be included in the structure that is managed by the Organizer. The graphical presentation of a coverage file is computed as you request it by running the Coverage Viewer.
Therefore, the graphical presentation of coverage information will be included in the printout if the Coverage Viewer is running. The resulting printout will reflect the current contents of the windows, that is, the Main Window and the Coverage Details Window of the Coverage Viewer.
These entities cannot be included in the structure that is managed by the Organizer. Furthermore, this information is computed automatically by the Type Viewer. Therefore, the Type Viewer must be running in order to include the information in the resulting printout. The contents of the Main Window and Tree Window of the Type Viewer may be included.
If a TTCN document is selected in the Organizer, it is possible to print it, and the default scope of print is the selected document. A TTCN document cannot be included in a global printout, i.e. from the main Print dialog in the Organizer.
When you are going to print from an ORCA or SDT tool, the printout will be the information that is currently visible in the active tool window.
The Setup button issues the Print Setup dialog which is used for specifying the scope of print. For example, if you print from the SDL Editor, the default scope of print is the active SDL Editor window, i.e. the SDL page currently being edited. In the Print Setup dialog, the scope of print may include any of the pages contained in the SDL diagram, or be restricted to the SDL symbols currently selected in the active window.
The default scope of print is the active Editor window, i.e. the diagram page or the MSC currently being edited.
The default scope of print is the active SDL Editor window, i.e. the SDL Overview diagram currently being viewed.
In a Viewer, the scope of print is the contents of the window from where you invoked print.
The scope of print is the current contents of the window.
The default scope of print is the entire, currently active, TTCN document. The printout will contain one table per page.
To print, you select Print from the File menu. This will open a Print dialog. Since the print functions in the tools are not identical, the print dialogs look somewhat different depending on where they are invoked from. As you can see in Figure 87 and Figure 88, the differences are that the Organizer print dialog includes the Contents area, whereas the ORCA and SDT tool print dialogs include a Setup button.
The main differences between printing from the Organizer and an ORCA or SDT tool are:
|
Note: Endpoints are not displayed in printed documents/diagrams, regardless of the value of the Show Link Endpoints option. |
Figure 87 : The Organizer Print dialog
|
|
Figure 88 : An ORCA and SDT tool Print dialog
|
|
Both dialogs contain the following areas and buttons:
The Organizer print dialog also contains the Contents area with setup buttons. A Setup button is also included in each ORCA and SDT tool print dialog. The setup buttons in the Contents area of the Organizer print dialog are equivalent to the Setup button in an ORCA and SDT tool print dialog.
All dialog areas and buttons will be described in this chapter.
The Contents area is only available in the Organizer Print dialog. In the area, it is possible to control what information to print, through a number of toggle buttons and Setup buttons. Each of the toggles identify a group of documents that may be printed:
|
Note: It is not possible to include TTCN documents in a global printout from the Organizer. See The Print TTCN Dialog in the Organizer for information on how to print TTCN documents from the Organizer. |
Some toggle buttons may be turned on by default. This is determined by which document types that are present in the default scope of print.
This option determines whether a table of contents should be generated or not. The table of contents consists of a textual list with information about what source diagrams and generated diagrams that are included in the printout, with references to physical page numbers. There is also a possibility to only include Organizer chapters in the table of contents, i.e. all other printed entities are suppressed in the table of contents.
The table of contents is either printed on the first pages that constitute the resulting printout, or after an initial text document acting as a title page. For each 5:th line in the table of contents, a horizontal line is inserted to easier associate a given item and its page number.
This option determines whether a printout of the Organizer main window should be included or not in the generated output. Only the visible parts (i.e. expanded nodes) are included.
The resulting printout will match the Organizer's View Options, i.e. file names, directories, etc. will be shown if they are in the Organizer Main window.
This option determines whether a printout of the Link Manager Window should be included or not in the generated output. Only the visible parts (i.e. expanded nodes) are included.
These options determines whether the documents and diagrams that are visible in the Organizer should be included or not in the printout. The SDL Interaction diagrams are: system, system type, block, block type, substructure, package diagrams. The SDL Flow diagrams are: process, process type, service, service type, procedure, operator, macro diagrams.
|
Note: Endpoint markers will not be included in printed diagrams. |
This option determines whether Transition Coverage and Symbol Coverage trees should be included or not in the generated output.
This option determines whether Definitions and Uses should be included or not in the generated output.
The resulting output will show the graphical appearance as when displayed in the Index Viewer, with the exception that only SDL entities defined or used in SDL diagrams printed together with the index will be visible in the index.
This option determines whether an SDL-92 Type list and SDL Type Inheritance and Redefinition list should be included in the generated output or not.
The resulting output will show the SDL-92 type lists for the SDL system currently in view in the Organizer. The lists will be produced by using the options defined in the List Options, Tree Options and Symbol Options of the Type Viewer.
Furthermore, each group of documents that may be printed is supplied with setup buttons. When you click a setup button, a Print Setup dialog will be issued, see Print Setup Dialogs. In the dialog, it is possible to set additional options that affect the printout of the current group of documents.
The Document area contains a number of settings that make it possible to specify the size of the paper to use, the print range and additional information to be printed on each individual page.
The Document options are:
The Paper format option menu specifies what paper format the print function will use. The paper formats are:
The Margins button provides access to the Paper Format Setup dialog where the print margins may be specified.
Figure 89 : The Paper Format Setup dialog
|
|
The print margins govern how much space is reserved around the area used when printing. Values are expressed in millimeters.
This feature controls whether or not a header/footer should be printed on each page. The page header/footer is defined in a text file of its own, which you need to supply. For information about the contents and syntax of this file, see Footer and Header Files.
|
Note: Header or footer files are not supported in FrameMaker Output or Interleaf Output. |
An SDL / OM page or an MSC diagram may require multiple physical pages when printed. If you want to print an SDL / MSC / OM document and the document is physically spread over more than one physical page, the Page markers toggle button facilitates the reassembling of the paper sheets into the original page.
Figure 90 : The page numbering
Physical page numbering follows a "first right, then down" fashion.
|
|
|
Note: The physical page breaks are indicated with dashed lines in the diagram editors. A page number is inserted at the lower right corner of each page in the editor. Page markers are not supported in FrameMaker Output or Interleaf Output. |
When you order multiple print jobs, you may want to restart the page numbering on each printout with a number different from 1, which is the default value.
If you want to change the number of the first page, you should type the number in the First page no: field.
It is possible to exclude a number of pages form a printout. To specify the print range, you type the page numbers in the Print from and Print to fields. Make sure that the toggle button is on, your settings will have no effect otherwise.
When the toggle button is off, all physical pages that constitute the printout will be generated.
The Destination area contains print options that affect the output format and the destination of the resulting output. It is for example possible to send a printout to a printer or to look at the results in a pre-viewer.
The options are:
This feature controls what output format will be generated when printing. You select the output format in an option menu. The output formats supported are:
imaker and create a new FrameMaker document, showing the contents of the file.
If this radio button is turned on, the output will be a file. The name of this radio button depends on the format specified in the Format option menu. If the format selected will generate one output file -- i.e. the format name ends with Per Page -- the name will be Map file. Otherwise it will be To file.
A map file contains a translation scheme of all files generated (containing information about SDL diagram / page and the corresponding printout file). The naming algorithm of the generated files will ensure a fixed mapping between a diagram and the generated files between two subsequent Print jobs. However, if the input to the Print function is changed (its size!), this is not necessarily true.
See Map File if you want detailed information on the syntax of a map file.
If this radio button is on, the output file will be used as input to an OS command. An example of this is to load a printer with a PostScript file. It may also be to send the resulting PostScript code to a PostScript previewer. For instance, if type a previewer command in the field -- ghostview for example -- you may preview the PostScript file.
The command lpr (or any other related) will send the printout to a printer.
The default command is specified in the Preference Manager. In the Windows version, the command lpr is available, which functions much like the corresponding UNIX print spool command.
When you click the Setup button (only available in an ORCA and SDT tool Print dialog), a Print Setup dialog will be issued. In the dialog, it is possible to set additional options. The additional options differ between the ORCA or SDT tools. See Print Setup Dialogs for more information.
To print one or more TTCN documents from the Organizer, you select one of the TTCN document in the Organizer and then you select Print from the Organizer File menu. This will issue the Organizer Print TTCN dialog.
When you print a TTCN document, the main difference between printing from the Organizer and printing from ITEX is:
See also The Print Dialogs in ITEX.
The Organizer Print TTCN dialog contains options for the print range and first page number and whether the document is to be printed to a file or a printer. More options are available in the Print TTCN Setup dialog.
Figure 91 The Organizer Print TTCN dialog
|
|
The number that you type in this field, will be the page number inserted on the first page.
It is possible to exclude a number of pages form a printout. To specify the print range, you type the page numbers in the Print from and Print to fields. Make sure that the toggle button is on, your settings will have no effect otherwise.
When the toggle button is off, all physical pages that constitute the printout will be generated.
The options in the Destination area affects the destination of the printout.
If this radio button is on, the printout will be a PostScript file. You also have to specify the name of the file and where it is to be saved.
If this radio button is on, the output file will be used as input to an OS command. An example of this is to load a printer with a PostScript file. It may also be to send the resulting PostScript code to a PostScript previewer. For instance, if type a previewer command in the field -- ghostview for example -- you may preview the PostScript file.
The command lpr (or any other related) will send the printout to a printer.
When you click the Setup button, a Print Setup dialog will be issued. In the dialog, it is possible to set additional options, such as which of the existing TTCN documents to print. See Print Setup Dialogs for more information.
When you print a TTCN document, the main difference between printing from the Organizer and printing from ITEX is:
See also The Print TTCN Dialog in the Organizer.
In Windows, the print dialogs are Windows standard. Besides the actual Print dialog there are also Print Setup and Print Preview dialogs.
To open a Print Setup dialog:
To open a print preview dialog:
On UNIX, you can select which Browser parts and items, for example a single table or sets of tables, to include in the printout. The selections may be arbitrary -- they will be printed as a coherent document anyway. It is also possible to change the page numbering of the printout.
The settings in the print dialog will be described below:
Figure 92 : The ITEX Print dialog on UNIX
|
|
<Itex.sample> in the ITEX directory).If a TTCN document contains ten pages numbered 1 to 10, then Start page = 3 and End page = 3 will cause only page 3 to be printed.
The editable field of the Print dialog not only allows to change the name of the printer or to apply flags to the print command. It is also possible to insert the name of a filter for the produced PostScript code. In the public domain there exist a package of programs called pstools that make various magic operations with a PostScript file. The following example will print four ITEX pages on each A4 page (the syntax of pstops is somewhat hard to read though):
pstops `4:0@0.5(0.8cm,14cm)+1@0.5(10.5cm,14cm)\ +2@0.5(0.8cm,0cm)+3@0.5(10.5cm,0cm)' | lpr
Other filters are able to print double sided intended to bind into a book, print odd pages first etc.
By using a PostScript viewer as Ghostview instead of the normal print command, the printout of the TTCN document can be viewed on screen rather than being printed:
ghostview -
The text in this field is controlled by the resource Itex.print.commandPrefix. This is by default lpr -P or lp -s depending on platform but can be altered (note that the content of the environment variable PRINTER/LPDEST is concatenated to this string). See Customizing ITEX (on UNIX) which contains a description on how to modify resources in ITEX.
A Print Setup dialog will be issued when you click the Setup button in an ORCA or SDT tool Print dialog, or when you click any of the setup buttons in the Contents area of the Organizer Print dialog. When you click the Setup button in the Organizer Print TTCN dialog, the Print TTCN Setup dialog will be issued. The settings in a setup dialog will affect the current group of documents.
The setup dialogs look somewhat different depending on the tool they are invoked from. There are four types of print setup dialogs:
Figure 93 : The Table of contents Print Setup dialog
|
|
Figure 94
: The Organizer Print Setup dialog
The Print Setup dialog looks the same in the Organizer and the SDL, OM, SC and HMSC Editors.
|
|
Figure 95 : The MSC Editor Print Setup dialog
|
|
Figure 96
: The SDT Viewer Print Setup dialog
The Print Setup dialog looks the same in the Link Manager, Type Viewer, the Index Viewer, the Coverage Viewer and the Text Editor.
|
|
Figure 97 The Organizer Print TTCN Setup dialog
|
|
The setup dialogs contain the following:
All areas and options mentioned will be explained below.
To specify what is to be printed and not:
|
|
|
Note: On UNIX, you may transfer all diagrams/pages between the two lists by pressing |
It is possible to set the scale in almost all Print Setup dialogs. You can select Percent, Scale to fit page or Scale to fit width.
|
Note: It is not possible to set the scale in the Text Editor Print Setup dialog or in the Organizer Print TTCN Setup dialog. |
With the Percent radio button on, the printout of the current document category will be scaled according to the value defined in the Percent text field. The default value is 100% but you may of course change this.
With the Scale to fit page radio button on, the printout will be rescaled -- if needed -- to fit the physical paper size.
With the Scale to fit width button on, the documents will be rescaled in order to fit the physical paper width. The result becomes a column of pages constituting each document.
It is possible to set the orientation in all Setup dialogs. In the Orientation options menu you may choose between the following orientations of the printout:
By changing the options, you can rotate the printout in order to optimize paper use.
Below the Orientation option, there are a number of additional options, depending on which Print Setup dialog you have opened.
If this toggle button is on, only objects that are selected in a window will be printed. This option is not available when you print from the Organizer. In an ORCA or SDT tool, it is disabled if no object is selected or if more than one window contain a selection.
This toggle button is only available in the MSC Print Setup dialog. It specifies whether an instance ruler (see Instance Ruler) should appear on each printed page or not. The instance ruler is, when printed, given an appearance similar to the one shown in the MSC Editor window.
This toggle button is only available in the Organizer View Print Setup dialog. It specifies whether paper page references to all printed diagrams and documents should be included in the Organizer view listing.
This toggle button is only available in the table of contents Print Setup dialog. It specifies whether the table of contents should be printed after a plain text document placed first among the diagrams and documents that are to be printed. The initial text document then acts as a title page before the table of contents.
This toggle button is only available in the table of contents Print Setup dialog. It specifies whether only the chapters in the Organizer view should be included in the table of contents, or if all diagrams and documents also should be included.
This toggle button is only available in the Organizer Print TTCN Setup dialog. If the toggle is on, a document burst page will be printed. The burst page is an unnumbered cover page for the TTCN document, where the name of the test suite and the print date are printed.
This toggle button is only available in the Organizer Print TTCN Setup dialog. If the toggle is on, part burst pages will be printed. The part burst pages are unnumbered cover pages, that separate the different parts of a TTCN document. The name of the part, the test suite and the print date, are printed on each part burst page.
This toggle button is only available in the Organizer Print TTCN Setup dialog. If the toggle is on, the TTCN document will be printed with a page format suitable for a double-sided copying. The appearance is controlled by resources and can therefore be changed (see the file Itex.sample in the ITEX directory of the Telelogic Tau installation).
You may specify if a header and/or footer is to be inserted on each printed page. The first thing you have to do is to define the header and footer in separate text files. The format is ASCII based and line oriented. A number of variables are available, providing additional information of the kind of diagram printed.
Text is written on a white background, which becomes visible if the text appears on top of any graphical object.
The priority order for writing headers and footers is as the inverse order in which the items appear in the file. That is any text, variable or graphical symbol, overwrites an already written item. (The last row in the file has the highest priority).
The syntax used in the header and footer files is given below in a BNF notation:
File ::= ( <LINE> | <EXTENSION-LINES> | <EPSF> ) * <LINE> ::= <X> <Y> ( <TEXT> | <VARIABLE> ) + \n <X> ::= integer, x - position in millimeter <Y> ::= integer, y - position in millimeter <TEXT> ::= any ASCII text - no newlines allowed <VARIABLE> ::= any variable as described in Variables, <EXTENSION-LINES> ::= any of the extensions as defined in Extensions. <EPSF> ::= EPSF <X> <Y> <FILE> <FILE> ::= user provided filename containing EPS code
|
Note: The positions are relative the upper left corner of the physical paper in the header and the lower left corner in the footer. |
The following variables are supported in header and footer files:
(i.e. variables used in SDT 2.3)
For example, you may have a process called Myproc that you are going to print out. First you write a footer file with the following contents:
10 20 Telelogic AB 10 15 <date> 150 15 <diagramtype> <diagramname> <pagename> 180 20 Page <page>
If the date is March 1, 1999, the 15th printed page would look something like this:
Figure 98 : The resulting footer
|
|
Below are listed the extensions that enhance the appearance of the header and footer.
The keyword FRAME makes a frame appear at any position on the paper. The function is intended for framing the header and/or footer.
The exact format is:
FRAME x1 y1 x2 y2 [type]
where the start and stop positions are given in millimeters. The optional type argument may be either 3D or plain (default).
Figure 99 : 3D frame and plain frame
|
|
A separator is a horizontal line which is intended to separate the header and/or footer from the data area of a printed page.
The SEPARATOR statement has the general format:
SEPARATOR x1 y1 length [type]
where the start position and length of the separator are given in millimeters. The optional type argument may be either:
Figure 100 : Filled, double and single separators
|
|
Use the BOX keyword to make a filled rectangle appear anywhere on the paper. It can be used for highlighting sections of the header and/or footer.
The format is:
BOX x1 y1 x2 y2 [grayscale]
where the start and stop positions are given in millimeters. The optional grayscale argument is a number in the range 0 to 100 (default is 50).
Figure 101 : Boxes
Grayscale=0 = white, grayscale=50 = medium gray and grayscale=100 = black.
|
|
It is possible to have a separate footer or header for the first printed page. There are three keywords that can be typed on a separate line in a footer or header definition file to achieve this:
Definitions after this keyword will only be used for the first printed page.
Definitions after this keyword will be used for all pages after the first page, but not for the first page.
Definitions after this keyword will be used for all pages.
When multiple output files are generated for one input diagram, a map file is also generated. It shows the translation table between input diagrams and resulting files. The name of this file should be specified in the Map file field.
The map file is an ASCII text file containing lines of the format:
<filename> "[<diagram type>]" "[<diagram name>]" "[<page name>]"
where <filename> is an absolute path to a generated file. The file name is composed of:
If this naming scheme generates two files with the same name, a number (1-99) is added to the second file name, preceding the extension.
... /usr/ope/doc/ContDe.eps "Block" "Controller" "Declarations" ... /usr/ope/doc/ContDe1.eps "Block" "Container" "Declarations" ...
... C:\tau\doc\ContDe.EPS "Block" "Controller" "Declarations" ... C:\tau\doc\ContDe1.EPS "Block" "Container" "Declarations" ...
Should either of the descriptive <diagram type>, <diagram name> or <page name> fields be inapplicable to an item, the corresponding field in the map file will be empty (i.e. "").
PostScript output may be generated as one standard PostScript file or one or more Encapsulated PostScript (EPS) files. When multiple EPS files are generated, a translation table will also be produced in a Map File, linking the name of a generated file to the contents.
A normal print operation generate one PostScript document. All data is represented uniformly, using the same paper format, header, footer etc. Only the scale and orientation might vary between pages.
The EPS output makes use of the scale and orientation settings for each document category. Since EPS files are not clipped, the internal scale has little importance when the file is imported into an external documentation or desktop publishing system.
Header, footer and adjacent page markers are not included in the output.
The scaling options are handled as follows:
Expanded texts are the text contained in such symbols that are minimized5 in a graphical page, see Text / Additional Heading / Package Reference Symbols.
Expanded text is output as plain text using the font specified by the SDT*PrintFontFamily and SDT*PrintTextHeight preferences.
Expanded text in EPS output is stored on separate files. One text file is generated for each logical page containing expanded text, regardless of the number of expanded texts in that logical page.
<x>.eps will be <x>.exp. <x> will be <x>.exp. The generated PostScript code conforms to either of these standards:
FrameMaker output may be generated either as:
Depending on the scale setting (see Scaling in EPS Files), each logical page will be represented as one or more cropped anchored frames in the output.
Header, footer and adjacent page markers are not included in the output.
Expanded text (see Handling of Expanded Text in PostScript for an explanation) is inserted as plain text after the anchored frames generated for the corresponding logical page. In order to preserve the appearance of the users original text, hard returns are inserted where new lines are found.
The generated MIF files conform to FrameMaker Interchange Format version 4.00, which can be read into FrameMaker version 4.x and 5.x without problems.
The X Window root window has an atom (property) that governs how FrameMaker communicates with Telelogic Tau. The name is arbitrary, but must defined both in Telelogic Tau and FrameMaker. In the example below, the name _Frame_Tau_Import will be used.
To have Telelogic Tau and FrameMaker behave in accordance, you should specify what resource to be used by Telelogic Tau when starting FrameMaker. The resource values should be entered in the SDT resource file (in which case all users are affected) or in a suitable user X resource file. The resource is called sdtfmimp*rpcProp.
... sdtfmimp*rpcProp: _Frame_Tau_Import ...
There are multiple ways to set up FrameMaker. The resource Maker.rpcProp may be used for this.
Interleaf output may be produced as:
The generated pages are the same in both cases. A translation table is also generated in the latter case.
Depending on the scale setting (see Scaling in EPS Files), each logical page will be represented as one or more anchored frames in the output.
Header, footer and adjacent page markers are not included in the output.
Expanded text (see Handling of Expanded Text in PostScript) is inserted as plain text after the frames generated for the corresponding logical page. In order to preserve the appearance of the users original text, hard returns are inserted where new lines are found.
The generated IAF files conform to Interleaf ASCII Format version 8.0 (used in Interleaf 5).
By default only three printer fonts are available in printouts: Times, Courier and Helvetica. It is possible to add other printer fonts. The requirement is that there exist AFM (Adobe Font Metrics) files for the desired fonts. An AFM file contains the character metrics necessary for correct layout of text in printouts.
ftp.adobe.com).
Store the files in the directory $telelogic/fontinfo. <basename> by using lower case characters (e.g. palatino-I.afm). Otherwise, you are free to choose any <basename> that does not conflict with other fonts or font files.
| File contents | File name |
|---|---|
|
regular font |
<basename>.afm |
|
bold font |
<basename>-B.afm |
|
italic font |
<basename>-I.afm |
|
bold italic font |
<basename>-BI.afm |
<basename> in the Preference Manager (case is not important in this context):
Figure 102 : Specifying print font as Other.
Palatino is selected in the current example.
|
|
This section is divided into three parts.
The following print facilities will be described in this section:
You can create a textual header definition file that defines the appearance of a header that is found at the top of each printed page. All the possibilities for creating a header is described in Footer and Header Files, here you will only find the most important ones.
|
|
The Organizer preference ShowHeader defines if the header symbol should be visible as default in the Organizer view. If the header symbol is not visible, you can make the symbol visible by selecting Header File in the View > View Options dialog.
Figure 104 : The header symbol in the Organizer view
|
|
You can double-click on the header symbol to open a Text Editor to be able to define the header and create a header definition file. When you have defined the header (read more about some of the possibilities for that below), save the file and you are done with this step.
In the header definition file, insert a line like this:
60 20 This printout was produced by X
This means that 60 millimeters from the left border and 20 millimeters from the top border, the text "This printout was produced by X" will be placed.
In a header definition file, insert a line like this:
100 10 <page>(<totalpages>)
This means that 100 millimeters from the left border and 10 millimeters from the top border, a text such as "3(9)" will be placed, informing the reader of the printout that this is page three of nine.
You can introduce pictures in the headers. The pictures must be in Encapsulated PostScript file format (EPSF), and they are referenced from the header definition file. If you have a picture of for instance your company logo in a file /home/lat/logo.eps, then you can get it into your header with the following line:
EPSF 10 35 /home/lat/logo.eps
This line means that the picture defined in the referenced file will be placed 10 millimeters from the left border, and 35 millimeters from the top border.
You can have one header for the first page, and another header for all other pages. To achieve this, you can divide your header definition file in three parts by using three different keywords, or rather keylines:
IFFIRST (Part 1. Place everything that is unique for the first page header here.) ENDIF IFNOTFIRST (Part 2. Place everything that is unique for the other header here.) ENDIF (Part 3. Place everything that is common to both the first page header and the other header here.)
You can divide the diagrams and documents in your Organizer view into different chapters by using the chapter symbol. You add a chapter symbol to the Organizer view with Edit > Add New. In the dialog that follows, select one of the Chapter alternatives under the Organizer document type group, and specify the chapter name under New document name. (If you do not want to create a chapter introduction text (see below), make sure that the Show in editor toggle button is off before closing the dialog.)
Figure 105 : Chapters in the Organizer view
|
|
Chapters can be auto-numbered and can be moved with the up and down quick buttons. You can select a chapter symbol to restrict the scope for diagrams and documents that are going to be printed.
It is possible to associate a text with a chapter symbol. The text will be printed at the position of the chapter symbol, and the text can be regarded as a chapter introduction text.
To create a chapter introduction text, you should invoke the Text Editor. This can be done in two ways:
In the Text Editor, type in the chapter introduction text and save the file.
For a large SDL diagram with many pages, it is convenient to divide the different pages of the diagram into different sub chapters.
To make this possible, you have to make the page symbols visible in the Organizer, if they are not visible already. This is done in the View Options dialog by turning on Page Symbols.
Figure 106 : Chapters between SDL pages
|
|
When page symbols are visible, you can move chapter symbols into the correct place within the SDL system by using the up and down quick-buttons. You can also create new chapter symbols directly at the correct place, by selecting the SDL symbol that the chapter symbol should be placed after, before invoking Add New.
Normally, the start chapter number is 1 (or 1.1 if the first chapter symbol has the type Chapter 1.1.) You can change this number in the View > Chapter Options dialog.
As default, all chapters are visible in the table of contents. If you have a lot of chapters, you can limit the number of chapters in the table of contents by using the View > Chapter Options dialog. A maximum chapter level of 2 will only include chapter symbols of type Chapter, Chapter 1 and Chapter 1.1 in the table of contents.
To print a table of contents, you have to turn on the Table of contents toggle button in the Contents section in the Print dialog.
Figure 107 : The Table of Contents entry in the Print dialog
|
|
As default, the table of contents includes chapters, diagrams and documents. To restrict the table of contents to just chapters, there are two ways:
Figure 108 : Part of the Print Setup dialog for Table of contents
|
|
A plain text document can become a title page by placing it first among the diagrams and documents that are printed. There is nothing special about a title page, except that it can be placed before the table of contents.
Figure 109 : A title text document in the Organizer view
|
|
To print a table of contents, you have to turn on the Table of contents toggle button in the Contents section in the Print dialog.
Normally, you do not have to do anything to get the title page before the table of contents, because the print operation will as default treat an initial text document as a title page. There is however a way to turn this on and off. This is done in the Print Setup dialog for the Table of contents entry in the Contents section in the Print dialog. You can get to this dialog from the Print dialog by pressing the setup button with a picture close to the Table of contents entry.
State Matrices are described in detail in The Text Editor. Here are only the most important things discussed, enabling you to get a nice printout of state matrices for processes in your SDL system.
When you have a correct SDL system, you can create state matrices with the Generate > State Overview menu choice. A state information file (*.ins) will be created in your target directory, a plain text symbol connected to the file will be added in the Organizer view, and a Text Editor will pop up, acting as a State Matrix Viewer.
Process HelloWorld: nextstates States a Start state b waiting c stop | STATES SIGNALS | a b c |------------- - | b Hello | c |
The Text Editor has two menu choices that you can use to get the state matrices that you want.
The options in the two dialogs above can also be set in a more permanent way, using preferences. To do this, use these Text Editor preferences:
When you view state matrices on-line, you will not see any paper page references in a page number state matrix. All page numbers are undefined and replaced by a "*". The page numbers are only visible in your printout, and only if you print the SDL processes together with the state matrices from the Organizer.
The index is described in detail in The Index Viewer. Here are only the most important things discussed, enabling you to get a nice printout of an index of all SDL entities defined and used in your SDL system.
When you have a correct SDL system, you can press the Generate Index quick button in the Organizer. This will pop up an index viewer with an index of all SDL entities defined and used in your SDL system.
Figure 111 : An SDL entity index example
|
|
The generated index may be too long to be printed in its entirety. You can make the index smaller by filtering out information that you consider unimportant.
You can filter out SDL entities defined in specific SDL diagrams. This is done with the View > Filter Diagrams dialog. A common use of this possibility is to filter out SDL entities defined in package Predefined.
You can filter out SDL entity types. This is done in the View > Filter Types dialog. For instance, if you want an index of just the signals in your SDL system, then you can use this possibility to filter out all other SDL entity types.
To make your filter more permanent than just for the current Index Viewer session, you should define your filter settings in the Preference Manager before starting the Index Viewer. These two preferences are appropriate:
Each SDL entity in the index can be presented in four different ways. You can change the index appearance for the current Index Viewer session with the View > Index Appearance dialog. To make your changes more permanent, use the Preference Manager and the following preference:
As default, the index appearance is set to Detailed. This setting is appropriate for on-line viewing. For a printout, it might produce unnecessary large indexes. To get a smaller index in a printout, use the Compact index appearance.
It is possible to get paper page references for both definitions and uses of SDL entities in a printout of an index. To achieve this, leave the Index Viewer window on screen while doing a printout from the Organizer that includes your SDL system and the index view.
There are two kinds of fonts:
Below, you will learn how to set up Telelogic Tau to use appropriate fonts for different uses.
State matrices are viewed and printed from the Text Editor. State matrices should be presented using a non-proportional font. To get a non-proportional font in printouts of state matrices, set the preference SDT* PrintFontFamily to Courier.
Sometimes, it is convenient to make aligned tables in SDL text symbols. This requires a non-proportional font. On the other hand, you do not want a non-proportional font for all other symbols in a process diagram, because you want to squeeze as much text as possible into a flow symbol without going outside the symbol border.
You can have a separate, non-proportional font for SDL text symbols. This is achieved by setting Editor* TextSymbolFontFamily to Courier. This preference is valid both on-line and in print. All the other symbols use the fonts set by Editor* ScreenFontFamily and Editor* PrintFontFamily.
In this sub section we will take a more detailed and practical look at how an ordinary SDL system can be turned into an SDL system with enhanced print facilities.
|
Note: As default in this section, we are talking about menu choices and dialogs in the Organizer. |
Before starting doing print enhancements for the specific SDL system, we should set up some preferences affecting how the final printout will look like.
We will use an SDL system called HelloWorld as an example. When we start, we have a correct SDL system that is not adapted in any way for producing a nice printout. If we just do a plain printout of HelloWorld, we will get the following:
|
Note: The figures below are not exact copies of a printout, they have been modified slightly to fit in this manual. |
Figure 112 : HelloWorld, Organizer view
|
|
Figure 113 : HelloWorld, system diagram
|
|
Figure 114 : HelloWorld, block diagram
|
|
Figure 115 : HelloWorld, process diagram
|
|
To get a better printout, we will add the following:
When we have done that, we will perform a print operation to actually get our enhanced printout.
The header should have the following properties:
Fortunately, someone at our company has provided a company logo in Encapsulated PostScript format (*.eps), and a template header definition file. The template looks like this:
IFFIRST 18 28 Name of designer ENDIF IFNOTFIRST 183 20 <page>(<totalpages>) 90 24 Chapter <chapternumber> <chaptername> ENDIF EPSF 10 25 /home/lat/hello/telelogic.eps 90 20 Name of SDL system
/home/lat/hello/headerTemplate.txt.
Figure 116 : Specifying the template header file in the Add New dialog
|
|
Name of designer -> Lars Tufvesson Name of SDL system -> HelloWorld
A title page is a plain text document that is placed first among all printed pages and documents.
******************* *System HelloWorld* ******************* A revolutionary SDL system software package
We would like to divide our diagrams and documents in three chapters:
The second chapter will be further divided into two sub chapters. Each chapter and sub chapter should have a chapter introduction text.
This chapter contains two state matrices for the SDL process: One with page numbers to the SDL process and one with nextstate information.
We will produce the state matrices for this chapter in the next sub section. For now, we leave this chapter empty.
In this chapter, you will find the actual SDL system.
In this sub chapter, the first process page will be defined.
In this sub chapter, the second process page will be defined.
The appendix contains an index of all SDL entities.
The Organizer can with the help of the Analyzer generate a state overview information file (*.ins). The file is placed in the target directory. The Text Editor can display this file as state matrices.
*.ins file. *.ins). When you have examined the state matrices, exit the Text Editor. *.ins file should be placed in the first chapter instead of in the same chapter as the SDL system. To move the plain text symbol for the *.ins file to the correct location, select the symbol and use the up quick button as many times as required to get the symbol into the first chapter.We would like an index of SDL entities defined in our SDL system last in the printout. The Organizer can with the help of the Analyzer produce a cross reference file. The Index Viewer can present the information in the cross reference file as an index. To keep the size of the index small, we filter out some SDL entities and we present the index in an as compact way as possible.
*.xrf and contains the cross reference information. The Index Viewer pops up when the Analyzer is ready, and presents the cross reference information as an index.Now, everything is in place to do the actual print operation.
|
|
Figure 118 : The table of contents
|
|
Figure 119 : The Organizer view
|
|
Figure 120 : The introduction to chapter 1
|
|
Figure 121 : The state matrices
Figure 122 : The introduction to chapter 2
|
|
Figure 123 : The SDL system diagram
|
|
Figure 124 : The SDL block diagram
|
|
Figure 125 : The introduction to chapter 2.1
|
|
Figure 126 : The first process page
|
|
Figure 127 : The introduction to chapter 2.2
|
|
Figure 128 : The second process page
|
|
Figure 129 : The introduction to the appendix
|
|
|
|
In the previous section, we took an ordinary SDL system and made enhancements to get a nice printout. In this section, we will look at how we can make the enhancements as permanent as possible. We would like to be able to load a system file, invoke the print operation and get a nice printout without changing any print settings.
Let us take a new look at all the changes we have made, to see how we can make a future print operation as painless as possible.
Every time the print dialog is invoked, the Table of contents setup option After initial text document will be turned on. This means that the title page will show up as a title page in future print operations also. No extra actions necessary here.
The chapter symbols should stay where they were initially placed. Due to implementation reasons, chapter symbols placed between SDL page symbols might be a little more volatile than they should be. The position of a chapter symbol is determined by remembering the name of the next SDL page symbol. If you rename that SDL page symbol, the chapter looses its hook and may end up in the wrong position.
The chapter options that you can set in the Chapter Options dialog are reset every time Telelogic Tau is restarted. This means that if you want the start chapter number to permanently be anything other than 1.1.1.1, or you want to hide sub chapters in the table of contents, then you have to check the Chapter Options settings before each print operation.
State matrix options are not saved together with the state overview file (*.ins). This means that if you go for the default settings (show state matrices for all SDL processes and show page numbers and nextstate information for transitions) then you do not have to do anything special to get the same appearance in future print operations.
Note however that the default settings can be changed with preference values. This means that everyone that performs a print operation should use the same preference values for these Text Editor preferences:
There is one more thing to consider regarding state matrices: The state overview file (*.ins) is generated in the target directory. You may regard the target directory as a temporary directory where files can be erased after a Telelogic Tau session is ended. It might be cumbersome to regenerate a state overview file each time you want to do a printout. In this situation, it might be a good idea to move the state overview file to the source directory, where your SDL diagram files resides. The file move is most easily done outside of Telelogic Tau, but you have to reconnect the plain text symbol in the Organizer view to the state overview file in the source directory with Telelogic Tau.
The main difference between the state overview file (*.ins) generated for state matrices and the cross reference file (*.xrf) generated for the index is that a symbol is added in the Organizer view for the state overview file, while there is no symbol added for the cross reference file.
Index options are not saved together with the cross reference file. This means that if you go for the default settings (a detailed index with no filter) then you do not have to do anything special to get the same appearance in future print operations.
Note however that the default settings can be changed with preference values. This means that everyone that performs a print operation should use the same preference values for these Index Viewer preferences:
The cross reference file (*.xrf) is generated in the target directory. You may regard the target directory as a temporary directory where files can be erased after a Telelogic Tau session is ended. It might be cumbersome to regenerate a cross reference file each time you want to do a printout. In this situation, it might be a good idea to move the cross reference file to the source directory, where your SDL diagram files resides. The file move is most easily done outside of Telelogic Tau.
Finally, we have to take care of the fact that there is no symbol for the cross reference file in the Organizer view. To get a printout of an index, you have to have an Index Viewer window on screen and loaded with a correct cross reference file. (To get paper page references in the index, the index has to be printed from the Organizer together with the SDL system.) The easiest solution is to always generate a new index with the Generate Index quick button when it is time to print. If you do not want to generate a new index each time, you could do like this:
Use the Add New dialog to add a new document. Set the document type to Organizer > Generic and the document name to something appropriate like Index. Close the dialog and use Edit > Connect to connect the new generic document symbol to your cross reference file in the source directory. With this in place, the only thing you have to do before the print to get an index printed, is to pop up an Index Viewer with the menu choice Tools > SDL > Index Viewer. The Organizer will automatically load the started Index Viewer with the first found file with the extension *.xrf in the Organizer view, if there is such a file.
Every time the print dialog is invoked, the Table of contents setup option Only chapters in TOC will be set to off. This means that if you want only chapters in the table of contents, you have to turn this option on every time you want to print.
In a similar manner, every time Telelogic Tau is started, the Table of contents toggle button in the main print dialog is set to off. This means that every time you want to do a print, you have to check the Table of contents toggle button and turn it on, if it is off.