Difference between revisions of "TechDraw TemplateHowTo"

From FreeCAD Documentation
Jump to navigation Jump to search
(Marked this version for translation)
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
<translate>
 
<translate>
  
 +
<!--T:25-->
 
{{TutorialInfo
 
{{TutorialInfo
 
|Topic=Drafting
 
|Topic=Drafting
Line 10: Line 11:
 
}}
 
}}
  
== Introduction ==
+
== Introduction == <!--T:26-->
  
 +
<!--T:27-->
 
This tutorial shows you how to create an [[SVG]] file that can be used as the background [[TechDraw Templates|template]] for the [[TechDraw Workbench]] pages.
 
This tutorial shows you how to create an [[SVG]] file that can be used as the background [[TechDraw Templates|template]] for the [[TechDraw Workbench]] pages.
  
Line 20: Line 22:
 
We're going to make a simple template for US Letter size paper in landscape orientation.
 
We're going to make a simple template for US Letter size paper in landscape orientation.
  
 +
<!--T:28-->
 
A copy of the result of this tutorial is available in
 
A copy of the result of this tutorial is available in
 
{{Code|code=
 
{{Code|code=
Line 25: Line 28:
 
}}
 
}}
  
 +
<!--T:29-->
 
Where {{incode|$INSTALL_DIR}} is the directory where FreeCAD was installed, for example
 
Where {{incode|$INSTALL_DIR}} is the directory where FreeCAD was installed, for example
 
{{Code|code=
 
{{Code|code=
Line 35: Line 39:
 
1. Open a new document in Inkscape.
 
1. Open a new document in Inkscape.
  
 +
<!--T:30-->
 
2. In Document Properties
 
2. In Document Properties
 
* Select page size "US Letter" and orientation "landscape".
 
* Select page size "US Letter" and orientation "landscape".
Line 42: Line 47:
 
{{clear}}
 
{{clear}}
  
 +
<!--T:31-->
 
3. Use the XML Editor to add a "freecad" namespace clause to the {{incode|<svg>}} item.
 
3. Use the XML Editor to add a "freecad" namespace clause to the {{incode|<svg>}} item.
 
* <code>xmlns:freecad="http://www.freecadweb.org/wiki/index.php?title=Svg_Namespace"</code>.
 
* <code>xmlns:freecad="http://www.freecadweb.org/wiki/index.php?title=Svg_Namespace"</code>.
Line 48: Line 54:
 
{{clear}}
 
{{clear}}
  
== Create template drawing ==
+
== Create template drawing == <!--T:32-->
  
 +
<!--T:33-->
 
4. Draw outlines, zone numbers, center lines, and other geometry.
 
4. Draw outlines, zone numbers, center lines, and other geometry.
  
 +
<!--T:34-->
 
5. Draw the boxes and lines for the title block.
 
5. Draw the boxes and lines for the title block.
  
 +
<!--T:35-->
 
6. Add and position your static text.
 
6. Add and position your static text.
  
 +
<!--T:36-->
 
7. Add and position the text that will be editable.
 
7. Add and position the text that will be editable.
  
 +
<!--T:37-->
 
8. You now have your finished artwork, that should look something like this:
 
8. You now have your finished artwork, that should look something like this:
 
[[File:InkFinishedArt.png|800px|center]]
 
[[File:InkFinishedArt.png|800px|center]]
Line 63: Line 74:
 
{{clear}}
 
{{clear}}
  
== Create editable fields ==
+
== Create editable fields == <!--T:38-->
  
 +
<!--T:39-->
 
9. Use the XML Editor to add a {{incode|freecad:editable}} tag to each editable {{incode|<text>}} item.
 
9. Use the XML Editor to add a {{incode|freecad:editable}} tag to each editable {{incode|<text>}} item.
 
* Assign a meaningful field name to each editable text.
 
* Assign a meaningful field name to each editable text.
Line 71: Line 83:
 
{{clear}}
 
{{clear}}
  
== Adjust size of the SVG ==
+
== Adjust size of the SVG == <!--T:40-->
  
 +
<!--T:41-->
 
10. Use the XML editor to adjust the {{incode|viewBox}} attribute to match your page size in millimeters.
 
10. Use the XML editor to adjust the {{incode|viewBox}} attribute to match your page size in millimeters.
 
* It is four values, in the format {{incode|"0 0 width height"}}
 
* It is four values, in the format {{incode|"0 0 width height"}}
Line 79: Line 92:
 
{{clear}}
 
{{clear}}
  
 +
<!--T:42-->
 
11. Your template will now appear much bigger than desired.
 
11. Your template will now appear much bigger than desired.
 
[[File:InkMuchTooBig.png|800px|center]]
 
[[File:InkMuchTooBig.png|800px|center]]
Line 84: Line 98:
 
{{clear}}
 
{{clear}}
  
 +
<!--T:43-->
 
12. We need to shrink it.
 
12. We need to shrink it.
 
* {{MenuCommand|Edit → Select All in All Layers}}, or box select and select all.
 
* {{MenuCommand|Edit → Select All in All Layers}}, or box select and select all.
Line 89: Line 104:
 
* Set it to the page size less any applicable margins, for example, {{Button|W: 250}}, and {{Button|H: 200}}.
 
* Set it to the page size less any applicable margins, for example, {{Button|W: 250}}, and {{Button|H: 200}}.
  
 +
<!--T:44-->
 
13. Use "Align and Distribute" or the {{Button|X:}} and {{Button|Y:}} spinboxes to position the artwork within the limits of the page if required.
 
13. Use "Align and Distribute" or the {{Button|X:}} and {{Button|Y:}} spinboxes to position the artwork within the limits of the page if required.
  
 +
<!--T:45-->
 
14. Your template should now look right, just like it did in the finished artwork picture above.
 
14. Your template should now look right, just like it did in the finished artwork picture above.
  
== Remove transformans on the SVG ==
+
== Remove transformans on the SVG == <!--T:46-->
  
 +
<!--T:47-->
 
15. Ensure that all your editable texts are "ungrouped" with {{KEY|Shift}}+{{KEY|Ctrl}}+{{KEY|g}}.
 
15. Ensure that all your editable texts are "ungrouped" with {{KEY|Shift}}+{{KEY|Ctrl}}+{{KEY|g}}.
  
 +
<!--T:48-->
 
16. Select everything on your page, {{MenuCommand|Edit → Select All}}, and then {{MenuCommand|Edit → Copy}}.
 
16. Select everything on your page, {{MenuCommand|Edit → Select All}}, and then {{MenuCommand|Edit → Copy}}.
  
 +
<!--T:49-->
 
17. Then delete the current layer, {{MenuCommand|Layer → Delete Current Layer}}.
 
17. Then delete the current layer, {{MenuCommand|Layer → Delete Current Layer}}.
  
 +
<!--T:50-->
 
18. Then paste, {{MenuCommand|Edit → Paste in Place}}.
 
18. Then paste, {{MenuCommand|Edit → Paste in Place}}.
  
 +
<!--T:51-->
 
19. Your template should now look right and shouldn't have any unwanted transforms.
 
19. Your template should now look right and shouldn't have any unwanted transforms.
  
 +
<!--T:52-->
 
20. Save your template.
 
20. Save your template.
  
 +
<!--T:53-->
 
21. Try it in FreeCAD and [[TechDraw Workbench]] with [[TechDraw New Pick]].
 
21. Try it in FreeCAD and [[TechDraw Workbench]] with [[TechDraw New Pick]].
 
[[File:FCTemplateHow.png|center]]
 
[[File:FCTemplateHow.png|center]]
Line 115: Line 139:
 
Don't use Layers in Inkscape until you've mastered template creation without them. Layers and Groups can automatically insert unwanted transforms into your [[SVG]] file.
 
Don't use Layers in Inkscape until you've mastered template creation without them. Layers and Groups can automatically insert unwanted transforms into your [[SVG]] file.
  
 +
<!--T:54-->
 +
As a final step before using your new template, make sure to remove any transform clauses from the Svg code. Transform clauses '''will cause problems'''.
 +
 +
<!--T:57-->
 
See a Stackoverflow discussion on [https://stackoverflow.com/questions/13329125/removing-transforms-in-svg-files removing transform clauses in SVG files].
 
See a Stackoverflow discussion on [https://stackoverflow.com/questions/13329125/removing-transforms-in-svg-files removing transform clauses in SVG files].
  
Line 121: Line 149:
 
{{TechDraw Tools navi}}
 
{{TechDraw Tools navi}}
  
 +
<!--T:55-->
 
{{Userdocnavi}}
 
{{Userdocnavi}}
  
 +
<!--T:56-->
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
 
</translate>
 
</translate>

Revision as of 21:30, 13 February 2020

Other languages:
Deutsch • ‎English • ‎français • ‎italiano
Base ExampleCommandModel.png Tutorial
Topic
Drafting
Level
Intermediate
Time to complete
60 minutes
Authors
wandererfan
FreeCAD version
0.17
Example files
None


Introduction

This tutorial shows you how to create an SVG file that can be used as the background template for the TechDraw Workbench pages.

This tutorial assumes you are moderately familiar with Inkscape and SVG, as well as FreeCAD and the TechDraw Workbench.

We're going to make a simple template for US Letter size paper in landscape orientation.

A copy of the result of this tutorial is available in

$INSTALL_DIR/Mod/TechDraw/Templates/HowToExample.svg

Where $INSTALL_DIR is the directory where FreeCAD was installed, for example

/usr/share/freecad/Mod/TechDraw/Templates/HowToExample.svg

Create base document

1. Open a new document in Inkscape.

2. In Document Properties

  • Select page size "US Letter" and orientation "landscape".
  • Set default units to "mm", and the page size to width "279.4" and height "215.9".
InkDocProp.png

Inskcape: document with page size and orientation


3. Use the XML Editor to add a "freecad" namespace clause to the <svg> item.

InkXMLNameSpace.png

Inkscape: XML Editor adding the "freecad" namespace clause to the <svg> item


Create template drawing

4. Draw outlines, zone numbers, center lines, and other geometry.

5. Draw the boxes and lines for the title block.

6. Add and position your static text.

7. Add and position the text that will be editable.

8. You now have your finished artwork, that should look something like this:

InkFinishedArt.png

Inkscape: tentative template layout


Create editable fields

9. Use the XML Editor to add a freecad:editable tag to each editable <text> item.

  • Assign a meaningful field name to each editable text.
InkXMLeditableTag.png

Inkscape: XML Editor adding the "freecad:editable" property to the desired <text> item


Adjust size of the SVG

10. Use the XML editor to adjust the viewBox attribute to match your page size in millimeters.

  • It is four values, in the format "0 0 width height"
InkXMLviewBox.png

Inkscape: XML Editor adjusting the viewbox to match the page size in millimeters


11. Your template will now appear much bigger than desired.

InkMuchTooBig.png

Inkscape: tentative template layout exceeding the page size


12. We need to shrink it.

  • Edit → Select All in All Layers, or box select and select all.
  • Adjust the W: and H: spinboxes to match your artwork's size in millimeters.
  • Set it to the page size less any applicable margins, for example, W: 250, and H: 200.

13. Use "Align and Distribute" or the X: and Y: spinboxes to position the artwork within the limits of the page if required.

14. Your template should now look right, just like it did in the finished artwork picture above.

Remove transformans on the SVG

15. Ensure that all your editable texts are "ungrouped" with Shift+Ctrl+g.

16. Select everything on your page, Edit → Select All, and then Edit → Copy.

17. Then delete the current layer, Layer → Delete Current Layer.

18. Then paste, Edit → Paste in Place.

19. Your template should now look right and shouldn't have any unwanted transforms.

20. Save your template.

21. Try it in FreeCAD and TechDraw Workbench with TechDraw New Pick.

FCTemplateHow.png

FreeCAD: finished template with an editable text field being modified


Notes

Don't use Layers in Inkscape until you've mastered template creation without them. Layers and Groups can automatically insert unwanted transforms into your SVG file.

As a final step before using your new template, make sure to remove any transform clauses from the Svg code. Transform clauses will cause problems.

See a Stackoverflow discussion on removing transform clauses in SVG files.