Documentation
Search…
Export with CSV Export plugin

Using the CSV Plugin

1. Download and install the plugin.

Download the plugin zip file from the latest release in GitHub. Then, in Tropy, navigate to Preferences > Plugins (in Windows, Edit > Preferences > Plugins).
Click on Install Plugin. In the dialogue box that opens, navigate to wherever you saved the plugin folder from GitHub; select it, then click Open. You have now installed the CSV Export plugin.

2. Activate and customize the plugin.

First, click Enable next to the plugin's name.
Then click on the name of the plugin to open up a customization panel within the Plugins pane.
You will see there several options for customization. You can change the name of your plugin instance if you wish. Then check the boxes for the options you want.
CSV Export customization window
The fields labeled Item Template and Photo Template tell Tropy exactly which fields you want to include in the CSV export. If you are exporting items that use a custom template for items or photos, you should select that template in the appropriate Template field here. That ensures that all the fields are exported and in the order you expect.
If you're exporting multiple items that use multiple templates for items or photos, you'll want to create a new template in the template editor that includes all the fields you want in your export. Then select that template in the Item Template or Photo Template field here in Plugins.
You can also set the default file name of the export (though this can be changed when you're using the plugin), or choose to copy the exported data to your clipboard instead.
For more details about the various customization options, see the plugin README

3. Use the plugin to export items.

Once you have customized the plugin, close the Preferences window (there's no Save button---your settings autosave).
In your item table, right-click on the item you wish to export, or select multiple items and then right-click. Navigate to Export Selected Items and click on the name of the CSV Export plugin (remember that you might have given it a different name in the Plugins customization window).
Using the CSV plugin in the item table
A dialog box will open. Select where you want to save your exported CSV and change the name of the file if you wish. Then click Save.

4. Look at your CSV in another application.

Your CSV should be complete! If you look at the CSV in another application, you'll notice that the header row is the URIs of the fields in your chosen metadata template. Tropy exports using the URIs because it's possible that you have multiple labels for the same property across various templates.

Notes

If you anticipate exporting items in specific different categories often (e.g., newspapers and correspondence), you may wish to have two separate instances of the plugin so you don't have to switch back and forth between your Newspaper template and your Correspondence template in the Plugin settings. To add another instance, click on the plus sign next to the first plugin instance to add another instance and customize it as you wish (without deleting the first instance). Be sure you name it something different!
Multiple CSV plugin instances
Copy link