Paratext includes the complete history of the project, including which team member edited the text and when. Some simple operations like copying the project to a new project in order to change the project’s short name will cause all the history of the project to be lost. The Convert Project tool was added to Paratext to allow changing the project short name, normalizing Unicode characters, and changing the name(s) of project users, while preserving the project history.
Where do I find the Convert Project tool?
If you are converting data before migrating it to Paratext 8, you will need to use the conversion tool found in the latest version of Paratext 7.6 Beta. If you do not, please see the section on Installing the Convert Project Tool for Paratext 7 before continuing. Paratext 8 includes this tool for use on data that has already been migrated. In both Paratext 7.6 and 8, the tool is found in Tools > Advanced > Convert Project.
Prepare for a major change
Everyone on the project must do a send/receive on the project and all related back translation or auxiliary projects. Then they must stop working on the data. Once all members have done this, the project administrator must do a send/receive of the same projects. Now the administrator has the master copies and is ready to proceed.
Converting a Project
You must be a project administrator to use the tool. Make sure the project you want to convert is selected before you open the tool.
When you open the tool, the dialog looks like this:
You must enter a new project short name. The tool will leave the old project unchanged, but will create a new project taking the old project data and applying the changes you specify.
Remove deleted files from project history
Check this box if you want to clean up the history from files (such as large illustrations) that are not part of the project any more.
Clean up Paratext Live history
If you have used Paratext live and you want to change user names in the project history, check this box.
Convert encoding to 65001 – Unicode
If your project uses a non-Unicode encoding, you can check this box to convert the encoding to Unicode. This box cannot be checked if the project is already in Unicode.
You can have the tool normalize your text as either Composed (letters and diacritics are one code point) or Decomposed (letters and diacritics are two code points). We highly recommend setting normalization to Composed, as this is the best practice for software integration.
Replace User names
To change a user name listed in the project history, select the existing user name you want to remove from the list in the box on the left, then type the new name you want to replace it with in the box on the right, then click “Add.” This will set this pair of names to be replaced. You can add more names to be replaced if you need to. If you click “Add” then realize you made a mistake in your pair of names, click the “Remove” button to remove that pair of names.
Example: this will create a new project PTP2, cleaning up the Paratext live history, and replacing the user name “Jeff Shrum” with “Isabela Novidades”
When you click the Convert project button, the tool goes to work applying your changes. It has to work on each change in your project history, so it can take many hours if the project history has lots of changes.
If doing the conversion before migration to Paratext 8
Now the project with the new short name is ready for immediate migration, since you had the up-to-date master copy before doing the conversion.
If doing the conversion after migration to Paratext 8
When the tool finishes, the new project will not be registered. If it is a standard translation project, you can register it by using the link from Project Properties and Settings to fill in the registry information. You should also delete the old project and its registration from the registry as follows:
- If you are concerned that the conversion may have created issues, make a backup of the old project before you delete it. File -> Backup Project to File
- In Paratext 8, go to the Project menu and select Delete Project…
- Select the old project you want to unregister in the first field.
- In the second field, select “Delete project for all users; delete registration”
- Select OK. Go ahead and accept the warnings.
The old project is now unregistered and the converted project has replaced it.