https://github.com/tropy/tropy-plugin-archive

Export metadata and photos into a zip archive.
https://github.com/tropy/tropy-plugin-archive

Last synced: 11 months ago
JSON representation

Export metadata and photos into a zip archive.

• Host: GitHub
• URL: https://github.com/tropy/tropy-plugin-archive
• Owner: tropy
• License: agpl-3.0
• Created: 2018-04-25T16:29:28.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-04-24T02:56:14.000Z (about 3 years ago)
• Last Synced: 2024-11-01T10:42:54.275Z (over 1 year ago)
• Language: JavaScript
• Size: 2.08 MB
• Stars: 7
• Watchers: 9
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


Tropy Archive Plugin


Tropy plugin for exporting items into a single zip archive.

This includes all the metadata, as well as the photo files.

## Installation

- Download the `.zip` file from the [latest release](https://github.com/tropy/tropy-plugin-archive/releases/latest) on GitHub.

- In Tropy, navigate to _Preferences… > Plugins_

  and click _Install Plugin_ to select the downloaded ZIP file.

## Configuration

To configure the plugin, click its _Settings_ button in _Preferences > Plugins_:

In the plugin preferences,

- the `Name` parameter names the particular _instance_ of the plugin,

to make it easier to select that configuration from the Export menu.

- the `Root folder` parameter specifies the name of the folder

(inside the zip archive) where all the exported items will be placed.

- the `Image folder` parameter specifies the name of the subdirectory within the Root folder where image files will be saved.

By default this is `.`,

which means the Root directory itself rather than a subdirectory

- the `Save as` parameter specifies the default file name and location for the zip archive to be saved.

- `Always ask?` can be checked to make the file picker dialog always be shown,

even when the `Save as` parameter is set to specify a default location.

## Usage

To trigger the plugin, select the entry in the export sub-menu in Tropy.

## Development

See [the example plugin documentation](https://github.com/tropy/tropy-plugin-example/blob/main/README.md#developing-and-debugging) for development instructions.