Std ProjectUtil: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 36: Line 36:


# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# The Project utility dialog box pops up.
# 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 *.FCStd file you want to edit.
Line 41: Line 42:
# 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 unpacked. 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===
Line 50: Line 51:


# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# Select the {{MenuCommand|Tools → Project utility...}} option from the menu.
# The Project utility dialog box pops up.
# 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 Document.xml file. The command will be automatically find all linked files.
Line 57: Line 59:
# 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.
# 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.
# 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==
==Notes==

Revision as of 19:56, 20 April 2020

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.


Std ProjectUtil

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

Description

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.

The Project utility dialog box

Usage

Extract project

  1. Select the Tools → Project utility... option from the menu.
  2. The Project utility dialog box pops up.
  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 unpacked. 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).

Create project

  1. Select the Tools → Project utility... option from the menu.
  2. The Project utility dialog box pops up.
  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