Std ProjectUtil: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
 
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>


<!--T:1-->
{{Docnav
{{Docnav
|[[Std_DependencyGraph|DependencyGraph]]
|[[Std_ExportGraphviz|Std ExportGraphviz]]
|[[Std_MeasureDistance|Std MeasureDistance]]
|[[Std_MeasureDistance|MeasureDistance]]
|[[Std_Tools_Menu|Std Tools Menu]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=
|IconL=Std_DependencyGraph.svg
|IconR=Std_MeasureDistance.svg
|IconR=Std_MeasureDistance.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}


<!--Empty=1 to suppress icon-->
<!--T:2-->
{{GuiCommand
{{GuiCommand
|Name=Std ProjectUtil
|Name=Std ProjectUtil
|Empty=1
|MenuLocation=Tools → Project utility...
|MenuLocation=Tools → Project utility...
|Workbenches=All
|Workbenches=All
}}
}}


==Description==
==Description== <!--T:3-->


<!--T:4-->
The '''Std ProjectUtil''' command is there to assist manual edits of FreeCAD project files. A FreeCAD project file (*.FCStd) is in fact a ZIP file containing multiple files. In some rare cases it is useful to extract these files and, after manual edits, create a new project file from them.
With the '''Std ProjectUtil''' command you can extract files from a FreeCAD project file ({{FileName|*.FCStd}}), which is in fact a [https://en.wikipedia.org/wiki/Zip_(file_format) ZIP] file, and, after manual edits, create a new project file from them.


</translate>
</translate>
[[Image:Project_utility_en.png]]
[[Image:Project_utility_en.png]]
<translate>
<translate>
<!--T:5-->
{{Caption|The Project utility dialog box}}
{{Caption|The Project utility dialog box}}


==Usage==
==Usage== <!--T:6-->


===Extract project===
===Extract project=== <!--T:7-->


<!--T:8-->
# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# Select the {{MenuCommand|Tools → [[Image:Std_ProjectUtil.svg|16px]] Project utility...}} option from the menu.
# The Project utility dialog box opens.
# Press the {{Button|...}} button to the right of {{MenuCommand|Extract project → Source}}.
# Press the {{Button|...}} button to the right of {{MenuCommand|Extract project → Source}}.
# Select the *.FCStd file you want to edit.
# Select the {{FileName|*.FCStd}} file you want to edit.
# Press the {{Button|...}} button to the right of {{MenuCommand|Extract project → Destination}}.
# Press the {{Button|...}} button to the right of {{MenuCommand|Extract project → Destination}}.
# Select a folder where the project file should be unpacked. It is advisable to select an empty folder.
# Select a folder where the project file should be extracted. It is advisable to select an empty folder.
# Press the {{Button|Extract}} button
# Press the {{Button|Extract}} button.
# Press the {{Button|Close}} button
# Press the {{Button|Close}} button to close the dialog box.


===Manual edits===
===Manual edits=== <!--T:9-->


<!--T:10-->
It is important to realize that the files inside a FreeCAD project file are interlinked. Only editing a single file will typically lead to errors. To make consistent edits across multiple files use a good code editor, such as [http://notepad-plus-plus.org/ Notepad++].
It is important to realize that the files inside a FreeCAD project file are interlinked. Only editing a single file will typically lead to errors. To make consistent edits across multiple files use a good code editor, such as [http://notepad-plus-plus.org/ Notepad++] (for the Windows OS) or [https://notepadqq.com/s/ Notepadqq] (for Linux OS).


===Create project===
===Create project=== <!--T:11-->


<!--T:12-->
# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# Select the {{MenuCommand|Tools → [[Image:Std_ProjectUtil.svg|16px]] Project utility...}} option from the menu.
# The Project utility dialog box opens.
# Press the {{Button|...}} button to the right of {{MenuCommand|Create project → Source}}.
# Press the {{Button|...}} button to the right of {{MenuCommand|Create project → Source}}.
# Select the Document.xml file. The command will be automatically find all linked files.
# Select the {{FileName|Document.xml}} file. The command will be automatically find all linked files.
# Press the {{Button|...}} button to the right of {{MenuCommand|Create project → Destination}}.
# Press the {{Button|...}} button to the right of {{MenuCommand|Create project → Destination}}.
# Select a folder where the new project file should be created.
# Select a folder where the new project file should be created.
# Press the {{Button|Create}} button.
# Press the {{Button|Create}} button.
# A new project file with a fixed name ('project.FCStd') is created. There is no warning if a file with that name already exists.
# A new project file with a fixed name, {{FileName|project.fcstd}}, is created in the selected folder. There is no warning if a file with that name already exists.
# Optionally check the {{CheckBox|TRUE|Load project file after creation}} checkbox.
# Optionally check the {{CheckBox|TRUE|Load project file after creation}} checkbox.
# Press the {{Button|Close}} button.
# Press the {{Button|Close}} button to close the dialog box.

==Notes== <!--T:13-->


<!--T:14-->
==Notes==
* For more information about the FreeCAD project file format see [[File_Format_FCStd|File Format FCStd]].


See [[File_Format_FCStd|File Format FCStd]] for more information about the FreeCad project file format.


<!--T:15-->
{{Docnav
{{Docnav
|[[Std_DependencyGraph|DependencyGraph]]
|[[Std_ExportGraphviz|Std ExportGraphviz]]
|[[Std_MeasureDistance|Std MeasureDistance]]
|[[Std_MeasureDistance|MeasureDistance]]
|[[Std_Tools_Menu|Std Tools Menu]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=
|IconL=Std_DependencyGraph.svg
|IconR=Std_MeasureDistance.svg
|IconR=Std_MeasureDistance.svg
|IconC=Freecad.svg
|IconC=Freecad.svg

Latest revision as of 07:30, 11 August 2021

Std ProjectUtil

Menu location
Tools → Project utility...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
None

Description

With the Std ProjectUtil command you can extract files from a FreeCAD project file (*.FCStd), which is in fact a ZIP file, and, after manual edits, create a new project file from them.

The Project utility dialog box

Usage

Extract project

  1. Select the Tools → Project utility... option from the menu.
  2. The Project utility dialog box opens.
  3. Press the ... button to the right of Extract project → Source.
  4. Select the *.FCStd file you want to edit.
  5. Press the ... button to the right of Extract project → Destination.
  6. Select a folder where the project file should be extracted. It is advisable to select an empty folder.
  7. Press the Extract button.
  8. Press the Close button to close the dialog box.

Manual edits

It is important to realize that the files inside a FreeCAD project file are interlinked. Only editing a single file will typically lead to errors. To make consistent edits across multiple files use a good code editor, such as Notepad++ (for the Windows OS) or Notepadqq (for Linux OS).

Create project

  1. Select the Tools → Project utility... option from the menu.
  2. The Project utility dialog box opens.
  3. Press the ... button to the right of Create project → Source.
  4. Select the Document.xml file. The command will be automatically find all linked files.
  5. Press the ... button to the right of Create project → Destination.
  6. Select a folder where the new project file should be created.
  7. Press the Create button.
  8. A new project file with a fixed name, project.fcstd, is created in the selected folder. There is no warning if a file with that name already exists.
  9. Optionally check the Load project file after creation checkbox.
  10. Press the Close button to close the dialog box.

Notes