diff --git a/.gitbook/assets/api-key b/.gitbook/assets/api-key.bin similarity index 100% rename from .gitbook/assets/api-key rename to .gitbook/assets/api-key.bin diff --git a/.gitbook/assets/auto-consolidation-check.png b/.gitbook/assets/auto-consolidation-check (1) (1).png similarity index 100% rename from .gitbook/assets/auto-consolidation-check.png rename to .gitbook/assets/auto-consolidation-check (1) (1).png diff --git a/.gitbook/assets/Consolidation-box.png b/.gitbook/assets/consolidation-box.png similarity index 100% rename from .gitbook/assets/Consolidation-box.png rename to .gitbook/assets/consolidation-box.png diff --git a/.gitbook/assets/Consolidation-needed.png b/.gitbook/assets/consolidation-needed.png similarity index 100% rename from .gitbook/assets/Consolidation-needed.png rename to .gitbook/assets/consolidation-needed.png diff --git a/.gitbook/assets/CSV-export-customization.png b/.gitbook/assets/csv-export-customization.png similarity index 100% rename from .gitbook/assets/CSV-export-customization.png rename to .gitbook/assets/csv-export-customization.png diff --git a/.gitbook/assets/preferences@2x.png b/.gitbook/assets/preferences-2x.png similarity index 100% rename from .gitbook/assets/preferences@2x.png rename to .gitbook/assets/preferences-2x.png diff --git a/.gitbook/assets/Screen Shot 2020-03-17 at 11.39.29 AM.png b/.gitbook/assets/screen-shot-2020-03-17-at-11.39.29-am.png similarity index 100% rename from .gitbook/assets/Screen Shot 2020-03-17 at 11.39.29 AM.png rename to .gitbook/assets/screen-shot-2020-03-17-at-11.39.29-am.png diff --git a/.gitbook/assets/Screen Shot 2020-03-17 at 2.24.57 PM.png b/.gitbook/assets/screen-shot-2020-03-17-at-2.24.57-pm.png similarity index 100% rename from .gitbook/assets/Screen Shot 2020-03-17 at 2.24.57 PM.png rename to .gitbook/assets/screen-shot-2020-03-17-at-2.24.57-pm.png diff --git a/.gitbook/assets/template-download-header@2x.png b/.gitbook/assets/template-download-header-2x.png similarity index 100% rename from .gitbook/assets/template-download-header@2x.png rename to .gitbook/assets/template-download-header-2x.png diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0974d9e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +_book diff --git a/GLOSSARY.md b/GLOSSARY.md new file mode 100644 index 0000000..badc92e --- /dev/null +++ b/GLOSSARY.md @@ -0,0 +1,36 @@ +## Item + +An item can include one photo, multiple photos, or no photos. It is the primary unit of organization in Tropy. You can add metadata and tags to items individually or in bulk. You can add items to lists. + +## Item table + +The item table is the center panel of the project view. When the slider on the panel is moved to the right, the item table turns into an item grid with thumbnails of your items. + +## Item view + +The item view is where you take notes on individual items. You can also do basic photo editing and add or edit metadata. To access the item view, double-click on any item. To return to project view from the item view, click on the back arrow \(<\) at the top of the metadata pane on the left. + +## List + +Lists are a group of photos selected from a project. This feature is useful if you want to collect photos and items related to a particular section of a project \(a chapter of a book or thesis, or a section of an article\). Photos and items can appear in more than one list. A link to the lists you create appears in the right pane of the project view. + +## Metadata + +Metadata is "data about data," or information recorded about objects, documents, and other items to help catalog, describe, and organize it. Metadata can include information about the content of an item, its location, its purpose, or any number of other descriptors. For more about metadata, see [What is metadata and how do I use it?](//beginning/metadata.md) + +## Metadata pane + +The metadata pane appears on the righthand side of the project view, and on the lefthand side of the item view. It can be toggled to show the tags pane. The metadata pane is where you can see and record metadata about your items. + +## Project + +A project is a collection of photographs. You can only have one project open in Tropy at any given time, which means that you cannot move photos from one project to another within Tropy. For that reason, it usually makes sense to conceive of a project in broad terms: a project as a book or thesis, not a chapter. You can use lists, tags, and/or notes to organize material within a Tropy project. + +## Project view + +The project view is the view that loads when you open Tropy. From the project view, you can view all your items, add metadata or tags, and manage lists and tags. + +## Sidebar + +The sidebar is the lefthand panel in the project view. It includes the project name, a list of your lists, and a tag list. + diff --git a/README.md b/README.md index 2dbab2e..b1bef0f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ description: >- # Tropy Basics -## What is Tropy? +## What is Tropy? Tropy is free, open-source software that allows you to organize and describe photographs of research material. Once you have imported your photos into Tropy, you can combine photos into items (e.g., photos of the three pages of a letter into a single item), and group photos into lists. You can also describe the content of a photograph. Tropy uses customizable metadata templates with multiple fields for different properties of the content of your photo, for example, title, date, author, box, folder, collection, archive. You can enter information in the template for an individual photo or select multiple photos and add or edit information to them in bulk. Tropy also lets you tag photos. You can also add one or more notes to a photo; a note could be a transcription of a document. A search function lets you find material in your photos, using metadata, tags, and notes. @@ -17,7 +17,7 @@ Tropy is free, open-source software that allows you to organize and describe pho {% embed url="https://youtu.be/jqTkI49JUDA" %} -## Preparing to use Tropy +## Preparing to use Tropy ### Where are your photos? @@ -40,7 +40,7 @@ Tropy currently works with these file formats: ### Download Tropy. -To use Tropy, you need to download a copy of the software from the Download page at [tropy.org](https://tropy.org/). Tropy is free software; there is no cost to download or use it. Tropy is available for macOS, Windows, and Linux. Choose the version for your operating system; once Tropy has downloaded, open it and follow the prompts to install it on your computer. +To use Tropy, you need to download a copy of the software from the Download page at [tropy.org](https://tropy.org). Tropy is free software; there is no cost to download or use it. Tropy is available for macOS, Windows, and Linux. Choose the version for your operating system; once Tropy has downloaded, open it and follow the prompts to install it on your computer. \ Tropy documentation is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). diff --git a/SUMMARY.md b/SUMMARY.md index 3da6caf..a1ba6fd 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -47,7 +47,6 @@ * [Export with CSV Export plugin](other-features/export-with-plugins.md) * [Export with Archive plugin](other-features/export-with-archive-plugin.md) * [Export to Omeka S](other-features/omeka.md) -* [Import IIIF Manifests](other-features/iiif.md) * [Print items](other-features/print-items.md) * [Keyboard shortcuts in Tropy](other-features/keyboard-shortcuts.md) * [Preferences](other-features/preferencesmd.md) @@ -58,3 +57,4 @@ * [Moving photos](troubleshooting/moving-photos.md) * [Reporting problems](troubleshooting/forums.md) * [Backup](troubleshooting/backup.md) + diff --git a/assets/Item-view.png b/assets/Item-view.png new file mode 100644 index 0000000..7bad9f0 Binary files /dev/null and b/assets/Item-view.png differ diff --git a/assets/Screen Shot 2017-05-15 at 11.11.46 AM.png b/assets/Screen Shot 2017-05-15 at 11.11.46 AM.png new file mode 100644 index 0000000..9e24ff7 Binary files /dev/null and b/assets/Screen Shot 2017-05-15 at 11.11.46 AM.png differ diff --git a/.gitbook/assets/add_photos (1).png b/assets/add_photos.png similarity index 100% rename from .gitbook/assets/add_photos (1).png rename to assets/add_photos.png diff --git a/assets/add_photos@2x.png b/assets/add_photos@2x.png new file mode 100644 index 0000000..7619c60 Binary files /dev/null and b/assets/add_photos@2x.png differ diff --git a/assets/api-key b/assets/api-key new file mode 100644 index 0000000..ccf5198 Binary files /dev/null and b/assets/api-key differ diff --git a/assets/api-key@2x b/assets/api-key@2x new file mode 100644 index 0000000..aa8e961 Binary files /dev/null and b/assets/api-key@2x differ diff --git a/assets/bulk-edit.png b/assets/bulk-edit.png new file mode 100644 index 0000000..0c80e3f Binary files /dev/null and b/assets/bulk-edit.png differ diff --git a/assets/bulk-edit@2x.png b/assets/bulk-edit@2x.png new file mode 100644 index 0000000..f108be3 Binary files /dev/null and b/assets/bulk-edit@2x.png differ diff --git a/assets/create-project.png b/assets/create-project.png new file mode 100644 index 0000000..b657984 Binary files /dev/null and b/assets/create-project.png differ diff --git a/assets/drag-and-drop-merge.png b/assets/drag-and-drop-merge.png new file mode 100644 index 0000000..afd6d99 Binary files /dev/null and b/assets/drag-and-drop-merge.png differ diff --git a/assets/drag-and-drop-merge@2x.png b/assets/drag-and-drop-merge@2x.png new file mode 100644 index 0000000..622270f Binary files /dev/null and b/assets/drag-and-drop-merge@2x.png differ diff --git a/assets/duplicates.png b/assets/duplicates.png new file mode 100644 index 0000000..5081deb Binary files /dev/null and b/assets/duplicates.png differ diff --git a/assets/duplicates@2x.png b/assets/duplicates@2x.png new file mode 100644 index 0000000..80d03c3 Binary files /dev/null and b/assets/duplicates@2x.png differ diff --git a/assets/empty-project-view.png b/assets/empty-project-view.png new file mode 100644 index 0000000..2ffe482 Binary files /dev/null and b/assets/empty-project-view.png differ diff --git a/assets/empty-project-view@2x.png b/assets/empty-project-view@2x.png new file mode 100644 index 0000000..69d8abd Binary files /dev/null and b/assets/empty-project-view@2x.png differ diff --git a/assets/esper.png b/assets/esper.png new file mode 100644 index 0000000..36456b7 Binary files /dev/null and b/assets/esper.png differ diff --git a/assets/esper@2x.png b/assets/esper@2x.png new file mode 100644 index 0000000..cd88bc4 Binary files /dev/null and b/assets/esper@2x.png differ diff --git a/assets/grid-view-slider.png b/assets/grid-view-slider.png new file mode 100644 index 0000000..f985f81 Binary files /dev/null and b/assets/grid-view-slider.png differ diff --git a/.gitbook/assets/notes-toolbar (1).png b/assets/notes-toolbar.png similarity index 100% rename from .gitbook/assets/notes-toolbar (1).png rename to assets/notes-toolbar.png diff --git a/assets/notes-toolbar@2x.png b/assets/notes-toolbar@2x.png new file mode 100644 index 0000000..69f5cec Binary files /dev/null and b/assets/notes-toolbar@2x.png differ diff --git a/assets/photo-editing.png b/assets/photo-editing.png new file mode 100644 index 0000000..4c92db5 Binary files /dev/null and b/assets/photo-editing.png differ diff --git a/assets/preferences@2x.png b/assets/preferences@2x.png new file mode 100644 index 0000000..d21d42e Binary files /dev/null and b/assets/preferences@2x.png differ diff --git a/assets/right-click-merge.png b/assets/right-click-merge.png new file mode 100644 index 0000000..f13a6c8 Binary files /dev/null and b/assets/right-click-merge.png differ diff --git a/assets/right-click-merge@2x.png b/assets/right-click-merge@2x.png new file mode 100644 index 0000000..903bd43 Binary files /dev/null and b/assets/right-click-merge@2x.png differ diff --git a/assets/selections.png b/assets/selections.png new file mode 100644 index 0000000..eeeaefd Binary files /dev/null and b/assets/selections.png differ diff --git a/assets/template-download-header@2x.png b/assets/template-download-header@2x.png new file mode 100644 index 0000000..d1621f2 Binary files /dev/null and b/assets/template-download-header@2x.png differ diff --git a/assets/template-fields@2x.png b/assets/template-fields@2x.png new file mode 100644 index 0000000..4627789 Binary files /dev/null and b/assets/template-fields@2x.png differ diff --git a/assets/template-header@2x.png b/assets/template-header@2x.png new file mode 100644 index 0000000..4e34663 Binary files /dev/null and b/assets/template-header@2x.png differ diff --git a/assets/view-photos.png b/assets/view-photos.png new file mode 100644 index 0000000..9210de6 Binary files /dev/null and b/assets/view-photos.png differ diff --git a/assets/view-photos@2x.png b/assets/view-photos@2x.png new file mode 100644 index 0000000..adf5872 Binary files /dev/null and b/assets/view-photos@2x.png differ diff --git a/before-you-begin/before-you-begin.md b/before-you-begin/before-you-begin.md index fbbe0ce..921998f 100644 --- a/before-you-begin/before-you-begin.md +++ b/before-you-begin/before-you-begin.md @@ -6,17 +6,17 @@ description: >- # Tropy Basics -## What is Tropy? +## What is Tropy? -Tropy is free, open-source desktop software that allows you to organize and describe photographs of research material. Once you have imported your photos into Tropy, you can combine photos into items (e.g., photos of the three pages of a letter into a single item), and group photos into lists. You can also describe the content of a photograph. Tropy uses customizable metadata templates with multiple fields for different properties of the content of your photo, for example, title, date, author, box, folder, collection, archive. You can enter information in the template for an individual photo or select multiple photos and add or edit information to them in bulk. Tropy also lets you tag photos. You can also add one or more notes to a photo; a note could be a transcription of a document. A search function lets you find material in your photos, using metadata, tags, and notes. You can export to JSON-LD, CSV, or PDF. +Tropy is free, open-source desktop software that allows you to organize and describe photographs of research material. Once you have imported your photos into Tropy, you can combine photos into items \(e.g., photos of the three pages of a letter into a single item\), and group photos into lists. You can also describe the content of a photograph. Tropy uses customizable metadata templates with multiple fields for different properties of the content of your photo, for example, title, date, author, box, folder, collection, archive. You can enter information in the template for an individual photo or select multiple photos and add or edit information to them in bulk. Tropy also lets you tag photos. You can also add one or more notes to a photo; a note could be a transcription of a document. A search function lets you find material in your photos, using metadata, tags, and notes. You can export to JSON-LD, CSV, or PDF. -* Tropy is not photo editing software (e.g., Photoshop). It offers only basic editing functions (rotate, crop, zoom, and a few others) sufficient to allow you to make the content of a photo legible. It will not make any changes to your original photos. You can save a copy of photos that you make changes to. -* Tropy is not a citation manager (e.g., Zotero). It does not capture metadata from online catalogs or finding aids. It does not generate citations for use in word-processing software. +* Tropy is not photo editing software \(e.g., Photoshop\). It offers only basic editing functions \(rotate, crop, zoom, and a few others\) sufficient to allow you to make the content of a photo legible. It will not make any changes to your original photos. You can save a copy of photos that you make changes to. +* Tropy is not a citation manager \(e.g., Zotero\). It does not capture metadata from online catalogs or finding aids. It does not generate citations for use in word-processing software. * Tropy is not a web application. It exists on your desktop. Development is underway to allow collaboration on the web. -* Tropy is not a platform for writing up your research (e.g., DEVONthink). While it does allow you to take notes attached to photos, you cannot use it to create any other kind of word-processor document. -* Tropy is not a platform for presenting your research online (e.g., Omeka). It operates on your personal computer, not on a server. You can export your projects to JSON-LD, CSV, PDF, and [Omeka S](https://omeka.org/s/), where you can create online exhibits. +* Tropy is not a platform for writing up your research \(e.g., DEVONthink\). While it does allow you to take notes attached to photos, you cannot use it to create any other kind of word-processor document. +* Tropy is not a platform for presenting your research online \(e.g., Omeka\). It operates on your personal computer, not on a server. You can export your projects to JSON-LD, CSV, PDF, and [Omeka S](https://omeka.org/s/), where you can create online exhibits. -## Preparing to use Tropy +## Preparing to use Tropy ### Where are your photos? @@ -42,3 +42,4 @@ Tropy currently works with these file formats: To use Tropy, you need to download a copy of the software from the Download page at [tropy.org](https://tropy.org/). Tropy is free software; there is no cost to download or use it. Tropy is available for macOS, Windows, and Linux. Choose the version for your operating system; once Tropy has downloaded, open it and follow the prompts to install it on your computer. ### Watch this [quick overview](https://vimeo.com/239557418) of Tropy's functions. + diff --git a/before-you-begin/metadata.md b/before-you-begin/metadata.md index 2a9b906..5b40034 100644 --- a/before-you-begin/metadata.md +++ b/before-you-begin/metadata.md @@ -21,13 +21,13 @@ In addition, Tropy also offers tags, which provide a means of creating unstructu If you’ve been able to find sources to photograph in an archive or library, then you’ve already used metadata. Library catalogs and finding aids are full of metadata that is useful for you. Librarians and archivists craft descriptions of their collections to help researchers who use their collections, and you should absolutely take advantage of their work. Some of the metadata you’ll want to record in Tropy comes straight from the catalog or finding aid, such as archive name, collection name, and organizational elements such as identifier, box and folder. -Additional metadata comes from each individual source itself, and is known as item-level metadata. Few archival finding aids or catalogs include item-level metadata; it is more common to describe a collection only to the level of each folder in a box, or each box. For example, the [finding aid](http://rs5.loc.gov/service/mss/eadxmlmss/eadpdfmss/2003/ms003007.pdf) for the Pinkerton National Detective Agency Records at the Library of Congress records that Box 79 contains 3 folders of reports of the investigation of the Bonner Manufacturing Co. jewel theft from 1924. Item-level metadata describing those reports could include the name of the agent who wrote the report, the date of the report, the location referred to in the report, whether the report was handwritten or edited and typed, the type of investigative methods used (shadowing, undercover surveillance, informants, interviews), and the subject of the report. Features of a source included in a Tropy template are characteristics of every report; features that appear in only some sources could be tags or simply recorded in the notes. +Additional metadata comes from each individual source itself, and is known as item-level metadata. Few archival finding aids or catalogs include item-level metadata; it is more common to describe a collection only to the level of each folder in a box, or each box. For example, the [finding aid](http://rs5.loc.gov/service/mss/eadxmlmss/eadpdfmss/2003/ms003007.pdf) for the Pinkerton National Detective Agency Records at the Library of Congress records that Box 79 contains 3 folders of reports of the investigation of the Bonner Manufacturing Co. jewel theft from 1924. Item-level metadata describing those reports could include the name of the agent who wrote the report, the date of the report, the location referred to in the report, whether the report was handwritten or edited and typed, the type of investigative methods used \(shadowing, undercover surveillance, informants, interviews\), and the subject of the report. Features of a source included in a Tropy template are characteristics of every report; features that appear in only some sources could be tags or simply recorded in the notes. ### Using Standards and Vocabularies -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](https://lov.linkeddata.es/dataset/lov). +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](https://lov.linkeddata.es/dataset/lov). -This document provides best practices to create good metadata for the content you upload to Tropy. A template in Tropy provides a means of creating structured metadata about your sources. Each item in a Tropy project can have [its own unique template](../in-the-template-editor/create-template.md), though you’ll probably find that only one or two templates, or a template for each collection from which you have sources, will meet your needs. Three templates ship with Tropy; we’ve designed these basic templates to capture the information most commonly useful to researchers. In most cases, you can create a template for your research by [editing one of those templates](../in-the-template-editor/edit-templates.md) to add additional categories of information (fields) or deleting categories that are not important to you. +This document provides best practices to create good metadata for the content you upload to Tropy. A template in Tropy provides a means of creating structured metadata about your sources. Each item in a Tropy project can have [its own unique template](../in-the-template-editor/create-template.md), though you’ll probably find that only one or two templates, or a template for each collection from which you have sources, will meet your needs. Three templates ship with Tropy; we’ve designed these basic templates to capture the information most commonly useful to researchers. In most cases, you can create a template for your research by [editing one of those templates](../in-the-template-editor/edit-templates.md) to add additional categories of information \(fields\) or deleting categories that are not important to you. Descriptive metadata will allow you to quickly and easily locate your sources at the item level. Therefore, each item should have its own unique metadata entry, but images from the same source will often share information like collection name and location, which in Tropy are easy to add in bulk or as default values in a template. There are three main things to remember when writing good metadata: @@ -41,13 +41,13 @@ What follows is a brief explanation of the fields used in two of the default tem ### Tropy Generic -Incorporating widely used forms of archival organization (box, folder, identifier) and basic features of research material (author, date, type of source), this template is intended to provide a framework that applies to many kinds of research. Additional fields can be added to customize the template to include characteristics of specific collections. At present you can only use each property once in a template. +Incorporating widely used forms of archival organization \(box, folder, identifier\) and basic features of research material \(author, date, type of source\), this template is intended to provide a framework that applies to many kinds of research. Additional fields can be added to customize the template to include characteristics of specific collections. At present you can only use each property once in a template. #### Title _Title_ is the name of the source. Documents such as books, pamphlets, and even memos have obvious titles that can be recorded in this field. Best practice for metadata suggests that you consider including more than just such a title, and use this field for a short description of the document that provides the essential information about it. -A descriptive title might repeat some of the information that you include in other categories in the template (like author, type of document, subject of the document) but including it here gives you a brief picture of the source in one place. Such a summary description would be useful in Tropy in allowing you to quickly identify the nature of a source when scrolling through your material in project view. +A descriptive title might repeat some of the information that you include in other categories in the template \(like author, type of document, subject of the document\) but including it here gives you a brief picture of the source in one place. Such a summary description would be useful in Tropy in allowing you to quickly identify the nature of a source when scrolling through your material in project view. _Property used_: `purl.org/dc/elements/1.1/title` @@ -65,19 +65,19 @@ _Label_: The Dublin Core metadata standard was designed to be core categories ap _Date_ is the date a source was created. If you are unsure of the exact date, it is always better to include a date range than no date at all. -In order to effectively organize and find sources based on date, use a consistent date format like YYYY-MM-DD (known as ISO format). +In order to effectively organize and find sources based on date, use a consistent date format like YYYY-MM-DD \(known as ISO format\). _Property used_: `purl.org/dc/elements/1.1/date` If you use ISO format, your date will automatically reformat to be more easily readable. -To indicate an uncertain date, use \~ before or the date (e.g., \~1802, or \~1802-01-01; 1802\~ or 1802-01-01\~ to indicate uncertainty about the day). Your date will reformat to include "c." This feature is still evolving and more complex date format support is planned. +To indicate an uncertain date, use ~ before or the date \(e.g., \~1802, or \~1802-01-01; 1802\~ or 1802-01-01\~ to indicate uncertainty about the day\). Your date will reformat to include "c." This feature is still evolving and more complex date format support is planned. _Note_: You may want to describe a source in terms of dates in addition to when it was created, such as the date or dates referred to in the source, or dates when a source was modified or edited. In these cases, there are additional metadata properties that you can use to add additional date fields to your template, such as `purl.org/dc/elements/1.1/coverage`, `purl.org/dc/terms/created`, or `purl.org/dc/terms/modified`. #### Type -_Type_ is the type or genre of source. This could be a type of document (e.g., correspondence, book, pamphlet, memo, form) or genre of document (e.g., autobiography, psychiatric report, trial transcript). It could also be a type or genre of image or object (e.g., painting, map, diagram, cartoon). +_Type_ is the type or genre of source. This could be a type of document \(e.g., correspondence, book, pamphlet, memo, form\) or genre of document \(e.g., autobiography, psychiatric report, trial transcript\). It could also be a type or genre of image or object \(e.g., painting, map, diagram, cartoon\). In order to effectively organize and finds sources based on type, use consistent terms or a controlled vocabulary. [The Dublin Core Metadata Initiative Type Vocabulary](http://dublincore.org/documents/2003/02/12/dcmi-type-vocabulary/) and [Getty Art and Architecture Thesaurus](http://www.getty.edu/research/tools/vocabularies/aat/) are good resources. @@ -95,7 +95,7 @@ You could copy and modify this template to create a template for a specific arch _Collection_ is the name of the collection of which the source is a part, e.g., the Pinkerton National Detective Agency Records. You should consult a catalog or finding aid to ensure that you use the correct title for a collection. -_Property used_: tropy.org/v1/tropy#collection +_Property used_: tropy.org/v1/tropy\#collection Existing metadata vocabularies do not offer elements that fit the way that archival material is typically organized. For that reason, Tropy includes a limited number of custom metadata elements. @@ -105,17 +105,17 @@ You could copy and modify this template to create a template for a specific arch _Box_ is the unit in the collection which the source can be found. This category may not be needed for all sources, as not all collections use boxes as a form of organization, or label or number boxes. If that is the case, you could copy and modify this template to create one for such a collection by deleting this field. You could also simply leave this field blank. -_Property used_: tropy.org/v1/tropy#box +_Property used_: tropy.org/v1/tropy\#box Existing metadata vocabularies do not offer elements that fit the way that archival material is typically organized. For that reason, Tropy includes a limited number of custom metadata elements. -If the archive in which you are working has different terms for how its material is organized (e.g., folio, or container, rather than box), you could modify the template and change the label for this field to one appropriate to the collection from which your sources come. +If the archive in which you are working has different terms for how its material is organized \(e.g., folio, or container, rather than box\), you could modify the template and change the label for this field to one appropriate to the collection from which your sources come. #### Folder -_Folder_ is the folder (within a box) in which a source can found. This category may not be needed for all sources, as not all collections use folders as a form of organization, or label or number folders. If that is the case, you could copy and modify this template to create one for such a collection by deleting this field. +_Folder_ is the folder \(within a box\) in which a source can found. This category may not be needed for all sources, as not all collections use folders as a form of organization, or label or number folders. If that is the case, you could copy and modify this template to create one for such a collection by deleting this field. -_Property used_: tropy.org/v1/tropy#folder +_Property used_: tropy.org/v1/tropy\#folder Existing metadata vocabularies do not offer elements that fit the way that archival material is typically organized. For that reason, Tropy includes a limited number of custom metadata elements. @@ -161,15 +161,15 @@ _Label_: This template replaces “audience” with the more specific term “re _Location_ is the location from which a letter was sent. -To effectively organize sources, use a controlled vocabulary. The [Library of Congress Name Authorities](http://authorities.loc.gov/help/name-auth.htm), [Getty Thesaurus of Geographic Names](http://www.getty.edu/research/tools/vocabularies/tgn/), and [GeoNames](http://www.geonames.org/) are good resources.\ -&#xNAN;_Property used_: purl.org/dc/elements/1.1/coverage\ -&#xNAN;_Label_: This template replaces _coverage_ with the more specific term _location_ to reflect the specific form of the documents to which it will be applied. (The Dublin Core element coverage can refer to spatial or temporal features of a source.) +To effectively organize sources, use a controlled vocabulary. The [Library of Congress Name Authorities](http://authorities.loc.gov/help/name-auth.htm), [Getty Thesaurus of Geographic Names](http://www.getty.edu/research/tools/vocabularies/tgn/), and [GeoNames](http://www.geonames.org/) are good resources. +_Property used_: purl.org/dc/elements/1.1/coverage +_Label_: This template replaces _coverage_ with the more specific term _location_ to reflect the specific form of the documents to which it will be applied. \(The Dublin Core element coverage can refer to spatial or temporal features of a source.\) ## **Tags** A tag is a freely chosen keyword or phrase; it can be as idiosyncratic as you want. It can refer to any feature of a source, rather than a specific category, as in the structured metadata of a Tropy template. You can [add as many tags](../in-the-project-view/tags.md) as you want to an item. -Essentially, there is no such thing as a bad tag; if it’s useful to you, it’s a good tag. However, when you create tags, you need to take care not to use homonyms(the same tags used with different meanings) and synonyms (multiple tags for the same concept), which can lead to ineffective organization of your material (e.g., the tag “orange” could refer to the color or the fruit). Likewise, being careful to use only singular or plural will help produce useful tags. +Essentially, there is no such thing as a bad tag; if it’s useful to you, it’s a good tag. However, when you create tags, you need to take care not to use homonyms\(the same tags used with different meanings\) and synonyms \(multiple tags for the same concept\), which can lead to ineffective organization of your material \(e.g., the tag “orange” could refer to the color or the fruit\). Likewise, being careful to use only singular or plural will help produce useful tags. In Tropy, one distinction between template fields and tags is in how you access the items described. All the items with a tag can be found simply by clicking on the tag in the project view. To find all the items described with a particular term in the metadata template, you need to search for that term in the project view. @@ -183,3 +183,4 @@ Tropy imports some of that photo metadata, and displays it under the item metada * the date the image was taken; * the image size in pixels; * the file size. + diff --git a/before-you-begin/readme.md b/before-you-begin/readme.md new file mode 100644 index 0000000..1cff98b --- /dev/null +++ b/before-you-begin/readme.md @@ -0,0 +1,45 @@ +--- +description: >- + Tropy is free open-source software that allows you to organize and describe + photographs of research material. +--- + +# Tropy Basics + +## What is Tropy? + +Tropy is free, open-source desktop software that allows you to organize and describe photographs of research material. Once you have imported your photos into Tropy, you can combine photos into items \(e.g., photos of the three pages of a letter into a single item\), and group photos into lists. You can also describe the content of a photograph. Tropy uses customizable metadata templates with multiple fields for different properties of the content of your photo, for example, title, date, author, box, folder, collection, archive. You can enter information in the template for an individual photo or select multiple photos and add or edit information to them in bulk. Tropy also lets you tag photos. You can also add one or more notes to a photo; a note could be a transcription of a document. A search function lets you find material in your photos, using metadata, tags, and notes. You can export to JSON-LD, CSV, or PDF. + +* Tropy is not photo editing software \(e.g., Photoshop\). It offers only basic editing functions \(rotate, crop, zoom, and a few others\) sufficient to allow you to make the content of a photo legible. It will not make any changes to your original photos. You can save a copy of photos that you make changes to. +* Tropy is not a citation manager \(e.g., Zotero\). It does not capture metadata from online catalogs or finding aids. It does not generate citations for use in word-processing software. +* Tropy is not a web application. It exists on your desktop. Development is underway to allow collaboration on the web. +* Tropy is not a platform for writing up your research \(e.g., DEVONthink\). While it does allow you to take notes attached to photos, you cannot use it to create any other kind of word-processor document. +* Tropy is not a platform for presenting your research online \(e.g., Omeka\). It operates on your personal computer, not on a server. You can export your projects to JSON-LD, CSV, PDF, and [Omeka S](https://omeka.org/s/), where you can create online exhibits. + +## Preparing to use Tropy + +### Where are your photos? + +The first step in using Tropy is to identify where on your computer your archival photos are stored---identify the folder and its location in your file system. + +### Are your photos in the format required by Tropy? + +Tropy currently works with these file formats: + +* JPG/JPEG +* PNG +* SVG +* TIFF +* GIF +* PDF +* JP2000 +* HEIC + +### Download Tropy. + +To use Tropy, you need to download a copy of the software from the Download page at [tropy.org](https://tropy.org/). Tropy is free software; there is no cost to download or use it. Tropy is available for macOS, Windows, and Linux. Choose the version for your operating system; once Tropy has downloaded, open it and follow the prompts to install it on your computer. + +### Watch this [quick overview](https://vimeo.com/239557418) of Tropy's functions. + + + diff --git a/before-you-begin/rights.md b/before-you-begin/rights.md index 00ab405..5180da6 100644 --- a/before-you-begin/rights.md +++ b/before-you-begin/rights.md @@ -2,9 +2,9 @@ As you work with archival materials, remember that the owner of the materials may have legal rights to restrict your use or publication of them. Finding copyrighted materials in an archive doesn’t mean you can’t read those materials and cite them in your work. Copyright law allows archives and libraries to provide copies for use in private study, scholarship or research. However, you may need to get the permission of the copyright owner before publishing your digital photos of that material. **Putting material on a publicly accessible website constitutes publication.** -Many archives have rights statements that you have to read, acknowledge, and sign before you see any materials. Rights statements can also commonly be found in finding aids and in online catalogs. Make sure you include and record rights information as part of the metadata for items in Tropy. The default templates in Tropy include rights as a mandatory field, so that an alert appears until you complete that material. We recommend that you include a URL to the relevant information in your rights metadata, if one is available (see, for instance, [this page](https://www.masshist.org/library/permissions/citations) from the Massachusetts Historical Society). +Many archives have rights statements that you have to read, acknowledge, and sign before you see any materials. Rights statements can also commonly be found in finding aids and in online catalogs. Make sure you include and record rights information as part of the metadata for items in Tropy. The default templates in Tropy include rights as a mandatory field, so that an alert appears until you complete that material. We recommend that you include a URL to the relevant information in your rights metadata, if one is available \(see, for instance, [this page](https://www.masshist.org/library/permissions/citations) from the Massachusetts Historical Society\). -There is considerable variation in the form and contents of the rights information provided by archives and libraries, and it is not always clear who owns the rights to material. Archives do not automatically own the copyright of material in their holdings. Donors or sellers can retain the rights for material, or they may not own the copyright of all the items they transfer to an archive. For example, a donor may not own the copyright to letters written to them, or they may have transferred the rights to someone else, such as a publisher (see [SAA, FAQs](https://www2.archivists.org/publications/brochures/copyright-and-unpublished-material)). +There is considerable variation in the form and contents of the rights information provided by archives and libraries, and it is not always clear who owns the rights to material. Archives do not automatically own the copyright of material in their holdings. Donors or sellers can retain the rights for material, or they may not own the copyright of all the items they transfer to an archive. For example, a donor may not own the copyright to letters written to them, or they may have transferred the rights to someone else, such as a publisher \(see [SAA, FAQs](https://www2.archivists.org/publications/brochures/copyright-and-unpublished-material)\). Material in archives may also not be under copyright. Instead, it may be in the public domain, which means the material can be used freely without permission or attribution. Copyright cannot be claimed over digital images of public domain material; you need to alter the work to be able to claim copyright. However, your use of digitized public domain material can be restricted by terms of use, such as those you agree to in order to use subscription-based databases such as ProQuest products or Ancestry.com. @@ -12,7 +12,7 @@ Material in archives may also not be under copyright. Instead, it may be in the **Please note:** These lists apply only to U.S. copyright status. If you live or work in another country or are using material published in another country, you should check that country's copyright policies. -* U.S. federal government documents (produced by or for government agencies); note that only some state government documents are in the public domain +* U.S. federal government documents \(produced by or for government agencies\); note that only some state government documents are in the public domain * Laws and legal codes * Works whose owners waive their copyright by using the [Creative Commons 0](https://creativecommons.org/share-your-work/public-domain/cc0/) dedication @@ -23,9 +23,10 @@ Material in archives may also not be under copyright. Instead, it may be in the * In copyright law, unpublished material can include correspondence and photographs * Works published between 1923 and 1977 without a copyright notice * Works published between 1923 and 1963 if the owner did not renew the copyright -* Unpublished works older than the year of the author’s death + 70 years (in 2020, authors who died before 1950) -* Unpublished works older than 120 years from the date of creation, if the author’s death is not known, or if the author is anonymous or created the work for hire (in 2020, works created before 1900) +* Unpublished works older than the year of the author’s death + 70 years \(in 2020, authors who died before 1950\) +* Unpublished works older than 120 years from the date of creation, if the author’s death is not known, or if the author is anonymous or created the work for hire \(in 2020, works created before 1900\) For more information, see ALA’s [Copyright Slider](http://librarycopyright.net/resources/digitalslider/index.html). Copyright info courtesy of the [Public Library Partnerships Project](http://dp.la/info/about/projects/public-library-partnerships/) + diff --git a/beginning/README.md b/beginning/README.md new file mode 100644 index 0000000..8daf052 --- /dev/null +++ b/beginning/README.md @@ -0,0 +1,25 @@ +# What is Tropy? + +Tropy is free open-source desktop software that allows you to organize and describe photographs of research material. Once you have imported your photos into Tropy, you can combine photos into items \(e.g., photos of the three pages of a letter into a single item\), and group photos into lists. You can also describe the content of a photograph. Tropy uses customizable metadata templates with multiple fields for different properties of the content of your photo, for example, title, date, author, box, folder, collection, archive. You can enter information in the template for an individual photo or select multiple photos and add or edit information to them in bulk. Tropy also lets you add tags to describe the content of a photo. You can also add one or more notes to a photo; a note could be a transcription of a document. A search function lets you find material in your photos, using the information in the metadata, tags, and notes. + +* Tropy is NOT photo editing software \(e.g., Photoshop\). It offers only basic editing functions \(rotate, crop, zoom, adjust contrast\) sufficient to allow you to make the content of a photo legible. -- not available in Beta version +* Tropy is NOT a citation manager \(e.g., Zotero\). It does not capture metadata from online catalogs or finding aids. It does not generate citations for use in word processing software. Nor can you export records from Tropy to Zotero. +* Tropy is NOT a platform for writing up your research \(e.g., DEVONthink\). It allows to you to take notes attached to photos. It does not allow you to create any other kind of document. +* Tropy is NOT a platform for presenting your research online \(e.g., Omeka\). It operates on your desktop, not in your browser. You can export your projects to platforms that can be used to present material online, including to Omeka -- not available in Beta version + +# Preparing to Use Tropy {#prepare} + +### Where are your photos? + +To organize and describe your photos, you need to import them into Tropy. The first step in using Tropy is to identify where on your computer those photos are stored--- identify the folder and how to get to it from your desktop. + +### Are your photos in the format required by Tropy? + +Tropy only works with .jpg/.jpeg files. It does NOT work with .tiff, .png, or gif files. You may need to convert your photos to JPG in order to use Tropy. + +_Beta version_: Tropy will include photo editing tools that allow you to make basic changes to a photo, such as rotating it. These tools are not available in the beta version. If you have photos that are oriented vertically not horizontally, you may want to change the orientation before importing them into Tropy. + +### Download Tropy. + +To use Tropy, you need to download a copy of the software from the Download page at [tropy.org](https://tropy.org/). Tropy is free software; there is no cost to download or use it. Tropy is available for macOS, Windows, and Linux. Choose the version for your operating system; once Tropy has downloaded, open it and follow the prompts to install it on your computer. + diff --git a/beginning/beta-to-1.md b/beginning/beta-to-1.md new file mode 100644 index 0000000..3ef1d42 --- /dev/null +++ b/beginning/beta-to-1.md @@ -0,0 +1,13 @@ +## Transitioning from beta to 1.0 + +If you have been using the beta version of Tropy, your projects and photos should migrate into Tropy 1.0 with no problems. However, there are a few steps you should take in order to retain all the work you've done in the beta. + +* First, make a backup of all your projects in the beta. +* Export any custom templates and vocabularies you may have created in the beta. +* Download and install the 1.0 version. +* Import your custom templates and vocabularies into the 1.0 version. \(You'll have to create an empty project in order to access the templates.\) +* Open your project file from the beta. If you have imported your custom templates, your items should appear with the proper template. +* From the File menu, select _Consolidate Photo Library_. This will tell the 1.0 version where your original photos are. + +And you're ready to work with the 1.0 version! + diff --git a/book.json b/book.json new file mode 100644 index 0000000..7b6544b --- /dev/null +++ b/book.json @@ -0,0 +1,3 @@ +{ + "plugins": [ "retina" ] +} \ No newline at end of file diff --git a/in-the-item-view/item-view-basics.md b/in-the-item-view/item-view-basics.md index 043cb5e..803b3e8 100644 --- a/in-the-item-view/item-view-basics.md +++ b/in-the-item-view/item-view-basics.md @@ -4,15 +4,16 @@ Item view is where you can focus on the content of your items. You can edit meta ## Important keyboard shortcuts -| Action | Shortcut | -| ----------------------------------------------------- | -------------------------------------------------------- | -| Move to next item (in order of project view sort) | Alt+down arrow | -| Move to previous item (in order of project view sort) | Alt+up arrow | -| Move to next photo (within an item) | Alt+right arrow | -| Move to previous photo (within an item) | Alt+left arrow | -| Rotate image | R (rotate right) or L (rotate left) (or Ctrl/Command+] ) | -| Fill image | Ctrl/Command+9 | -| Fit image to width | Ctrl/Command+0 | -| | | +| Action | Shortcut | +| :--- | :--- | +| Move to next item \(in order of project view sort\) | Alt+down arrow | +| Move to previous item \(in order of project view sort\) | Alt+up arrow | +| Move to next photo \(within an item\) | Alt+right arrow | +| Move to previous photo \(within an item\) | Alt+left arrow | +| Rotate image | R \(rotate right\) or L \(rotate left\) \(or Ctrl/Command+\] \) | +| Fill image | Ctrl/Command+9 | +| Fit image to width | Ctrl/Command+0 | +| | | ![](../.gitbook/assets/Item-view.png) + diff --git a/in-the-item-view/notes.md b/in-the-item-view/notes.md index 43ef022..9c9df01 100644 --- a/in-the-item-view/notes.md +++ b/in-the-item-view/notes.md @@ -2,7 +2,7 @@ To transcribe or take notes on your item, click in the bottom pane of the item view and begin typing. Your notes autosave as you type. You can come back to the notes pane at any time to continue to edit your notes. Notes attach to individual photos or selections within your item, rather than the item itself, but you can always see a list of your notes in the notes pane on the lefthand side of the item view. -To change from the stacked layout (the photo editor on top of the notes pane) to side-by-side, right-click in the notes pane or photo editor and select _View Layout._ Then select _Side by side._ +To change from the stacked layout \(the photo editor on top of the notes pane\) to side-by-side, right-click in the notes pane or photo editor and select _View Layout._ Then select _Side by side._ ## Notes formatting toolbar @@ -10,19 +10,19 @@ To change from the stacked layout (the photo editor on top of the notes pane) to You can format your notes using the toolbar at the top of the notes pane. Select the text you want to format and click the button on the toolbar. Functions available for formatting are: -* Boldface \[Ctrl/Cmd + b] -* Italic \[Ctrl/Cmd + i] -* Underline \[Ctrl/Cmd + u] -* Strikethrough \[Shift + Ctrl/Cmd + t] -* Block quote \[Shift + Ctrl/Cmd + > or Shift + Ctrl/Cmd + .] -* Superscript \[Shift + Ctrl/Cmd + p] -* Subscript \[Shift + Ctrl/Cmd + b] -* Bulleted list (the last two buttons allow you to have multiple levels of indent on your lists for both bullet and enumerated lists) +* Boldface [Ctrl/Cmd + b] +* Italic [Ctrl/Cmd + i] +* Underline [Ctrl/Cmd + u] +* Strikethrough [Shift + Ctrl/Cmd + t] +* Block quote [Shift + Ctrl/Cmd + > or Shift + Ctrl/Cmd + .] +* Superscript [Shift + Ctrl/Cmd + p] +* Subscript [Shift + Ctrl/Cmd + b] +* Bulleted list \(the last two buttons allow you to have multiple levels of indent on your lists for both bullet and enumerated lists\) * Enumerated list * Hyperlink * Note that to use a hyperlink, you will need to Ctrl/Cmd + click on the hyperlink in the notes field. -Several formatting actions are taken for you automatically, including creating em and en dashes. To remove the automatic formatting, press Backspace (Delete for macOS) immediately after the keystroke that creates the automatic formatting. Your text will then revert to the original keystroke. +Several formatting actions are taken for you automatically, including creating em and en dashes. To remove the automatic formatting, press Backspace \(Delete for macOS\) immediately after the keystroke that creates the automatic formatting. Your text will then revert to the original keystroke. ## Multiple notes @@ -30,8 +30,9 @@ Tropy items can have as many notes as you want. To add a new note, click the + o ## Multiple modes of writing -Tropy allows you to write both horizontally (left to right) and vertically. To switch to vertical mode, type in the notes field and then right-click in the notes field. From the context menu that appears, navigate to _Writing Mode_ >_Vertical._ You can have only one writing mode per note, so you'll need to create multiple notes in order to take notes in multiple modes about the same photo. +Tropy allows you to write both horizontally \(left to right\) and vertically. To switch to vertical mode, type in the notes field and then right-click in the notes field. From the context menu that appears, navigate to _Writing Mode_ >_Vertical._ You can have only one writing mode per note, so you'll need to create multiple notes in order to take notes in multiple modes about the same photo. ## Line numbers and line wrap You can turn on line numbers in your note by typing in the notes field, then right-clicking. From the context menu that appears, click on _Show Line Numbers._ Line wrap is on by default; to turn it off, click on _Wrap Lines._ + diff --git a/in-the-item-view/photo-editing.md b/in-the-item-view/photo-editing.md index 840733d..c60c31e 100644 --- a/in-the-item-view/photo-editing.md +++ b/in-the-item-view/photo-editing.md @@ -28,3 +28,4 @@ The _Invert colors_ checkbox allows you to reverse the colors in a negative, suc ## Save photos with edits. You can save your photos with the edits you've made to it. In the Photos pane, right-click on the photo you wish to save, then click _Export Photo_. Tropy will prompt you to save your photo. It will automatically fill in a .png file extension; if you wish, you may change that extension to .jpg. Select where you want to save your photo, and click _Save_. + diff --git a/in-the-item-view/selections.md b/in-the-item-view/selections.md index 798638a..5175080 100644 --- a/in-the-item-view/selections.md +++ b/in-the-item-view/selections.md @@ -12,7 +12,7 @@ When you have created a selection, it appears nested underneath its origin photo ## Add metadata to your selection. -To change the name of your selection, click on its name in the Photos pane to select it. Then click the name again to enter editable mode. You can then change the name of the selection. +To change the name of your selection, click on its name in the Photos pane to select it. Then click the name again to enter editable mode. You can then change the name of the selection. To enter more customized metadata about your selection, you can scroll down in the metadata pane to see and edit the selection metadata. Selection metadata templates are [fully customizable](../in-the-template-editor/create-template.md), just like item-level and photo-level templates, so you can add a great deal of metadata specific to your selection. @@ -21,3 +21,4 @@ When you have a selection highlighted, whatever notes you type in the notes fiel ## Save a selection as its own image. You can export a selection to its own file, including all changes you've made using the photo editing tools. To do so, right-click on the selection in the Photos pane, and click _Export Selection_. Tropy will prompt you to save your selection. It will fill in a .png file extension; if you wish, you may change that extension to .jpg. Select where you want to save your selection, and click _Save_. + diff --git a/in-the-project-view/add_metadata.md b/in-the-project-view/add_metadata.md index 9b441dd..374c32f 100644 --- a/in-the-project-view/add_metadata.md +++ b/in-the-project-view/add_metadata.md @@ -7,14 +7,14 @@ You can add a new template to your Tropy project to ensure that the metadata you To add or edit metadata to describe your item, click on it to select it. In the metadata pane on the righthand side of the project view, select a template from the pull-down menu. Then you have several options for adding information. 1. Enter your metadata information in the metadata pane on the righthand side of the window. Press Enter to save your information, or press Tab to save your information and move on to the next field. -2. When viewing your items as a list, you can directly edit fields that appear in list columns. Select your item in the item table, and click again on the field you wish to edit. Once you’ve completed your entry, press Enter or Tab to save your information and move on. You can also edit fields by pressing Enter while an item is selected. +2. When viewing your items as a list, you can directly edit fields that appear in list columns. Select your item in the item table, and click again on the field you wish to edit. Once you’ve completed your entry, press Enter or Tab to save your information and move on. You can also edit fields by pressing Enter while an item is selected. 3. Double-clicking on your item in the item table will bring you to the [item view](../in-the-item-view/item-view-basics.md), where you can also edit the metadata, now in the lefthand pane. #### Adding additional fields to individual items Generally, all your metadata is entered into a template that can be applied to any item. However, you may find metadata for an item that would likely apply to only that one item. For example, if you work with primarily English-language sources, but one of your sources is translated from another language, you may not want to create a whole new template in order to record the original language in your metadata pane. Instead, you can add an additional field to your item that is not part of the template. -To do this, right-click on the name of the template in the metadata pane. Click on _New Field._ A box will pop up where you can select from any metadata vocabulary term to create your additional field. (Note that even for additional fields, mapping to an existing metadata schema is required.) Once you've selected the vocabulary term for your new field, it will appear at the end of your existing metadata template. Notice that the field name is italicized--this is an indication that it is not part of the template. +To do this, right-click on the name of the template in the metadata pane. Click on _New Field._ A box will pop up where you can select from any metadata vocabulary term to create your additional field. \(Note that even for additional fields, mapping to an existing metadata schema is required.\) Once you've selected the vocabulary term for your new field, it will appear at the end of your existing metadata template. Notice that the field name is italicized--this is an indication that it is not part of the template. #### Moving metadata from one field to another @@ -24,7 +24,7 @@ You can move metadata from one field to another by clicking and holding in the m You can edit the metadata for multiple items at a time. -* Ctrl/Command+click on each item you want to edit; then type your metadata into the metadata pane on the righthand side. +* Ctrl/Command+click on each item you want to edit; then type your metadata into the metadata pane on the righthand side. * To select a large group, press Shift, then select the last item of the group you want to select. The metadata you input will be applied to all items you have selected. * To select everything in the item table, press Ctrl/Command+A. ![](../.gitbook/assets/bulk-edit.png) @@ -34,14 +34,16 @@ You can edit the metadata for multiple items at a time. Digital cameras store information about images they capture in the header of the digital file, using the Exif or IPTC standard. That information usually includes the camera make and models, the camera settings and the date the photograph was taken. -Tropy imports some of that photo metadata and displays it in a metadata template specific to individual photos. The list below is the fields that automatically import; if you wish to add more fields, either from the camera data or from [any other vocabulary](../in-the-template-editor/vocabularies.md), you can [edit or create your own photo template](../in-the-template-editor/edit-templates.md) in [Preferences](../other-features/preferencesmd.md). (**Note** that in order to automatically populate your photo template with data from your camera, you'll need to set an appropriate template as the default photo template before you import your photos. Fields do not automatically populate if you switch templates once a photo is in Tropy.) +Tropy imports some of that photo metadata and displays it in a metadata template specific to individual photos. The list below is the fields that automatically import; if you wish to add more fields, either from the camera data or from [any other vocabulary](../in-the-template-editor/vocabularies.md), you can [edit or create your own photo template](../in-the-template-editor/edit-templates.md) in [Preferences](../other-features/preferencesmd.md). \(**Note** that in order to automatically populate your photo template with data from your camera, you'll need to set an appropriate template as the default photo template before you import your photos. Fields do not automatically populate if you switch templates once a photo is in Tropy.\) -* file name (which is editable when you select the photo and then click on it to move to editable mode in the photo pane) +* file name \(which is editable when you select the photo and then click on it to move to editable mode in the photo pane\) * date image was taken * image size in pixels * file size * date added to Tropy * date last modified in Tropy -This information may also be imported directly into your item template if it fits into the metadata schema in your template (e.g., the file name is imported as Title in most cases). If you wish to adjust where in your template the filename goes, you can do so in [Preferences](../other-features/preferencesmd.md). +This information may also be imported directly into your item template if it fits into the metadata schema in your template \(e.g., the file name is imported as Title in most cases\). If you wish to adjust where in your template the filename goes, you can do so in [Preferences](../other-features/preferencesmd.md). + + diff --git a/in-the-project-view/combine_photos.md b/in-the-project-view/combine_photos.md index 5f0a290..fcf2cfa 100644 --- a/in-the-project-view/combine_photos.md +++ b/in-the-project-view/combine_photos.md @@ -3,15 +3,16 @@ Tropy items can include one or multiple photos, making it easy to group multi-page documents. All photos within an item share the same metadata. Merging is not intended to collect multiple different documents, but rather to combine multiple photos that belong to the same document. **Grouping items into topical or organizational collections is best done with lists or tags.** * You can combine items within Tropy using several methods. - 1. **Drag and drop**: Drag an item on top of another item to combine them into one item. + 1. **Drag and drop**: Drag an item on top of another item to combine them into one item. - ![](../.gitbook/assets/drag-and-drop-merge.png) - 2. **Right-click**: Hold down the Command/Ctrl key, then click on each item. Right-click, then click _Merge selected items_ from the drop-down menu. + ![](../.gitbook/assets/drag-and-drop-merge.png) - ![](../.gitbook/assets/right-click-merge.png) + 2. **Right-click**: Hold down the Command/Ctrl key, then click on each item. Right-click, then click _Merge selected items_ from the drop-down menu. + + ![](../.gitbook/assets/right-click-merge.png) * If you want to add photos to an item, and those photos are not already in Tropy, then you have two options. 1. Right-click on the item you want to add photos to. Select _Add photo_ and select one or more photos from your file system. Click _Open._ The photo will be added to your item; you can see it in the item pane under Photos. - 2. In the item pane under photos, click the +. Select one or more photos, and click _Open_. + 2. In the item pane under photos, click the +. Select one or more photos, and click _Open_. ## Merging metadata @@ -41,3 +42,4 @@ To duplicate, right-click on the photo in the Photos pane. Select _Duplicate Pho To move the duplicated photo to its own item, right-click on the photo and select _Move Photo to New Item_. When you do that, the duplicated photo will appear in the item table as its own item, which you can then edit to reflect its separate metadata. To move the duplicated photo to an existing item, drag the photo from the Photos pane onto the item in the item table that you want to add it to. + diff --git a/in-the-project-view/copy-and-paste-items..md b/in-the-project-view/copy-and-paste-items..md index fc30026..2189f4a 100644 --- a/in-the-project-view/copy-and-paste-items..md +++ b/in-the-project-view/copy-and-paste-items..md @@ -1,7 +1,8 @@ # Copy and paste items. -You can copy an item from a project and paste it again into either the same project or another project on your computer. (For moving items between projects on different machines, we recommend the [Archive plugin](../other-features/export-with-archive-plugin.md).) +You can copy an item from a project and paste it again into either the same project or another project on your computer. \(For moving items between projects on different machines, we recommend the [Archive plugin](../other-features/export-with-archive-plugin.md).\) To copy, select your item and press Ctrl/Cmd + C on your keyboard. To paste that item, make sure your item table is active and then press Ctrl/Cmd + V on your keyboard. + diff --git a/in-the-project-view/delete_photos.md b/in-the-project-view/delete_photos.md index 34d6360..8afca49 100644 --- a/in-the-project-view/delete_photos.md +++ b/in-the-project-view/delete_photos.md @@ -2,8 +2,8 @@ You can delete items in two ways. -1. Right-click on any item and select _Delete item_, or -2. drag your item to the _Deleted items_ trash can on the left side of the project view in order to delete. +1. Right-click on any item and select _Delete item_, or +2. drag your item to the _Deleted items_ trash can on the left side of the project view in order to delete. Deleted items are removed from all lists and projects. @@ -12,3 +12,4 @@ To view your deleted items, click on _Deleted items_. To restore a deleted item, right-click on it in _Deleted items_. Then click _Restore item_. To permanently delete, right-click on the item and then click _Permanently delete_. To permanently delete all of your deleted items, right-click on _Deleted items_ and select _Permanently delete_. + diff --git a/in-the-project-view/lists.md b/in-the-project-view/lists.md index 83bc6ca..0beafd6 100644 --- a/in-the-project-view/lists.md +++ b/in-the-project-view/lists.md @@ -1,28 +1,29 @@ # Organize items into lists. -Lists are a tool for organization. You can use lists to select items that are linked thematically or topically. Items can appear in multiple lists, so you can use lists for both structured organization (such as chapters or sections of your research) or more unstructured thematic organization (such as Imperialism or Politics). Items in lists also remain in the main project view. +Lists are a tool for organization. You can use lists to select items that are linked thematically or topically. Items can appear in multiple lists, so you can use lists for both structured organization \(such as chapters or sections of your research\) or more unstructured thematic organization \(such as Imperialism or Politics\). Items in lists also remain in the main project view. ## Create a new list. -1. Create a new list by going to _File_ > _New_ > _List_. The new list appears in the sidebar. Now type a name for your list and press Enter. +1. Create a new list by going to _File_ > _New_ > _List_. The new list appears in the sidebar. Now type a name for your list and press Enter. 2. Create a list by right-clicking on _Lists_ or your project name in the left pane and selecting _New List_. #### Nested lists -You can nest lists within each other, creating a list hierarchy. To create a new nested list, right-click on the name of the parent list and select _New List._ You can then name your new list whatever you want. +You can nest lists within each other, creating a list hierarchy. To create a new nested list, right-click on the name of the parent list and select _New List._ You can then name your new list whatever you want. -To nest an existing list within another list, drag and drop the list name onto the name of the list you want it nested inside. +To nest an existing list within another list, drag and drop the list name onto the name of the list you want it nested inside. ![Nested lists](../.gitbook/assets/nested-lists.png) ## Add items to a list. -Drag and drop an item onto the list name in order to add it to that list. (The item will remain in the main project view.) Items can appear in more than one list. +Drag and drop an item onto the list name in order to add it to that list. \(The item will remain in the main project view.\) Items can appear in more than one list. -You can add multiple items to a list at once, by selecting multiple items (using Ctrl/Command+click or Shift+click) and then dragging them to a list name. +You can add multiple items to a list at once, by selecting multiple items \(using Ctrl/Command+click or Shift+click\) and then dragging them to a list name. ## Remove items or lists. To remove an item from a list: Right-click on the item in the list and select _Remove Item From List._ To delete a list: Right-click on the list name and select _Delete list._ + diff --git a/in-the-project-view/search.md b/in-the-project-view/search.md index e7da54b..ca4af76 100644 --- a/in-the-project-view/search.md +++ b/in-the-project-view/search.md @@ -9,3 +9,5 @@ To clear your search, delete your search term from the search box. * When searching for a term that includes an apostrophe or other punctuation, enclose your search term in quotation marks, e.g., _"O'Brien,"_ not _O'Brien_. * To search for an item that includes multiple search terms, use AND between your search terms, e.g., _Cathcart AND Eaton._ + + diff --git a/in-the-project-view/tags.md b/in-the-project-view/tags.md index 350002a..253945a 100644 --- a/in-the-project-view/tags.md +++ b/in-the-project-view/tags.md @@ -2,7 +2,7 @@ ## Use tags -Tags are useful for delineating subjects, organization, content highlights, and many other uses. To maximize your tags' usefulness, you should check the tag list before creating a new tag to make sure you don't already have that tag (with a different capitalization or part of speech, for instance). You may also want to consult [What is metadata and how do I use it?](../before-you-begin/metadata.md) for further information. +Tags are useful for delineating subjects, organization, content highlights, and many other uses. To maximize your tags' usefulness, you should check the tag list before creating a new tag to make sure you don't already have that tag \(with a different capitalization or part of speech, for instance\). You may also want to consult [What is metadata and how do I use it?](../before-you-begin/metadata.md) for further information. ### Create a new tag. @@ -14,7 +14,7 @@ To access all of your items tagged with a particular tag, click on the tag name ### Add a tag that already exists. -You have two options for adding a tag that already exists. You can either (1) drag and drop your item onto the tag in the sidebar; or (2) right-click on the item, then move to _Tags_ and select the tag you wish to apply. You can also add tags in bulk, by selecting multiple items and then either dragging and dropping or selecting a tag from the right-click menu. +You have two options for adding a tag that already exists. You can either \(1\) drag and drop your item onto the tag in the sidebar; or \(2\) right-click on the item, then move to _Tags_ and select the tag you wish to apply. You can also add tags in bulk, by selecting multiple items and then either dragging and dropping or selecting a tag from the right-click menu. In the tags tab of the metadata pane, you can also click _Add Tag to Item_, and then starting typing a tag, and you will see suggestions of existing tags to autocomplete. @@ -37,8 +37,9 @@ In the sidebar, right-click on a tag and select _Delete tag._ Once you have created a tag, you can assign it a color. In the tag list in the sidebar, right-click on the tag name and navigate to Change Color. If you assign a color to a tag, items with that tag will receive a small colored circle in grid view so that you can easily see which items have colored tags. -You can assign all of your new tags a default color. Right-click on the word Tags in the tags list in project view and select _Default Tag Color_. Once you've selected a default tag color, all new tags will have that color automatically (though you can change the color using the same menu). +You can assign all of your new tags a default color. Right-click on the word Tags in the tags list in project view and select _Default Tag Color_. Once you've selected a default tag color, all new tags will have that color automatically \(though you can change the color using the same menu\). __ ## View tagged items To view tagged items, click on the tag name in the sidebar. The items with that tag will appear in the item table. Note that if you have a list selected, only items within that list will appear in the tagged-items results. + diff --git a/in-the-project-view/view_photos.md b/in-the-project-view/view_photos.md index 074162d..f8d1881 100644 --- a/in-the-project-view/view_photos.md +++ b/in-the-project-view/view_photos.md @@ -10,15 +10,15 @@ You can see a full-size preview of any of your items by pressing Space. Press Sp ### Photo enhancement in project view -To change the orientation of your items' photos, right-click on the item you wish to rotate, then click Rotate Left or Rotate Right. You can also use the keyboard by pressing Ctrl/Cmd + \[ or Ctrl/Cmd + ]. Changing orientation in the item table in project view changes all the photos in an item, or all the photos in all the items you have selected. +To change the orientation of your items' photos, right-click on the item you wish to rotate, then click Rotate Left or Rotate Right. You can also use the keyboard by pressing Ctrl/Cmd + \[ or Ctrl/Cmd + \]. Changing orientation in the item table in project view changes all the photos in an item, or all the photos in all the items you have selected. -To rotate individual photos within an item, select a photo from the photos pane to the right of the item table instead of an item in the item table. +To rotate individual photos within an item, select a photo from the photos pane to the right of the item table instead of an item in the item table. ### List view features If you are viewing your photos as a list, you can make changes to the default setup. -**Sort the list by column.** Click on the name of the column you want to sort by. The arrow (^) indicates which column your items are sorted by and whether they are sorted ascending (^) or descending (ˇ). +**Sort the list by column.** Click on the name of the column you want to sort by. The arrow \(^\) indicates which column your items are sorted by and whether they are sorted ascending \(^\) or descending \(ˇ\). **Re-order the columns.** Click on the column header and drag it to the location you want it. @@ -41,3 +41,4 @@ Moving the slider to the right switches the display to a grid. **Note**: The ima ## Item view To move to item view, double-click on one of your items. + diff --git a/in-the-template-editor/create-template.md b/in-the-template-editor/create-template.md index 8c2872d..eb0c60f 100644 --- a/in-the-template-editor/create-template.md +++ b/in-the-template-editor/create-template.md @@ -2,7 +2,7 @@ There are several steps to creating a new template. Before you begin, you may want to review our [documentation on metadata](../before-you-begin/metadata.md). -When you're ready to make your template, navigate to Tropy > Preferences and click to the Templates section. When you first open the Preferences pane, New Template will be the default, but if you click over to one of the other templates, you can get back to New Template by clicking on it in the Template drop-down box or by clicking the first button next to the drop-down. +When you're ready to make your template, navigate to Tropy > Preferences and click to the Templates section. When you first open the Preferences pane, New Template will be the default, but if you click over to one of the other templates, you can get back to New Template by clicking on it in the Template drop-down box or by clicking the first button next to the drop-down. ## Metadata about your template![](../.gitbook/assets/template-header@2x.png) @@ -28,12 +28,13 @@ Tropy currently only allows fields that have URIs in an existing metadata schema * **Property**: The drop-down box here allows you to select from a list of properties that appear in various metadata schemas. The Dublin core fields are the default; you can add other metadata schemas in the [Vocabulary](vocabularies.md) section in Preferences. * You can search for metadata terms by clicking in the Property field and starting to type a term. Click on the term that you want. - * The Property name is what will appear in your template. If you want it to read something different (for example, "Source" renamed to "Archive"), you can fill in the Label field with your desired label. + * The Property name is what will appear in your template. If you want it to read something different \(for example, "Source" renamed to "Archive"\), you can fill in the Label field with your desired label. * **Is mandatory field**: If this box is checked, Tropy will post an alert button next to the field in the metadata pane in the project or item view of Tropy until it is properly filled in. -* **Hint**: The hint will appear in the editable field of the metadata template in the project or item view. The hint is a useful way to remind yourself of what you meant by the property you selected. For example, if you are using a standard format such as ISO for dates, you could put "ISO format" in the hint. -* **Default value**: If this box is filled in, the text in the box will appear automatically in the metadata pane in the project or item view. This feature is especially relevant for institutions creating templates for patrons to use. You can fill in, for example, the name of your institution, as you wish it to appear, the rights information attached to your collections, and other fields that will be the same no matter who uses the template. +* **Hint**: The hint will appear in the editable field of the metadata template in the project or item view. The hint is a useful way to remind yourself of what you meant by the property you selected. For example, if you are using a standard format such as ISO for dates, you could put "ISO format" in the hint. +* **Default value**: If this box is filled in, the text in the box will appear automatically in the metadata pane in the project or item view. This feature is especially relevant for institutions creating templates for patrons to use. You can fill in, for example, the name of your institution, as you wish it to appear, the rights information attached to your collections, and other fields that will be the same no matter who uses the template. * **Is read-only**: This box, only clickable if a default value is set, allows the creator of a template to indicate that the default value cannot be changed within the metadata pane. To add more fields to your template, click on the + on the right-hand side. To delete fields, click on the -. You can re-order your fields by dragging their boxes. Click and hold on the left-hand side of the box to place your fields in a different order. + diff --git a/in-the-template-editor/edit-templates.md b/in-the-template-editor/edit-templates.md index 2ecb928..662fafa 100644 --- a/in-the-template-editor/edit-templates.md +++ b/in-the-template-editor/edit-templates.md @@ -2,7 +2,7 @@ Editing templates is a process similar to creating templates. There are two ways to edit a template. -1. For templates you have created yourself, or templates that are not locked, you can add or edit fields as you would do when [creating a template](create-template.md) initially. (In a locked template, the fields are all grayed out and not clickable.) +1. For templates you have created yourself, or templates that are not locked, you can add or edit fields as you would do when [creating a template](create-template.md) initially. \(In a locked template, the fields are all grayed out and not clickable.\) 2. If you want to edit a locked template, you will have to duplicate the locked template. To duplicate, click on the second button next to Template in the editor. ![](../.gitbook/assets/template-header@2x.png) @@ -10,3 +10,4 @@ Editing templates is a process similar to creating templates. There are two ways Once you have duplicated the template, rename your duplicate and assign it a different URI.Then click _Create_. After you have created the new template, you can change fields, add fields, or delete fields. + diff --git a/in-the-template-editor/export-import-templates.md b/in-the-template-editor/export-import-templates.md index 84db490..7218485 100644 --- a/in-the-template-editor/export-import-templates.md +++ b/in-the-template-editor/export-import-templates.md @@ -6,7 +6,7 @@ Once you have created a template, you can export it so others can use it as well Click on the fifth button in the template header. -![](../.gitbook/assets/template-download-header@2x.png) +![](../.gitbook/assets/template-download-header-2x.png) This will open a dialog box. From there, you can save your template. The default filename is the name you gave to your template. The file format is .ttp. @@ -15,3 +15,4 @@ This will open a dialog box. From there, you can save your template. The default You can import templates from others. Any .ttp file can be imported into Tropy. Click on the fourth button in the template header. In the dialog box that opens, navigate to wherever you have the .ttp file saved, then click _Open_. The imported template now appears in the Template dropdown box in the template header. You don't have to do anything further to be able to use the template. Once you close the Preferences window, the template will be available in your metadata pane. + diff --git a/in-the-template-editor/using-templates.md b/in-the-template-editor/using-templates.md index f53b270..8e0417a 100644 --- a/in-the-template-editor/using-templates.md +++ b/in-the-template-editor/using-templates.md @@ -6,8 +6,9 @@ Metadata templates are forms that you select or create that allow you to record ## Working with the template editor -Access the template editor by navigating to Tropy > Preferences (in Windows, Tropy > Edit > Preferences). Click on the Templates icon. +Access the template editor by navigating to Tropy > Preferences \(in Windows, Tropy > Edit > Preferences\). Click on the Templates icon. -![](../.gitbook/assets/preferences@2x.png) +![](../.gitbook/assets/preferences-2x.png) In the drop-down box, you'll see "New Template..." The drop-down is where you can access any templates that are currently loaded into your version of Tropy. The icons to the right of that drop-down represent the first steps toward creating or editing a metadata template. The next several sections of the documentation will walk you through how to use each of those buttons. + diff --git a/other-features/collaboration.md b/other-features/collaboration.md index 9c37b67..f787f59 100644 --- a/other-features/collaboration.md +++ b/other-features/collaboration.md @@ -1,11 +1,12 @@ # Collaboration -Synchronous collaboration with other scholars or across computers is not currently supported, but we are working hard to develop a system for asynchronous collaboration. +Synchronous collaboration with other scholars or across computers is not currently supported, but we are working hard to develop a system for asynchronous collaboration. -You can save a Tropy project anywhere, on your hard drive, on an external drive, on a cloud drive. If you want others to be able to access the project and use it, you may need to set up a portable project (read how to do that [here](https://forums.tropy.org/t/testing-portable-project-files/1003)). +You can save a Tropy project anywhere, on your hard drive, on an external drive, on a cloud drive. If you want others to be able to access the project and use it, you may need to set up a portable project \(read how to do that [here](https://forums.tropy.org/t/testing-portable-project-files/1003)\). #### Read-only mode If you are working with a project team, and the research is complete, you may want to make your project read-only so that you or your collaborators don't accidentally change things in your project unexpectedly. Tropy now supports read-only projects. To make a project read-only in Windows, read [here](https://www.oreilly.com/library/view/windows-server-cookbook/0596006330/ch04s14.html). To make a project read-only on Mac, read [here](https://www.howtogeek.com/669095/how-to-set-file-permissions-on-mac/). + diff --git a/other-features/export-with-archive-plugin.md b/other-features/export-with-archive-plugin.md index 95e74f8..7348ce1 100644 --- a/other-features/export-with-archive-plugin.md +++ b/other-features/export-with-archive-plugin.md @@ -8,26 +8,26 @@ The Archive plugin allows you to export items in full--including photos, metadat First, download the latest release [here](https://github.com/tropy/tropy-plugin-archive/releases). -Then navigate to _Preferences > Plugins_. Click on _Install plugin_ and navigate to wherever the ZIP folder saved on your computer. Select the ZIP folder (don't unzip it) and click _Open_. +Then navigate to _Preferences > Plugins_. Click on _Install plugin_ and navigate to wherever the ZIP folder saved on your computer. Select the ZIP folder \(don't unzip it\) and click _Open_. -![Plugins window with Archive plugin active](<../.gitbook/assets/Screen Shot 2020-03-17 at 11.39.29 AM.png>) +![Plugins window with Archive plugin active](../.gitbook/assets/screen-shot-2020-03-17-at-11.39.29-am.png) ### Activate and customize the plugin The plugin should now appear in your list of plugins. Click _Enable_ to activate the plugin. -You'll then see a number of options. You can give your plugin a name, if you like (or you can leave it blank). +You'll then see a number of options. You can give your plugin a name, if you like \(or you can leave it blank\). -The "Root folder" option tells Tropy what to name the folder inside the ZIP archive which will contain all your exported data. If you want the images to be saved in a folder inside this root folder, separate from the metadata file, you can set the "Image folder" option (though we do not recommend this for general use). +The "Root folder" option tells Tropy what to name the folder inside the ZIP archive which will contain all your exported data. If you want the images to be saved in a folder inside this root folder, separate from the metadata file, you can set the "Image folder" option \(though we do not recommend this for general use\). The "Save as" option allows you to customize the location and file name for the ZIP archive that will be created. If you select "Always ask?" you will get a dialog box every time you use the plugin in the main Tropy interface that asks you where you'd like to save the ZIP archive and what you'd like to call it. -Once you've set up your preferences, close the Preferences window (no save necessary). +Once you've set up your preferences, close the Preferences window \(no save necessary\). ## Using the Archive plugin -To export using the archive plugin, select the item or items you want to archive. Right-click on the item(s) and navigate to _Export_. Then select the name that you gave the plugin. +To export using the archive plugin, select the item or items you want to archive. Right-click on the item\(s\) and navigate to _Export_. Then select the name that you gave the plugin. -![How to use the archive plugin (notice that it's called ZIP Export, which is the name we gave it above).](<../.gitbook/assets/Screen Shot 2020-03-17 at 2.24.57 PM.png>) +![How to use the archive plugin \(notice that it's called ZIP Export, which is the name we gave it above\).](../.gitbook/assets/screen-shot-2020-03-17-at-2.24.57-pm.png) If you selected "Always ask?" a dialog box will open and you can select the place you wish to save and the name you wish your folder to have. If you did not, then your ZIP archive will save to the location you set in _Preferences_. diff --git a/other-features/export-with-plugins.md b/other-features/export-with-plugins.md index 48c4a32..8e6dc15 100644 --- a/other-features/export-with-plugins.md +++ b/other-features/export-with-plugins.md @@ -1,10 +1,10 @@ -# Export with CSV Export plugin +# Export with CSV plugin ### Using the CSV Plugin #### 1. Download and install the plugin. -Download the plugin zip file from the [latest release in GitHub](https://github.com/tropy/tropy-plugin-csv/releases/latest). Then, in Tropy, navigate to _Preferences_ > _Plugins_ (in Windows, _Edit > Preferences > Plugins_). +Download the plugin zip file from the [latest release in GitHub](https://github.com/tropy/tropy-plugin-csv/releases/latest). 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. @@ -16,21 +16,21 @@ Then click on the name of the plugin to open up a customization panel within the 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](../.gitbook/assets/CSV-export-customization.png) +![CSV Export customization window](../.gitbook/assets/csv-export-customization.png) 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](../in-the-template-editor/create-template.md) 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. +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](https://github.com/tropy/tropy-plugin-csv/blob/master/README.md) #### 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). +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). +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](../.gitbook/assets/using-csv-export.png) @@ -42,6 +42,6 @@ Your CSV should be complete! If you look at the CSV in another application, you' #### 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! +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](../.gitbook/assets/multiple-csv-instance.png) diff --git a/other-features/export.md b/other-features/export.md index f1350bc..a32643d 100644 --- a/other-features/export.md +++ b/other-features/export.md @@ -4,9 +4,11 @@ Tropy items can be exported as [JSON-LD](https://json-ld.org/), as well as to [O ## To JSON-LD -To export from Tropy, right-click on an item in the item table. From the right-click menu, select _Export Item > JSON-LD_. This action will open a dialog box, where you can save your JSON file onto your computer. To export multiple items, Ctrl/Command+click or Shift+click to select multiple items. Then right-click and select _Export Selected Items_. +To export from Tropy, right-click on an item in the item table. From the right-click menu, select _Export Item > JSON-LD_. This action will open a dialog box, where you can save your JSON file onto your computer. To export multiple items, Ctrl/Command+click or Shift+click to select multiple items. Then right-click and select _Export Selected Items_. At present, Tropy only exports metadata and notes to JSON-LD, not associated photos. Your photos still exist outside Tropy as well, since importing in Tropy only links to your photos. You can export your notes in either HTML or Markdown. To change which format you wish to use, navigate to _Preferences_ and scroll down to _Export_. Select either "Notes as HTML" or "Notes as Markdown." + + diff --git a/other-features/iiif.md b/other-features/iiif.md index 536e8d9..822288b 100644 --- a/other-features/iiif.md +++ b/other-features/iiif.md @@ -16,7 +16,7 @@ See [the plugin documentation](https://github.com/tropy/tropy-plugin-iiif) for m > available in Lewis Walpole Library, > Yale University -[IIIF Manifest](https://collections.library.yale.edu/catalog/16193053) +[https://collections.library.yale.edu/catalog/16193053]() ## Sample IIIF manifest for a manuscript containing multiple images @@ -25,4 +25,7 @@ See [the plugin documentation](https://github.com/tropy/tropy-plugin-iiif) for m > (Roma: G. Mascardi, 1628), > National Gallery of Art (US) Library -[IIIF Manifest](https://libraryimage.nga.gov/manifest/mms/99682033504896.json) +[https://libraryimage.nga.gov/manifest/mms/99682033504896.json]() + + + diff --git a/other-features/keyboard-shortcuts.md b/other-features/keyboard-shortcuts.md index 0d7f546..11c0e2c 100644 --- a/other-features/keyboard-shortcuts.md +++ b/other-features/keyboard-shortcuts.md @@ -4,17 +4,18 @@ Here is a list of global keyboard shortcuts for use in Tropy. More specific shor ## Global Shortcuts -| Action | Shortcut | -| ------------- | -------------------- | -| New project | Ctrl/Command+Shift+P | -| New item | Ctrl/Command+Shift+N | -| Open project | Ctrl/Command+Shift+O | +| Action | Shortcut | +| :--- | :--- | +| New project | Ctrl/Command+Shift+P | +| New item | Ctrl/Command+Shift+N | +| Open project | Ctrl/Command+Shift+O | | Import photos | Ctrl/Command+Shift+I | -| Close | Ctrl/Command+W | -| Quit Tropy | Ctrl/Command+Q | -| Undo | Ctrl/Command+Z | -| Redo | Shift+Ctrl/Command+Z | -| Cut | Ctrl/Command+X | -| Copy | Ctrl/Command+C | -| Paste | Ctrl/Command+V | -| Merge items | Ctrl/Command+Shift+M | +| Close | Ctrl/Command+W | +| Quit Tropy | Ctrl/Command+Q | +| Undo | Ctrl/Command+Z | +| Redo | Shift+Ctrl/Command+Z | +| Cut | Ctrl/Command+X | +| Copy | Ctrl/Command+C | +| Paste | Ctrl/Command+V | +| Merge items | Ctrl/Command+Shift+M | + diff --git a/other-features/omeka.md b/other-features/omeka.md index 66d912e..f209ed4 100644 --- a/other-features/omeka.md +++ b/other-features/omeka.md @@ -16,16 +16,16 @@ Installing the Omeka S plugin is a multi-step process. 1. Navigate to your Omeka's admin panel and click on _Users_. In the list of users, each name has a pencil next to it. Click on the pencil to open the user profile. Read more about how to add or edit users [here](https://omeka.org/s/docs/user-manual/admin/users/). 2. In the user profile, click on _API keys._ 3. You now need to add a new key. Type a name into the _New key label_ field and hit _Enter._ -4. You should get a box that generates a _key\_identity_ and a _key\_credential_. **Do not close this browser page until you have finished the process of installing and configuring the Tropy plugin.**![Screenshot of Omeka S interface showing the notice after an API key is created.](../.gitbook/assets/api-key) +4. You should get a box that generates a _key\_identity_ and a _key\_credential_. **Do not close this browser page until you have finished the process of installing and configuring the Tropy plugin.**![Screenshot of Omeka S interface showing the notice after an API key is created.](../.gitbook/assets/api-key.bin) ### **Part 3: In the Plugins Pane** -1. Open Tropy and navigate to Preferences in the top menu (in Windows, _Edit_ > _Preferences_). +1. Open Tropy and navigate to Preferences in the top menu \(in Windows, _Edit_ > _Preferences_\). 2. In Preferences, click on Plugins. At the bottom of the Plugins pane, click on _Install Plugin_. Navigate to wherever you saved the plugin file from the GitHub repository; select it and click _Open._ 3. Now your Omeka plugin should appear in the Plugins pane. Click on _Enable_ to continue setup. 4. In the form that opens when you enable the plugin, you now have to fill in all the fields in order for your plugin to work properly. * **Name**: You can name your instance of the Omeka plugin anything you like. We recommend that you give it the same name as your Omeka site. - * **API URL**: Copy the URL of your Omeka installation and paste it between the `< >` (removing the angle brackets). You should have only one `http://`. Do not link to your individual site within your Omeka installation, but to the root Omeka S installation. + * **API URL**: Copy the URL of your Omeka installation and paste it between the `< >` \(removing the angle brackets\). You should have only one `http://`. Do not link to your individual site within your Omeka installation, but to the root Omeka S installation. * **Identity key and credential key**: These two fields come from the page you should still have open in your Omeka installation. Copy and paste them into the appropriate fields. Once you've filled in these fields, you're all set---you can now close the Preferences window. @@ -55,8 +55,9 @@ If you imported custom vocabularies into Tropy, you'll need to import them into Items are exported from Tropy along with their custom templates. Provided that you have imported all the proper vocabularies, your item should show up in Omeka with all the expected fields. Custom labels, however, do not transfer. In order to retain your custom labels in Omeka, you'll have to make a [resource template](https://omeka.org/s/docs/user-manual/content/resource-template/) that reflects your custom template labels. You can then apply your resource template to your items individually or in bulk. * To make a resource template, go to your Omeka site's admin page. In the lefthand menu, click on _Resource templates._ Then click on _Add new resource template_ in the top right. -* Just as in Tropy, you'll need to give your template a name. (If it makes sense, you might want to name it the same thing as your Tropy template.) +* Just as in Tropy, you'll need to give your template a name. \(If it makes sense, you might want to name it the same thing as your Tropy template.\) * Then build your template using the same fields as your Tropy template. You can find your properties quickly by typing them into the _Filter properties_ box on the righthand side. Make sure they are identical to the ones you've used in your Tropy template. * Once you've compiled all your fields, you can edit the labels by clicking on the pencil next to each field. Add your custom label in the _Alternate_ title box. Make sure you click _Set changes_ once you've added your custom label. * When you've changed all your custom labels, click _Add_ in the top right to add your resource template to your Omeka resources. * To apply your custom resource template to your items, return to the item list. Then click on the pencil next to an item to edit it. Set your resource template and then click _Save._ You can also do this action in bulk by using the _Batch actions_ button at the top. + diff --git a/other-features/preferencesmd.md b/other-features/preferencesmd.md index 3d18df4..97196b7 100644 --- a/other-features/preferencesmd.md +++ b/other-features/preferencesmd.md @@ -10,11 +10,11 @@ Under _Preferences_, you can customize your installation of Tropy in several way **Theme**: Select light or dark mode. -**Locale**: Tropy can be used in multiple languages. Select your preferred language. If you do not see the language you prefer to work in, and you would be willing to help us translate Tropy into that language, please join our [translation team](https://explore.transifex.com/cds/tropy/) at Transifex! Tropy currently has locales in English, French, German, Italian, Japanese, Chinese, Spanish, Dutch, Portuguese, Brazilian Portuguese, and Ukrainian. +**Locale**: Tropy can be used in multiple languages. Select your preferred language. If you do not see the language you prefer to work in, and you would be willing to help us translate Tropy into that language, please join our [translation team](https://explore.transifex.com/cds/tropy/) at Transifex! Tropy currently has locales in English, French, German, Italian, Japanese, Chinese, and Spanish. **Interface**: The preferences here help you match Tropy's behavior to your typical scrolling behavior. -**Export:** Tropy can export your notes in either [HTML](https://www.w3schools.com/html/default.asp) or [Markdown](https://daringfireball.net/projects/markdown/). Select which one you'd like from the menu here. \_\_ +**Export:** Tropy can export your notes in either [HTML](https://www.w3schools.com/html/default.asp) or [Markdown](https://daringfireball.net/projects/markdown/). Select which one you'd like from the menu here. __ **Print**: Select your print option here. See more at [Print items](print-items.md). @@ -24,12 +24,12 @@ Under _Preferences_, you can customize your installation of Tropy in several way **ID:** You can't change this; it's to help Tropy find your project internally. -**File:** This is \*\*\*\* where you can find your file, if you ever need to access the file. +**File:** This is **** where you can find your file, if you ever need to access the file. **Link photos:** Link photos replaces the portable projects hack. Here, you tell Tropy what the relationship is between the project file and the image files. * Using absolute paths: This option is how Tropy operates by default. If you choose this option, you can move your project file wherever you like, but you will have to consolidate your photos if you move your photos. -* Relative to the project file: Select this option if you may want to move your photos and your project file together, or if you store your photos in the same location as your project file (either in a hard drive or a cloud drive). You can open your Tropy project from multiple devices, but you should not move your photos without also moving your project file. +* Relative to the project file: Select this option if you may want to move your photos and your project file together, or if you store your photos in the same location as your project file (either in a hard drive or a cloud drive). You can open your Tropy project from multiple devices, but you should not move your photos without also moving your project file. * Relative to your home directory: This option is the one for you if you store your photos and project file in Dropbox or another cloud drive, and you open your photos on multiple computers where your home directory might have a different name or location. Your photos and project file should be in the same drive, but that drive may be accessed from multiple devices. You can change this option at any point; however, be sure your photos are fully consolidated (the links are all intact) before making a change. If you make an error in selecting the right option for your situation, you can always [consolidate your photos](../troubleshooting/moving-photos.md#re-associating-photos) again to restore the links. diff --git a/other-features/print-items.md b/other-features/print-items.md index c9f2c18..eca40b6 100644 --- a/other-features/print-items.md +++ b/other-features/print-items.md @@ -2,7 +2,9 @@ Tropy allows you to print out your items and their metadata using a standard print dialog box. -To print, select the item or items you wish to print. (To select multiple items, press Ctrl + click each item you wish to select.) Then navigate to _File_ > _Print_. You can also press Ctrl+P to see the print dialog box. The print dialog box gives you many options for formatting and layout. Select the format you want and click _Print_. +To print, select the item or items you wish to print. \(To select multiple items, press Ctrl + click each item you wish to select.\) Then navigate to _File_ > _Print_. You can also press Ctrl+P to see the print dialog box. The print dialog box gives you many options for formatting and layout. Select the format you want and click _Print_. + +Tropy's preferences give you options for what parts of your items you wish to print. To change these preferences, go to _Preferences_ and scroll down to _Print_. In that panel you can select whether to print with notes, with metadata, and with photos. + -Tropy's preferences give you options for what parts of your items you wish to print. To change these preferences, go to _Preferences_ and scroll down to _Print_. In that panel you can select whether to print with notes, with metadata, and with photos. diff --git a/troubleshooting/backup.md b/troubleshooting/backup.md index 0ea1a53..c4c4730 100644 --- a/troubleshooting/backup.md +++ b/troubleshooting/backup.md @@ -1,5 +1,6 @@ # Backup -Tropy files can be backed up just like any other files on your computer. They live in three places: 1. The project file (.tpy), saved wherever you told the file to save when you created your project, likely in My Documents or a similar folder. 2. The 'user data' folder, which contains any custom templates you might have created: `~/Library/Application Support/Tropy` (macOS) `~/.config/tropy` (linux) or `%APPDATA%\Tropy` (Windows), 3. and the photos (which Tropy currently does not modify at all). +Tropy files can be backed up just like any other files on your computer. They live in three places: 1. The project file \(.tpy\), saved wherever you told the file to save when you created your project, likely in My Documents or a similar folder. 2. The 'user data' folder, which contains any custom templates you might have created: `~/Library/Application Support/Tropy` \(macOS\) `~/.config/tropy` \(linux\) or `%APPDATA%\Tropy` \(Windows\), 3. and the photos \(which Tropy currently does not modify at all\). You can back up all of these files just as you would back up any other computer file, using an external drive, a cloud drive, or some other method. + diff --git a/troubleshooting/forums.md b/troubleshooting/forums.md index c0ced02..58844f8 100644 --- a/troubleshooting/forums.md +++ b/troubleshooting/forums.md @@ -2,7 +2,7 @@ ### Detecting problems -If your database has been corrupted in some way, you should see a flag next to your project name. +If your database has been corrupted in some way, you should see a flag next to your project name. ![Flag on corrupted projects](../.gitbook/assets/corrupted-flag.png) @@ -11,3 +11,4 @@ If your database has been corrupted in some way, you should see a flag next to y Tropy maintains [support forums](https://forums.tropy.org/) where you can ask questions, suggest additional features, and see what others are saying about Tropy. If you have questions or suggestions for making this documentation more useful, please [write us a note on the forums](https://forums.tropy.org/)! + diff --git a/troubleshooting/moving-photos.md b/troubleshooting/moving-photos.md index 7530cd9..2b7bf5d 100644 --- a/troubleshooting/moving-photos.md +++ b/troubleshooting/moving-photos.md @@ -6,19 +6,19 @@ description: >- # Moving photos -Generally, we recommend that you put your photos into a permanent home before you put them into Tropy. However, sometimes you have to move your photos once you've put them in. +Generally, we recommend that you put your photos into a permanent home before you put them into Tropy. However, sometimes you have to move your photos once you've put them in. -Tropy does not make a copy of your photos--it only maintains a link to where they are stored on your computer. So if you move your photos, you'll need to tell Tropy their new location. You'll know that Tropy can't find your photos if you click on them in the photo pane and see an exclamation point flag. +Tropy does not make a copy of your photos--it only maintains a link to where they are stored on your computer. So if you move your photos, you'll need to tell Tropy their new location. You'll know that Tropy can't find your photos if you click on them in the photo pane and see an exclamation point flag. #### Re-associating Photos -To re-associate your photos, right-click on one of the photos and click _Consolidate Photo._ A dialog box will pop up asking you to identify the new location of the photo file. +To re-associate your photos, right-click on one of the photos and click _Consolidate Photo._ A dialog box will pop up asking you to identify the new location of the photo file. -![Right-click on the photo name and select Consolidate Photo.](../.gitbook/assets/Consolidation-box.png) +![Right-click on the photo name and select Consolidate Photo.](../.gitbook/assets/consolidation-box.png) -Once you've selected the new location, click _OK._ Another box will pop up asking "Do you want Tropy to automatically check and resolve further missing photos at this location?" If you click _Yes,_ Tropy will use the location you've just provided to re-associate all the other photos it can find based on their relationship to your newly identified photo. +Once you've selected the new location, click _OK._ Another box will pop up asking "Do you want Tropy to automatically check and resolve further missing photos at this location?" If you click _Yes,_ Tropy will use the location you've just provided to re-associate all the other photos it can find based on their relationship to your newly identified photo. -![The dialog box asks whether you want Tropy to look for your other photos as well.](../.gitbook/assets/auto-consolidation-check.png) +![The dialog box asks whether you want Tropy to look for your other photos as well.](../.gitbook/assets/auto-consolidation-check%20%281%29%20%281%29.png) @@ -27,3 +27,4 @@ For example, let's say you import the photos straight from your Desktop into Tro Or let's say you get a new computer and you move your project and your photos over to the new computer; but on the new computer some paths are different, for example, let's say you have a different home directory and so now your pictures are at `/home/ariadne/Pictures/A` and `/home/ariadne/Pictures/B`. In this case you can consolidate a single photo in either of the two folders: Tropy should still be able to re-associate all the photos, because, relative to each other, they all moved to a single new location. **Bulk re-association works only if you have not changed file names when you moved your folders. If you change file names, you will have to consolidate each photo individually.** + diff --git a/using-templates.md b/using-templates.md new file mode 100644 index 0000000..e69de29 diff --git a/using-tropy/add_files.md b/using-tropy/add_files.md index 46cd7e8..a8c2e53 100644 --- a/using-tropy/add_files.md +++ b/using-tropy/add_files.md @@ -2,33 +2,34 @@ When you import a photo, Tropy makes a thumbnail copy of the photo. The original photo remains in its original location on your hard drive. You have several options for adding photos to your project. -* Navigate to _File_ > _Import photos_. You can select one photo from your files, or using Shift+click or Ctrl/Command+click, you can select multiple photos. To select all photos in a folder, type Ctrl/Command+A. Then click _Open_ in the dialog box. -* Click the + in the menu bar above the item table in project view. +* Navigate to _File_ > _Import photos_. You can select one photo from your files, or using Shift+click or Ctrl/Command+click, you can select multiple photos. To select all photos in a folder, type Ctrl/Command+A. Then click _Open_ in the dialog box. +* Click the + in the menu bar above the item table in project view. + + ![](../.gitbook/assets/add_photos.png) - * From your computer’s file system, navigate to the folder where your photos are, and select one or more photos. Then drag those photos into the middle pane of Tropy in order to add them. Depending on the number of photos you are importing, you should expect import to take some time. **Note:** At this time, Tropy does not support drag-and-drop directly from Apple’s photo software, including iPhoto and Photos.app. To get photos from Photos, export your photos to a different location on your computer and then follow the steps above. **We strongly, strongly recommend that you do not store your research photos in Apple Photos long-term, whether you use Tropy or not.** -You may want to add an item that does not yet have any photos attached to it. To do so, go to _File_ > _New_ > _Item_. You can then add photos to that item just as you would add photos to an item that already contains photos. +You may want to add an item that does not yet have any photos attached to it. To do so, go to _File_ > _New_ > _Item_. You can then add photos to that item just as you would add photos to an item that already contains photos. **Troubleshooting**: When you import photos into Tropy, make sure the search box is clear; otherwise it will seem like your photos are not importing. ### Importing large files from PDF/SVG -If you are working with very large files, you may need to make some adjustments in order for Tropy to render them. +If you are working with very large files, you may need to make some adjustments in order for Tropy to render them. -To render your files at a different density, change the pixels per inch setting in the metadata panel. You can access the ppi setting in the Photo pane. The default is 72ppi. If your image is not high enough quality at 72ppi, you can increase it (you should try 144ppi and then 300ppi). Once you have changed the PPI, the image viewer should refresh your image. +To render your files at a different density, change the pixels per inch setting in the metadata panel. You can access the ppi setting in the Photo pane. The default is 72ppi. If your image is not high enough quality at 72ppi, you can increase it \(you should try 144ppi and then 300ppi\). Once you have changed the PPI, the image viewer should refresh your image. -You can change the default ppi setting at which images are imported in _Preferences_ > _Default density._ +You can change the default ppi setting at which images are imported in _Preferences_ > _Default density._ ### Dragging images directly from a web browser Tropy allows you to drag static images into Tropy directly from a web browser. Click and hold on the image you wish to import and drag it onto the item table. This action creates a link to the web version of the image; it does not download it. To access the original web location of the image, right-click on the photo name in the photos panel and select _Show original photo._ -**Note:** This method does not work with images that are displayed within an interactive image browser (such as the New York Public Library's interface). To use images displayed in an interactive browser, you'll need to use the download options and save a local copy of the image. +**Note:** This method does not work with images that are displayed within an interactive image browser \(such as the New York Public Library's interface\). To use images displayed in an interactive browser, you'll need to use the download options and save a local copy of the image. ### Importing JSON-LD files @@ -40,10 +41,11 @@ You can use the CSV plugin to bulk import items, photos and metadata into Tropy ## Consolidate your photo library. -If you make changes to the originals of your photos, you will need to tell Tropy that you've made changes. (For instance, perhaps you cropped or changed the contrast on a photo outside Tropy.) This process is called consolidation. +If you make changes to the originals of your photos, you will need to tell Tropy that you've made changes. \(For instance, perhaps you cropped or changed the contrast on a photo outside Tropy.\) This process is called consolidation. -To consolidate, navigate to _File_ > _Consolidate Photo Library_. You don't need to do anything else; this command lets Tropy recreate any thumbnails that are missing or have been changed. +To consolidate, navigate to _File_ > _Consolidate Photo Library_. You don't need to do anything else; this command lets Tropy recreate any thumbnails that are missing or have been changed. You can consolidate individual photos by right-clicking on them in the Photos pane and selecting _Consolidate photo._ -## +## + diff --git a/using-tropy/create_project.md b/using-tropy/create_project.md index 4da00f6..5987439 100644 --- a/using-tropy/create_project.md +++ b/using-tropy/create_project.md @@ -2,18 +2,19 @@ A project is a collection of photographs. Because Tropy allows for a lot of flexibility in each project, it usually makes sense to conceive of a project in broad terms: a project as a book or thesis, not a chapter. You can use lists, tags, and/or notes to organize material within a Tropy project. -**From the menu bar**: Click on _File_ > _New_ > _Project_. +**From the menu bar**: Click on _File_ > _New_ > _Project_. ![](../.gitbook/assets/create-project.png) -**To change where your project is saved**:\ -By default, your project saves to your documents folder on your hard drive (My Documents in Windows, Documents in macOS, etc.). +**To change where your project is saved**: +By default, your project saves to your documents folder on your hard drive \(My Documents in Windows, Documents in macOS, etc.\). To change where your project is saved, click on _Change file name and location_ in the “Create new project” dialog box. Then select a new location. You can also rename the file so that the name of the project is different from the name of the file. Then click _Save_ to return to the "Create new project" dialog box. When you have named your project, click _Create project_. -**To find out where your project is saved**:\ +**To find out where your project is saved**: Once you are in Tropy, if you need to find out where your project is saved, right-click on its name in the sidebar and select _Show project file._ -### Open multiple projects at the same time_._ +### Open multiple projects at the same time_._ + +To open multiple projects at the same time, navigate to _File > Open in New Window_ and select the project you wish to open in addition to the project you currently have open. You can [copy and paste items](../in-the-project-view/copy-and-paste-items..md) between projects \(though there is diminishing utility in this the more you do it; if you find you're copying large quantities of items, you should consider combining your two projects into one\). -To open multiple projects at the same time, navigate to _File > Open in New Window_ and select the project you wish to open in addition to the project you currently have open. You can [copy and paste items](../in-the-project-view/copy-and-paste-items..md) between projects (though there is diminishing utility in this the more you do it; if you find you're copying large quantities of items, you should consider combining your two projects into one). diff --git a/using-tropy/intro-to-the-interface.md b/using-tropy/intro-to-the-interface.md index e04a01b..8b67858 100644 --- a/using-tropy/intro-to-the-interface.md +++ b/using-tropy/intro-to-the-interface.md @@ -10,7 +10,7 @@ Tropy's interface is designed to be as user-friendly and straightforward as poss ![Project view, using grid view](../.gitbook/assets/schematic-project-view.jpg) -To collapse or expand any of the panes on the right, double-click in their headers. For more information about how to use the tools in this view, see [View photos in project view](../in-the-project-view/view_photos.md) and the following pages. +To collapse or expand any of the panes on the right, double-click in their headers. For more information about how to use the tools in this view, see [View photos in project view](../in-the-project-view/view\_photos.md) and the following pages. ### Item view diff --git a/using_tropy/README.md b/using_tropy/README.md new file mode 100644 index 0000000..e69de29 diff --git a/using_tropy/project_view/README.md b/using_tropy/project_view/README.md new file mode 100644 index 0000000..e69de29 diff --git a/using_tropy/project_view/project-view-basics.md b/using_tropy/project_view/project-view-basics.md new file mode 100644 index 0000000..e69de29 diff --git a/using_tropy/templates/README.md b/using_tropy/templates/README.md new file mode 100644 index 0000000..e69de29 diff --git a/whats-new.md b/whats-new.md index 652cf98..e06835a 100644 --- a/whats-new.md +++ b/whats-new.md @@ -6,29 +6,29 @@ description: This page describes the new features from our current release. ### New in Tropy 1.10 -* **New way of linking your photos!** In the past, if you've wanted to be able to move your photos around, you had to follow a somewhat hackneyed process to create what we were calling a portable project. We've gotten rid of portable projects in favor of a much easier solution--you can now [select whether you want your photos to be linked to Tropy](other-features/preferencesmd.md#project) using relative paths or absolute paths. +* **New way of linking your photos!** In the past, if you've wanted to be able to move your photos around, you had to follow a somewhat hackneyed process to create what we were calling a portable project. We've gotten rid of portable projects in favor of a much easier solution--you can now [select whether you want your photos to be linked to Tropy](other-features/preferencesmd.md#project) using relative paths or absolute paths. ### New in Tropy 1.7 -* **Copy and paste items with metadata:** Tropy now allows you to [copy and paste](in-the-project-view/copy-and-paste-items..md) items using JSON-LD. +* **Copy and paste items with metadata:** Tropy now allows you to [copy and paste](in-the-project-view/copy-and-paste-items..md) items using JSON-LD. * **JSON-LD import:** You can now [import JSON-LD](using-tropy/add_files.md#importing-json-ld-files) files as Tropy items. -* **Archive plugin:** You can now [bundle Tropy items](other-features/export-with-archive-plugin.md) (photos, metadata, and notes) into a zip archive that you can transfer to another device or user. +* **Archive plugin:** You can now [bundle Tropy items](other-features/export-with-archive-plugin.md) \(photos, metadata, and notes\) into a zip archive that you can transfer to another device or user. ### New in Tropy 1.6 -* **New thumbnail ratios:** Tropy now renders your thumbnails with proper aspect ratio (not squares). When you first update, your thumbnails may look weird or stretched because the aspect ratio has changed. They should correct themselves automatically. +* **New thumbnail ratios:** Tropy now renders your thumbnails with proper aspect ratio \(not squares\). When you first update, your thumbnails may look weird or stretched because the aspect ratio has changed. They should correct themselves automatically. * **New import options:** * PDF support! Hooray! Be sure to read the user guide about how and when to [use PDFs](using-tropy/add_files.md#importing-large-files-from-pdf-svg). * You can now import JPEG2000 and HEIC images. * You can now drag certain images [straight from your web browser](using-tropy/add_files.md#dragging-images-directly-from-a-web-browser) into Tropy. * You can now move your metadata to a different field without copying and pasting. See how at [Add metadata to items.](in-the-project-view/add_metadata.md) * You can explore our new print options, including printing without metadata, without notes, or without photos. See how at [Print items](other-features/print-items.md). -* You can now use Tropy in Spanish! +* You can now use Tropy in Spanish! ### New in Tropy 1.5.3 -* You can now print items to a real printer (or to PDF). See how at [Print items.](other-features/print-items.md) -* You can now export your notes as either HTML (how it was before) or Markdown. See how at [Export to JSON-LD.](other-features/export.md) +* You can now print items to a real printer \(or to PDF\). See how at [Print items.](other-features/print-items.md) +* You can now export your notes as either HTML \(how it was before\) or Markdown. See how at [Export to JSON-LD.](other-features/export.md) ### New in Tropy 1.5.2 @@ -37,3 +37,4 @@ description: This page describes the new features from our current release. ### New in Tropy 1.5.1 * You can now open multiple projects at one time: see how at [Open multiple projects.](using-tropy/create_project.md#open-multiple-projects-at-the-same-time) +