Automatic PDF generation configuration file
Note: A configuration file autopdf.cfg must be present in the norms/lvar folder of the project for this function to be available.
The configuration file contains content, layout and text settings for the PDF.
General settings
| Setting | Description | Possible value(s) | Default |
|---|---|---|---|
| filename | Name of the file to be created (optionally including the path). In case no path is given, the system will use the one set in production information. | Strings, usual keywords | Blockname ".pdf" |
| papersize | Paper type or dimensions | Either a paper type name or two numbers specifying the width and height in mm. Possible paper name values are: A0 to A10, B0 to B10, ISOB0 to ISOB10, C0 to C7, DL, Letter, Legal, Statement, Tabloid, Ledger, Executive, and Folio. | No default |
| orientation | Orientation if papersize is set to a paper type name | Portrait (any other value will result in Landscape orientation) | Empty (meaning Landscape orientation) |
| page_margin | Margin between paper edge and contents | Positive number in mm | 5% of paper width |
| image_margin | Margin around images (available space in frame model if present) 1 | Positive number in mm | 5% of available width |
| overview_image_margin | Margin between images and overview cells | Positive number in mm | 5% of cell width |
| rows | Number of rows in overview pages | Whole, positive number | 3 |
| columns | Number of columns in overview pages | Whole, positive number | 4 |
| frame_model_overview_start | The model file name (.mod) that is used on the 1st overview page 2 | File name, including extension | Empty |
| frame_model_overview | File name of model used on the other overview pages | File name, including extension | Empty |
| frame_model | File name of model used on the image pages | File name, including extension | Empty |
| image_resolution | Number of points per inch for images | Positive number | 150 |
| font | Font for all texts not in a frame model | Font name | Arial |
| overview_title_text_pos | Position of title in the overview cells | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | tm (top middle) |
| overview_title_text_height | Character height of titles in the overview | Positive number | 1/15th over overview image height |
| overview_caption_text_pos | Position of caption in the overview cells | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | tl (top left) |
| overview_caption_text_height | Character height of captions in the overview | Positive number | 1/10th of overview image height |
| title_text_pos | Position of title on the image pages | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | tm (top middle) |
| title_text_height | Character height of titles on the image pages | Positive number | 1/30th of image height |
| caption_text_pos | Position of caption on the image pages | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | tl (top left) |
| caption_text_height | Character height of captions on the image pages | Positive number | 1/25th of image height |
| boxpos | Position of the box texts on the image pages | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | bl (bottom left) |
| boxtxtheight | Character height of box texts | Positive number | 1/25th of image height |
| boxtype | Selects exact or rounded box values and whether or not to use grid or mm for width and height values | Exact (not rounded) and/or mm (use mm values instead of default grids) | Empty (meaning rounded box values using the default grids) |
| boxtxts | Prefixes of box values | 3 strings enclosed in double quotes | "L: " "W: " "H: " |
| vanepos | Position of vane in the images | "tl", "tr", "bl" or "br" | tl (top left) |
| vanetxts | Labels of axes of the vane | 6 strings enclosed in double quotes | "Fore" "Aft" "PS" "SB" "Top" "Bottom" |
| page_number_pos | Position of page number | "off", "bl", "bm", "br", "mr", "tr", "tm", "tl", "ml" or "mm" | bm (bottom middle) |
| page_number_style | Style of page number | "none", "single" (just page number) or
"xofy" (current page number and the total number of pages separated by a '/') |
"none" (meaning no page numbers) |
| page_number_height | Character height of page number | Positive number | 1/50th of page width |
Collection definition settings
The configuration file includes the following collections of definitions and their descriptions.
| Setting | Description | Possible value(s) | Default |
|---|---|---|---|
| level_# | Parent level of the branches to process | Number >= 0 | No default |
| set_# | Parts to be included | Boolean rule | No default |
| caption_# | Specifies the caption text | Logistical fields, string | No default |
| title_# | Specifies the title text | Logistical fields, string | No default |
| title_overview_# | Specifies the overview title text | Logistical fields, string | No default |
| include_in_overview_# | Indicates whether images are included in the overview or not (Optional setting) | Yes or No | Yes |
| level_is_wbd_level_# | Sets how value of level_# is interpreted (Optional setting) | Yes or No | No |
| show_previous_steps_# | Selection between cumulative and single images (Optional setting) | Yes or No | Yes |
The '#' is an integer starting at 1. The system expects a series of consecutive collections. There has to be at least one collection in the configuration. Processing stops as soon as one of the settings is missing (except for optional settings).
The level_# setting specifies the parent level of the folders to create images for. This depends also on the value of level_is_wbd_level_#.
Note: To always use the Show full tree structure levels, whether the option is selected or not, set the value of level_is_wbd_level_# to Yes. Otherwise the level is counted according to the tree as it is displayed at the time of PDF generation.
A series of images is created for each child folder of the specified level. A series starts with the parts (complying to the set_# expression) in the first valid child folder. The block/root has level 0, its children level 1, and so on. Levels with empty or default values are ignored as folders, though the parts they contain are not ignored.
After set_#, a Boolean expression (true/false) should follow, meaning that comparisons on the logistical data of parts can be performed. Only parts that have the value true are included in an image.
Unless the value of show_previous_steps_# is No, the next image holds these parts (but now in grey) and includes the parts of the next child folder. If show_previous_steps_# is set to No, the parts in the previous folder are not shown. In that case, the way the parts are viewed (zoom factor, camera position) is reset for each image.
A new series of images is started for the next parent with the specified level. This repeats until the bottom of the tree.