Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 40 additions & 30 deletions docs/Admin/Adding_and_Managing_Plugins.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,80 @@
# Working with Plugins

Plugins are tools to extend the basic functionality of Omeka Classic. A list of plugins available for download is on the [Plugins Directory](http://omeka.org/classic/plugins){target=_blank}. Instructions are available on each plugin's documentation page.
Plugins are tools to extend the basic functionality of Omeka Classic based on each individual installation's needs. A list of plugins available for download is on the [Plugins Directory](http://omeka.org/classic/plugins){target=_blank}. This list includes both plugins built and maintained by the Omeka Team, and plugins made and submitted by our users. Specific instructions are available on each plugin's documentation page, whether in this manual (for our Team plugins) or at the links provided by each user-built plugin.

The Omeka Team cannot guarantee that user-built plugins work as expected, and do not maintain these plugins or update them when needed.

!!! Note
Not every plugin will work with every version of Omeka, especially newer plugins on old installations. Older versions of plugins may be available on their Github pages. Use the Plugins Directory to find the "Github" link on the right side of the screen for each plugin, then look on the right hand side of the Github page for the "Releases" section.

![A screenshot of the Plugins page, with one not yet installed, one installed but not activated, and one active plugin](../doc_files/Plugins.png "A screenshot of the Plugins page, with one not yet installed, one installed but not activated, and one active plugin")

Manage plugins from the Plugins page found at the top of your Dashboard. Plugins will be listed alphabetically. Each plugin listed will have links to perform various actions:
Manage plugins from the Plugins page found at the top of your Dashboard. Plugins will be listed alphabetically. Each plugin listed will have links to perform various actions:

- **Install**: Runs the installer for the plugin and activates the plugin.
- **Configure**: Takes you to a page for customizing the plugin's unique settings.
- **Install**: Run the installer and activates the plugin.
- **Configure**: If applicable, a page for customizing the plugin's unique settings.
- **Deactivate**: Deactivating merely "unplugs" the plugin, but does not delete any data collected while the plugin was active.
- **Activate**: Activates the plugin after it has been manually deactivated. All plugins are automatically activated once installed.
- **Uninstall**: Runs the uninstaller for the plugin and deletes any information in your installation related to the plugin, including data in metadata fields.
- **Uninstall**: Runs the uninstaller for the plugin and deletes information in your installation related to the plugin, including content in item metadata fields.

In some cases, uninstalling plugins can delete data associated with the plugin from your database. Check the plugin's documentation before uninstalling if you're unsure. Consider deactivating and testing first.
In some cases, uninstalling plugins can delete data associated with the plugin from your database, such as information entered into metadata fields on items or collections. Check the plugin's documentation. We recommend deactivating and testing the changes first, before uninstalling.

Installing a Plugin
Install a plugin
-------------------
Watch [our screencast showing these steps](https://vimeo.com/153819886){target=_blank}. To add and activate a new plugin for your Omeka installation, follow these steps:
To add and activate a new plugin for your Omeka installation, follow these steps:

1. [Download and unzip the compressed plugin file](https://omeka.org/classic/plugins/){target=_blank} on your computer.
1. Open your FTP client and use your FTP login info to access your site. Or, if you are using cPanel File Manager, WebFTP, or another in-browser tool, log in there.
1. Navigate to your Omeka folder (it should have the same name as your Omeka install), open it, then open the `/plugins` folder.
1. Locate the plugin folder on your computer and upload it into your Omeka website's `/plugins` folder.
- Sometimes the plugin unzips into a folder of the same name, so make sure to go inside it and upload the folder that only contains the plugin name, not the version number. For example, you may have downloaded the `CSSEditor-1.1.zip` file and extracted it to a `CSSEditor-1.1` folder, which contains a `CSSEditor` folder. Upload the `CSSEditor` folder.
-- You may also be able, or required, to upload the zipped file and unzip it here, if your file client does not allow you to upload a folder. Remember to watch for an extra folder level in this case.
-- You may also be able, or required, to upload the zipped file and unzip it in place, if your tool does not allow you to upload a folder. Remember to watch for an extra folder level in this case.
1. In another browser window, log in to your Omeka admin panel (`https://youromekasite.org/admin`).
1. Navigate to the Plugins tab in the upper navigation of the admin dashboard, and scroll down to find the plugin you uploaded. Plugins are listed alphabetically.
- If the plugin is not visible, double-check that the folder is in the right location ('/plugins') and that the folder name for the theme does not start with 'plugin-'.
1. Click the “Install” to the right of the plugin name to finish the process.
- If the plugin is not visible, double-check that the folder is in the right location ('/plugins') and that the folder name is correct, including ensuring that the folder does not start with 'plugin-'.
1. Click “Install” to the right of the plugin name to finish the process.
- Click “Configure” if available/needed.
1. Read the documentation for plugin to understand what configuration options are available.
1. Read the documentation for the plugin to understand what configuration options are available.

If you are using a hosting provider that offers cPanel and online file management options, [Reclaim Hosting](../GettingStarted/Hosting_Suggestions.md) has [step-by-step instructions](https://support.reclaimhosting.com/hc/en-us/articles/1500005711142-Managing-Plugins-and-Themes-in-Omeka-and-Omeka-S){target=_blank} for uploading plugins with cPanel's browser-based FTP option.

If you are using a hosting provider that offers cPanel and online file management options, [Reclaim Hosting](../GettingStarted/Hosting_Suggestions.md) has [step-by-step instructions](http://docs.reclaimhosting.com/omeka/uploading-plugins-to-omeka){target=_blank} for uploading plugins with cPanel's browser-based FTP option.
You can watch [our screencast showing these steps](https://vimeo.com/153819886){target=_blank}.

!!! Note
You can also use `git clone` or the Github interface to download the latest plugin code directly from Github. Be sure to watch for extra folder levels or incorrect folder names in this case, such as a folder starting with `plugin-` or ending with `-master`. Rename the folder to remove things like `plugin-` and/or `-master` from the folder name.
You can also use `git clone` or the Github interface to download the latest plugin code directly from Github into a folder in your `/plugins` folder. Be sure to watch for extra folder levels or incorrect folder names in this case, such as a folder starting with `plugin-` or ending with `-master`. Rename the folder to remove things like `plugin-` and/or `-master` from the folder name, as in `git clone https://github.com/omeka/plugin-Timeline.git Timeline`.

Upgrading Plugins
Upgrade plugins
-----------------
When a plugin is out of date, a notification will appear at the bottom of the plugin's entry on your Plugins page. The notification reads "A new version of this plugin is available. Get the new version." Clicking the phrase "get the new version" will take you to a page where you can download the latest version of the plugin.
When an active plugin is out of date, a notification will appear at the bottom of the plugin's entry on your Plugins page. The notification reads "A new version of this plugin is available. Get the new version." with a link.

Clicking the phrase "Get the new version" will take you to a page where you can download the latest version of the plugin.

![Entry for the plugin COinS, display the out of date notification below the usual information for the plugin](../doc_files/plugin_updatenotice.png "Entry for the plugin COinS, display the out of date notification below the usual information for the plugin")
![Entry for a plugin, displaying the out-of-date notification below the usual information for the plugin](../doc_files/plugin_updatenotice.png "Entry for a plugin, displaying the out-of-date notification below the usual information for the plugin")

In order to upgrade a plugin, you will need to use your FTP client to replace the old plugin folder with the new one:
You will upgrade by replacing the old plugin folder with the new one:

1. Download the new version of the plugin, and unzip it on you computer.
1. Open your FTP client and use your FTP login info to access your site.
1. Navigate to your Omeka folder (it should have the same name as your Omeka install), open it, then open the `/plugins` folder.
1. Remove the old plugin folder from your `/plugins` folder.
1. Go to the admin dashboard of your Omeka site and navigate to the Plugins tab on the top navigation menu.
1. Click the "Deactivate" button to deactivate the plugin you would like to upgrade. **Warning**: Do not click the uninstall button, or you may delete data associated with the plugin.
1. Download the new version of the plugin, and unzip it on your computer.
1. Open your FTP client and use your FTP login info to access your site, or use cPanel's file manager, or your WebFTP interface, etc.
1. Navigate to your Omeka folder online, then open the `/plugins` folder.
1. Delete the old plugin folder from your `/plugins` folder. You can move it out of that location or rename if you wish to keep it, just in case.
1. Upload the new version of the plugin to the `/plugins` folder. Be careful, as above, to ensure the folder name is correct.
1. Go to the admin dashboard of your Omeka site and navigate to the Plugins tab on the top navigation menu.
1. Find your plugin in the list. You should be directed to upgrade the plugin - click the "Upgrade" button to complete the process.

Plugin Dependencies
If you have installed the plugin with `git clone`, do not use these instructions. You should update the plugin using `git pull`.

Plugin dependencies
----------------
Some plugins are designed to provide infrastructural functions for other plugins. Such plugins are required to be installed and active for other plugins that depend on them to work. If you upload a plugin to your site but cannot activate it due to a message like this, simply install the required plugin following the usual steps above.
Some plugins provide infrastructural functions for other plugins. These plugins are required to be installed and active for other plugins that depend on them to work. If you upload a plugin to your site but cannot activate it due to a message like this, simply install the required plugin following the usual steps above.

![Example of a plugin which requires another plugin to be installed before it can be activated](../doc_files/pluginRequired.png "Example of a plugin which requires another plugin to be installed before it can be activated")
![The "User Profiles" plugin, appearing with a pink background, with an alert saying that it requires the "RecordRelations" plugin in order to work.](../doc_files/pluginRequired.png "The "User Profiles" plugin, appearing with a pink background, with an alert saying that it requires the "RecordRelations" plugin in order to work.")

Pre-packaged Plugins
Pre-packaged plugins
--------------------
The following plugins come prepackaged with the download of Omeka Classic:
The following plugins come pre-packaged with every installation of Omeka Classic:

- [Coins](../Plugins/Coins.md) – Adds Coins metadata to items on the admin theme and in public themes.
- [Simple Pages](../Plugins/SimplePages.md) – Publish static pages on your public site.
- [Exhibit Builder](../Plugins/ExhibitBuilder.md) – Build narratives around your collections.
- [Coins](../Plugins/Coins.md) – Adds COinS metadata to items on the admin theme and in public themes.
- [Simple Pages](../Plugins/SimplePages.md) – Publish static pages on your public site.
- [Exhibit Builder](../Plugins/ExhibitBuilder.md) – Build narratives around your collections.
20 changes: 10 additions & 10 deletions docs/Admin/Appearance/Appearance_Settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Appearance Settings

The Settings sub-tab in the Appearance section help you to manage derivative image sizes and adjust some of the display settings for items on the public and admin sides. It is divided into two sections: **Derivative Size Constraints** and **Display Settings**.
The Settings tab in the Appearance section helps you to manage derivative image sizes and adjust some of the display settings for items on the public and admin sides. It is divided into two sections: **Derivative Size Constraints** and **Display Settings**.

![A screenshot of the appearance settings tab](../../doc_files/appearSettings.png "A screenshot of the appearance settings tab")

Expand All @@ -9,40 +9,40 @@ Derivative Size Constraints

In this section, you can set the maximum image sizes for the derivative images Omeka creates when you upload a file.

For each of Fullsize and Thumbnail, you can set a number in pixels for the longest side of the image. For example, if you are uploading a 800x1000 pixel image, a setting of "100" as the thumbnail maximum would resize the image down to 80x100 pixels.
For each of Fullsize and Thumbnail, you can set a number in pixels for the **longest side** of the image. For example, if you are uploading a 800x1000 pixel image, a setting of "100" as the thumbnail maximum would resize the image down to 80x100 pixels.

A Square Thumbnail, instead, resizes the smallest edge down, and crops the excess from the longest side. For example, if you are uploading a 800x1000 pixel image, a setting of "100" as the thumbnail maximum would resize the image down to 100x125 pixels and then crop 12.5 pixels from each side to display the center of the image.
A Square Thumbnail, instead, resizes the **smallest edge** of the image down, and crops the excess from the longest side. For example, if you are uploading a 800x1000 pixel image, a setting of "100" as the thumbnail maximum would resize the image down to 100x125 pixels and then crop 12.5 pixels from each side to display the center of the image.

Note that these settings are general for the installation - the size at which thumbnails display on item browse, exhibit, and other pages may also depend on which theme you are using.
Note that these settings are general **file sizes** for the installation - the sizes at which thumbnails **display** on item browse, exhibit, and other pages may also depend on which theme you are using.

These following are the default settings for the three size constraints, in pixels:

- Fullsize Image: 800
- Thumbnail: 200
- Square Thumbnail: 200.

To make changes, simply type a number into the corresponding text field.
To make changes, simply type a number into the corresponding text field and save the page.

Please note that changes to these settings will only affect files uploaded after you have made the changes; it does not retroactively re-size existing files. If you want to change existing files, you will need to install the [Derivative Images plugin](../../Plugins/DerivativeImages.md).
Please note that changes to these settings will only affect files uploaded after you have made the changes; it cannot retroactively re-size existing files. If you want to change existing files, you will need to install the [Derivative Images plugin](../../Plugins/DerivativeImages.md).

Those with access to the server files can also [manage thumbnail creation settings](../../Technical/ConfiguringThumbnailCreation.md) to change where thumbnails crop the image (see linked documentation for more information).

Display Settings
----------------------------------------------------------------
These settings relate to the display of results on the public and admin sides and some aspects of metadata display on the public side.

**Use Square Thumbnails**: sets the installation to use square-cropped images by default wherever thumbnails appear in the public interface, regardless of themes (NB: Omeka Classic versions 2.5 and higher only).
**Use Square Thumbnails**: sets the installation to use square-cropped images by default wherever thumbnails appear in the public interface, regardless of themes. If unchecked, the public site will use thumbnails with the original aspect ratio of each file. (This setting is for Omeka Classic versions 2.5 and higher only.)

**Link to File Metadata**: when this box is checked, clicking on a file on an item's public show page will take site users to the file's metadata page rather than the fullsize image.
**Link to File Metadata**: clicking on a file on an item's public show page will take site users to the file's metadata page rather than the fullsize image. If unchecked, the public site will not make file metadata pages available to users.

**Results per page (admin)**: sets the number of results on the admin-side browse pages for items, collections, and exhibits. The default is 10.

**Results per page (public)**: sets the number of results on the public-side browse pages for items, collections, and exhibits. The default is 10.

**Show Empty Elements**: determines whether you want to show empty metadata fields on the public pages. The default setting is unchecked. If you wish show all metadata (empty and filled) fields, check this box. The image below shows how empty elements display on a public item show page.
**Show Empty Elements**: determines whether you want to show empty metadata fields on the public pages. The default setting is unchecked. If you wish to show all metadata (empty and filled) fields, check this box. The image below shows how empty elements display on a public item show page.

![Item show page with empty elements displayed. Each empty element has “no text” where the input would be](../../doc_files/showEmptyElm.png "Item show page with empty elements displayed. Each empty element has “no text” where the input would be")

**Show Element Set Headings**: Unchecking this box will remove the element set headings (e.g. "Dublin Core," "Person Item Type Metadata") from display on the public pages of the site, uncheck this box. The default setting is checked. The image below shows the Dublin Core heading on a public item show page.
**Show Element Set Headings**: unchecking this box will remove the element set headings (e.g. "Dublin Core," "Person Item Type Metadata") from display on the public pages of the site. The default setting is checked. The image below shows the Dublin Core heading on a public item show page.

![Item show page with heading Dublin Core above item title](../../doc_files/showElmSet.png "Item show page with heading Dublin Core above item title")
Loading