Help file available in pdf.
Matt_Cartouche is a script that inserts a title block (in fact a simple screen text) which is composed of elements included in the drawing title and some variables.
2. Installation
| Just unzip Matt_Cartouche.zip in the plugins folder. This file is composed of : • The main script(“Matt_Cartouche.rb”) • A folder called “Matt_Cartouche” : • Images for the toolbar • Some translation files |
|
| After installation, run SU. Matt_Cartouche will create a sub menu in “plugins” menu and a toolbar composed of two icons. |
|
3. To use Matt_Cartouche
Before using this script you must configure your drawing title and cartouche settings.
a) Drawing title
To find informations in the title, Cartouche will need a separator. You can use separator you want, but it must be written in settings. For example:
ARMSTRONG# New Orleans# Trumpet# ind_A.rb
You can see a separator in the title (“#”), and 4 informations: “ARMSTRONG”, “New Orleans”, “Trumpet” and “ind_A.rb”. For now Cartouche doesn’t know what this informations correspond to, you will help it in settings.
b) Cartouche settings presentation
You can open it by clicking on the second icon or going to menu plugins/Cartouche/Settings. Settings in a dialog box with some fields.
You can see Cartouche can have 8 fields. Fields can be composed of simple texts, variables, and title parts. Let me explain you how it works.
c) Title order vs Cartouche order
You have to distinguish title informations order, and cartouches fields order. That’s very important. In my example ARMSTRONG is the first title information, but you can put it at the end of the cartouche! Numbers after @ symbol in the fields value are localisation of title informations.
d) Cartouche settings explanations
The most important thing to understand with cartouche is field value parameters. The rest is very simple.
As you can see in the cartouche settings example, there are some symbols in field value.
| - @ | -> | Means "the field value is in the title" |
| - 1 | -> | Means "The filed value is title information N°1" |
| - > | -> | Means "This information will appear upcased in the cartouche" |
| - < | -> | Means "This information will appear capitalized in the cartouche" |
| - = | -> | Means "This information will appear as written in the cartouche" |
| - (-1) | -> | Means "Just write last character in the cartouche" |
| _/_ | -> | Optional code. You must write this symbol at the end of your parameter line. Means "Do not put this information on a new line" |
| - %DATE | -> | A variable that puts current date in the cartouche |
| - %DIR | -> | A variable that puts directory of the drawing in the cartouche |
| - %N | -> | A variable that returns number of the scene |
| - %PAGE | -> | A variable that puts current scene tab name in the cartouche. And your cartouche will change at every change of scene |
Field 1 value “@1>” means “The field 1 value is title information N°1 and will be capitalized”.
Field 3 value “@3<” means “The field 3 value is title information N°3 and will be written as you write in the title”.
Field 4 value “%DATE” means “The field 4 will be the current date”.
Field 5 value “@5>(-1)” means “The field 5 value is title information N°5, will be capitalized and just last character will be in the cartouche”.
Field 6 value “MN” means “The filed 6 will be “MN””.
You can't modify variable case. So you can't use >, <, = or (-1), (1..1), etc.
For information to take from the title, You MUST follow this order:
| @ | If you don’t put it, Cartouche will understand what is written is just some text |
| Integer | To tell to cartouche where information is placed in the title |
| <>= | To change case of the information |
| (…) | Optional symbol, for isolating a part of the information |
| _/_ | Optional symbol, for staying on current cartouche line |
e) Tooltip mode
This is an option in cartouche settings. %PAGE variable puts scene tab name in the cartouche. If you validate this option, %PAGE variable will be changed. So if you have an iso view in your scene, name of the iso view will replace scene tab name.
f) Cartouche separator
These 2 lines in settings are used with _/_ symbol. When this symbol is at the end of a line in settings, Cartouche understands that information will not be a new text line. So it takes 1st separator to start and 2nd separator at the end.
g) Last tool: Record existing cartouche
This tool is used in case of Cartouche creates another text above existing. For example if you delete an existing cartouche, and undo your action, Cartouche will loose text link.
h) Examples
With Armstrong example, here is the setting for putting a cartouche:
And with the settings example, here is the result:
Thank you for reading this text.
Matt666.