Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copyedits #44

Merged
merged 28 commits into from
Jun 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
3796f4e
Minor text tweaks and link-fixing
allanaaa May 4, 2022
6f8cf4b
Index & Getting Started section edits
allanaaa May 16, 2022
e5a3dd5
Installation section, plus an interface change, plus a plugin
allanaaa May 17, 2022
534c321
Let's learn from #37 while we're here.
allanaaa May 17, 2022
e460c0e
Next batch, with image and formatting tweaks
allanaaa May 24, 2022
b23cdbe
Next batch
allanaaa May 24, 2022
6f2a0f0
Closes #46
allanaaa May 25, 2022
655a9a3
Next batch, plus killing the plugins_shortcodes page & its links
allanaaa May 26, 2022
2c3016e
Updated instructions for plugin installation
allanaaa May 26, 2022
55d2ec4
Next few docs plus some fixes for #45
allanaaa May 27, 2022
3994d70
Update extra.css
allanaaa May 27, 2022
0ae1f5c
Plugins & troubleshooting
allanaaa May 30, 2022
a1e0e05
Technical section.
allanaaa May 30, 2022
0ea383b
Merge branch 'master' into copyedits
allanaaa May 30, 2022
2c20119
Specify file uploads
allanaaa Jun 2, 2022
6f075dd
Merge branch 'master' into copyedits
allanaaa Jun 2, 2022
8da25d6
Update index.md
allanaaa Jun 2, 2022
8d2614c
Update SocialBookmarking.md
allanaaa Jun 2, 2022
d0243de
Update SimpleContactForm.md
allanaaa Jun 2, 2022
4b07c70
Update Item_Types.md
allanaaa Jun 2, 2022
09f4cf7
Update Report-a-bug.md
allanaaa Jun 2, 2022
1882d3d
Update Files.md
allanaaa Jun 6, 2022
0afcaac
Update Feature_List.md
allanaaa Jun 6, 2022
d4a2230
Update Shortcodes.md
allanaaa Jun 6, 2022
80f709e
Update Item_Types.md
allanaaa Jun 6, 2022
8842c4b
Update Items.md
allanaaa Jun 6, 2022
86900f7
Update Files.md
allanaaa Jun 6, 2022
bb00c20
List styling: colons.
allanaaa Jun 6, 2022
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
90 changes: 43 additions & 47 deletions docs/Admin/Adding_and_Managing_Plugins.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,72 @@
# 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 Add-Ons Directory](http://omeka.org/classic/plugins) (Please note that not every plugin will work with every version of Omeka), and instructions are available on each plugin's documentation page.
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 page](../doc_files/Plugins.png)
!!! 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:

- **Install**: Runs the installer for the plugin and activates the plugin.
- **Uninstall**: Runs the uninstaller for the plugin and deletes any information in your installation related to the plugin.
- **Activate**: Activates plugin after it has been manually deactivated. All plugins will be activated once present in the Omeka /plugins directory on the server.
- **Deactivate**: Action merely "unplugs" the plugin but does not delete any data collected while plugin was active.
- **Configure**: Takes you to a page for customizing the plugin's unique settings.
- **Configure**: Takes you to 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.

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.
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.

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

1. Download and unzip the file on your computer.
2. Open your FTP client.
3. Use your FTP login info to access your site.
4. Navigate to your Omeka folder. It should have the same name as your Omeka install.
5. Open the Omeka folder
6. Open the /plugins folder
7. Upload your new plugin folder into your Omeka website's /plugins folder.
- Sometimes the unpacked plugin is inside a folder of the same name so make sure you are uploading the correct directory.
- NB: your plugin must be inside the /plugins folder.
- You can also upload the zipped file and unzip it here, if your FTP client allows
7. Rename the folder to remove the `plugin-` from the folder name. If you do not do this, the plugin will display as invalid on your Omeka dashboard.
7. In a new browser window, log in to your Omeka admin panel (youromekasite.net/admin)
8. Navigate to the Plugins tab in the upper navigation of the admin dashboard, and scroll down to find the plugin you uploaded (note: plugins are listed alphabetically)
- If the plugin is not visible, return to step 6 and double-check
9. Click the ”Install" to the right of the plugin name to finish the process.
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:

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.
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, return to the 4th step and 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.
- Click “Configure” if available/needed.
10. Read documentation for plugin to understand configuration
1. Read the documentation for plugin to understand what configuration options are available.

If you are using [Reclaim Hosting](../GettingStarted/Hosting_Suggestions.md) they have [step-by-step instructions](http://docs.reclaimhosting.com/omeka/uploading-plugins-to-omeka){target=_blank} for uploading plugins with their browser-based FTP option.

If you are using [Reclaim Hosting](https://reclaimhosting.com/) they have [step-by-step instructions](http://docs.reclaimhosting.com/omeka/uploading-plugins-to-omeka) for uploading plugins with specific instructions for their browser based FTP option
!!! 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.

Upgrading Plugins
-----------------
When your 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.

![Entry for the plugin COinS, display the out of date notification below the usual information for the plugin](../doc_files/plugin_updatenotice.png)
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.

In order to upgrade a plugin, you will need to use your FTP client to replace the old plugin folder with the new one.
![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")

The following are detailed instructions for upgrading a 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:

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 any data created with the plugin.
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 any data created with the plugin.
1. Download the new version of the plugin, and unzip it on you computer.
1. Open your FTP client.
1. 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.
1. Open the Omeka folder
1. Open the /plugins folder
1. Remove the old plugin folder from your /plugins folder on your serve.
1. Upload the folder with the new version of the plugin to the /plugins folder.
1. Go to the Admin dashboard of your Omeka site, navigate to the Plugins tab on the top navigation menu.
1. You may be directed to Upgrade your plugin - click the link to upgrade and then re-activate your plugin.

Required Plugins
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. Upload the new version of the plugin to the `/plugins` folder. Be careful, as above, to ensure the folder name is correct.
1. Go back to the Plugins page in your browser.
1. You may be directed to upgrade your plugin - click the link to upgrade and then re-activate your plugin.

Plugin Dependencies
----------------
Some plugins are designed to provide basic functionality that is useful for many 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 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.

![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](../doc_files/pluginRequired.png "Example of a plugin which requires another plugin to be installed before it can be activated")

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

- [Coins](../Plugins/Coins.md) – Adds Coins metadata to items on the admin theme and in public themes.
- [SimplePages](../Plugins/SimplePages.md) – Publish static pages on your public site.
- [Simple Pages](../Plugins/SimplePages.md) – Publish static pages on your public site.
- [Exhibit Builder](../Plugins/ExhibitBuilder.md) – Build narratives around your collections.
30 changes: 15 additions & 15 deletions docs/Admin/Appearance/Appearance_Settings.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
# 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 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**.

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

Derivative Size Constraints
----------------------------------------------------------------
In this section, you can set the default maximum image sizes for Fullsize, Thumbnails, and Square Thumbnails in pixels for the longest side of the image.

Note that these settings are general for the install - the size 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
These following are the default settings for the three size constraints, in pixels:

- Fullsize Image: 600;
- Thumbnail: 300;
- Fullsize Image: 600
- Thumbnail: 300
- Square Thumbnail: 200.

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

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 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).

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)
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** set 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 (NB: 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**: 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.

**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 (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.
**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 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](../../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, uncheck this box. 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](../../doc_files/showElmSet.png "Item show page with heading Dublin Core above item title")
Loading