tropy / docs

Tropy Documentation

Tropy

Bring order to your research — use the power of Tropy to organize and describe your research photos so you can find your sources whenever you need them.

Visit tropy.org to learn more or follow @[email protected] for important announcements. To get started, download the latest version of Tropy for your platform, check out the user's manual and join the discussion on the forums.

Interested to work on Tropy or create your own builds? Please find more details below. Happy hacking!

Installation

Visit tropy.org or the release page to download the latest version of Tropy.

You can also install Tropy via Homebrew, winget, or the AUR.

Installation from Source

Install the latest version of Node.js (at least the version that ships with the current Electron release) and all dependencies required to use node-gyp on your platform.

Clone this repository and install Tropy's dependencies:

$ npm install
$ npm run rebuild -- --force

To test that everything works, run:

$ npm test

Creating Builds

To create a dev-build for your current platform run npm run build. This will create a dev-build of Tropy in the dist folder.

Tropy Development

Start Tropy in dev-mode by running npm start.

Plugin Development

You can extend Tropy's functionality via plugins. To find out more, consult the plugin specification and clone the sample plugin to get started.

docs's Issues

Add documentation on adding vocabularies / n3 import

Add changelog to documentation

Broken link to linked open vocabularies

docs/before-you-begin/metadata.md

Line 28 in 181113f

Metadata can be as free-form as you want. But it’s generally best to try to record metadata using a standard that already exists. Why? Metadata standards provide consistency both within your own projects and also in the larger community of scholarship about your sources. Each category in a Tropy metadata template must be linked to a category \(property\) from an existing metadata standard.At present you can only use each property once in a template. Several standards, or vocabularies, are included in Tropy; you can also [add more vocabularies](../in-the-template-editor/vocabularies.md). Metadata specialists in almost every field of study have created many vocabularies, so there’s a good chance that whatever property you need already appears in an existing vocabulary. To search for a metadata vocabulary that meets your needs, start with [Linked Open Vocabularies](http://lov.okfn.org/dataset/lov/).

as seen on https://docs.tropy.org/before-you-begin/metadata

The link for "linked open vocabularies" (http://lov.okfn.org/dataset/lov/) on this page doesn't appear to be active any more, and no longer redirects to the correct site. I think https://lov.linkeddata.es/dataset/lov is the equivalent working link.

Happy to submit a PR for this, unless this will cause problems for the documentation generator

OK to replace Mac key names with symbols?

Would there be any objection to replacing the names of the Mac's meta keys with their conventional symbols, which should be familiar to users? So

⌘ for command
⌥ for option
⇧ for shift

Perhaps with a separate column? In that case the first line of the shortcuts table would look like:

Action	Windows/Linux Shortcut	Mac Shortcut
New project	Ctrl+Shift+P	⇧⌘P

Note in this case that the convention is to put the shift symbol first, as is done is some of the other lines, actually, so there's a little inconsistency in the current table.

I'd be happy to add a key, if that seems desirable.

I also intend to add some missing Mac versions of shortcuts in various places in the docs (e.g., the "Print items" page) and would use the symbols there, too.

Broken link to Tropy’s rights documentation

The link to the rights documentation under https://docs.tropy.org/before-you-begin/metadata#rights leads to https://docs.tropy.org/beginning/rights.html but that page returns a 404.

Multilingual support

Tracking issue to add support for translated documentation.

• Add LANGS.md

• Include some preliminary languages:

# Languages

* [English](en/)
* [Deutsch](de/)
* [Español](es/)
* [Français](fr/)

• Create guide for user-generated documentation