Omeka Classic: Modifying Appearance from Omeka on Vimeo.
-Installing a Theme +Install a theme ----------------------------------------------------------------- -Watch the [screencast](https://vimeo.com/153819886){target=_blank} demonstrating the process of installing plugins and themes (with close-captioning): - - -Omeka Classic: Installing Plugins and Themes from Omeka on Vimeo.
To add and activate a new theme for your Omeka installation, follow these steps: 1. [Download and unzip the compressed theme file](https://omeka.org/classic/themes/){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 `/themes` folder. +1. Navigate to your Omeka folder (it should have the same name as your Omeka installation), open it, then open the `/themes` folder. 1. Locate the theme folder on your computer and upload it into your Omeka website's `/themes` folder. - Sometimes the theme unzips into a folder of the same name, so make sure to go inside it and upload the folder that only contains the theme name, not the version number. For example, you may have downloaded the `theme-minimalist-v2.5.2.zip` file and extracted it to a `theme-minimalist-v2.5.2` folder, which contains a `minimalist` folder. Upload the `minimalist` 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. @@ -30,19 +26,24 @@ To add and activate a new theme for your Omeka installation, follow these steps: 1. Click “Use this theme” under the theme thumbnail to finish the process. 1. Click “Configure theme” after the page reloads. Read the documentation for your chosen theme to understand what configuration options are available. -Selecting a Theme +You can watch this [screencast](https://vimeo.com/153819886){target=_blank} demonstrating the process of installing plugins and themes (with close-captioning): + + +Omeka Classic: Installing Plugins and Themes from Omeka on Vimeo.
+ +Select a theme ------------------------------------------------------------- -You can browse the themes you have installed for your Omeka Classic site by going to the Appearance tab in the upper admin navigation. The Themes tab in the Appearance section will be the first to display. +You can browse the themes you have installed for your Omeka Classic site by going to the "Appearance" link in the upper admin navigation. The "Themes" tab in the Appearance section will be the first to display. -This page displays your active theme at top, with all available themes in a grid below. Three themes come pre-installed with every Omeka instance. +This page displays your active theme at top, with all available themes in a grid below. Three themes come pre-installed with every Omeka instance: Default, Berlin, and Seasons.  -The active theme is displayed at top, with a preview of the the theme's appearance, a summary of its features, and a button to configure the theme (see below). +The active theme is displayed at the top, with a preview of the theme's appearance, a summary of its features, and a button to configure the theme (see below). If the active theme is out of date, you will see a message under the active theme summary stating "A new version of this theme is available. Get the new version." The phrase "Get the new version" is a link to the page where you can download the latest version of your theme. To update, simply follow the installation instructions above, replacing the outdated theme folder with the new one. -Inactive themes will not prompt you to update. You may wish to remove inactive themes to simplify your Omeka installation once you have finished customizing its design. +Inactive themes will not prompt you to update. You may wish to remove inactive themes to simplify your Omeka installation once you have finished customizing its design. Note that themes installed here become available to your [Exhibits](../../Plugins/ExhibitBuilder.md) and may be in use there. You can view the active themes in the Exhibits table. ![Active theme Emiglio showing the "New version" warning](../../doc_files/theme-needsupdate.png "Active theme Emiglio showing the "New version" warning") @@ -51,43 +52,45 @@ To select a new theme, find the theme you want among those installed on your Ome ![A teal arrow points at the "Use this theme" button for Minimalist, in amongst other themes listed.](../../doc_files/theme_activate.png "A teal arrow points at the "Use this theme" button for Minimalist, in amongst other themes listed") -Configuring a Theme +Configure a theme ---------------------------------------------------------------- Configurations let you make choices about the look of your site, including adding a logo and homepage text, managing featured elements, and adding footer text. -The configuration settings you make are unique to each theme and will be saved with that theme. To configure your theme, click the "Configure Theme" button below the theme graphic to customize your site. +The configuration settings you make are unique to each theme and will be saved with that theme. To configure your theme, click the "Configure Theme" button below the theme graphic to customize your site. Each theme has its own way of handling these settings, so be sure to refresh and view the public site to see how your changes look. -![A screenshot with a teal arrow pointing to the "Configure Theme" button](../../doc_files/Themeconfigureclick.png "A screenshot with a teal arrow pointing to the "Configure Theme" button") +![A screenshot with an arrow pointing to the "Configure Theme" button](../../doc_files/Themeconfigureclick.png "A screenshot with an arrow pointing to the "Configure Theme" button") Enable your chosen theme and view the configuration page to see if there is guiding text there. While not all themes have the same configuration options, most will have the following two sections: -**Header and Footer** configuration options are: +### **Header and Footer** configuration options - **Logo File**: You may upload an image that will replace the site title in the header of your website. In many themes, this logo will be left-aligned, with margins around it. Many themes recommend a maximum width for your logo of 500px, and some have a required maximum height of 150px. - **Header Background**: Upload an image file that will display across the top of your website, behind your site title or logo. -- **Footer Text**: An HTML-enabled text box where you can enter text for a site footer to appear on every page. Note that shortcodes will not work in this field, nor will HTML-coded images or other multimedia. +- **Footer Text**: An HTML-enabled text box where you can enter text for a site footer to appear on every page. Note that shortcodes will not work in this field, but can you use the HTML Editor to enter in tags and encoding. - **Display Copyright in Footer**: Check this box if you wish to display your site’s copyright information in the footer. Site copyright information is found in the [General Settings](../Settings/index.md) section. - **Use Advanced Site-wide Search**: Check this box to allow public-side site visitors to search the whole site, including items, collections, and files, and to use boolean methods when searching.  -**Homepage** configuration options are: +### **Homepage** configuration options + +Remember that each theme may put these display options in a different place. Be sure to save, then view the public site to see how your changes look. - **Display Featured Item**: Check this box if you wish to show a featured item on the homepage. - **Display Featured Collection**: Check this box if you wish to show a featured collection on the homepage. - **Display Featured Exhibit**: Check this box if you wish to show a featured exhibit on the homepage. -- **Homepage Recent Items**: Choose the number of recent items to be displayed on the homepage. These will appear in the order in which they were mostly recently added to the archive. -- **Homepage Text**: Add some text to be displayed on your homepage above the Featured Items. This is a good place to add a short tagline or description of your site. Note that shortcodes will not work in this field, nor will HTML-coded images or other multimedia. Save longer explanations for an [About page using the Simple Pages plugin](../../Plugins/SimplePages.md). +- **Homepage Recent Items**: Choose the number of recent items to be displayed on the homepage. These will appear in order from newest to oldest. +- **Homepage Text**: Add text to be displayed on your homepage above the Featured Items. This is a good place to add a short tagline or description of your site. Note that shortcodes will not work in this field, nor will HTML-coded images or other multimedia. Save longer explanations for an [About page using the Simple Pages plugin](../../Plugins/SimplePages.md).  -Additional configuration options may include: +### Other configuration options -- **Colors**: For themes including Thanks Roy, Center Row, The Daily, Big Stuff. These fields allow you to customize the color of specific parts of the theme (link text, buttons, etc). You must use a six-character [hexadecimal color value](https://www.w3schools.com/colors/default.asp){target=_blank}, including the `#`. +- **Colors**: For themes including Thanks Roy, Center Row, The Daily, Big Stuff, Freedom. These fields allow you to customize the color of specific parts of the theme (link text, buttons, etc). You must use a six-character [hexadecimal color value](https://www.w3schools.com/colors/default.asp){target=_blank}, including the `#`. - **Style**: For the themes Seasons and Rhythm. Select a style sheet (color scheme) from a dropdown menu. -- **Items**: May include: - - *Item File Gallery*: For the themes Thanks Roy, Seasons, Minimalist, and Emiglio. This box displays the files for each item as a gallery of square thumbnails rather than fullsize images. - - *Use Original Thumbnail Size*: Check the box if you want to use thumbnails' original sizes on the browse view. Otherwise, the thumbnails are restricted to 100px in height. +- **Items** may include: + - **Item File Gallery**: For the themes Thanks Roy, Seasons, Minimalist, and Emiglio. Checking this box displays the files for each item as a gallery of square thumbnails rather than fullsize images. + - **Use Original Thumbnail Size**: Check the box if you want to use thumbnails' original sizes on the browse view. Otherwise, the thumbnails are restricted to 100px in height. - **Exhibit Builder**: For the themes Seasons and Minimalist. Select an exhibit page navigation style: whether page navigation in exhibits is a full-width bar that stretches across the page or a sidebar that uses a small fraction of the page width. - **Homepage Text position**: A dropdown menu to set whether the homepage text appears above or below featured items, exhibits, and collections. diff --git a/docs/Admin/Settings/Element_Sets.md b/docs/Admin/Settings/Element_Sets.md index f71ed84..3cc7415 100755 --- a/docs/Admin/Settings/Element_Sets.md +++ b/docs/Admin/Settings/Element_Sets.md @@ -1,20 +1,31 @@ # Element Sets -Element Sets are standardized metadata categories that enable you to consistently classify, identify, and sort the digital resources in your Omeka Classic database. Element Sets utilize standardized Dublin Core metadata fields enabling you to classify the items in your database by content, format, and administrative details surrounding stewardship such as rights and preservation. +Many of the metadata fields provided for your items are contained within element sets. Element sets provide standardized metadata categories that enable you to consistently identify, classify, and sort the digital resources in your Omeka Classic installation. Element sets include such things as Dublin Core metadata fields, enabling you to classify the items in your installation according to international standards. + +Element sets can contain fields common to all item types (such as "Title"), as well as fields particular to one or several item types. Item types are not bound to one element set: for example, a Dublin Core item type of "Moving Image" is not restricted to elements only from Dublin Core, but can include elements from VRA Core and other element sets. + +Your installation may also have elements that are not included in the element sets displayed on this page. For example, user-added elements on Item Types will not be assigned to an element set.  -To manage your Element Sets in Omeka, select Settings in the top navigation bar. In the Settings screen, choose Element Sets. +To manage your Element sets in Omeka, select "Settings" in the top navigation bar. In the "Settings" screen, choose the "Element Sets" tab. -You should see a table with the installed element sets on your Omeka Classic installation. Each row of the table will show the Name and Description for the element set. To edit an element set, click the *edit* button under the element set name. To delete an element set, click the *delete* button (note that you cannot delete the Dublin Core element set). +You will see a table with all the element sets on your Omeka Classic installation. Each row of the table will show the Name and Description for the element set. To edit an element set, click the "Edit" button under the element set name. To delete an element set, click the "Delete" button (note that you cannot delete the Dublin Core element set). + +You should deactivate or uninstall a plugin that adds an element set to this page, rather than deleting it from the installation. Deleting an element set while the related plugin is still active may cause errors. Depending on the plugin, uninstalling it may leave information in these fields, which you can then delete from this page, or leave attached to your items.  +To add more standardized element sets to your installation, review our plugin offerings. Two common ones are [VRA Core](../../../Plugins/VRACore/) and [PBCore](../../../Plugins/PBCore/). + +Other plugins also add metadata fields to this list, such as [PDF Text](../../../Plugins/PdfText/), which creates a new field for holding the text extracted from files. -Annotate Elements +These element-set names can display on public pages when viewing an item that uses any of their fields. This is the ["Show Element Set Headings" setting on the "Appearance" page's "Settings" tab](../Appearance/Appearance_Settings.md#display-settings). You can enable or disable this display. + +Annotate elements ------------------------------------------------------ -You may customize descriptions of element set metadata through adding comments to metadata fields and you may arrange the order in which the fields appear on your site. +You may customize descriptions of element set metadata through adding comments to metadata fields. These comments will appear to logged-in users when editing an item, and can help give guidance on how to use a given field. Comments will not appear on your public site.  @@ -22,6 +33,9 @@ To add comments to the metadata field descriptions, click on the arrow to the ri  -Reorder Fields +Reorder fields ------------------------------------------------------------- -To arrange the order in which the Dublin Core metadata fields appear on your site, mouse over the name of each element. Your mouse icon will become a hand. Click on the name of the element and drag and drop it to create an order appropriate for your Omeka database. Don't forget to save your changes. + +You may arrange the order in which the fields appear on your site, within each element set. You cannot reorder the element sets themselves. + +To arrange the order in which the metadata fields appear on your site, mouse over the name of each element. Your mouse icon will become a hand. Click on the name of the element and drag and drop it to create an order appropriate for your site. Don't forget to save your changes. diff --git a/docs/Admin/Settings/Item_Type_Elements.md b/docs/Admin/Settings/Item_Type_Elements.md index 95cc980..3bc9168 100755 --- a/docs/Admin/Settings/Item_Type_Elements.md +++ b/docs/Admin/Settings/Item_Type_Elements.md @@ -1,29 +1,34 @@ # Item Type Elements - +Item Type Elements enables you to manage the metadata fields associated with each [item type](../../Content/Item_Types.md) available in your site, e.g. Still Image, Oral History, Document. -Item Type Elements enables you to manage all the metadata fields associated with each [item type](../../Content/Item_Types.md) available in your site, e.g. Still Image, Oral History, Document. +See the [Item Types page](../../Content/Item_Types.md#default-elements-for-item-types) for the list of elements already included with each pre-defined item type, more information on how to define types and assign elements to them, and how to add entirely new elements. See the [Element Sets](Element_Sets.md) page for more information on the elements common to all items regardless of their types. -You can add new item type elements or change the description of existing elements. +From this tab on the Settings page, you can review existing elements, and edit the descriptions of existing elements to guide your team in using them more effectively. You can also delete elements that you do not wish to have available for use with any item type. -Add New Item Type Elements +Add new item type elements ------------------------ -You can create a new Item Type Element when [editing](../../Content/Item_Types.md#edit-an-existing-item-type) or [creating](../../Content/Item_Types.md#creating-a-new-item-type) Item Types, through the Item Types tab on the left-hand navigation of the Admin dashboard. +You can create a new Item Type element when [editing](../../Content/Item_Types.md#edit-an-existing-item-type) or [creating](../../Content/Item_Types.md#creating-a-new-item-type) Item Types, through the Item Types tab on the left-hand navigation of the Admin dashboard. -Edit Item Type Element Descriptions +Edit item type element descriptions ----------------------------------- -From the Item Type Elements sub-tab of Settings page, you can add information about the content, the use, or the style of these fields. Please note that this is only accessible for Super Users. +From the Item Type Elements tab of the Settings page, you can add information about the content, the use, or the style of these fields. Please note that this tab is only accessible for Super Users.  -To manage Item Type Elements, select Settings in the top navigation bar (marked with a 1 in the image above). Once the General Settings page loads, click the Item Type Elements sub-tab (marked 2 in the image above). +To manage Item Type Elements, select Settings in the top navigation bar. Once the General Settings page loads, click the Item Type Elements tab. -The Item Type Elements sub-tab should load with blocks for every Item Type Element in your site. Each block shows the label for the element (in the top of the block) followed by a description field which you can edit. +The Item Type Elements tab should load with blocks for every Item Type Element in your site. Each block shows the label for the element (in the top of the block) followed by a description field which you can edit. - + -Enter any information about the Item Type Element here. This description will accompany any Item Type utilizing the metadata field you have just edited. Don't forget to Save Changes when you have finished. +Enter information about the Item Type Element here. This description will accompany any Item Type utilizing the metadata field you have just edited. Don't forget to Save Changes when you have finished. To view your changes, select Item Types in the left hand navigation and select any Item Type containing the element you have just edited by. You can also see these changes by editing or creating a new item and using the Item Type containing that element (see image below for an example).  + +Delete item type elements +----------------------------------- + +To remove an item type element, click the "X" in the top-right corner of its entry on this page. Warning: This will delete all information contained in this field on all the items that use it. You will need to save the page to ensure the element is deleted. You can restore something instead of deleting it by clicking again in the same area, which will have turned red and show an "Undo" icon (a circular arrow). Or you can simply navigate away from this page without saving your changes. \ No newline at end of file diff --git a/docs/Admin/Settings/Search_Settings.md b/docs/Admin/Settings/Search_Settings.md index b4d666b..8de4f56 100755 --- a/docs/Admin/Settings/Search_Settings.md +++ b/docs/Admin/Settings/Search_Settings.md @@ -1,23 +1,28 @@ # Search Settings -This is information for managing search settings on Omeka Classic. See [the Searching page](../../GettingStarted/Searching.md) for information on conducting searches. +This is information for managing your search settings on Omeka Classic. See [the Searching page](../../GettingStarted/Searching.md) for information on conducting searches. The Search Settings options allow you to set which types of records are automatically searched when a user enters terms into the basic search bar on both the admin and public sides. You can also re-index your Omeka database to ensure that all selected content is searchable. -Access the Search Settings tabs by going to the Settings tab in the top navigation (1) and then clicking over to Search (2): +Access the Search Settings tab by going to the Settings link in the top navigation (1) and then clicking over to Search (2):  +*Arrows labelled as above point to the tabs.* ## Search Query Type -As an Omeka Classic site Super Administrator, you may specify the type of search query that runs when users interact with the simple search: Keyword, Boolean, or Exact match. +An Omeka Classic Super Administrator account may specify the type of search query that runs when users interact with the simple search: Keyword, Boolean, or Exact match.  +*Search settings page, with Search Query Type selection active for Keyword.* + +These options are explained on the [Searching page](../../GettingStarted/Searching.md#search-options) of this manual. ## Select Record Types -Also, you may choose which record types you wish to be searchable: items, collections, files. +You may choose which record types you wish to be searchable: items, collections, files. Remember that each of these types of content can have their own metadata text.  +*Search settings page, with Item, File, and Collection checkboxes active.* Using the checkboxes found to the left of each record type, choose which ones you want discoverable by the site-wide search. @@ -25,13 +30,19 @@ The basic options are: - Item - File -- Collection +- Collection. + +Additionally, if you are using the Simple Pages and Exhibit Builder plugins you may make that content available: + +- Simple Page +- Exhibit +- Exhibit Page. -Additionally, if you installed the Simple Pages and Exhibit Builder plugins you may make that content available as well. Other plugins may make their content available for searching as well. +Other plugins may also make their content available for searching, such as "User Profiles". Please note that the "Exhibit" record type includes exhibit descriptive information, and an "Exhibit Page" is the actual content of the exhibit. -Be sure to save changes if you check or uncheck boxes. +Be sure to save your changes if you check or uncheck boxes. Once records types are selected, searchers use the ellipsis button to choose from the options you have provided, in both admin and public site-wide searches. diff --git a/docs/Admin/Settings/Security_Settings.md b/docs/Admin/Settings/Security_Settings.md index 056d396..4b571b2 100755 --- a/docs/Admin/Settings/Security_Settings.md +++ b/docs/Admin/Settings/Security_Settings.md @@ -1,12 +1,10 @@ # Security Settings -To manage Security Settings, select Settings in the top navigation bar. +Security settings enable you to determine the file formats and HTML markup allowed on your Omeka Classic site, and to set Captcha controls to protect your site from automated spam. -In the Settings section, choose Security. Only Super users may edit these settings. +To manage Security Settings, select "Settings" in the top navigation bar. In the Settings section, choose the "Security" tab to the right of the "General" tab. Only [Super Users](../Users.md) may edit these settings. - - -Security settings enable you to determine the file formats and html markup allowed on your Omeka Classic site and to set Captcha controls to protect your site from automated spam. + The Security Settings page is divided into three sections: File Validation, Captcha, and HTML Filtering. diff --git a/docs/Admin/Settings/index.md b/docs/Admin/Settings/index.md index 21f3b07..2c9bc97 100644 --- a/docs/Admin/Settings/index.md +++ b/docs/Admin/Settings/index.md @@ -1,20 +1,20 @@ # General Settings -Find the general site settings by clicking on the Settings button in the top navigation bar of the admin view. Settings are only accessible by Super Users. +Find the general site settings by clicking on the "Settings" link in the top navigation bar of the admin view. Settings are only accessible to [Super Users](../Users.md).  -In the General Settings tab, you may edit the fields you filled in when you installed your site, and add other information. +In the "General" Settings tab, you may edit the fields you filled in when you installed your site, and add other information. -The fields are as follows +The fields are as follows: -- **Administrator Email**: Address entered will send emails to new users, when created. This address will be the "from" in any administrative emails sent from the page. - - Some hosting providers may require this email to match your domain (you@yoursite.org). +- **Administrator Email**: Address entered will send emails to new users, when created. This address will be where emails appear to be from, in any administrative emails sent from the page. (This field is required) + - Some hosting providers may require this email to match your domain (`you@yoursite.org`). - **Site Title**: Appears as the name of your site on the homepage. -- **Site Description**: Description text appears in the website's `head` tags, but is not published on the homepage. -- **Site Copyright**: Fill in this text box if you wish for it to appear in the footer. Then, when configuring your theme, check the box to display copyright in the footer. -- **Site Author Information**: Names of contributors to the website appears in the website’s `head` tags, but is not published on the homepage. -- **Tag delimiter**: If you wish to separate tags by a space or a character other than a comma, specify in the Tag Delimiter field. +- **Site Description**: Descriptive text entered here appears in the website's `head` tags, but is not published on the homepage. This may be displayed when your site comes up in search-engine results. +- **Site Copyright Information**: Fill in this text box with authorship or licensing information about your site. Then, when configuring your theme, you can check a box to display this copyright information in the footer of each page of your site. Site copyright information is always shared in the header of each page of your site, making it machine-readable whether or not it is displayed in your footer, in a `` tag. +- **Site Author Information**: Fill in the names of contributors to the website. This information appears in the website’s header, in a machine-readable `` tag, but is not published visibly on the site. +- **Tag Delimiter**: If you wish to separate tags by a character other than a comma, specify it in the Tag Delimiter field. You can enter in characters such as spaces, dashes, or pipes (|) here. - Be aware that if you change the setting after tags have been created, you run the risk of splitting tags. For example, if you have tags with hyphens already in them, such as "stone-age", changing the tag delimiter to a "-" may make those items tagged with "stone" and "age" instead. -- **ImageMagick Directory Path**: If you are receiving ImageMagick errors, click the Test button here to be sure that the path to its directory is properly routed. Some hosting services may also need you to enter this manually after installation. \ No newline at end of file +- **ImageMagick Directory Path**: If you are receiving ImageMagick errors, click the "Test" button here to be sure that the path to its directory is properly routed. Some hosting services may need you to enter the correct path manually after installation. \ No newline at end of file diff --git a/docs/Admin/Users.md b/docs/Admin/Users.md index b7547d1..72f1b92 100755 --- a/docs/Admin/Users.md +++ b/docs/Admin/Users.md @@ -1,6 +1,14 @@ # Users -The Users section allows the Site Administrator to control who may access the admin section of the site and what they can do. You may add, delete, and assign categories of your users. +An Omeka site can have one or many registered users. This can represent staff of your organization, with various responsibilities for your site and collections, or members of your community who are contributing knowledge and materials. Omeka offers four user roles with different access and powers on the site - you can assign people to any of these levels, depending on your needs. + +Plugins can add more roles, as well as more permissions to each role. For example, if you want to encourage comments on your items, you can add the Commenting plugin (which requires the Guest User plugin to be installed), which enables the collection form for users to submit their thoughts, and then assign members of your team, based on their user levels, to moderate whatever comments are submitted. + +Logged-out users will not see a public login page anywhere on your public Omeka site; this page is accessed by going to `yourinstallation/admin` in a browser (it automatically resolves to `/admin/user/login`). You can manually add a login page or a link to the administrative interface to your public site if desired. + +## Manage users + +The "Users" section is a link at the top of the page, visible to Super users. This page allows site administrators to control who may access the administrative section of the site and what they can do. You may add, delete, and assign categories to your users. ![A teal arrow points to the "Users" section link at the top of the admin page](../doc_files/Usersnav.png "A teal arrow points to the "Users" section link at the top of the admin page") @@ -12,21 +20,21 @@ The Browse Users screen shows the number of users, as well as the username, disp To sort users, simply click on the column heading by which you would like to sort. If you want to sort descending rather than ascending, click twice on the heading. The small paired arrows beside the column heading indicate whether the sort is ascending (top arrow darker) or descending (bottom arrow darker). -You can search users by username, real name, or email address. Username and real name searches can include complete words or partial strings; for example, you could search for any username containing “jam.” Email searches only function with a complete email address. +You can search users by username, display name, or email address. Username and display name searches can include complete words or partial strings. Email searches only function with a complete email address. -User Levels and Access +User levels and access ------------------------------------------------------------ -Omeka Classic allows you to give different backend users different levels of access to your archive. Read through the following list of actions available to users to determine what works best for your project team members. +Omeka Classic allows you to give different backend users different levels of access to your administrative interface. Read through the following list of actions available to users to determine what works best for your project team members. All logged-in Super, Admin, Contributor, and Researcher users on each site can view non-public content (items, collections, Simple Pages, Exhibits, etc.) on the site. -**Super Users** +**Super** - Can do anything and everything in Omeka. -- Supers are the only users with access to the top navigation tabs for Plugins, Appearance, Users, and Settings. +- Super Users are the only accounts with access to the top navigation tabs for Plugins, Appearance, Users, and Settings. -**Admin Users** +**Admin** Admin users do not have access to the tabs for managing plugins, appearance, users, or site settings. @@ -40,48 +48,55 @@ Admin users can: - Interact with plugins installed and activated by a SuperUser. - Add, edit, and delete tags. -**Contributor Users** +**Contributor** -Contributor users have control over their own content but can only view content created by others. They cannot make their own content public. +Contributors have control over their own content but can only view content created by others. They cannot make their own content public. Contributor users can: -- add, edit, tag, and delete items which they created. -- cannot make their own items public. -- create their own exhibits from items that are public. +- Add, edit, tag, and delete items which they created. They cannot make their own items public - someone else must approve them. +- Create their own exhibits, from items that are public. -**Researcher Users** +**Researcher** Researchers can log in to the admin side of an Omeka site and see the content, but cannot interact with it in any way. They cannot add, edit, delete, or tag any items. -Add a User -------------------------------------------------------------- +**Guest users** + +An additional user role, Guest User, can be added using the [Guest User](../Plugins/GuestUser.md) plugin. This role cannot access the administrative interface of your Omeka site at all, but can contribute content on the public site. This plugin is required for [Commenting](../Plugins/Commenting.md), [Contribution](../Plugins/Contribution.md), and other front-end interaction plugins. -To Add a User, select the green button in the upper left hand corner. +The Guest User plugin adds the functionality of allowing anonymous submissions. Site visitors must still make an account to submit content, but their username or other identifying information will not be attached to their submissions. + +Add users +------------------------------------------------------ + +To add a user, select the green "Add a User" button in the upper left hand corner.  -- Fill in the fields for the new user. Assign a role to the user, and click the green Add User button below the form. -- The new user will receive an email at the address you provide with their username and a link that takes them to a form to create a password. Until the new user activates his/her account, and inactive status appears after the Username. -- To edit user information, including changing passwords, Super and Admin users may click on the "edit" button on the right side of the username. +- Fill in the fields for the new user. Assign a role to the user, and click the green "Add User" button to save the page. +- The new user will receive an email at the address you provide with their username and a link that takes them to a form to create a password. Until the new user activates his/her account, an "Inactive" status appears after the username in the main Users list. +- To edit user information, including changing passwords, Super and Admin users may click on the "Edit" button below the username. -Edit Users ----------------------------------------------------------------- -To edit a user, click on the word Edit beneath the username in the Browse Users page. This will direct you to a new page with tab options labelled General, Change Password, and API Keys. +Edit users +------------------------------------------------------- +To edit a user, click on the word "Edit" beneath the username in the Browse Users page. This will direct you to a new page with tab options labelled "General", "Change Password", and "API Keys".  -On the General tab you can edit the username, display name, email, and role of the user. You can also toggle whether a user is active or inactive. Inactive users are not deleted, so the items, collections, and tags created by that user remain associated with their account, but the individual can not longer log into the site to make changes or create new data. +On the "General" tab you can edit the username, display name, email, and role of the user. You can also toggle whether a user is active or inactive. + +**Inactive users** are not deleted, so the items, collections, and tags created by that user remain associated with their account, but the individual can no longer log into the site to make changes or create new data. -The Change Password tab requires you to enter a new password twice, but does not require the user’s original password. +The "Change Password" tab requires you to enter a new password twice, but does not require the user’s original password.  -To add an API key for a user, enter text for a label for the key in the field provided and then click “Update API Keys.” An API key will be generated and added to the page. To remove a key, click the checkbox in the Rescind column of keys. +To add an API key for a user, enter text for a label for the key in the field provided and then click “Update API Keys”. An API key will be generated and added to the page. To remove a key, click the checkbox in the "Rescind" column of keys. -Note: you must save changes before switching tabs. +Note: You must save your changes before switching tabs. -Delete Users +Delete users ---------------------------------------------------------------- -Find the user you wish to delete from `/admin/users/browse`, and click the "delete" button found beneath the username. You will be asked to confirm the action before you permanently delete the user. Items, collections, and tags created by this user will remain in the system, but will no longer be associated with this user. +Find the user you wish to delete from `/admin/users/browse`, and click the "Delete" button found beneath the username. You will be asked to confirm the action before you permanently delete the user. Items, collections, and tags created by this user will remain in the system, but will no longer be associated with this user. diff --git a/docs/Content/Collections.md b/docs/Content/Collections.md index 0fc1d40..bce8cd1 100755 --- a/docs/Content/Collections.md +++ b/docs/Content/Collections.md @@ -1,59 +1,63 @@ # Collections -Collections are groups of Omeka items. Collections may be used in a variety of contexts that make the most sense for your archive. +Collections are groups of Omeka items. Collections are a flexible means of organizing and presenting Omeka items, and can be used in the ways that make the most sense for your objects. -In Omeka Classic, an item can only belong to one collection. Collections can, of course, have multiple items. The concept of Omeka collections originates from museum and archives collections; one cannot put a document into more than one box. It is not necessary to follow a traditional interpretation of a collection, say by owner or donor. +In Omeka Classic, an item can only belong to one collection. Collections can, of course, have multiple items. The concept of Omeka collections originates from museum and archives collections; one cannot put a document into more than one box. -Collections have no hierarchy, unless you install the [Collection Tree plugin](../Plugins/CollectionTree.md) in order to have a nested collections. Items in collections have no set order, unless you install the [Item Order plugin](../Plugins/ItemOrder.md) and rearrange your items. +Collections have no hierarchy, unless you install the [Collection Tree plugin](../Plugins/CollectionTree.md) in order to have a nested collections. Items in collections have no set order, unless you install the [Item Order plugin](../Plugins/ItemOrder.md) in order to rearrange your items. The following screencast covers creating collections and adding items to those collections, as well as how to use the Collection Tree and Item Order plugins:Managing Collections in Omeka Classic from Omeka on Vimeo.
-You can also use [tags](Tags.md) to organize similar items into categories. +You can use [tags](Tags.md) to organize similar items into browseable categories. Tags can provide the multi-category flexibility that collections don't offer. The following screencast can help you determine when you would like to use collections or tags:Omeka Classic: Managing Collections and Tags from Omeka on Vimeo.
-Create a Collection +Create a collection ----------------------------------------------------------- 1. Click on the "Collections" tab in the left navigation bar from the Dashboard. Any collections you have created will be listed on the `admin/collections` page. -2. To create a new collection, click, "Add a Collection.". -3. You may assign a full complement of Dublin Core metadata to any collection, or simply create a title and description. -4. To make your collection public, check the "Public" box under the "Add Collection" button. Likewise, to feature your collection, check "Feature." -5. When you are finished adding metadata, clicking "Add Collection." +1. To create a new collection, click, "Add a Collection". +1. You may assign a full complement of Dublin Core metadata to any collection, or simply create a title and description. +1. The Dublin Core Extended plugin and the VRA Core plugin will also offer more fields to describe collections. +1. To make your collection public, check the "Public" box under the "Add Collection" button. +1. Likewise, to feature your collection, check "Feature". +1. When you are finished adding metadata, click the "Add Collection" button to save it. -Now that you have created a collection you may associate an item with this collection, from the `items/add` or `items/edit` pages. Read more below. +Now that you have created a collection, you may associate an item with this collection, from the `items/add` or `items/edit` pages. Read more below.  -Adding Items to Collections +Add items to collections ------------------------------------------------------------- -To add items to collections, you must first create the collection. See the [Items documentation](Items.md) to read more about associating an item with a collection. An item may only belong to one collection a time. You may switch an item from one collection to another at any time. +To add items to a collection, you must first create the collection. See the [Items documentation](Items.md) to read more about associating an item with a collection. An item may only belong to one collection at a time. You may switch an item from one collection to another at any time. -Items can only be added to a collection from the Item's edit page or the browse items page. +Items can only be added to a collection from the "Browse Items" page, at `/admin/items`, or from an individual item's editing interface. From the item edit page, use the dropdown menu on the right hand side, under the "Save Changes" button, to select a collection. - + -From the "Browse Items" page, you can use the batch edit option to add multiple items to a collection, again using a dropdown menu to select the existing collection. +From the "Browse Items" page, you can use the batch-edit option to add multiple items to a collection, again using a dropdown menu to select the existing collection. - + The thumbnail image for a collection is automatically derived from the primary file of the most recently created item in the collection, or, if you have an item checked as "featured," the most recently-created featured item in the collection. Collection thumbnails cannot be edited manually. -Edit a Collection +Edit a collection --------------------------------------------------------------- -To edit a collection, click the Edit link underneath the title from the Browse Collections page, at `/admin/collection`. Edit in any fields you wish, and click the "Save Changes" button to the right of the screen. +To edit a collection, click the "Edit" link underneath the title from the Collections page, at `/admin/collection`. Edit in any fields you wish, and click the "Save Changes" button to the right of the screen. -Browsing Collections +Browse collections --------------------------------------------------------------- By clicking the Collections tab, you may browse through the collections in your archive. They are listed with very basic metadata: Title, Contributors, Date Added, and Total Number of Items. You may sort collections by clicking Title or Date Added. +On the public interface, you can find the Browse Collections page at `yoursite/collections/browse`. A link is automatically added to the site navigation pointing to `yoursite/collections/browse`, and can be turned off in the [Navigation settings](../Admin/Appearance/Navigation.md). + diff --git a/docs/Content/Files.md b/docs/Content/Files.md index df58807..7aee95d 100755 --- a/docs/Content/Files.md +++ b/docs/Content/Files.md @@ -1,70 +1,96 @@ # Files -When adding [items](Items.md) to your database, often you will upload one or more files (images, documents, etc.) associated with that item. An item can have as many files attached as you wish, or none. Omeka Classic does not offer a way to upload files that are not attached to an item, except for some branding files such as a header background or logo file, [depending on the theme](../Admin/Appearance/Themes.md#configuring-a-theme). +When adding [items](Items.md) to your database, often you will upload one or more files (images, documents, etc.) associated with that item. An item can have as many files attached as you wish, or none. + +Omeka Classic does not offer a way to upload files that are not attached to an item, except, [depending on the theme](../Admin/Appearance/Themes.md#configuring-a-theme), some branding files such as a header background or logo.  -File Types +File types ------------------------------------------------------------- -Omeka Classic accepts most files and file types, and can be customized to accept or reject file types of your choice. You may wish to [format your multimedia files](#media-files) according to what can best be embedded and streamed in modern browsers. - -If you are having difficulty or are seeing file-validation errors, please see more information about adjusting the accepted file types and extensions in [File Validation section of the Security Settings page](../Admin/Settings/Security_Settings.md#file-validation). +Omeka Classic accepts most common files and file types, and can be customized to accept or reject file types of your choice. You may wish to [format your multimedia files](#multimedia-files) according to what can best displayed and streamed in web browsers. - +If you are seeing file-validation errors, please see more information about adjusting the accepted file types and extensions in the [File Validation section of the Security Settings page](../Admin/Settings/Security_Settings.md#file-validation). + -File Display Order +File display order --------------------------------------------------------------- If you have multiple files added to an item, you may click and drag the files into the preferred display order for both public and admin item pages. - +The first file associated with an item will be used as its thumbnail in browsing and searching, as well as on timelines and in other features added by plugins. + + -Files with Thumbnails +File derivatives ------------------------------- -Thumbnails are automatically created for many file types as of Omeka 2.0. Thumbnail creation relies on the ability of your chosen thumbnail utility (the default being ImageMagick) and which file types it can process. If you have access to the `config.ini` file, you can manage [thumbnail configuration](../Technical/ConfiguringThumbnailCreation.md). Look up the utility you are using (such as [ImageMagick](https://imagemagick.org/){target=_blank}, [Imagick](https://www.php.net/imagick){target=_blank}, or [GD](https://www.php.net/manual/en/intro.image.php){target=_blank}) to find out which file types it supports. +Thumbnail images are automatically created for many file types (as of Omeka 2.0), including thumbnails from the first frame of videos. + +Derivative images are generated as follows: + +- A square thumbnail, used most commonly on browsing pages and in search results. This will clip the longer side of an image (centered) to the same length as the shorter side. +- An original-dimension thumbnail. You can choose to use square or original-dimension thumbnails throughout the public site, with a choice on the Settings tab of the [Appearance page](../Admin/Appearance/Appearance_Settings.md). +- A "full-size" image used on file view pages, by default 800 pixels on its longest side. +- The original-sized image as uploaded, available for download or viewing on file view pages. + +You can control the size of each derivative file generated (square thumbnails and small original-dimension thumbnails, as well as full-size images) on the Settings tab of the [Appearance page](../Admin/Appearance/Appearance_Settings.md#derivative-size-constraints). + +You can use the [Derivative Images plugin](../Plugins/DerivativeImages.md) to re-generate thumbnails for uploaded media if needed. + +Items without attached files can display a default thumbnail rather than no thumbnail. + +Thumbnail creation relies on the ability of your server's chosen thumbnail utility (the default being ImageMagick) and which file types it can process. If you have access to the `config.ini` file, you can manage [thumbnail configuration](../Technical/ConfiguringThumbnailCreation.md). - +Look up the utility you are using (such as [ImageMagick](https://imagemagick.org/){target=_blank}, [Imagick](https://www.php.net/imagick){target=_blank}, or [GD](https://www.php.net/manual/en/intro.image.php){target=_blank}) to find out which file types it supports. -File Size Limitations + + +File size limitations ----------------------------- -Omeka Classic imposes no file size limitations. Your server, however, may have restrictions on file upload sizes or speeds that may be causing problems. These limitations vary from server to server and we cannot change this for you. If you have a problem uploading files through the Add New Files interface, please first check with your hosting service or your local server administrator. +Omeka Classic imposes no file size limitations. Your server, however, may have restrictions on file upload sizes or speeds that may be causing problems. These limitations vary from server to server and we cannot change this for you. If you have a problem uploading files through the "Add New Files" interface, please first check with your hosting service or your local server administrator. -Batch Add Files +Batch-add files --------------------------------------------------------------- -To upload more than one file at a time, you may download and install add-ons such as the [Dropbox plugin](../Plugins/Dropbox.md). It allows you to upload multiple files from Dropbox directly into a folder on your server, which you can then add in the items interface. +To upload a large number of files, or large files, you may download and install the [Dropbox plugin](../Plugins/Dropbox.md). It allows you to upload files from your computer directly into a folder in your installation, which you can then associate with existing items, or use to create new items. Note that this plugin is not associated with the "Dropbox" corporation and you do not need any external account to use this plugin. -File Metadata +File metadata -------------------------------------------------------------- -You may add a distinct set of Dublin Core metadata for each file uploaded. - -To add metadata, click the Edit button found to the right of the file name in `admin/items/edit`. You also may view or edit file metadata from the `admin/items/show` screen by clicking the file name under the heading "File Metadata." +You may add a distinct set of Dublin Core metadata for each file uploaded. This will be stored and displayed separately from the associated item's metadata. - +To add metadata, click the "Edit" button found to the right of the file name on `admin/items/edit`. You also may view or edit file metadata from the `admin/items/show` screen by clicking the file name under the heading "File Metadata." - + -Alt Text +Alt text ---------------------- -If a file does not have any metadata, as you can see in the above screenshot, Omeka uses the filename as alt text. If the file has information in its Dublin Core Title property, that text will be displayed as the alt text for that file wherever it appears on the site. +If a file does not have any metadata, as you can see in the above screenshots, Omeka uses the original filename as the media title and the alt text. If the file has information in its Dublin Core Title property, that text will be displayed as the alt text for that file wherever it appears on the site. -Media Files +Multimedia files ------------------------ -As of version 2.4, Omeka Classic uses HTML 5 audio and video tags when embedding audio and video. This means generally better support on newer browsers, but worse support on older ones and for older video formats especially. +As of version 2.4, Omeka Classic uses HTML5 audio and video tags when embedding audio and video. This means generally better support on newer browsers, but worse support on older ones and for older video formats especially. By choosing from a few well-supported formats for audio and video files, you can provide a much better experience for your users across different platforms and devices. +### Images + +#### TIFF +TIFF files are not supported for display in most browsers. TIFFs can be ingested into Omeka Classic, where they will have derivative images generated in JPG format. The original TIFFs will be provided for download anywhere that Omeka calls the 'original' file. The JPGs will be displayed anywhere Omeka calls the 'fullsize', 'medium', or thumbnail images. This may depend on the theme. + ### Video + #### MP4 The MP4 container (.mp4 or .m4v) is the best-supported video format across browsers and platforms. By far the best choice for video that will work well across different browsers are .mp4 files with H.264 video and AAC audio. -.mp4 files can contain other types of video (or audio), including newer ones like H.265, and older ones like MPEG-4 Visual. Any video codec other than H.264 has *much* worse browser support. +.mp4 files can contain other types of video (or audio), including newer ones like H.265, and older ones like MPEG-4 Visual. Any video codec other than H.264 has **much** worse browser support. -#### Other Formats +Here is an example of an MP4 added to an item: + + + +#### Other formats The WebM (.webm) container with VP8 or VP9 video is supported by several browsers, but Internet Explorer and Safari are notable and significant exceptions. The Ogg (.ogg, .ogv) container and Theora video are supported by some browsers, but there is little support among mobile browsers and no support at all on IE or Safari. @@ -72,13 +98,17 @@ The Ogg (.ogg, .ogv) container and Theora video are supported by some browsers, ### Audio #### MP3 -MP3 (.mp3) is one of the most common formats for compressed audio, and it enjoys wide support across browsers and from desktop to mobile. +MP3 (.mp3) is one of the most common formats for compressed audio, and it enjoys wide support across browsers and from desktop to mobile. When an MP3 is added to an item, it will display as an embedded audio player with a play button, volume control, and a horizontal navigation. + +Here is an example of an MP3 and a JPG both added to an item: + + #### AAC AAC is a somewhat newer format than MP3, but it also is well supported in most browsers. The widest support is for AAC in an MP4 container (this usually carries the file extension .m4a), with somewhat lesser support for other containers and formats (often found with a .aac extension). -#### Other Formats +#### Other formats WAV or WAVE (.wav) audio is supported by most browsers (with the notable exception of Internet Explorer). The major downside for use on the Web is that WAV audio is uncompressed, so it takes up vastly more storage space and bandwidth than the compressed formats listed above. If feasible, it’s best to use one of those instead of WAV. @@ -86,8 +116,8 @@ Ogg Vorbis audio (.ogg, .oga) is a compressed format like MP3 and AAC, but it ha Opus (.opus) is one of the newer available audio formats. For the time being, it has a similar problem as Vorbis: a lack of support among browsers, but there are signs that Opus could gain more support in the future. -### Legacy Formats -There are a lot of media files out there that aren’t in any of the formats listed here. With certain add ons or on certain platforms (like Safari on the Mac in many cases), it can be possible to embed some of those files with HTML 5, but expect many or most users to be unable to play them. Browser plugins can also play many file types, but browsers are steadily reducing and removing their support for these kinds of plugins. +### Legacy formats +There are a lot of media files that aren’t in any of the formats listed here. With certain add-ons or on certain platforms (like Safari on Mac, in many cases), it can be possible to embed some of those files with HTML5, but expect many or most users to be unable to play them. Browser plugins can also play many file types, but browsers are steadily reducing and removing their support for these kinds of plugins. For old media, often the best choice is to just present a download link so the viewer can play or convert the file locally. This is what Omeka does when it doesn’t recognize a file type or when a browser reports that it can’t play a file. @@ -95,5 +125,6 @@ File formats which result in a download link, rather than an embedded playback, - Video: .avi, .wmv - Audio: .aiff (except Safari), .midi, .wha +- Image: .tiff (we generate JPG derivatives for display, but offer the original TIFF for download.) If you do not see a format listed here that you think should be, try it out and let us know the results. diff --git a/docs/Content/Item_Types.md b/docs/Content/Item_Types.md index 715e5f3..f01370d 100755 --- a/docs/Content/Item_Types.md +++ b/docs/Content/Item_Types.md @@ -1,77 +1,160 @@ # Item Types -Item types are categories for your Omeka items based on their formats. Omeka offers you a specific set of associated metadata for each item type. Omeka comes by default with [Dublin Core item types](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-7){target=_blank}, but you can easily edit these or add your own. +Item types are categories for your Omeka items, often based on their formats. Each item can be assigned to one type. Omeka allows you to add a specific set of associated metadata fields for each item type. Omeka comes by default with the [standardized Dublin Core item types](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-7){target=_blank}, but you can easily edit these or add your own. + +You can view the following screencast to learn more about item types:Omeka Classic: Modifying Item Types from Omeka on Vimeo.
-Pre-defined Item Types +Pre-defined item types --------------------------------------------------------- -- **Document**: A resource containing textual data. Note that facsimiles or images of texts are still of the genre text. -- **Moving Image**: A series of visual representations that, when shown in succession, impart an impression of motion. -- **Oral History**: A resource containing historical information obtained in interviews with persons having firsthand knowledge. This may be an audio or video recording, or a transcript of a conversation. -- **Sound**: A resource whose content is primarily intended to be rendered as audio. -- **Still Image**: A static visual representation. Examples of still images are: paintings, drawings, graphic designs, plans, and maps. Recommended best practice is to assign the type "text" to images of textual materials. -- **Website**: A resource comprising a web page or web pages and all related assets (such as images, sound and video files, etc.). -- **Event**: A non-persistent, time-based occurrence. Metadata for an event provides descriptive information that is the basis for discovery of the purpose, location, duration, and responsible agents associated with an event. Examples include an performance, battle, exhibition, webcast, conference, workshop, trial, or wedding. -- **Email**: A resource containing textual messages and binary attachments sent electronically from one person to another or one person to many people. -- **Lesson Plan**: Instructional materials with fields that include duration (length of time involved), standards, objectives, materials, and lesson plan text. -- **Hyperlink**: An item that allows you to provide a URL as the main attached information. You can also attach files. Notes that entries in the URL field of this item type will not automatically be rendered into a clickable link, but you can employ the HTML editing feature to do so. -- **Person**: An individual. Elements include biographical data, birth and death, etc. -- **Interactive Resource**: A resource requiring interaction from the user to be understood, executed, or experienced. Examples include forms on Web pages, applets, multimedia learning objects, chat services, or virtual reality environments. +Note that you can see [other definitions and comments about these types on the Dublin Core website](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-7){target=_blank}. + +The following are the item types and descriptions included with every installation of Omeka Classic: + +- **Text**: A resource consisting primarily of words for reading. Examples include books, letters, dissertations, poems, newspapers, articles, archives of mailing lists. Note that facsimiles or images of texts are still of the genre Text. +- **Moving Image**: A series of visual representations imparting an impression of motion when shown in succession. Examples include animations, movies, television programs, videos, zoetropes, or visual output from a simulation. +- **Oral History**: A resource containing historical information obtained in interviews with persons having firsthand knowledge. +- **Sound**: A resource primarily intended to be heard. Examples include a music playback file format, an audio compact disc, and recorded speech or sounds. +- **Still Image**: A static visual representation. Examples include paintings, drawings, graphic designs, plans and maps. Recommended best practice is to assign the type Text to images of textual materials. +- **Website**: A resource comprising of a web page or web pages and all related assets (such as images, sound and video files, etc.). +- **Event**: A non-persistent, time-based occurrence. Metadata for an event provides descriptive information that is the basis for discovery of the purpose, location, duration, and responsible agents associated with an event. Examples include an exhibition, webcast, conference, workshop, open day, performance, battle, trial, wedding, tea party, conflagration. +- **Email**: A resource containing textual messages and binary attachments sent electronically from one person to another or one person to many people. +- **Lesson Plan**: A resource that gives a detailed description of a course of instruction. +- **Hyperlink**: A link, or reference, to another resource on the Internet. +- **Person**: An individual. +- **Interactive Resource**: A resource requiring interaction from the user to be understood, executed, or experienced. Examples include forms on Web pages, applets, multimedia learning objects, chat services, or virtual reality environments. +- **Dataset**: Data encoded in a defined structure. Examples include lists, tables, and databases. A dataset may be useful for direct machine processing. +- **Physical Object**: An inanimate, three-dimensional object or substance. Note that digital representations of, or surrogates for, these objects should use Moving Image, Still Image, Text or one of the other types. +- **Service**: A system that provides one or more functions. Examples include a photocopying service, a banking service, an authentication service, interlibrary loans, a Z39.50 or Web server. +- **Software**: A computer program in source or compiled form. Examples include a C source file, MS-Windows .exe executable, or Perl script.  -Edit an Existing Item Type +Edit an existing item type --------------------------------------------------------------- You can edit existing item types to modify their metadata fields. 1. Go to the Item Types page in the admin panel and click on the type you want to modify. 2. In the next screen, click the "Edit" button. From here, you can edit or delete the current metadata fields or add new ones. -3. When finished, click "Save Changes." +3. When finished, click "Save Changes". - + -While it is possible to delete existing item types using the “delete” button on the "Browse Item Types" page, we recommend that you do not delete the predefined item types; it may cause problems should you ever want to export data, or import from another Omeka install. Rather, you should create an alternate, more customized item type and use that in your installation instead. +While it is possible to delete existing item types using the "Delete" button on the "Browse Item Types" page, we recommend that you do not delete the predefined item types; it may cause problems should you ever want to export data, or import from another Omeka install. Rather, you should create an alternate, more customized item type and use that in your installation instead. -Create a new Item Type +Create a new item type -------------------------------------------------------------- -To create a new Item Type, click the green “Add an Item Type" button above the table. - - - -Each Item Type must have a *Name*, which must be unique. You can also add a *Description* to help clarify the Item Type (for example, the descriptions in the list of item types above) and guide users who are adding and describing items. - -## Creating and Adding Elements - -Your Item Types provide [sets of elements for your items](../Admin/Settings/Item_Type_Elements.md) - specific metadata fields that allow you to describe your items according to their categories (formats, or other types that you design). Learn more on the [Item Type Elements](../Admin/Settings/Item_Type_Elements.md) page. - -When adding elements to Item Types, there are two options: add an existing element or create a new one. You can do this to the default Item Types and any you create. +To create a new item type, click the green "Add an Item Type" button above the table. That will take you to the following screen. + + + +Each item Type must have a **Name**, which must be unique. You can also add a **Description** to help clarify the item type (for example, the descriptions in the list of item types above) and guide users who are adding and describing items. + +## Create and add elements + +Your item types provide sets of elements for your items - specific metadata fields that allow you to describe your items according to their categories (formats, or other types that you design). You can review existing metadata fields on the [Item Type Elements](../Admin/Settings/Item_Type_Elements.md) page. + +When adding elements to item types, there are two options: add an existing element or create a new one. You can do this to the default item types and to any that you create. + +**Existing elements** are elements that have already been created for another item type, but might be applicable to yours. For example, if you were creating a “Letter” item type, you might add the existing “To” and “From” elements from the “Email” item type, and the “Text” element from the “Text” item type. + +### Default elements for item types + +Omeka Classic creates a number of elements that are attached to its pre-defined item types. The default elements for each item type listed above are: + +- Text: + - Text + - Original Format +- Moving Image: + - Transcription + - Original Format + - Duration + - Compression + - Producer + - Director +- Oral History: + - Interviewer + - Interviewee + - Location + - Transcription + - Original Format + - Duration + - Bit Rate/Frequency + - Time Summary +- Sound: + - Transcription + - Original Format + - Duration + - Bit Rate/Frequency +- Still Image: + - Original Format + - Physical Dimensions +- Website: + - Local URL +- Event: + - Event Type + - Participants + - Duration +- Email: + - Email Body + - Subject Line + - From + - To + - CC + - BCC + - Number of Attachments +- Lesson Plan: + - Standards + - Objectives + - Materials + - Duration + - Lesson Plan Text +- Hyperlink: + - URL +- Person: + - Birth Date + - Birthplace + - Death Date + - Occupation + - Biographical Text + - Bibliography. + +The item types Interactive Resource, Dataset, Physical Object, Service, and Software have no default elements. + +All of these elements can be deleted, modified, or attached to new or existing item types. + +### Add an existing element to an item type + +1. In the Add Element block, select the **Existing** option. +1. Click the "Add Element" button below. You will see a new block created above this block, with a "Select Below" dropdown menu. + +1. In the element block that is created, select the desired element from the dropdown list. All available elements are displayed alphabetically - not sorted by element set. + -**Existing elements** are elements that have already been created for another item type, but might be applicable to yours. For example, if you were creating a “Letter” Item Type, you might add the existing “To” and “From” elements from the “Email” Item Type, and the “Text” element from the “Text” Item Type. +### Add a new element to an item type -### To add an existing element to an Item Type: +**New elements** require you to enter in a unique element name, and can optionally include a description. This text should help guide users who are entering metadata into this field, and can include vocabulary, structure, or formatting instructions. You might need to create new elements for unique item types, for example “Cancellation Date” and “Cancellation Location” for a “Stamp” item type. -1. In the Add Element block, select the *Existing* option. -1. Click the green *Add Element* button. - -1. In the element block which is created, select the desired element from the dropdown list. All available elements are displayed alphabetically. - +1. In the Add Element block, select the **New** option. +1. Click the "Add Element" button. You will see a new block created above this block, with two empty fields for "Element Name" and "Element Description". +1. In the element block that is created, enter a unique "Element Name" in the first field (toward the top of the block). Enter an "Element Description" in the larger text field. The name is required and the description is optional. + -**New elements** require you to enter in a unique element name, and can optionally include a description. This text should help guide users who are entering metadata into this field, and can include vocabulary, structure, or formatting instructions. You might need to create new elements for unique Item Types, for example “Cancellation Date” and “Cancellation Location” for a “Stamp” item type. +Note that an element can be created with the same name as an existing element, and the page can be saved, but that new element will disappear when the page is reloaded. - +Remember that a new element created here will be visible for review on the Item Type Elements tab in the Settings section. Remember also that a new element created here will not be included in any Element Sets and will not appear on that tab. -### To add a new element to an Item Type: +### Manage elements -1. In the Add Element block, select the *New* option. -1. Click the green *Add Element* button. -1. In the element block which is created, enter an *Element Name* in the first field (toward the top of the block). Enter an *Element Description* in the larger text field. - +You can delete elements from item types, by clicking the large "X" on the upper right corner of the element block. -You can delete elements from Item Types, by clicking the large X on the upper right corner of the element block. If it is a custom-created element, and it is no longer attached to any Item Types, it will still appear in the dropdown menu in the future. +Note that this will not delete elements from your installation, only remove them from association with an item type. If it is a custom-created element, and it is no longer attached to any item types, it will still appear in the dropdown menu in the future. -To delete these or existing elements from your Omeka install, go to the Settings tab, then the [Item Type Elements](../Admin/Settings/Item_Type_Elements.md) tab. You can edit element descriptions there, or delete elements from the database. +To delete these or other existing elements from your Omeka installation, go to the Settings tab, then the [Item Type Elements](../Admin/Settings/Item_Type_Elements.md) tab. You can edit element descriptions there, or delete elements from the database.  + +You can hide unused elements from the advanced search page, rather than deleting them from the database, by using the [Hide Elements](https://omeka.org/classic/plugins/HideElements/) plugin. \ No newline at end of file diff --git a/docs/Content/Items.md b/docs/Content/Items.md index ac4b996..a9474ca 100755 --- a/docs/Content/Items.md +++ b/docs/Content/Items.md @@ -7,7 +7,7 @@ Watch our [screencast](https://vimeo.com/102040466){target=_blank} for a quick iOmeka Classic: Managing Items from Omeka on Vimeo.
-Before Adding Items +Before adding items --------------------------------------------------------------- You may want to consult the [Site Planning Tips](../GettingStarted/Site_Planning_Tips.md) page to think about how to build your site and what you want to do with your items. @@ -16,58 +16,61 @@ You may also want to decide what type of information you plan to share using the You may wish to work out your metadata fields as you plan batch imports using one of our plugins: [CSV Import](../Plugins/CSV_Import.md), [Dropbox](../Plugins/Dropbox.md), [Zotero](../Plugins/ZoteroImport.md), [OAI-PMH Harvester](../Plugins/OaipmhHarvester.md), or [import from another Omeka installation](../Plugins/Omeka_API_Import.md). -Add an Item +Add an item -------------------------------------------------------------  -From your items page in the administrative interface (`https://youromekadomain.org/collections/admin/items`), click the "Add an Item" button. +From your items page in the administrative interface (`https://youromekadomain.org/your-installation/admin/items`), click the "Add an Item" button. This takes you to the `admin/items/add` page, where you see a navigation bar across the top pointing you to four different stages of adding an item. -1. The first tab shows the **Dublin Core** metadata fields. These are available for every item in the archive. +1. The first tab shows the **Dublin Core** metadata fields. These are available for every item in your installation. - Each field can have multiple values; simply click the "Add Input" button beside each field title to add a new input for that field. - - You can use HTML in these elements if you want; see below for more information. + - You can use HTML in these elements if you want; see below for more information. You cannot enter emojis or similar special characters, in either plain-text metadata or the HTML editor. 1. The **Item Type Metadata** tab lets you choose a specific [Item Type](Item_Types.md) for the object you are adding. - Once you choose the type by using the drop-down menu, relevant metadata fields appear for you to complete. - See [Item Types](Item_Types.md) for information about adding/editing item types. 1. The **Files** tab lets you upload files to an item. - - Clicking the "Add Another File" link will reveal another field for adding a file. You can associate any number of files to an item. Read more about [Files](Files.md). + - Clicking the "Add Another File" link will reveal another field for adding a file. You can associate any number of files to an item. You can read more about [Files](Files.md) on the next page of the user manual. 1. The **Tags** tab allows you add keyword tags to your item. - - You must press the “Add Tags” button in order to attach tags to an item. Simple entering them in the Add Tags field will not work. + - Remember to press the “Add Tags” button, after entering your text, to add the tags to an item. -Two more steps: +Three more steps to consider: -1. Make your new item “Public” and/or “Featured” with the checkboxes to the right of the item form, just under the button for "Add Item". If you do not make an item public, it will remain unseen by logged-out visitors to your site, but visible to every logged-in user no matter their [role](../Admin/Users.md#user-levels-and-access). +1. Make your new item “Public” with the checkbox to the right of the item form, just under the button for "Add Item". If you do not make an item public, it will remain unseen by logged-out visitors to your site, but visible to every logged-in user no matter their [role](../Admin/Users.md#user-levels-and-access). +1. Make your new item "Featured" with the checkbox to the right, if you wish it to appear in spots on the public site including "Featured Items" on the homepage. See the [homepage configuration section](../Admin/Appearance/Themes.md#homepage-configuration-options) for more information. 1. Assign items to a [collection](Collections.md). On the right side of the page, under the "Add Item" button, is a drop-down menu where you can assign your item to a collection. You cannot create a new collection from this menu. Remember, items can only belong to one collection. To finish, click the "Add Item" button to save your data. You cannot save a draft of an item, but you can make it private if you want to edit it further before sharing it publicly. -### Using HTML in Item Elements +### Using HTML in item elements -Each metadata field's text may be enhanced using basic HMTL tags. Check the HTML box below the text box to enable a visual HTML editor. +Each metadata field's text may be enhanced using basic HTML tags. Check the HTML box below the text box to enable a visual HTML editor.  -For more information about working with the HTML editor, please read [Using the HTML Editor](Using_HTML_Editor-TinyMCE.md). +For more information, see [Using the HTML Editor](Using_HTML_Editor-TinyMCE.md). -Properties of Items +Properties of items ------------------------------------------------------------- -Items: Each item contains Dublin Core and Item Type metadata, plus other metadata fields added by plugins. An item can belong to one collection (or none), and have an infinite number of tags. Items may contain many or no files. +**Items**: Each item contains Dublin Core and Item Type metadata, plus other metadata fields added by plugins. An item can have one item type (or none), belong to one collection (or none), and have an infinite number of tags. Items can be public or private, and can be featured. Items may have many or no files attached. You can use [Item Relations](../Plugins/ItemRelations.md) to establish connections between items using metadata fields, or [Commenting](../Plugins/Commenting.md] to allow site visitors to leave their thoughts on items. Items can have location data added using the [Geolocation](../Plugins/Geolocation.md) plugin. -Collections: May comprise different items. Items may only belong to one collection a time. +**Metadata**: Each item, each collection, and each file, can have as much or as little metadata as you wish. Metadata can be supplied in Dublin Core or custom formats, using controlled vocabularies, or supplied by users when they create items through the [Contribution](../Plugins/Contribution.md) plugin. Individual fields can be made private through the [Hide Elements plugin](https://omeka.org/classic/plugins/HideElements/){target=_blank}, and strings such as email addresses can be hidden within fields using the [Redact Elements](../Plugins/RedactElements.md) plugin. -Tags: Tags can be added to any item, and an item may contain an infinite number of tags. +**Collections**: Items may only belong to one collection at a time. You can use [Collection Tree](../Plugins/CollectionTree.md) to create a hierarchy of collections, so that an item will display in association with a lower-level collection and also its parent collection. -Browse Items in Admin +**Tags**: Tags can be added to any item, and an item may contain an infinite number of tags. You can browse and edit tags on the admin side, and add a public page for tag browsing to your navigation. + +Browse items in admin ------------------------------------------------------------- -Clicking on the "Items" tab from the Dashboard or `/admin` page takes you to a list of items. By default, these are sorted with the most-recently added items at the top. +Clicking on the "Items" tab in the administrative interface takes you to a list of items. By default, these are sorted with the most-recently added items at the top.  The "Browse Items" view displays items in a table. Each row is one item. There are columns for a checkbox (to select items for bulk actions), the item title, item creator, item type, and the date added. -Click the paired up-down arrows next to the "Title", "Creator", and "Date Added" headers to sort the items by that field. +Click the up-down arrows next to the "Title", "Creator", and "Date Added" headers to sort the items by that field. Note that items that are not public will display "(Private)" next to the title. Items that are featured have a small star icon after the item’s title. The image below shows first a featured item (note the star), then a private item, then a general public item. @@ -81,9 +84,9 @@ You may also use the blue "Show Details" button above the table, which will disp  -To search all items, click the "Search Items" button, which takes you to an advanced item search page. +To search all items, click the "Search Items" button at the top of the table, which takes you to an [advanced item search page](../GettingStarted/Searching.md). -Edit an Item +Edit an item -------------------------------------------------------------- You can edit any of the information you entered when creating an item, or add new information, from the "Items" page in the left-hand navigation. @@ -97,30 +100,33 @@ This takes you to the item-editing page where you may make your changes, the sam Make sure you click the "Save Changes" button when you are happy with your edits. -Delete an Item +Delete an item ---------------------------------------------------------------- You may delete any item from the `admin/items` page by clicking the "Delete" link found below the title. You will be asked to confirm this action. You may also delete an item by editing the item, then clicking the "Delete" button, found to the right of the page under the link to "View Public Page". -Batch Editing & Deleting +Batch edit & delete ------------------------------------------------------------------------------------------- -- Click the "Items" tab from the Dashboard or admin screen (`admin/items`). -- Find items that you wish to edit or delete in a batch by browsing, sorting, or searching. -- Use the checkboxes to the left of the items' titles to select them for batch editing, or select the box at the top left of the table to select all items available on that page. -- If you wish to batch-delete items, click the "Delete" button at the top right of the table. You will be taken to a confirmation screen that lists all the selected items by title, where you can un-select individual items if desired. -- If you wish to batch-edit items, click the the "Edit" button at the top right of the table. You will be taken to a batch-editing page where you may make changes. +Click the "Items" tab from the Dashboard or admin screen (`admin/items`). Find items that you wish to edit or delete in a batch by browsing, sorting, or searching. For example, you may wish to look at all items with an empty Title field, by using the "Search Items" button (select "Title" under "Field" and "is empty" under "Type"). + +Use the checkboxes to the left of the items' titles to select them for batch editing, or select the box at the top left of the table to select all items available on that page. You can also click the "Select all X results" button above the table to edit every item in the current results set. + +If you wish to batch-delete items, click the "Delete" button at the top right of the table. You will be taken to a confirmation screen that lists all the selected items by title, where you can un-select individual items if desired. + +If you wish to batch-edit items, click the the "Edit" button at the top right of the table. You will be taken to a batch-editing page where you may make changes.  -- You may change the following fields for each batch of selected items: - - public or private, - - featured or not featured, - - Item Type, - - Collection, - - add Tags to all selected items (but not delete), - - delete items. -- You can un-check the box to the left of each item if you marked one by mistake. -- Click "Save Changes" to edit all of the selected items. +You may change the following fields for each batch of selected items: +- public or private +- featured or not featured +- Item Type +- Collection +- add (but not delete) Tags for all selected items. + +You can also batch-delete items. + +Click "Save Changes" to edit all of the selected items. \ No newline at end of file diff --git a/docs/Content/Shortcodes.md b/docs/Content/Shortcodes.md index c5bcf93..18d46d3 100644 --- a/docs/Content/Shortcodes.md +++ b/docs/Content/Shortcodes.md @@ -1,13 +1,13 @@ # Shortcodes -A shortcode is a snippet that can be included in any body of text that works like embedding a multimedia object: a shortcode can insert an image, a video, a timeline, a form, or something else interactive or dynamic. +A shortcode works like embedding a multimedia object: a shortcode can insert an image, a video, a set of items, a timeline, a form, or something interactive or dynamic. A shortcode can be included in any body of text. -In Omeka, shortcodes work in basic text fields (not using the HTML editor) in specific places on Omeka Classic sites: on [Simple Pages](../Plugins/SimplePages.md), and on [Exhibit pages](../Plugins/ExhibitBuilder.md). +In Omeka, shortcodes work in basic text fields (not the HTML editor) on [Simple Pages](../Plugins/SimplePages.md), and on [Exhibit pages](../Plugins/ExhibitBuilder.md). -There are several built-in shortcodes that come with a basic Omeka install, and many more shortcodes that are added via plugins. You must install the needed plugin and follow its directions for use. +Several shortcodes come built-in with an Omeka installation, and many more shortcodes can be added via plugins. !!! Note - This page is a user’s guide to shortcodes. For help with developing shortcode functionality through plugins, see [Working with Shortcodes](http://omeka.readthedocs.org/en/latest/Tutorials/shortcodes.html){target=_blank} on Omeka’s Developer Documentation site. + For programmers who need help with developing shortcode functionality through plugins, see [Working with Shortcodes](http://omeka.readthedocs.org/en/latest/Tutorials/shortcodes.html){target=_blank} on Omeka Classic’s Developer Documentation site. General -------- @@ -16,58 +16,37 @@ Shortcodes can be added into text fields on **pages**. You cannot put a shortcod ``` Lorem ipsum dolor sit amet, consectetur adipiscing elit. [shortcode key=value] -Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. +Ut enim ad minim veniam, quis nostrud exercitation.... ``` Values can be wrapped in single or double quotes, making the following variations valid as well: `[shortcode key='value']` or `[shortcode key="value"]`. -**Shortcodes will not work with smart/curly quotes** (“ and ”). +**Shortcodes will not work with smart/curly quotes** (“ and ”). When in doubt, replace double quotes with single quotes. When using shortcodes on a Simple Page, do not use the HTML editor. Put the shortcode in the basic text field:  - - When using a shortcode in an Exhibit Builder block, place the code directly into the text editor:  -If the shortcode results in an image being displayed (from an item or file), the shortcode will display the filename or the file's Dublin Core title field as the `alt` text, and as the `title` (which appears when a user hovers the mouse over the image). You may wish to edit the file title with this in mind. +If the shortcode results in an image being displayed (from an item or file), the shortcode will display the filename or the file's Dublin Core title field as the `alt` text, and as the `title` (which appears when a user hovers their mouse over the image). You may wish to edit the file title with this in mind. + +### To find an item or file ID -### To Find an Item or File ID +Many shortcodes call elements from items or files by their internal Omeka identifier number. To find an item ID, go to the Items page. You can hover over each item title in turn to view its URL at the bottom of your browser, or click on the link, and look at the number that appears at the end of the URL; for example `https://youromekainstallation.com/admin/items/show/482`. -To find a file ID, navigate to the admin page for the item it is attached to. At the top of the Item page is a thumbnail display of the files associated with that item. Clicking on one will bring you to the file page; for example `http://youromekainstallation/omeka/admin/files/show/752`. +To find a file ID, navigate to the admin page for the item where it is attached. At the top of the Item page is a thumbnail display of the files associated with that item. Clicking on one will bring you to the file page; for example `http://youromekainstallation/omeka/admin/files/show/752`. -At the top of the page is a header containing the file ID \# and file title; for example File \#752: "The File Title". The integer following the \# sign is the ID; in this instance it would be 752. To return this file, the shortcode would be `[file id=752]`. +At the top of the page is a header containing the file ID number and file title; for example File \#752: "The File Title". The integer following the number sign is the ID; in this instance it would be 752. To return this file, the shortcode would be `[file id=752]`. -Built-in Shortcodes +Built-in shortcodes -------- - - - -The following short codes are built in to Omeka versions 2.2 and higher. For more guidance on the options and parameters, [see the table below](#shortcode-options). - -### Recent Items -The recent items shortcode returns a list of items most recently added to the database. - -The shortcode is `[recent_items]`. Without any parameters, it will return five items. - -Options: -- `num` to define a different number of items to display (default is 5). - -### Featured Items -The featured items shortcode returns a set number of items marked in the admin as featured. - -The shortcode is `[featured_items]`. Without any parameters, it will return one item at a time. - -Options: - -- `num` -- `has_image` +The following shortcodes are included with every installation of Omeka versions 2.2 and higher. For more guidance on the options and parameters, [see the table below](#shortcode-options). ### Items The items shortcode returns one or multiple items. @@ -88,18 +67,37 @@ Options: Examples: -To return a single, random item from a set of items tagged "baseball". +To return a single, random item from a set of items tagged "baseball": `[items num=1 tags=baseball sort=random]` -To return a list of five most recent items added by the user with the id 3. +To return a list of five most recent items added by the user with the ID 3: `[items num=5 user=3 sort=added order=d]` -To return all of the items tagged "baseball" from the collection with the id 5, sorted by title (ascending). +To return all of the items tagged "baseball" from the collection with the ID 5, sorted by title (ascending): `[items num=0 collection=5 tags=baseball sort="Dublin Core,Title" order=a]` +### Recent items +The recent items shortcode returns a list of items most recently added to the database. + +The shortcode is `[recent_items]`. Without any parameters, it will return five items. + +Options: + +- `num` to define a different number of items to display (default is 5). + +### Featured items +The featured items shortcode returns a set number of items marked in the admin as featured. + +The shortcode is `[featured_items]`. Without any parameters, it will return one item at a time. + +Options: + +- `num` +- `has_image` + ### Collections The collections shortcode returns one or multiple collections. @@ -112,7 +110,7 @@ Options: - `is_featured` - `sort` -### Featured Collections +### Featured collections The featured collections shortcode returns a number of collections marked as featured. The shortcode is `[featured_collections]`. Without any parameters, it will return one collection at a time. @@ -121,7 +119,7 @@ Options: - `num` -### Recent Collections +### Recent collections The recent collections shortcode returns a list of the most recent collections created. @@ -134,7 +132,7 @@ Options: ### File The file shortcode will return a file of a specified ID. -The shortcode is `[file id=#]`. It will not function if it is not provided a file ID. +The shortcode is `[file id=#]`. Nothing will display if it is not provided a file ID. Options: @@ -164,30 +162,35 @@ To return a thumbnail of an image, that links to the original file, with the fil `[file id=5 size=thumbnail]` -To return a square thumbnail of an image, that links to the fullsize image, with the file id of 12: +To return a square thumbnail of an image, that links to the fullsize image, with the file ID of 12: `[file id=12 size=square_thumbnail link_file=fullsize]` -### Shortcode Options +### Shortcode options + Most shortcodes have options that will modify the content they return. The following table explains some of the options which are shared across multiple shortcodes. | Option | Purpose | Settings | Example | | --- | --- | --- | --- | | `num` | Specify the number of items returned | Must be a whole number | `[recent_items num=10]` | -| `has_image` | Can be use to require that the called item have an image | `True` (return items with images) or `False` (return only items without images) | `[featured_items has_image=false]` | -| `ids` | Return an item or a list of items by item IDs | Multiple items separated by comma, or a range separated by hyphen. | `[items ids=10,76,432]` `[items ids=30-55]` | -| `is_featured` | Specify whether to return only items that are featured or not featured | `1`: Featured; `0`: Not featured | `[collections is_featured=1]` | -| `collection` | Return items only from a specific collection, using the collection ID number | Only one collection may be specified. | `[items collection=7]` | -| `item_type` | Return only items of a specific [item type](Item_Types.md) | | `[items item_type="still image"]` -| `tags` | Return only items from a specific tag | Multiple tags can be entered,separated by a comma, without any spaces. | `[items tags=baseball,math]` | -| `user` | Return only items added by a specific user, using the user ID number | Only one user may be specified. | `[items user=3]` | -| `sort` by Elements | Specify the element with double quotes, no space after comma | The syntax is `"Element Set,Element"`| `[items sort="Dublin Core,Title"]` | +| `has_image` | Return items either with or without images | `true` (with) or `false` (without) | `[featured_items has_image=false]` | +| `ids` | Return an item or a list of items by IDs | Separated by comma, or a range with hyphen | `[items ids=10,76,432]`, `[items ids=30-55]` | +| `is_featured` | Return items that are either featured or not featured | `1`: Featured; `0`: Not featured | `[collections is_featured=1]` | +| `collection` | Return items only from one collection, by ID number | | `[items collection=7]` | +| `item_type` | Return items of a specific [item type](Item_Types.md) | Double quotes around type | `[items item_type="still image"]` +| `tags` | Return items from a specific tag | Multiple tags separated by comma (no spaces) | `[items tags=baseball,math]` | +| `user` | Return items added by a user, by ID number | | `[items user=3]` | +| `sort=random` | Randomly choose from returned items | | `[items num=1 collection=3 sort=random]`| +| `sort` by Elements | Sort by element, specified by "Element Set,Element" | Double quotes, separated by comma (no spaces) | `[items sort="Dublin Core,Title"]` | | `sort=added` | Sort by date added | | `[items sort=added]`| | `sort=modifed` | Sort by date modified | | `[items sort=modifed]`| -| `sort=random` | Randomly choose from the set of returned items | | `[items num=1 collection=3 sort=random]`| -| `sort` option `order` | Specify the order of the sorting | Note: order requires a sort value to have been specified. `a`: ascending; `d`: descending | `[items num=5 sort=added order=d]` | +| `sort` option `order` | Specify the order of sorting | `a`: ascending; `d`: descending | `[items num=5 sort=added order=d]` | + +## Plugin shortcodes -## Plugin Shortcodes +The following shortcodes are provided by plugins built by the Omeka team. Externally-supported plugins may add more shortcodes. + +For more information on how the shortcode options below work, see the table above. ### Exhibit Builder These shortcodes require the [Exhibit Builder](../Plugins/ExhibitBuilder.md) plugin. @@ -208,9 +211,9 @@ Options: - `added` - `order` (with sort) -Exhibit IDs can be found at the end of the Edit page url for an exhibit; e.g. yoursite/admin/exhibits/edit/11 -the exhibit ID is 11. +Exhibit IDs can be found at the end of the Edit page URL for an exhibit. For example, for `yoursite/admin/exhibits/edit/11` the exhibit ID is 11. -#### Featured Exhibits +#### Featured exhibits The featured exhibits shortcode will return one or multiple exhibits that have been marked as featured. The shortcode is `[featured_exhibits]`. Without parameters, it will randomly return one exhibit from all of the ones marked as featured. @@ -220,48 +223,42 @@ Options: - `num` ### Geolocation -The [geolocation](../Plugins/Geolocation.md) shortcode will create a Google map of items based on parameters it is given. +The [geolocation](../Plugins/Geolocation.md) shortcode will display a map of geotagged items. -The shortcode is `[geolocation]`. Without parameters, it will return a map of all items that contain geolocation data, limited by the records per page as set in the Geolocation plugin configuration. +The shortcode is `[geolocation]`. Without parameters, it will return a map of all items that have geolocation data, limited by the records per page as set in the Geolocation plugin configuration. Options: -`fit`: specify whether to allow the Google map to automatically center and zoom the map to fit all of the markers. This is on by default. - -To manually specify the map/location zoom, use the following options. Note, to use these options, fit must be set to `0` or `false`. - -`lat`: specify the latitude of the map’s initial center point, in degrees. Must be between -90 and 90. +- `height`: set the map height. Can be set in pixels or percentages, requiring either `px` or `%`; defaults to 436px. For example: `[geolocation height=300px]` or `[geolocation height=50%]`. +- `width`: set the map width. Can be set in pixels or percentages, requiring either `px` or `%`; defaults to 100%. For example: `[geolocation width=200px]` or `[geolocation width=75%]`. +- `fit`: specify whether to allow the map to automatically center and zoom the map to fit all of the markers. This is on by default. -`lon`: specify the longitude of the map’s initial center point, in degrees. Must be between -180 and 180. +To manually specify the map/location zoom, use the following options. Note, to use these options, `fit` must be set to `0` or `false`. -`zoom`: specify the initial zoom level of the map. 0 is the most zoomed out. +- `lat`: specify the latitude of the map’s initial center point, in degrees. Must be between -90 and 90. +- `lon`: specify the longitude of the map’s initial center point, in degrees. Must be between -180 and 180. +- `zoom`: specify the initial zoom level of the map. 0 is the most zoomed out. If any of `lat`, `lon`, or `zoom` are not specifically set, and ‘fit' is set to `0` or `false`, the settings from the Geolocation plugin configuration page will be used. -`type`: specify the type of google map that appears. Defaults to the setting from the Geolocation plugin configuration page. Values are: +- `type`: specify the type of google map that appears. Defaults to the setting from the Geolocation plugin configuration page. Values are: + - `roadmap`: displays the road map view + - `satellite`: displays Google Earth satellite images + - `hybrid`: displays a mixture of road map and satellite views + - `terrain`: displays a physical map based on terrain information. -- `roadmap` - displays the road map view -- `satellite` - displays Google Earth satellite images -- `hybrid` - displays a mixture of road map and satellite views -- `terrain` - displays a physical map based on terrain information. - -`collection`: limits the map’s items to those from a specific collection, using the collection ID number. Only one collection may be specified. For example: `[geolocation collection=5]`. - -`tags`; limits the map’s items to those from a specific tag. Multiple tags can be entered, separated by a comma, and without any spaces. For example: `[geolocation tags=baseball,math]`. - -`height` set the map height. Can be set in pixels or percentages, but requires specification with either px or %; defaults to 436px. For example: `[geolocation height=300px]` or `[geolocation height=50%]`. - -`width`: set the map width. Can be set in pixels or percentages, but requires specification with either px or %; defaults to 100%. For example: `[geolocation width=200px]` or `[geolocation width=75%]`. +- `collection`: limits the map’s items to those from only one collection, by collection ID number. For example: `[geolocation collection=5]`. +- `tags`: limits the map’s items to those from a specific tag. Multiple tags can be entered, separated by a comma, with no spaces. For example: `[geolocation tags=baseball,math]`. Examples: -To print a map of all geotagged items, simply use: `[geolocation]`. +To display a map of all geotagged items, simply use: `[geolocation]`. -For a map that gets all of the items from your first collection, that are also tagged ‘baseball'. Ex. `[geolocation collection=1 tags=baseball]`. +For a map that gets all of the items in your first collection, that are also tagged "baseball": `[geolocation collection=1 tags=baseball]`. -A shortcode that leveraged all of the possible parameters would look like `[geolocation lat=42 lon=117 zoom=7 type=hybrid collection=4 tags=baseball,math,oakland height=500px width=500px]`. +A shortcode with all possible parameters would look like `[geolocation fit=0 lat=42 lon=117 zoom=7 type=hybrid collection=4 tags=baseball,math,oakland height=500px width=500px]`. -### Shortcodes Carousel +### Carousel Requires the [Shortcode Carousel plugin](../Plugins/ShortcodeCarousel.md). @@ -275,12 +272,11 @@ The same [options available for the Items shortcode](#items) are available for t Options: -`speed` sets the speed for the scrolling animation. May be "fast", "slow", or a time in milliseconds. Default is 400. For example: `[carousel speed=slow]` or `carousel speed=500]`. - -`autoscroll`: setting autoscroll=true will make the items automatically scroll interval. When autoscroll is on, interval sets the interval between scrolling in milliseconds. Default is 3000. For example: `[carousel autoscroll=true interval=700]`. +- `speed` sets the speed for the scrolling animation that transitions between items. May be "fast", "slow", or a time in milliseconds. Default is 400. For example, `[carousel speed=slow]` or `[carousel speed=500]`. +- `autoscroll`: setting `autoscroll=true` will make the items automatically scroll at regular intervals. When autoscroll is on, `interval` sets the interval between scrolling in milliseconds. The default is 3000. For example, `[carousel autoscroll=true interval=700]`. ### Timeline The [timeline](../Plugins/Timeline.md) shortcode will embed a timeline created using the Timeline plugin. -The shortcode is `[timeline title= '']`with the timeline title value inserted. \ No newline at end of file +The shortcode is `[timeline title= '']`with the timeline title value inserted. If no valid title is supplied, nothing will display. \ No newline at end of file diff --git a/docs/Content/Tags.md b/docs/Content/Tags.md index 401b45e..e1ad29e 100755 --- a/docs/Content/Tags.md +++ b/docs/Content/Tags.md @@ -1,42 +1,48 @@ # Tags -Tags are keywords or phrases that describe a piece of data. They are non-hierarchical labels that classify your content so that it is easily found. You can add tags to [Items](Items.md) and [Exhibits](../Plugins/ExhibitBuilder.md). +Tags are keywords or phrases that create links to describe a piece of data. They are non-hierarchical labels that classify your content so that it is easily found - textual metadata values without an associated metadata field. You can add tags to [items](Items.md) and [exhibits](../Plugins/ExhibitBuilder.md). + +You can watch the following video to learn more about adding access points to your Omeka items with tags:Omeka Classic: Managing Collections and Tags from Omeka on Vimeo.
-To manage your tags, sign into the Omeka Classic admin panel and select Tags from the left-hand navigation bar. This displays all the tags associated with records in your Omeka Classic installation. You may edit and delete tags, sort tags, and view items associated with individual tag. + +Browse Tags page +--------------- + +To manage your tags, select "Tags" from the left-hand navigation bar of the Omeka Classic administrative interface. This page display all the tags associated with records in your Omeka Classic installation. You may edit and delete tags, sort tags, and view items associated with individual tags.  -Browse Tags Page ---------------- -On the Browse Tags page, all tags used in your installation appear on the right side of the page, while on the left, next to the navigation, are options for search and an explanation of the tag display. +The "Browse Tags" page displays an explanation of the tag display.  Each tag used on your site appears as a unit which gives you the following (per the number labels in the above image): 1. The number of items with that tag -2. The name of the tag +2. The text value of the tag 3. The option to delete the tag.  -### Sort Tags +Next, the "Browse Tags" page displays a list of all tags used in your installation. This includes tags that are not currently associated with any items. The list includes options for sorting and searching your tags. + +### Sort tags There are four button options for sorting the tags, found above the tag cluster.  From left to right, they are: -- **Name:** The default sort for tags; sorts in alphabetical order by tag name. Click again to sort in reverse alphabetical order (arrow will point down). -- **Count:** Initially sorts tags by number of associated records with the largest number first. Click again, so that the arrow which appears next to it points up, to sort with the smallest number occurrences first. -- **Date Created:** Sorts records by date created. Default is oldest tags first. +- **Name:** The default sort for tags; sorts in alphabetical order (A-Z) by tag name. Click again to sort in reverse alphabetical order (Z-A) (the arrow will point down). +- **Count:** Initially sorts tags by number of associated records with the largest number first. Click again, so that the arrow which appears next to it points up, to sort with the smallest number occurrences first, including tags with zero current items assigned. +- **Date Created:** Sorts tags by the dates they were created, oldest tags first. Click again to see newest tags first. An upward pointing triangle indicates an ascending sort. A downwards pointing triangle indicates a descending sort. -In addition, there is a drop-down menu to the right of the sort options to limit the tags displayed by **Record Types** +In addition, there is a drop-down menu to the right of the sort options to limit the tags displayed by **Record Types**.  @@ -48,71 +54,71 @@ From the Record Types dropdown, select from the following options: - Exhibit - Item. -Note that if you do not have any exhibits tagged, you will still see the dropdown for Record Types - your options will be All and Items. +Note that if you do not have any exhibits tagged, you will still see the dropdown for Record Types - your options will be "All" and "Items". -When you have restricted display by record type, it will not show up in the dropdown but will display near the top of the page. To reset, either select "all" from the dropdown or click the blue "reset" button next to the Record Type message. +When you have restricted display by record type, it will not show up in the dropdown but will display near the top of the page. To reset, either select "All" from the dropdown or click the blue "Reset results" button next to the Record Type message.  -### Search Tags -In addition to the site-wide content [search](../GettingStarted/Searching.md), you can search just tags using the "Search tags" field in the upper left of the browse tags page, near the left-hand navigation bar. +### Search tags +In addition to the site-wide content [search](../GettingStarted/Searching.md), you can search exclusively tags using the "Search tags" field in the upper left of the browse tags page, near the left-hand navigation bar.  -Enter your search terms in this box. Note that this is broad search is for tags containing the search term: a search for "century" will return both "19th century" and "twentieth century." +Enter your search terms in this box. This is a broad search for tags containing the search term: a search for "century" will return both "19th century people" and "twentieth century." Once your search is complete, the search box will appear empty. Your search term is displayed above the tag browse, to the right of the tag search.  -Clear your search terms and return to regular tag browse by clicking the "Reset search" button. +Clear your search terms and return to the default browse by clicking the "Reset search" button.  If you have restricted record types to Exhibit or Item tags, the search will return results for those record types only. -### View Tagged Items -To view items associated with an individual tag, you need to be viewing *only* tags associated with Item record types. +### View tagged items +To view items associated with an individual tag, you need to be viewing only tags associated with Item record types. 1. From the Record Type filter, choose Items. 2. Find the tag whose items you want to view. 2. Click on the number to the left of the name of your tag. 3. A browse page opens displaying only items tagged with the tag you clicked. -## Edit a Tag -You can rename a tag from this page. Tags edited in the admin panel change on all items across the site wherever they appear. +## Edit a tag +You can rename a tag from this page. This tag edit will affect all attached resources across the site wherever they appear.  To edit a tag: - Click on the name of the tag you wish to edit. -- Enter changes you would like to make in the field. -- Hit Enter and your tag is saved with its new name. +- Enter the changes you would like to make in the field. +- Hit the enter key on your keyboard, and the tag is saved with its new name. -When editing, you cannot use an existing tag. For example, if you have 5 items tagged with "banana" and 2 items tagged with "bananana", you cannot edit the misspelled tag to the correct spelling. You would need to edit the items with the tag you want to remove, adding the desired tag and deleting the undesired tag. You can use the batch-edit function to add tags to items but not to delete tags. +When editing, you cannot use an existing tag. For example, if you have 5 items tagged with "banana" and 2 items tagged with "bananna", you cannot edit the misspelled tag to the correct spelling. You would need to edit the items with the tag you want to remove, adding the desired tag and deleting the undesired tag. You can use the batch-edit function to add tags to items, but not to delete tags. -Delete a Tag ------------------------------------------------------------------ -Deleting a tag removes all occurrences of that tag across all items. +## Delete a tag + +Deleting a tag removes all occurrences of that tag across all resources.  To delete a tag: - Choose the tag you wish to delete from the select menu. -- Select the X to the right of the tag. -- A window will open with the question, "Are you sure?" -- Click Delete, and that tag is permanently deleted across your Omeka items. (If you change your mind, close the query window by clicking on the X in the upper right hand corner.) +- Select the "X" to the right of the tag. +- A window will open with the question "Are you sure?" +- Click "Delete", and that tag is permanently deleted across your Omeka items and exhibits. (If you change your mind, close the query window by clicking on the "X" in the upper right hand corner.) + +## Public view -Public View --------------------- -Visitors to your site can browse tags by going to Browse Items and selecting the "Browse by Tag" option. The url for this page is `/items/tags`. Depending on the theme, the tags may appear as a cluster or a group, and may be scaled according to use. +Visitors to your site can browse tags by going to the "Browse Items" page and selecting the "Browse by Tag" option. The URL for this page is `/items/tags`. Depending on the theme, the tags may appear as a cluster or a group, and may be scaled according to use. For example, in Thanks, Roy, the default theme, the most frequently used tags are in a larger font:  -Whereas in Center Row, the tags simply display in a list: +In Center Row, the tags simply display in a list: - + \ No newline at end of file diff --git a/docs/Content/Using_HTML_Editor-TinyMCE.md b/docs/Content/Using_HTML_Editor-TinyMCE.md index 0a26505..566ddc6 100644 --- a/docs/Content/Using_HTML_Editor-TinyMCE.md +++ b/docs/Content/Using_HTML_Editor-TinyMCE.md @@ -1,38 +1,34 @@ # Using the HTML Editor -Users working in the administrative side of Omeka Classic sites can use a HTML editor, powered by TinyMCE, to style and format text, to add links, and to embed multimedia. +Users working in the administrative side of Omeka Classic sites can turn on the HTML editor, powered by TinyMCE, to style and format text, to add links, and to embed multimedia. This provides both a WYSIWYG editor (like a word processor) and a way to enter in HTML code directly (the Source Editor). -Use the Editor +Use the editor ---------------------------------------------------------------- For some text boxes, such as in [Exhibit Builder](../Plugins/ExhibitBuilder.md) blocks, the editor will automatically load. -When editing items or collections, you enable the editor by clicking the check box below an element. When this is clicked, you will see a formatting toolbar at the top of the element input. This allows you to style text visually, and the editor will insert the requisite HTML behind the scenes. +When editing items or collections, you enable the editor by clicking the "use HTML" checkbox that displays below the text field. When this is clicked, you will see a formatting toolbar at the top of the element input. This allows you to style text visually, and the editor will insert the requisite HTML behind the scenes. ![Title element field with the "Use HTML" box checked. Above the input field are icons representing options to format the text.](../doc_files/Wysiwyg_item.png "Title element field with the "Use HTML" box checked. Above the input field are icons representing options to format the text.") -Use the buttons in the toolbar to format text, change text alignment, create links and lists, and add headers. Be aware that CSS formatting in specific exhibit themes may control the appearance of this text, so the editor may not always reflect how the final page looks. +Use the buttons in the toolbar to format text, change text alignment, create links and lists, and add headers. Be aware that CSS formatting in site and exhibit themes may control the appearance of this text, so the editor may not always reflect how the final page looks. -If you want to write HTML code by hand, or embed web objects such as videos, click on the code button, represented by `<>`, on the far right of the editor options. - - - -This will open an HTML Source Editor window over the standard editing field. You may paste code snippets from Youtube or elsewhere, or write your own HTML, in the Source Editor window. +You can insert shortcodes in either the plain-text editing box or the HTML editing box. -![An empty html box. There is a heading for "Source Code," a large text entry field, and a blue "ok" button at the bottom.](../doc_files/htmleditor.png "An empty html box. There is a heading for "Source Code," a large text entry field, and a blue "ok" button at the bottom.") +If you want to write HTML code by hand, or embed web objects such as videos, click on the code button, represented by `<>`, on the far right of the editor options. - + -In this window, you may paste code that will embed videos or other web-generated elements. +This will open an HTML Source Editor window over the standard editing field. You may paste code snippets from Youtube or elsewhere, or write your own HTML, in the Source Editor window. You can use this to manually embed an image from one of your Omeka items, by using its URL directly in an `[timeline title='My Timeline']
`. -Allowed Tags ----------------------------------------------------------------- +Once you have finished coding the page, click the "Update" button. -Omeka installations load the default rule set of allowable HTML tags from TinyMCE. For a complete list see [this default rule set from TinyMCE](http://tinymce.moxiecode.com/wiki.php/Configuration:valid_elements){target=_blank}. +Allowed HTML elements +---------------------------------------------------------------- -You can customize your site's list of allowed or blocked tags. To do so, go to your [security settings](../Admin/Settings/Security_Settings.md#html-filtering) and add or remove HTML tags from the Filtering box. +Omeka installations load the default rules of allowable HTML tags from TinyMCE. You can customize your site's list of allowed or blocked tags. To do so, go to your [security settings](../Admin/Settings/Security_Settings.md#html-filtering) and add or remove HTML tags from the "Allowed HTML Elements" box. diff --git a/docs/Content/Working_with_Dublin_Core.md b/docs/Content/Working_with_Dublin_Core.md index 6299a63..adf255d 100644 --- a/docs/Content/Working_with_Dublin_Core.md +++ b/docs/Content/Working_with_Dublin_Core.md @@ -9,18 +9,18 @@ The Omeka team decided that we wanted to contribute to a movement that is helpin - [Dublin Core Metadata Element Set, Version 1.1: Reference Description](http://dublincore.org/documents/dces/){target=_blank}; [Latest version here](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-3){target=_blank} - [Historical overview and bibliography of Dublin Core resources (2010)](http://www.oclc.org/research/activities/past/orprojects/dublincore/default.htm){target=_blank} -Interpreting Dublin Core Fields in Omeka Classic +Interpreting Dublin Core fields in Omeka Classic -------------------------------------------------------- -The following Dublin Core fields are available in Omeka, together with some suggestions on interpreting the fields. The fields are broad and loosely-defined by design, so please consult with the [DCMI element descriptions](http://dublincore.org/documents/usageguide/elements.shtml){target=_blank} to be sure you are meeting the specific needs of your project. +The following Dublin Core fields are available in any Omeka installation, together with some suggestions on interpreting the fields. The fields are broad and loosely-defined by design, so please consult with the [DCMI element descriptions](http://dublincore.org/documents/usageguide/elements.shtml){target=_blank} to be sure you are meeting the specific needs of your project. -Read one example of Dublin Core interpretations from the [North Carolina Exploring Culture and Heritage Online](https://www.digitalnc.org/partners/describing-your-materials/){target=_blank} project. +We recommend reading one example of Dublin Core interpretations from the [North Carolina Exploring Culture and Heritage Online](https://www.digitalnc.org/partners/describing-your-materials/){target=_blank} project. -For almost any field, the [Library of Congress Suggest](../Plugins/Library_of_Congress_Suggest.md) plugin can supply you with the ability to select from a controlled vocabulary. This includes not just subject headings but people, places, and other authorities offered by LC. +For almost any field, the [Library of Congress Suggest](../Plugins/Library_of_Congress_Suggest.md) plugin can offer a controlled vocabulary. This includes not just subject headings but people, places, and other authorities offered by LC. With the [Simple Vocab plugin](../Plugins/SimpleVocab.md) you can design custom controlled vocabularies, such as a list of notable people relevant to your materials, and attach them to the Dublin Core elements below. -You may also want to review the detailed breakdown of [item types](Item_Types.md) with examples and a list of their item type metadata elements, and customize the Dublin Core fields most useful to you based on the item type. +You can review the detailed breakdown of [item types](Item_Types.md) with examples and a list of their item type metadata elements, and customize the Dublin Core fields most useful to you based on the item type. With these tools, you can plan a comprehensive and coordinated approach to using the Dublin Core fields in your Omeka site. @@ -133,3 +133,7 @@ The spatial or temporal topic of the resource, the spatial applicability of the Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the [Thesaurus of Geographic Names (TGN)](http://www.getty.edu/research/tools/vocabularies/tgn/index.html){target=_blank}. Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges. + +## More Dublin Core + +The [Dublin Core Extended plugin](../Plugins/DublinCoreExtended.md) adds further fields that may be of use to you. For example, it adds fields for "Abstract," "Bibliographic Citation," and "Table of Contents" for publication metadata; more specific date fields including "Date Created," "Date Modified," and "Date Copyrighted"; or "Spatial Coverage" and "Temporal Coverage" to provide separate and structured versions of the "Coverage" field above. diff --git a/docs/GettingStarted/Accessibility_Statement.md b/docs/GettingStarted/Accessibility_Statement.md index d7eb41f..b66ae05 100644 --- a/docs/GettingStarted/Accessibility_Statement.md +++ b/docs/GettingStarted/Accessibility_Statement.md @@ -4,7 +4,7 @@ The Omeka team is committed to making Omeka Classic an accessible option for sha The following statements apply to Omeka Classic versions 2.3 and higher. -Front End (Public view) +Front end (Public view) --------------------------------------------------------------- The public view of Omeka Classic has the following features to improve accessibility: @@ -18,7 +18,7 @@ There are also SkipNav and ARIA landmarks on [all Omeka Classic themes](https:// Please note that although the core code for Omeka Classic and its bundled themes and plugins conform to the above standards, sites built with Omeka Classic which have been customized or which are using non-Omeka themes and plugins may lack some or all of these options. While we encourage developers to consider accessibility, we cannot ensure that their code includes ARIA landmarks and SkipNav in the themes. -Back End (Administrative view) +Back end (Administrative view) ---------------------------------------------------------- The administrative dashboard of Omeka Classic has the following features for accessibility: diff --git a/docs/GettingStarted/UsingOmeka.md b/docs/GettingStarted/Examples.md similarity index 70% rename from docs/GettingStarted/UsingOmeka.md rename to docs/GettingStarted/Examples.md index 51ad008..3933df6 100644 --- a/docs/GettingStarted/UsingOmeka.md +++ b/docs/GettingStarted/Examples.md @@ -1,8 +1,8 @@ # Examples -The following page is meant to help people new to Omeka get a sense of how others have used Omeka Classic for projects, and inform you how to read an Omeka Classic website to understand what choices the site builders made. +The following page is meant to help people new to Omeka get a sense of how others have used Omeka Classic for projects, and help you read an Omeka Classic website to understand what choices the site builders made. -## Case Study +## Case study [Histories of the National Mall](http://mallhistory.org){target=_blank} interprets the National Mall's rich past by offering historical maps, a chronology of past events, short biographies of significant individuals, and episodes in the Mall's history. The site is built on Omeka Classic, designed and written for optimal reading on a smartphone or tablet. @@ -10,44 +10,57 @@ The team behind *Histories of the National Mall* wrote a comprehensive explanati ## How are others using Omeka Classic? -**Scholars** +### Scholars -- Use Omeka Classic to share primary source collections, publish a series of essays, and collaborate with others in the creation of digital scholarship. -- Features and plugins you might like: design themes, exhibit builder, tagging, DocsViewer, Geolocation, Image Annotation, Text Analysis. +- Use Omeka Classic to share primary source collections, publish a series of essays, and collaborate with others in digital scholarship. +- Plugins and features you might like: Exhibit Builder, DocsViewer, Geolocation, Timeline, Image Annotation, Text Analysis; tagging features. - Examples: [From Farms to Freeways: Women's Memories of Western Sydney](http://omeka.uws.edu.au/farmstofreeways/){target=_blank}; [New Roots: Voices from Carolina del Norte](https://newroots.lib.unc.edu/){target=_blank}; [Intemperance Archive](http://intemperance.org/){target=_blank}. -**Museum professionals** +### Museum professionals - Use Omeka Classic to share collections and build online exhibits to accompany or enhance physical exhibits. -- Features and plugins you might like: Dublin Core metadata standards, W3C and 508 compliant, design themes; Exhibit Builder, Posters, Contribution, Reports, Social Bookmarking, CSV Import, OAI-PMH Repository, and Omeka API Import. +- Plugins and features you might like: Exhibit Builder, Geolocation, Timeline, Posters, Contribution, Reports, Social Bookmarking, CSV Import, OAI-PMH Repository, Omeka API Import; Dublin Core metadata standards, [W3C and 508 compliance](../GettingStarted/Accessibility_Statement.md). - Examples: [John J. Audubon's Birds of America](http://omeka.tplcs.ca/virtual-exhibits/exhibits/show/audubon){target=_blank}; [Marshall M. Fredericks Sculpture Museum](http://omeka.svsu.edu/){target=_blank}. -**Librarians** +### Librarians - Use Omeka Classic as the publishing tool to complement your online catalog or launch a digital exhibit. -- Features and plugins you might like: Dublin Core metadata standards, W3C and 508 compliant, extensible and customizable item fields, Posters, Library of Congress Suggest, CSV Import, OAI-PMH Repository, and Omeka API Import. +- Plugins and features you might like: Dublin Core Extended, Library of Congress Suggest, Resource Meta, CSV Import, OAI-PMH Repository, Omeka API Import; Dublin Core metadata standards, W3C and 508 compliance, extensible and customizable item fields. - Examples: [DIY History](http://diyhistory.lib.uiowa.edu/){target=_blank}; [Virginia Tech Special Collections Online](https://digitalsc.lib.vt.edu/){target=_blank}; [Isaiah Thomas Broadside Ballads](http://www.americanantiquarian.org/thomasballads/){target=_blank}. -**Archivists** +### Archivists -- Use Omeka Classic to share your collections, display documents and oral histories, or create digital archives with user-generated content. -- Features and plugins you might like: Dublin Core metadata standards, W3C and 508 compliant, Exhibit Builder, extensible and customizable item fields, Dublin Core Extended, Docs Viewer plugin, tagging, CSV Import, OAI-PMH Repository, and Omeka API Import. -- Examples: [Florida Memory](https://www.floridamemory.com/){target=_blank}; [Digital History Archive of São Roque](http://www.arquivosaoroque.com.br/acervo/){target=_blank} (in Portugese); [Saint John's College Digital Archives](http://digitalarchives.sjc.edu/){target=_blank}. +- Use Omeka Classic to share your collections, display documents and oral histories, collect user-generated content, and allow users to easily browse and search your digitized archives. +- Plugins and features you might like: Exhibit Builder, Dublin Core Extended, Docs Viewer, CSV Import, OAI-PMH Repository, Omeka API Import; Dublin Core metadata standards, W3C and 508 compliance, extensible and customizable item fields, tagging. +- Examples: [Florida Memory](https://www.floridamemory.com/){target=_blank}; [Saint John's College Digital Archives](http://digitalarchives.sjc.edu/){target=_blank}. -**Educators** +### Enthusiasts + +- Use Omeka Classic to share your personal research or collections with the world, build exhibits, and write essays that showcase your expertise. +- Plugins and features you might like: Exhibit Builder, Contribution, Social Bookmarking, Exhibit Image Annotation, Simple Vocab; tagging. +- Examples: [A Shoebox of Norwegian Letters](http://huginn.net/shoebox/letters/){target=_blank}; [Square Dance History Project](https://squaredancehistory.org/){target=_blank}. + +### Educators - Use Omeka Classic to create lesson plans with accompanying primary sources, have students engage in the practices of public history and archival science, or serve as an alternative to written essay assignments. -- Features you might like: different user roles, ability to annotate Exhibit Builder, Editorial, Image Annotation, Text Annotation, Simple Vocab. -- Examples: [Fifteenth-Century Italian Art](http://www.quattrocentoitalia.artinterp.org/omeka/){target=_blank}; [Goin' North](https://goinnorth.org/){target=_blank}; [Ice Age Flood Explorer](http://floodexplorer.org/){target=_blank}. +- Plugins and features you might like: Exhibit Builder, Editorial, Exhibit Image Annotation, Text Annotation, Simple Vocab; different user roles, ability to annotate images. +- Examples: [Fifteenth-Century Italian Art](http://www.quattrocentoitalia.artinterp.org/omeka/){target=_blank}; [Goin' North](https://goinnorth.org/){target=_blank}. -**Enthusiasts** +#### Teaching with Omeka Classic +Omeka Classic has been used in classes at the undergraduate and graduate level, as well as by high school students. In addition to the information in the Educator use case (above), the following resources may prove helpful for those wanting to use Omeka in their classroom: -- Use Omeka Classic to share you personal research or collections with the world, build exhibits and write essays that showcase your expertise. -- Features you might like: design themes, Exhibit Builder plugin, Contribution plugin, tagging, social bookmarking plugin. -- Examples: [A Shoebox of Norwegian Letters](http://huginn.net/shoebox/letters/){target=_blank}; [Square Dance History Project](https://squaredancehistory.org/){target=_blank}. +**Blog posts and articles** + +- Amanda Visconti, [Teaching with Omeka DH Consultation Notes](http://web.archive.org/web/20220129111317/http://literaturegeek.com/2016/08/19/DH-consultation-notes-teaching-omeka){target=_blank} (originally found at http://literaturegeek.com/2016/08/19/DH-consultation-notes-teaching-omeka), *Literature Geek*, August 19, 2016. +- Alston Cobourn, [Spreading Awareness of Digital Preservation and Copyright via Omeka-based Projects](http://web.archive.org/web/20210413162928/https://jitp.commons.gc.cuny.edu/spreading-awareness-of-digital-preservation-and-copyright-via-omeka-based-projects/){target=_blank} (originally found at http://jitp.commons.gc.cuny.edu/spreading-awareness-of-digital-preservation-and-copyright-via-omeka-based-projects/), *The Journal of Interactive Technology and Pedagogy*, March 28, 2016. +- Jeffrey McClurken (Associate Professor and Chair of History and American Studies at the University of Mary Washington). [“Teaching with Omeka"](http://web.archive.org/web/20120616080742/http://chronicle.com/blogs/profhacker/teaching-with-omeka/26078) (originally found at http://chronicle.com/blogs/profhacker/teaching-with-omeka/26078){target=_blank}. ProfHacker blog, *Chronicle of Higher Education*, August 9, 2010. + +**Additional Resources** + +[Omeka Gym](http://web.archive.org/web/20210413192429/https://omekagym.omeka.net/about){target=_blank} (originally found at https://omekagym.omeka.net/about): a collection of resources for teaching with Omeka, including tutorials, exercises, assignments, and examples. Created by [Alexandra Bolintineanu](https://alexandrabolintineanu.wordpress.com/){target=_blank}. ## How to read an Omeka site @@ -59,10 +72,10 @@ The easiest of these is the message "Proudly Powered by Omeka" in the footer, wh Omeka sites will almost always have the same paths for certain pages: -- Browse items is siteurl/items -- Browse collections is siteurl/collections -- Exhibits are siteurl/exhibits -- Advanced search is siteurl/items/search. +- Browse items is `siteurl/items` +- Browse collections is `siteurl/collections` +- Exhibits are `siteurl/exhibits` +- Advanced search is `siteurl/items/search`. Even if the site creators have changed the label for these pages in their navigation menu, the URLs will generally be the same. Checking the address bar to see what function (item, collection, exhibit, etc.) the site is using will help you get a sense of how the creators have structured the site. @@ -72,18 +85,5 @@ Familiarize yourself with the standard [themes](http://omeka.org/classic/themes/ **Skim the navigation** -- Pay attention to URLs (exhibit, collection, item, item type, tag) -- Identify plugins by menu navigation label. - -## Teaching with Omeka Classic -Omeka Classic has been used in classes at the undergraduate and graduate level, as well as by high school students. In addition to the information in the Educator use case (above), the following resources may prove helpful for those wanting to use Omeka in their classroom: - -**Blog posts and articles** - -- Amanda Visconti, [Teaching with Omeka DH Consultation Notes](http://web.archive.org/web/20220129111317/http://literaturegeek.com/2016/08/19/DH-consultation-notes-teaching-omeka){target=_blank} (originally found at http://literaturegeek.com/2016/08/19/DH-consultation-notes-teaching-omeka), *Literature Geek*, August 19, 2016. -- Alston Cobourn, [Spreading Awareness of Digital Preservation and Copyright via Omeka-based Projects](http://web.archive.org/web/20210413162928/https://jitp.commons.gc.cuny.edu/spreading-awareness-of-digital-preservation-and-copyright-via-omeka-based-projects/){target=_blank} (originally found at http://jitp.commons.gc.cuny.edu/spreading-awareness-of-digital-preservation-and-copyright-via-omeka-based-projects/), *The Journal of Interactive Technology and Pedagogy*, March 28, 2016. -- Jeffrey McClurken (Associate Professor and Chair of History and American Studies at the University of Mary Washington). [“Teaching with Omeka"](http://web.archive.org/web/20120616080742/http://chronicle.com/blogs/profhacker/teaching-with-omeka/26078) (originally found at http://chronicle.com/blogs/profhacker/teaching-with-omeka/26078){target=_blank}. ProfHacker blog, *Chronicle of Higher Education*, August 9, 2010. - -**Additional Resources** - -[Omeka Gym](http://web.archive.org/web/20210413192429/https://omekagym.omeka.net/about){target=_blank} (originally found at https://omekagym.omeka.net/about): a collection of resources for teaching with Omeka, including tutorials, exercises, assignments, and examples. Created by [Alexandra Bolintineanu](https://alexandrabolintineanu.wordpress.com/){target=_blank}. +- Pay attention to URLs (`/exhibit`, `/collection`, `/item`, `/tag`). +- Identify plugins by the menu navigation label. diff --git a/docs/GettingStarted/Feature_List.md b/docs/GettingStarted/Feature_List.md index 804c5d3..4b52efa 100644 --- a/docs/GettingStarted/Feature_List.md +++ b/docs/GettingStarted/Feature_List.md @@ -2,7 +2,7 @@ Click [here](../doc_files/featurelist_2-x.pdf){target=_blank} for a PDF version of this page. -## Omeka Classic 2.6.1 Feature List +## Omeka Classic 2.6.1 feature list **Free, open-source, digital publishing suite for scholars, librarians, archivists, museum professionals, and cultural enthusiasts** - Publish archives, collections, exhibits, teaching materials; provide ways for the public to interact with your sites. @@ -34,31 +34,35 @@ Click [here](../doc_files/featurelist_2-x.pdf){target=_blank} for a PDF version **Standards-based metadata and web design** -- Every item, file, and collection contains fields for unqualified Dublin Core elements. Dublin Core is an internationally-recognized and widely-adopted schema. +- Every item, file, and collection contains fields for unqualified Dublin Core elements. Dublin Core is an internationally-recognized and widely-adopted schema. You can expand it with Dublin Core Extended, use PBCore or VRA Core instead, fill in fields with controlled vocabularies such as Library of Congress Suggest, and make your metadata machine-readable with the Resource Meta or OAI-PMH Repository plugins. - Omeka Classic comes packaged with design themes that follow best practices in accessible web design, are section 508 compliant, have ARIA roles for screen readers, and are responsive to different screen sizes for ease of reading on tablets and mobile phones. **Customizable web design** - Omeka Classic’s pre-packaged design themes can be quickly modified in the administrative interface by adding logos and a tagline, and by customizing the navigation. -- It's easy to customize an installed theme by [modifying the CSS](../Plugins/CSS_Editor.md), PHP, or HTML. +- It's easy to customize any installed theme by [modifying the CSS](../Plugins/CSS_Editor.md), PHP, or HTML. - Custom themes can be built using Omeka Classic’s flexible development API. **Interoperable** -- Unqualified Dublin Core data, combined with Omeka Classic-generated feeds and OAI-PMH harvestable data, give Omeka Classic sites the ability to share data among different systems and with other Omeka Classic sites. The [Dublin Core Extended plugin](../Plugins/DublinCoreExtended.md) adds a full complement of all DCMI elements. +- Unqualified Dublin Core data, combined with Omeka Classic-generated feeds and OAI-PMH harvestable data, give Omeka Classic sites the ability to share data among different systems and with other Omeka Classic sites. The [Dublin Core Extended plugin](../Plugins/DublinCoreExtended.md) adds a full complement of all DCMI elements; PBCore and VRA Core add further interoperable metadata fields. +- Add the [Resource Meta plugin](../Plugins/ResourceMeta.md) to feed your item-level metadata to machine-readable HTML that can be harvested by external indexers. **Data sharing** -- Share your Omeka Classic data through a variety of feeds including Atom, DCMES-XML, JSON, and RSS2. With the Dublin Core Extended plugin, RDF output is also available. +- Share your Omeka Classic data through a variety of feeds including Atom, DCMES-XML, JSON, and RSS2. +- With the Dublin Core Extended plugin, RDF output is also available. +- Make your metadata more machine-readable with the Resource Meta or OAI-PMH Repository plugins. - Every Omeka Classic site has a REST API enabled which makes your Omeka Classic data discoverable by outside applications. **Data migration** -- Populate an Omeka Classic site by adding items individually or batch adding with data migration and upload tools, such as the [OAI-PMH harvester plugin](../Plugins/OaipmhHarvester.md), [Dropbox plugin](../Plugins/Dropbox.md) for files, and API, CSV, and Zotero importer plugins. +- Populate an Omeka Classic site by adding items individually or batch adding with data migration and upload tools, such as the [OAI-PMH harvester plugin](../Plugins/OaipmhHarvester.md), [Dropbox plugin](../Plugins/Dropbox.md) for files, and Zotero importer plugins. For everything else, import a spreadsheet of formatted data with the CSV Import plugin. +- Easily move your materials from one Classic site to another with the Omeka API Import tool. **Internationalization of Omeka Classic code** -- Translations available in dozens of languages and anyone may submit new translations. +- Translations available in dozens of languages - and anyone may submit new translations. **Non-Roman character support** @@ -70,16 +74,16 @@ Click [here](../doc_files/featurelist_2-x.pdf){target=_blank} for a PDF version **Publish narratives using our exhibit builder** -- Create rich, interpretive exhibits in [Exhibit Builder](../Plugins/ExhibitBuilder.md) that combine items in your Omeka Classic site with narrative text. +- Create rich interpretive exhibits in [Exhibit Builder](../Plugins/ExhibitBuilder.md) that combine items in your Omeka Classic site with narrative text. - Configure each exhibit with a different theme or logo. **Create and organize items into collections** -- [Collection Tree](../Plugins/CollectionTree.md) plugin allows for collections to be nested. +- The [Collection Tree](../Plugins/CollectionTree.md) plugin allows for collections to be nested. **Use controlled vocabularies** -- Add the [Library of Congress Suggest](../Plugins/Library_of_Congress_Suggest.md) and [Simple Vocab](../Plugins/SimpleVocab.md) plugins to auto-complete the subject field, or create your own controlled list for other Dublin Core fields. +- Add the [Library of Congress Suggest](../Plugins/Library_of_Congress_Suggest.md) and [Simple Vocab](../Plugins/SimpleVocab.md) plugins to auto-complete the subject field, or create your own controlled options for other Dublin Core fields. **Community-source content** @@ -92,17 +96,19 @@ Click [here](../doc_files/featurelist_2-x.pdf){target=_blank} for a PDF version - Customize search to include items, collections, exhibits, and all web pages. - Create customized [reports](../Plugins/Reports.md) with a simple HTML export, or a PDF export that prints QR codes. -**Display items on a map** +**Browse items with interactive tool** - Assign locations to items, and add maps to exhibits using [Geolocation](../Plugins/Geolocation.md). +- Organize your items chronologically with [Timelines](../Plugins/Timeline.md). **Analyze and annotate your items** - Conduct textual analysis on the items in your Omeka Classic site using the [Ngram](../Plugins/Ngram.md) and [Text Analysis](../Plugins/TextAnalysis.md) plugins. - Create annotated images in your exhibits using [Exhibit Image Annotation](../Plugins/ExhibitImageAnnotation.md). - Enable users to annotate the text of your site using [Text Annotation](../Plugins/TextAnnotation.md). +- Keep staff annotations private with the [Editorial](../Plugins/Editorial.md) plugin. -## Visitor Experience With an Omeka Classic Site +## Visitor experience with an Omeka Classic site See the [Omeka Classic Showcase](http://omeka.org/classic/showcase/){target=_blank} for examples of site designs and experiences possible with an Omeka Classic site. - Visitors with a variety of web browsers, internet bandwidth, and devices can access your site because packaged themes are designed to be ADA compliant (section 508) and responsive to different screen sizes. diff --git a/docs/GettingStarted/Hosting_Suggestions.md b/docs/GettingStarted/Hosting_Suggestions.md index c79c20a..388c2fa 100644 --- a/docs/GettingStarted/Hosting_Suggestions.md +++ b/docs/GettingStarted/Hosting_Suggestions.md @@ -12,9 +12,9 @@ Suggestions from our users include: - [Dotblock](http://www.dotblock.com){target=_blank} - uses Softaculous - [HostGator](http://hostgator.com){target=_blank} - uses Softaculous - [TMD Hosting](https://www.tmdhosting.com){target=_blank} - uses Softaculous -- [Webuzo](http://webuzo.com){target=_blank} - uses Softaculous +- [Webuzo](http://webuzo.com){target=_blank} - uses Softaculous. -Below are a few suggestions for low-cost shared web hosts that offer the server environment required for installing Omeka manually: +Below are suggestions for low-cost shared web hosts that offer the server environment required for installing Omeka manually: - [AcuGIS](http://www.acugis.com){target=_blank} - [Cultural Hosting](https://culturalhosting.com){target=_blank} - a bilingual (Spanish and English) hosting company for cultural heritage organizations, based in Spain diff --git a/docs/GettingStarted/Screencasts.md b/docs/GettingStarted/Screencasts.md index 60e2b91..c49b00e 100644 --- a/docs/GettingStarted/Screencasts.md +++ b/docs/GettingStarted/Screencasts.md @@ -1,6 +1,6 @@ # Screencasts -General: +## General - [Introduction to Omeka Classic 2.0](https://vimeo.com/55973380) - [Managing Items](https://vimeo.com/102040466) @@ -11,7 +11,7 @@ General: - [Modifying Appearance](https://vimeo.com/103132986) - [Installing Plugins and Themes](https://vimeo.com/153819886) -Plugins: +## Plugins - [Managing Collections (including the Collection Tree plugin and Item Order plugin)](https://vimeo.com/194553469) - [Managing Metadata (including Library of Congress Suggest, Getty Suggest, Simple Vocab, and Search by Metadata plugins)](https://vimeo.com/176189711) diff --git a/docs/GettingStarted/Searching.md b/docs/GettingStarted/Searching.md index 72c1b10..9932d40 100644 --- a/docs/GettingStarted/Searching.md +++ b/docs/GettingStarted/Searching.md @@ -1,15 +1,15 @@ # Searching -This page explains the search functions in Omeka Classic on the public and admin sides, and how to use them. If you are looking for information on how to [manage search settings, please see that documentation](../Admin/Settings/Search_Settings.md). +This page explains the search functions in Omeka Classic on the public and administrative sides, and how to use them. If you are looking for information on how to manage search settings, please see [the page on Search Settings in the Administration section](../Admin/Settings/Search_Settings.md). -Basic Search +Basic search ------------- -The simplest way to search an Omeka Classic installation is using the simple search bar. On the admin side, this is always present in the upper right hand area of the window, under the top navigation bar. The exact location of the search bar on the public side varies by theme, but is generally close to the navigation menu. +The simplest way to search an Omeka Classic installation is with the simple search bar. On the admin side, this is always present in the upper right hand area of the screen, under the top navigation bar. The exact location of the search bar on the public side varies by theme, but is generally close to the navigation menu at the top of the screen. -To perform a basic search, type the keyword you want to search for in the field and either hit enter on your keyboard or click the search button (the magnifying glass icon). Depending on the [search settings](../Admin/Settings/Search_Settings.md), content in this search might include item, file, and collection metadata, the text on Simple Pages, exhibit summary pages, and exhibit pages. +To perform a basic search, type the keyword you want to search for into the box and either hit enter on your keyboard or click the search button (the magnifying glass icon). Depending on the [search settings](../Admin/Settings/Search_Settings.md), content in this search might include item, file, and collection metadata, the text on Simple Pages, exhibit summary pages, and exhibit pages. -### Search Options -To access the options for a basic search, click on the ellipsis (...) button to the right of the search bar, next to the search button (magnifying glass). +### Search options +To access the options for a basic search, click on the ellipsis button ("...") to the right of the search bar, next to the search button (the magnifying glass icon).  @@ -33,11 +33,11 @@ as well as options provided by plugins, such as: Advanced Search ---------------- -Advanced Search, which will only search the items in your Omeka Classic installation, is available on the admin side, and on the public side if the *Use Advanced Site-Wide Search* option is checked in the [theme settings](../Admin/Appearance/Themes.md#configuring-a-theme). +Advanced Search, which will only search the items in your Omeka Classic installation, is available on the admin side, and on the public side if the "Use Advanced Site-Wide Search" option is checked in the [theme settings](../Admin/Appearance/Themes.md#configuring-a-theme). -![Search options, with the ellipses expanded. There is a red 1 just under the ellipses. At the bottom of the window, below the options for search query type and record types, a red 2 is next to the "Advanced Search" link](../doc_files/searchExpanded.png "Search options, with the ellipses expanded. There is a red 1 just under the ellipses. At the bottom of the window, below the options for search query type and record types, a red 2 is next to the "Advanced Search" link") +To access the advanced search, click on the ellipsis button to the right of the basic search bar and then click the link reading “Advanced Search (Items Only)”. -To access the advanced search, click on the ellipsis (…) button to the right of the basic search bar and then click the link reading “Advanced Search (Items Only)”. +![Search options, with the ellipses expanded. At the bottom of the window, below the options for search query type and record types, there is the "Advanced Search" link](../doc_files/searchExpanded.png "Search options, with the ellipses expanded. At the bottom of the window, below the options for search query type and record types, there is the "Advanced Search" link") The “Search Items” page will load. It presents a variety of options for advanced searching across all items. You do not need to complete all fields, only as many as you want. @@ -81,10 +81,11 @@ If you have [the Exhibit Builder plugin](../Plugins/ExhibitBuilder.md) installed Troubleshooting --------------------------------------------------- **Seeing private items when searching on the public side**: + If you are logged in to your Omeka Classic installation, you will see all items and exhibits on the public and admin side - private and public. Try logging out, copying the page URL to a private browser window, or visiting the site in a browser where you are not logged in. -**If you are having trouble finding words you know are in your install, the following may be part of the problem:** +**Trouble finding words you know are in your install:** - MySQL by default does not index any words shorter than 4 characters long. This may include numerical identification numbers in your collection, particularly if they include punctuation, as in "2020.01.123-ABC". - Exact match searches will look for the exact string given by the user, anywhere in the record. For example a search for “poe” would also return “poem”. -- MySQL considers terms that appear in over 50% of indexed items to be so common that it excludes them from keyword searches. The easy way to tell if a term meets the 50% threshold is to choose the “Boolean” search, as MySQL does not apply the 50% limitation to Boolean searches. +- MySQL considers terms that appear in over 50% of indexed items to be so common that it excludes them from keyword searches. The easy way to tell if a term meets the 50% threshold is to choose the “Boolean” search, as MySQL does not apply the 50% limitation to Boolean searches. \ No newline at end of file diff --git a/docs/GettingStarted/Site_Planning_Tips.md b/docs/GettingStarted/Site_Planning_Tips.md index 91977dc..aca7040 100644 --- a/docs/GettingStarted/Site_Planning_Tips.md +++ b/docs/GettingStarted/Site_Planning_Tips.md @@ -1,14 +1,11 @@ # Site Planning Tips -Before you start building an Omeka Classic site, it is useful to sketch out wireframes of your new site to help plan the content of your site, and to determine how you want your audiences to access and use that content on the website. +Before you start building an Omeka Classic site, it is useful to view sites from our [showcase](https://omeka.org/classic/showcase/){target=_blank} and [site directory](https://omeka.org/classic/directory/){target=_blank}. Then think about the way Omeka manages [items](../Content/Items.md), [collections](../Content/Collections.md), and [files](../Content/Files.md) to help plan the content of your site, and to determine how you want your audiences to access and use that content. -Planning for the content first will help you think about the ways that Omeka Classic can work best for you throughout different stages of the project. - -Questions to Ask While Planning +Questions to ask while planning --------------------------------------------------------------- -These questions will help with those planning steps. -**What are the primary goals of the website?** +**What are the goals of the website?** **Who is the primary audience of this website? Secondary audiences?** @@ -16,47 +13,68 @@ What do you want these specific audiences to accomplish when they come to the si **What sections will this website include?** -Typical top level navigation and sections for a typical Omeka Classic site include: +Typical top-level navigation menus for an Omeka Classic site might include: + + - [Items](../Content/Items.md): links to a browseable list of items, and an option to browse by tags. + - [Collections](../Content/Collections.md): groups of items; the public can browse your collections to discover related items. + - [Exhibits](../Plugins/ExhibitBuilder.md): series of pages that contain interpretive text and rely on items/sources/objects as their building blocks. + - About: a [simple page](../Plugins/SimplePages.md) sharing information about the project: description, credits, rights, etc. + - [Search bar](../GettingStarted/Searching.md#basic-search): a quick tool for searching the site's content, with an option to link to an [advanced search](../GettingStarted/Searching.md#advanced-search) page. + +Plugins that you install can automatically add further pages to your site's navigation menu (such as a "Contribute" page from the Contribution plugin, or a "Timeline" page from the Timeline plugin). You can also add custom links, such as to your organizational website. - - [Items](../Content/Items.md): links to a browseable list of items, sortable by type of item and tags. - - [Collections](../Content/Collections.md): groups of items, public can dig through collection to find items. - - [Exhibits](../Plugins/ExhibitBuilder.md): Exhibits contain interpretative text and rely on items/sources/objects as their building blocks. - - About: a [simple page](../Plugins/SimplePages.md) good for publishing project descriptions, credits, rights, etc. - - [Search bar](../GettingStarted/Searching.md#basic-search): with an option to link to an [advanced search](../GettingStarted/Searching.md#advanced-search) page. +But the menu's options and suggestions are entirely up to you. You can add links directly to specific items, collection, or exhibits; you can add browsing access points such as links to each Item Type; you can write and include any number of pages. + + **What will I do with items in this website?** -The item is the building block of your site. -First add the objects and materials you want to share. -Add descriptions using some or all of the 20 standard [Dublin Core](../Content/Working_with_Dublin_Core.md) fields, plus additional item type-specific fields. -Once you have items in the Omeka Classic database, then you can build an exhibit with them or display categories of items organized by collections or tags. +The item is the building block of your site. Items can be photographs, videos, audio clips, newspaper issues (or titles, or articles, or pages), maps, books (or series, or pages), artifacts, quotes, people, events, locations, and other types of data - whatever you need to build your collection. One item can have many media files attached, or only one file, or no file at all. You can group items into a [collection](../Content/Collections.md); you can create a hierarchy of collections using [Collection Tree](../Plugins/CollectionTree.md). -- Determine the types of items/sources/objects you plan to use in this site: Document, Still Image, Moving Image, Audio, the [other pre-defined item types in Omeka](../Content/Item_Types.md#pre-defined-item-types), or something custom to your collection. -- Do you want to modify any of the item types or the item-type-specific fields? See [Managing Item Types](../Content/Item_Types.md) to learn more. +- Determine the **types** of items/sources/objects you plan to use in this site: Document, Still Image, Moving Image, Audio, the [other pre-defined item types in Omeka](../Content/Item_Types.md#pre-defined-item-types), or something custom to your collection, such as people or places. An item can be anything that needs description through metadata fields, or anything you wish to attach media to. +- Do you want to modify any of the **item types** or the item-type-specific **metadata fields**? See [Managing Item Types](../Content/Item_Types.md) to learn more. +- Describe your objects using some or all of the 20 standard [Dublin Core](../Content/Working_with_Dublin_Core.md) fields, plus additional item-type-specific fields. - Do you need additional Dublin Core fields? Install the [Dublin Core Extended](../Plugins/DublinCoreExtended.md) plugin. -- It is wise to determine, before you start building your collection of items, what type of consistencies you desire in your metadata - this may be especially true for fields such as date, publisher, creator, etc. - * Do you want to use Library of Congress subject headings as a [controlled vocabulary](https://en.wikipedia.org/wiki/Controlled_vocabulary)? Install [Library of Congress Subject Headings](../Plugins/Library_of_Congress_Suggest.md) plugin. - * Would you like to establish your own controlled vocabularies for specific metadata fields, to make it easier for your team to enter consistent data? Install the [Simple Vocab](../Plugins/SimpleVocab.md) plugin. -- Do you want to establish a controlled tagging schema? You can [add tags](../Content/Tags.md) to individual items and exhibits. Before building your collections you may want to devise this schema to help control vocabularies and spelling. Tags can help you pull together different items, for purposes such as arranging them on a map, or allowing users to browse items with a specific tag. -- Do you have materials in other databases or repositories? You may be able to import them in bulk into your Omeka Classic site. +- Determine, before you start building your collection of items, what **consistencies** you need in your metadata - this may be true for fields such as date formatting, publisher or creator names, etc. + * Do you want to use Library of Congress subject headings as a [controlled vocabulary](https://en.wikipedia.org/wiki/Controlled_vocabulary){target=_blank}? Install the [Library of Congress Subject Headings](../Plugins/Library_of_Congress_Suggest.md) plugin. + * Would you like to establish your own **controlled vocabularies** for specific metadata fields, to make it easier for your team to enter consistent data? Install the [Simple Vocab](../Plugins/SimpleVocab.md) plugin. +- You can add **tags** to individual items and exhibits. Do you want to establish a controlled tagging schema? Before building your collections, devise this schema to help control vocabularies and spelling. [Tags](../Content/Tags.md) can help you pull together different items, for purposes such as arranging them on a **map** or displaying them on a **timeline**, or allowing users to browse items with a specific tag. +- Do you have all your metadata ready in a spreadsheet? Bulk-import all the items you need with the [CSV Import](../Plugins/CSV_Import.md) plugin. + +Add the objects and materials you want to share. Once you have items in your Omeka Classic database, then you can build an exhibit with them or display categories of items organized by collections or tags. + +- Do you have materials in other databases or repositories? You may be able to **import** them in bulk into your Omeka Classic site. * Can items be exported in a Comma Separated Value format? Try the [CSV Import](../Plugins/CSV_Import.md) plugin. - * Is there an OAI-PMH harvestable set? Try the [OAI-PMH Harvester](../Plugins/OaipmhHarvester.md) plugin. - * Do you have hundreds of files, or large media files? Use the [Dropbox](../Plugins/Dropbox.md) plugin. -- Do you want to display items on a map? Install the [Geolocation](../Plugins/Geolocation.md) plugin, then add geolocation metadata to each item. -- Are you interested in collecting materials from your visitors through a web form, such as a story or textual reflection, photos, or videos? Install the [Contribution](../Plugins/Contribution.md) plugin to facilitate collecting. -- Do you want to build an exhibit with your items? Install the [Exhibit Builder](../Plugins/ExhibitBuilder.md) plugin. + * Is there an [OAI-PMH](https://www.openarchives.org/pmh/){target=_blank} harvestable set online? Try the [OAI-PMH Harvester](../Plugins/OaipmhHarvester.md) plugin. + * Do you have hundreds of files, or large media files? Use the [Dropbox](../Plugins/Dropbox.md) plugin to import files from another place online rather than uploading from your computer. +- Are you interested in **collecting materials from your visitors** through a web form, including stories, photos, or videos? Install the [Contribution](../Plugins/Contribution.md) plugin. **How do you want items to display?** -- Do you want to add social bookmarking icons to the bottom of items, to allow users to share links to that item with their social networks? Install the [Social Bookmarking](../Plugins/SocialBookmarking.md) plugin. -- Do you want to allow users to leave comments on items? Install the [Commenting](../Plugins/Commenting.md) plugin. -- Do you want to create and print QR codes that link visitors in a physical place to individual items in your Omeka Classic site? Install the [Bar Code and Reports](../Plugins/Reports.md) plugin. -- Do you have documents that you wish users to read on-screen rather than downloading them? Install the [DocsViewer](../Plugins/DocsViewer.md) plugin. +- Do you want to add **social bookmarking** icons to the bottom of item pages, to make it easier for users to share items with their social networks? Install the [Social Bookmarking](../Plugins/SocialBookmarking.md) plugin. +- Do you want to display a **map** showing the location information of each item? Install the [Geolocation](../Plugins/Geolocation.md) plugin, then add geolocation metadata to each item. +- Do you want to allow users to leave **comments** on items? Install the [Commenting](../Plugins/Commenting.md) plugin. +- Do you have documents that you wish users to **read on-screen** rather than downloading them? Install the [DocsViewer](../Plugins/DocsViewer.md) plugin or the. -Plan an Exhibit +**How do you want site visitors to access your items?** + +Omeka Classic is modular and customizable, which means you can use its tools and features in many useful combinations. + +- Each item can have one type (often Image, Sound, Video, etc.) that allow visitors to browse through those access points. You can create your own item types to categorize and divide your items any way you want. You can add those types to your navigation menu (URLs in the form `yoursite/items/browse?type=123`) to allow easier access. +- Each item can be in one collection. Collections can be created around any concept you want - a collection for each exhibit, chronological collections by a date range (1700-1800, 1800-1900, etc.), collections based around creators or donors. The "Browse Collections" page is automatically added to your site navigation, but you can also include direct links to each collection if you wish (URLs in the form `yoursite/collections/show/123`). + - Collections can also be arranged into a tree using the Collection Tree plugin. Then users can browse a top-level collection and see all of the items contained in its lower-level collections. This gives you organizational options past the limitation of one collection per item. +- Items can have an infinite number of tags, which you can use to provide subject headings, date ranges, or other grouping tools. "Browse by tag" is a link that appears on the "Browse Items" page by default, but you can also add this to your navigation (`yoursite/items/tags`). Or you can share links to specific tags directly, in the text on your homepage or in exhibits (URLs in the form `yoursite/items/browse?tags=europe`). +- Items can often have the same metadata values (such as one person listed as the Creator for many items). + - Using the [Search by Metadata](../Plugins/SearchByMetadata.md) plugin, you can turn certain metadata fields (such as Creator or Publisher) into clickable links that will take users to a search-results page including all items that match that (for example, all the items with "Shakespeare, William" as the text value in the Creator field). This can provide another access point, incorporated into your descriptive metadata, alongside tags, classes, and collections. And you can use those URLs in your navigation bar or in your page text, too. + - If these values (such as people) require describing (such as with biographical information), you can use items for this purpose (items with a "Person" item type, for example). Install the [Item Relations](../Plugins/ItemRelations.md) plugin to fill out a field (such as Creator) with a link to another item (such as your "William Shakespeare" item). +- With the Timeline and Geolocation plugins, you can add interactive tools that allow browsing by item dates or coordinates. These require precise formatting of your metadata but are easy to set up. These plugins also add pages to your site menu automatically, which can be removed or modified in the Navigation options. You can instead create pages that have timelines and maps embedded, or include these tools in your exhibits. +- Searching on your Omeka site brings up text results from the item and collection metadata you have provided, and can also include full-text-searching inside PDFs and other text documents attached as files. Consider installing the [PDF Text](../Plugins/PdfText.md) plugin and indexing the contents of your PDFs. +- With Simple Pages, you can manually create a page including links to any number of the options above. This can include a "Searching Tips" or "Research Guide" page with information about how you have structured your Omeka installation, and offer examples of how to browse and search the collection. + +Plan an exhibit ------------------------------------------------------------ -Exhibit Builder is not necessarily only for building museum-like exhibits. This function can be used to publish essays or teaching materials that draw upon the items in your archive. +The [Exhibit Builder](../Plugins/ExhibitBuilder.md) plugin is not only for building museum-like exhibits. This function can be used to publish essays or teaching materials that draw upon the items in your archive. Note that the Exhibit Builder plugin comes packaged with the basic installation of Omeka Classic. Before you build an exhibit, sketch out a storyboard or outline that spells out the sections, pages, and items for each page. @@ -64,14 +82,18 @@ Each exhibit can have multiple sections, which can contain multiple pages. Each Learn more in the instructions for using the [Exhibit Builder](../Plugins/ExhibitBuilder.md) plugin. -Create Simple Web Pages +Digital exhibit publishing is a popular class assignment for students, or a way for users and volunteers to contribute to your institution. Learn more about [creating different users and giving them permissions](../Admin/Users.md) to build things on your Omeka Classic installation. + +It's also common to create a digital companion exhibit to a physical exhibit in your space. Digital exhibits can expand upon and complement your displays of artifacts. Do you want to print QR codes that will link exhibit visitors to individual items in your Omeka Classic site? Install the [Reports](../Plugins/Reports.md) plugin. + +Create webpages --------------------- -You can use the [Simple Pages](../Plugins/SimplePages.md) plugin to create web pages for publishing an essay, to add an About or Credits page, to share copyright or access statements, or to build a general web presence for your organization. Any of those pages can become part of the main navigation for your website. +You can use the [Simple Pages](../Plugins/SimplePages.md) plugin to create web pages for publishing press releases, to add an About or Credits page, to share copyright or access statements, or to build a general web presence for your organization. Any of those pages can become part of the main navigation for your website. Note that the Simple Pages plugin comes packaged with the basic installation of Omeka Classic. A Simple Page does not require items or programming knowledge to build, but users can add HTML markup, PHP code, or embedded multimedia objects. -Try Omeka Classic Before Installing +Try Omeka Classic before installing --- If you would like to try Omeka Classic before installing on your own server, consider signing up for a free trial account at @@ -79,4 +101,4 @@ If you would like to try Omeka Classic before installing on your own server, con [Omeka.net](http://www.omeka.net/){target=_blank} is our Omeka Classic hosting service that allows anyone with an account to create or collaborate on a website to display collections and build digital exhibitions. With a [free trial account](https://info.omeka.net/signup/){target=_blank}, you can experience Omeka Classic’s administrative dashboard and try out 8 of the most popular plugins, including Exhibit Builder and Simple Pages. -For a comparison of the features of a hosted account at [Omeka.net](http://www.omeka.net/){target=_blank} and an installation on your own servers, see the [Omeka.net About page](http://info.omeka.net/about/). +For a comparison of the features of a hosted account at [Omeka.net](http://www.omeka.net/){target=_blank} and an installation on your own servers, see the [Omeka.net About page](http://info.omeka.net/about/). \ No newline at end of file diff --git a/docs/Installation/Configuring_Language.md b/docs/Installation/Configuring_Language.md index 8360e67..bf89e81 100644 --- a/docs/Installation/Configuring_Language.md +++ b/docs/Installation/Configuring_Language.md @@ -1,6 +1,8 @@ # Configuring Language -Open the `config.ini` file found in the folder `{omeka-root}/application/config` in a text editor. +Omeka is designed so that all of the interface strings in the administrative and public sides can be translated using [Transifex](https://www.transifex.com){target=_blank}. + +To have Omeka translate strings into another language where available, open the `config.ini` file found in the folder `your-omeka-installation/application/config` in a text editor. Look for the "Localization" section (at the top), and the line in it that reads: @@ -19,6 +21,8 @@ Omeka Classic is [translated](../Technical/Translate_Omeka.md) collaboratively u ## Available languages and codes Below are the languages in which Omeka is available (for at least 5% of the interface), along with the two- or four-letter codes that you will need to configure Omeka to use your chosen language. +Note that the percentage of the interface to translate includes all Omeka-Team-authored modules, many of which may not be applicable to your use. + *Last updated: May 17th, 2022.* Language | Code diff --git a/docs/Installation/Installing.md b/docs/Installation/Installing.md index 712f043..7cd6892 100644 --- a/docs/Installation/Installing.md +++ b/docs/Installation/Installing.md @@ -1,9 +1,9 @@ -# Installation +# Installing -## Preparing to Install -Before installing Omeka Classic, make sure your web server meets our basic [system requirements](System_Requirements.md). These are standard requirements that are available with many web hosting services. Once these requirements are met, all you need to do is install the Omeka software. +## Preparing to install +Before installing Omeka Classic, make sure your web server meets our [system requirements](System_Requirements.md). These are standard requirements that are available with many web hosting services. Check the dependencies of your intended plugins. Once these requirements are met, all you need to do is install the Omeka software. -7 Easy Installation Steps +Easy installation steps ----------- !!! note @@ -23,7 +23,7 @@ Before installing Omeka Classic, make sure your web server meets our basic [syst - Save the .zip file somewhere you can find it again, such as your Download folder. Double-click the .zip file to extract the files in the .zip archive, and make sure to note where the files are extracted. - If you are unable to extract the files, you might need to download an extraction program such as [WinZip](https://www.winzip.com/){target=_blank} or [WinRAR](https://www.win-rar.com/){target=_blank} (for Windows) or [Stuffit Expander](https://stuffit.com/){target=_blank} (for Mac and Windows). - The extracted (uncompressed) directory will have a name similar to `omeka-0.0.0` that includes the version number. - - Users familiar with Git might want to clone the latest code from [our public GitHub repository](http://github.com/omeka/Omeka){target=_blank}. + - Users familiar with Git might instead want to clone the latest code from [our public GitHub repository](http://github.com/omeka/Omeka){target=_blank}. 1. In the directory created by the extraction process, find and open your database configuration file, named `db.ini`. **Replace the 'XXXXX' values in the `db.ini` file** with your MySQL database host, database name, username, and password. @@ -31,36 +31,41 @@ Before installing Omeka Classic, make sure your web server meets our basic [syst - Do not change the values for `prefix` and `port` in the `db.ini` file. - See the [Database Configuration File page](../Technical/DatabaseConfigurationFile.md) for an explanation of each element in the `db.ini` file. +1. **Rename the directory** before you upload it, to give your Omeka installation a URL that is relevant to your project. You can also rename the directory after it is uploaded. + - This directory name will appear in the web URL of your site, as in, "yourinstitution.org/omeka" or "yourinstitution.org/archives" or "yourinstitution.org/exhibits". + 1. **Upload the directory** and all of its contents, including the updated `db.ini` file, to your server. - You can use a file transfer program such as Filezilla or FireFTP to transfer the contents of the directory to your server. This may take some time. Be sure to upload the directory with the edited file, not the original .zip file. - Make sure the `.htaccess` file that's in the top-level directory gets uploaded. This file is hidden by default in many file transfer programs; to see the `.htaccess` file, you may need to change the preferences in your file transfer program. - If you have command-line access to your server, you can re-compress a directory with the updated file, upload it, and extract it on the server. - - Rename the directory before or after you upload it, to **give your Omeka installation a URL that is relevant to your project**. 1. **Make Omeka's file-storage directory and its sub-directories writable by the web server.** - For Omeka 1.5.3, the directory is called `archive`. - For Omeka 2.0+, the directory is called `files`. - Follow the directions on the [Setting Directory Permissions page](Setting_Directory_Permissions.md). You can set the permissions with your file transfer program, or with shell commands over SSH. If you're not sure what to do, ask your hosting provider for advice, or to change the permissions for you. -1. Open your web browser and **visit the URL** where you uploaded the Omeka directory. Click "Install." +1. Open your web browser and **visit the URL** where you uploaded the Omeka directory. **Click "Install"** on the screen displayed there. - If you renamed the Omeka directory `collections` and put it in the top-most directory of your site, for instance, the URL to visit would be `https://youromekadomain.org/collections`. 1. **Complete the installation form** by filling out the required fields, including the name of your Omeka site, email address, and username/password of the super user (the super user account controls the entire website). - - You can change these settings in [General Settings](../Admin/Settings/index.md) once the installation is complete. + - You can change these settings in the [General Settings](../Admin/Settings/index.md) once the installation is complete. - You can leave fields that are already filled in as they are; you do not need to change the values. -If the installation was **successful**, you'll see a screen with links to view the live site or to log in with the superuser's username and password to the administrative panel at `https://youromekadomain.org/collections/admin`. Congratulations! +If the installation was **successful**, you'll see a screen with links to view the live site or to log in (with the superuser's username and password) to the administrative panel at `/admin`. Congratulations! + +!!! note + Note that the basic Omeka Classic installation comes packaged with three plugins - Exhibit Builder, Simple Pages, and COinS - and three themes - Default, Seasons, and Berlin. You do not need to download and install these add-ons separately after installing Omeka Classic. ## Troubleshooting If your installation was **unsuccessful**, try these steps: -- Make sure that the `.htaccess` file mentioned above was successfully uploaded. (For Omeka 1.3.1 and earlier, there are two `.htaccess` files: one in the root directory and one in the "admin" directory.) -- If the `.htaccess` file was successfully uploaded but your installation is still unsuccessful, make sure that the information in the `db.ini` file on the server is correct. +- Make sure that the `.htaccess` file mentioned above was successfully uploaded. (For Omeka 1.3.1 and earlier, there are two `.htaccess` files: one in the root directory and one in the `/admin` directory.) +- If the `.htaccess` file was successfully uploaded, make sure that the information in the `db.ini` file on the server is correct. - If your installation is still unsuccessful, try deleting the entire Omeka directory from your server and reuploading it. One or more files might have failed to upload. -- If the installation is apparently successful, but you are unable to upload items through the administrative interface, make sure that you correctly followed the instructions in step 6 above. Your web server *must* have write access to the file-storage directory for you to upload files. -- If the installation is successful, but you are getting "File not found" errors when you navigate to addresses such as `https://youromekadomain.org/collections/admin`, you probably have a conflict with another CMS such as WordPress on the same server. To fix this issue, you probably need to enable the "RewriteBase" line in your `.htaccess` file. +- If the installation is apparently successful, but you are unable to upload items through the administrative interface, make sure that you correctly followed the instructions in step 6 above. Your web server **must** have write access to the file-storage directory for you to upload files. +- If the installation is successful, but you are getting "File not found" errors when you navigate to addresses such as `https://youromekadomain.org/collections/admin`, you may have a conflict with another CMS such as WordPress on the same server. To fix this issue, you probably need to enable the "RewriteBase" line in your `.htaccess` file. - If you still have issues, please consult the [Troubleshooting Omeka](../Troubleshooting/index.md) page or post your issue on the [forum](https://forum.omeka.org/c/omeka-classic/7){target=_blank}. diff --git a/docs/Installation/Setting_Directory_Permissions.md b/docs/Installation/Setting_Directory_Permissions.md index b158f67..2e4a55a 100644 --- a/docs/Installation/Setting_Directory_Permissions.md +++ b/docs/Installation/Setting_Directory_Permissions.md @@ -1,6 +1,6 @@ # Setting Directory Permissions -One of the steps in Omeka's [installation](Installing.md) process is setting the correct permissions on the `files` directory (`archive` in older versions of Omeka). The necessary process for setting permissions can differ significantly between different servers, so it's often best to get specific advice from your hosting provider. This page tries to provide some more general guidance. +One of the steps in Omeka's [installation](Installing.md) process is setting the correct permissions on the `/files` directory (`/archive` in older versions of Omeka). The necessary process for setting permissions can differ significantly between different servers, so it's often best to get specific advice from your hosting provider. This page tries to provide some more general guidance. The user running the Omeka web process needs **read**, **write**, and **execute** permissions for the file-storage directory and all its subdirectories. @@ -33,18 +33,21 @@ Though it's generally not necessary, you can grant these permissions with this s chmod -R 755 files ``` -Group Access +Group access -------------------------------------------------------------- For many other servers, the best option is often to set the directories to a group that Apache belongs to, and then give the group write access to the directories. This option takes a few steps. 1. Find the correct group to use. Groups vary from server to server, but some common correct groups are `www-data` (the default on Ubuntu and Debian) and `apache` (the default on CentOS). Your host (or distribution if you run your own server) can tell you the right group to use. -2. Then, set the group for the files directory and all subdirectories. On the shell, you can use this command (where `group-name` is the correct group you just found): +2. Then, set the group for the files directory and all subdirectories. On the shell, you can use this command (where `group-name` is the correct group you just found): + ```chgrp -R group-name files``` + 3. Finally, grant read, write, and execute permissions to the **user** and **group** for the files directory and all subdirectories. On the shell, you can use this command: + ```chmod -R 775 files``` -World Access +World access ----------------------------------------------------- **This is the least secure option. Especially if you are using shared hosting, ask your host for advice before choosing it.** diff --git a/docs/Installation/System_Requirements.md b/docs/Installation/System_Requirements.md index ce52523..cacb6ae 100644 --- a/docs/Installation/System_Requirements.md +++ b/docs/Installation/System_Requirements.md @@ -8,7 +8,7 @@ Omeka Classic has the following system requirements: - [PHP](http://www.php.net/){target=_blank} scripting language version 5.6 or higher (with mysqli and exif extensions installed) - [ImageMagick](http://www.imagemagick.org/script/index.php){target=_blank} image manipulation software (for resizing images). -## Upgrading Your System +## Upgrading your system If you need to upgrade your server to meet any of the Omeka system requirements, consult these resources: diff --git a/docs/Installation/Upgrading.md b/docs/Installation/Upgrading.md index 04301b7..8b195b0 100644 --- a/docs/Installation/Upgrading.md +++ b/docs/Installation/Upgrading.md @@ -6,23 +6,25 @@ In order to upgrade from a pre-2.0 version of Omeka Classic, you must be running at least 1.2.1. If you are running an earlier version of Omeka Classic, please first upgrade to [1.2.1](https://github.com/omeka/Omeka/tree/1.2.1){target=_blank}. You can then upgrade directly to the latest version of Omeka Classic. 1. Always **back up your database** in case something goes wrong during the upgrade. For instructions, see [Backing up an Omeka Database](../Technical/Backing_up_an_Omeka_Database.md). -1. **Deactivate your plugins** in Settings > Plugins of the administrative panel. +1. **Deactivate your plugins** in "Settings" > "Plugins" of the administrative panel. - Be careful not to *uninstall* the plugins, because you may lose data. See the instructions for [upgrading plugins](../Admin/Adding_and_Managing_Plugins.md) for more information. - Check to make sure your plugins are compatible with the version of Omeka you're upgrading to. Especially when moving from 1.x to 2.x, you may need to use updated versions of plugins instead of the old ones. -1. **Move your old Omeka Classic installation** out of the way. Either move the contents of the directory to somewhere else on your server, or transfer the files to your local computer. -1. **Download and unzip** the latest version of Omeka into the empty directory where your previous install of Omeka was located. - - If you download to your computer and then upload to the server, either see if you can unzip the folder on the server *or* make sure that hidden files are visible on your computer to ensure that all files are transferred. +1. **Move your old Omeka Classic installation** out of the way. Either move the contents of the directory to somewhere else on your server, or transfer the files to your computer. +1. **Download and unzip** the latest version of Omeka into the empty directory where your previous installation of Omeka was located. + - If you download to your computer and then upload to the server, either see if you can unzip the folder on the server *or* make sure that hidden files are visible on your computer, to ensure that all files are transferred. See the [instructions for Installing](Installing.md) for further information. 1. **Move or copy the following files and directories** from your old Omeka folder to the corresponding location in your new Omeka installation. If copying, make sure you keep all permissions the same as they were before: - - `db.ini` (in version 0.9, this was located in `application/config/db.ini`; since version 0.10 this has been relocated to the root of your installation.) + - `db.ini` + - In version 0.9, this was located in `application/config/db.ini`; since version 0.10 this has been relocated to the root of your installation. - `application/config/config.ini` if you have changed the language, the PHP path, or other settings - - `files/` (for versions below 2.0, the folder is instead named `archive/`) - - If you are upgrading from 1.x to 2.x, rename `archive` to `files`, and rename the `files/files` in the directory you just renamed to `files/original`. + - `files/` + - For versions below 2.0, the folder is instead named `archive/`. - Any themes or plugins you had installed. The bundled themes (Thanks Roy, Berlin, Seasons) and plugins (COinS, Exhibit Builder, Simple Pages) will already have been updated with Omeka, so don't move them back over. - - If you've modified any of Omeka's core files, you'll need to move those changes over too. Be careful with this and make your edits line by line, as the original file may have been changed in newer versions. + - If you've modified any of Omeka's core files, you'll need to move those changes over too. Be careful with this and make your edits line by line, rather than by copying files, as the original file may have been changed in newer versions. + - **If you are upgrading from 1.x to 2.x**: rename `archive` to `files`, and rename the `files/files` in the directory you just renamed to `files/original`. 1. Finally, you may need to **upgrade your database**. Go to your Omeka site's administrative panel in your web browser. - - To access your site's administrative panel after upgrading, go to `example.com/admin`. If a database upgrade is needed, you will not be able to access your site's dashboard from your site's home page, which will display the message, "Public site is unavailable until the upgrade completes." + - To access your site's administrative panel after upgrading, go to `example.com/admin`. If a database upgrade is needed, you will not be able to access your site's dashboard from your site's home page, which will display the message "Public site is unavailable until the upgrade completes." - If a database upgrade is needed, you'll automatically be redirected from your admin page to an upgrade page (`example.com/admin/upgrade`). Click "Upgrade" to update your database to reflect the new data model and finish the upgrade. - - For Omeka 1.2.1 and earlier only: Instead of redirecting, older Omeka versions will show an alert on your dashboard with a link to follow if the database needs to be upgraded. + - **For Omeka 1.2.1 and earlier only**: Instead of redirecting, older Omeka versions will show an alert on your dashboard with a link to follow if the database needs to be upgraded. - If you weren't redirected when you went to your administrative panel, then no database changes were required, so you're done! ## Troubleshooting an upgrade diff --git a/docs/Plugins/.DS_Store b/docs/Plugins/.DS_Store index 34f55e0..ebd6977 100644 Binary files a/docs/Plugins/.DS_Store and b/docs/Plugins/.DS_Store differ diff --git a/docs/Plugins/CSV_Import.md b/docs/Plugins/CSV_Import.md index 2465cff..1dcea5c 100644 --- a/docs/Plugins/CSV_Import.md +++ b/docs/Plugins/CSV_Import.md @@ -6,23 +6,25 @@ When using this plugin, if you plan to map to specific Item Type metadata fields The plugin has the following features: -- File importing: If you specify permanent file URLs in a column, the importer will download and attach a file to each created item. NB: file import only works for files hosted and publicly available online; you cannot import files from a local source (that is, your computer), or from a password-protected location. -- Tag imports: You may include tags in your CSV file and those words will be imported as tags. -- Undo Imports: The Undo option lets you delete all the files added in an import. -- Set custom delimiters: you now have the option to set separate delimiters for columns, files, tags, and elements. +- File importing: If you specify permanent file URLs in a column, the importer will download and attach a file to each created item. Note that file import only works for files hosted and publicly available online; you cannot import files from a local source (that is, your computer), or from a password-protected location. You may have difficulty importing files from a storage service such as Google Drive or Dropbox unless you can supply a stable URL to each file. +- Automap Column Names to Elements: If you supply column names in the format {ElementSetName}:{ElementName}, such as `Dublin Core:Description`, CSV Import will automatically map those recognized columns for you. This does not work for [Item Types](../Content/Item_Types.md), only [Element Sets](../Admin/Settings/Element_Sets.md). +- Tag imports: You may include [tags](../Content/Tags.md) in your CSV, and those words will be imported as tags, using a separator that you specify in the import process. +- Choose custom delimiters: Set separate delimiters for columns, tags, files, and elements. +- Undo imports: The "Undo" option lets you delete all the items and files added in an import. ## Preparing for CSV Import -The best option is usually to use spreadsheet software (Excel, Google Sheets, Numbers) to create and organize your data. These programs can export a spreadsheet into CSV format, and will handle all the necessary escaping and quoting for you. +The best option is usually to use spreadsheet software (Excel, Google Sheets, Numbers) to create and organize your data. These programs can export a spreadsheet into CSV format, and will handle all the necessary escaping and quoting for you. When a file is saved from Google Sheets, it will automatically be put into the UTF-8 character set necessary for CSV Import. However, if you're creating or editing your data by hand, there are a few things to keep in mind: -- You will need to normalize your data before importing. Check to be sure that the first row of your CSV file contains column names, and that every row has the same number of columns. -- Check to see if any of the text contains commas, and if it does surround that segment with double-quotes. Many spreadsheet programs will do this for you automatically. If you are using a spreadsheet program, check the CSV that is exported by opening it in a plain text editor to see if the double-quotes are being added automatically. -- You can specify a unique delimiter for columns, files, tags, and elements. Once you do, be sure to be consistent in formatting. +- You will need to normalize your data before importing. Check to be sure that the first row of your CSV file contains column names, and that every row has the same number of columns. Every column must have a unique name or you will see an error message. You can only have one header row; every row after the first row will be imported as an item. +- Many spreadsheet programs will automatically enclose CSV entries in double-quotes if they contain commas. If you are using a spreadsheet program, check the CSV that is exported by opening it in a plain-text editor to see if the double-quotes are being added automatically. If not, surround every cell containing a comma with double-quotes. +- You can specify a unique delimiter for columns, files, tags, and elements. Once you do, be sure to be consistent in formatting. - Remember, every row represents one item, and all items in the file must be the same item type. - Look over the [Dublin Core](../Content/Working_with_Dublin_Core.md) and [Item Type](../Content/Item_Types.md) metadata to be sure you can easily map the fields in your CSV file to the Omeka installation. Make any modifications in fields or types as necessary. - It is possible to import files housed in a digital repository by adding the URL to that specific file in a column representing a file. You may import more than one file per item, by comma separating the urls within a cell. You must use a permanent link for this step. +- Note that Omeka cannot accept metadata entries that include emojis. You will see the import process stop with and "Import Error" and the [`errors.log` file](../Troubleshooting/Retrieving_Error_Messages.md) will show "Incorrect string value". You may also see the process stop if PDF Text is enabled and has difficulty processing a PDF that has emojis. ## Importing @@ -36,55 +38,57 @@ To import, go to the CSV Import tab in the left navigation bar in the admin Dash **Step 1: Select File and Item Settings** -- Select a CSV file from your computer using the *Choose File* button. +- Select a CSV file from your computer using the "Choose File" button. - If using an export from an Omeka CSV report, click the next checkbox, which will override all of the following options. -- You can use *Automap Column Names to Elements* if you have formatted your column names as follows: "Element Set Name:Element Name", for example `Dublin Core:Title`. -- *Select Item Type* of the sheet to be imported. NB you can only import one item type at a time. -- You can also *Select Collection* to which to add the imported items. -- There are two checkboxes to make all of the imported items *Public* and/or *Featured* +- You can use "Automap Column Names to Elements" if you have formatted your column names as follows: "Element Set Name:Element Name", for example `Dublin Core:Title`. +- "Select Item Type" of the sheet to be imported. Note that you can only import one item type at a time. +- You can also "Select Collection" to which to add the imported items. You can only import to one collection at a time. +- There are two checkboxes to make all of the imported items "Public" and/or "Featured".   -- The next four fields are for those who are not using a standard csv for their data: - - If you are not using commas to separate your columns, enter the character you are using instead in the *Choose Column Delimiter* . Note: You may not use a tab or an empty space. - - If you have used a character other than a comma to separate tags within individual cells in your CSV file, you must indicate that in the *Choose Tag Delimiter* field. Note: You may not use a tab or an empty space. - - If you have used a character other than a comma to separate multiple URLs within a cell (if you are importing items from an outside repository, for example), indicate that in the *Choose File Delimiter* field. Note: You may not use a tab or an empty space. - - If any of your metadata fields has more than one element (if your item has more than one creator, for example), please tell the plugin what character you used to separate the elements. If you have more than one element in a a field but leave this blank, the plugin will treat the entire text block as one element. Note: You may not use a tab or an empty space. +- The next four fields are for those who are not using a standard CSV for their data: + - If you are not using commas to separate your columns, enter the character you are using instead in the "Choose Column Delimiter" field. Note: You may not use a tab or an empty space. + - If you have used a character other than a comma to separate tags within individual cells in your CSV file, you must indicate that in the "Choose Tag Delimiter" field. Note: You may not use a tab or an empty space. + - If you have used a character other than a comma to separate multiple URLs within a cell (if you are importing items from an outside repository, for example), indicate that in the "Choose File Delimiter" field. Note: You may not use a tab or an empty space. + - If any of your metadata fields has more than one element (if your item has more than one creator, for example), indicate what character you used to separate the elements. If you have more than one element in a a field but leave this blank, the plugin will treat the entire text block as one element. Note: You may not use a tab or an empty space. -Click the *Next* button once you have filled out the above options to your satisfaction. +Click the "Next" button once you have filled out the above options to your satisfaction. **Step 2: Map Columns to Elements, Tags, or Files** On this next screen, you will see a table which includes each of the Dublin Core fields in Omeka, the text from your CSV file that is designated for that field. The "Example from CSV file" column in the table shows the data from the first row of data in your CSV, after the column headings. For each row in the table (which corresponds to a column in your original CSV) you have the following options: -- *Map to Element*: Select an element (all of your element sets should be represented) to which to map the column. -- Click the *Use HTML* checkbox if this data includes HTML markup. -- Click the *Tags?* checkbox (and do not map to an element) to map this data as [tags](../Content/Tags.md) -- Click the *Files?* to map this data as a [file](../Content/Files.md) import. +- **Map to Element**: Select an element (all of your element sets should be represented) to which to map the column. +- Click the **Use HTML?** checkbox if this data includes HTML markup. +- Click the **Tags?** checkbox (and do not map to an element) to map this data as [tags](../Content/Tags.md) +- Click the **Files?** to map this data as a [file](../Content/Files.md) import. + +!!! note + Note that at this time you cannot use CSV Import to add location data for use by the [Geolocation plugin](Geolocation.md). Map pins can only be added manually. -  -Click the Import CSV File button to complete the import. +Click the "Import CSV File" button to complete the import. -You may check on the progress of your import using the Status tab. +You may check on the progress of your import using the "Status" tab. Undo an Import ---------------------------------------------------------------- To undo an import: -- Click on the CSV Import administrative tab. -- Click the Status tab. -- Click the Undo link for the Import you want to undo. This will delete all items for this import. +- Click on the "CSV Import" administrative tab. +- Click the "Status" tab. +- Click the "Undo Import" link for the import you want to undo. This will delete all items for this import. You can then "Clear History" to remove this line from the "Status" table. - + -If your import hangs without completing for an extended period but the link to undo the import does not appear, you can enter the link directly into your browser address bar according to the following example: `http://yourinstallurl/admin/csv-import/index/undo-import/id/idnumberforimport` +If your import hangs without completing for an extended period but the link to undo the import does not appear, you can enter the link directly into your browser address bar according to the following example: `http://yourinstallurl/admin/csv-import/index/undo-import/id/idnumberforimport`. -For example, if your Omeka instance was at the root of example.com and this was your 3rd CSV import, you would use +For example, if your Omeka installation was at the root of `example.com` and this was your third CSV import, you would use `http://example.com/admin/csv-import/index/undo-import/id/3`. You can hover over the links for previous or subsequent imports to deduce the Import ID. ## Troubleshooting @@ -92,7 +96,8 @@ For example, if your Omeka instance was at the root of example.com and this was If you are having trouble with a CSV consistently not importing, try checking for these common issues: - Are your jobs starting and not completing? You might need to [set the path for PHP](../Technical/Setting_PHP_Path.md) so that your system can perform the background process to make the items. -- Are your file links readable? Try copying and pasting them into the address bar of a browser to see if the link resolves with a file. If it does not, then that may be the issue. -- Check the encoding on your CSV file. It should be UTF-8 -- Open your CSV file with a different program than the one you created it with and make sure that every row has the same number of columns. +- Are your file links readable? Try copying and pasting them into the address bar of a browser to see if the link resolves with a file. +- Check the encoding on your CSV file. It should be UTF-8. Ensure there are no emojis. +- Open your CSV file with a different program than the one you created it with, and make sure that every row has the same number of columns. - Open your CSV file in a text editor and ensure that text blocks are contained in double quotes. +- Test an import with other plugins disabled. Some plugins, such as PDF Text, run when items are imported and can cause their own issues with the process. diff --git a/docs/Plugins/Coins.md b/docs/Plugins/Coins.md index 876dc64..24e7b44 100644 --- a/docs/Plugins/Coins.md +++ b/docs/Plugins/Coins.md @@ -1,6 +1,6 @@ # COinS -The [COinS plugin](https://omeka.org/classic/plugins/Coins/){target=_blank} embeds citation metadata into the pages of your Omeka Classic site for each item. COinS (ContextObjects in Spans) is "a simple, ad hoc community specification for publishing OpenURL references in HTML." +The [COinS plugin](https://omeka.org/classic/plugins/Coins/){target=_blank} embeds citation metadata into the pages of your Omeka Classic site for each item. COinS ([ContextObjects in Spans](https://en.wikipedia.org/wiki/COinS){target=_blank}) is "a simple, ad hoc community specification for publishing OpenURL references in HTML." When activated, the COinS plugin makes your items viewable to certain [online bibliographic tools such as Zotero](http://www.zotero.org/){target=_blank} by automatically embedding citation metadata in your website. This plugin facilitates online research and interoperability with other systems. @@ -22,5 +22,4 @@ To batch process the addition of multiple items to your Zotero library from an O  -After you've selected those items, click okay at the bottom of the dropdown menu and a notification at the bottom of the screen tells you the operation was successful. - +After you've selected those items, click "Okay" at the bottom of the dropdown menu and a notification at the bottom of the screen tells you the operation was successful. \ No newline at end of file diff --git a/docs/Plugins/CollectionTree.md b/docs/Plugins/CollectionTree.md index 4bba90f..46c648a 100644 --- a/docs/Plugins/CollectionTree.md +++ b/docs/Plugins/CollectionTree.md @@ -1,33 +1,36 @@ # Collection Tree -The [Collection Tree plugin](https://omeka.org/classic/plugins/CollectionTree/){target=_blank} allows Omeka Classic sites to have nested [collections](../Content/Collections.md). One collection can have at most one parent collection, but a collection may have zero or multiple child collections. +The [Collection Tree plugin](https://omeka.org/classic/plugins/CollectionTree/){target=_blank} allows Omeka Classic sites to have nested [collections](../Content/Collections.md). One collection can have at most one parent collection, but a collection may have zero or multiple child collections. This screencast includes information on how Collection Tree can modify your collections:Managing Collections in Omeka Classic from Omeka on Vimeo.
-Once you have [installed](../Admin/Adding_and_Managing_Plugins.md) Collection Tree, the plugin will create a tab on the left-hand navigation of the admin side of the site. This tab allows you to view your collection hierarchy. To create a child/parent relationship between collections (nest), you must edit the collection. +Once you have [installed](../Admin/Adding_and_Managing_Plugins.md) Collection Tree, the plugin will create a tab on the left-hand navigation of the admin side of the site. This tab allows you to view your collection hierarchy. To create a child/parent relationship between collections (that is, to nest one collection inside another), you must edit the collection. You can configure the plugin to adjust the display by checking the following options: -- Order alphabetically: This setting orders the Collection Tree alphabetically, but does not affect the order of the collections browse page. -- Browse root-level collections only: This setting limites the public collections browse page so it only includes root collections and does not show subcollections. -- Show subcollections items: This setting includes all of the items from the subcollections in the list of items on the root collections' show page. -- Expand search to include subcollection items by default: This setting expands the universe for a collection search to include the content of the subcollections. +**Order alphabetically**: This setting orders the Collection Tree alphabetically, but does not affect the order of the collections browse page. By default collections will be ordered by creation date, i.e. by collection ID. + +**Browse root-level collections only**: This setting limits the public collections browse page so it only includes top-level (parent) collections and does not show subcollections (any collections nested inside others). + +**Show subcollections items**: This setting includes all of the items from the subcollections in the list of items on the parent collections' show page. For example, a top-level collection with 10 items contains another collection that itself has 29 items. Check this to make the top-level collection appear to contain 39 items instead. + +**Expand search to include subcollection items by default**: This setting will mean that a search performed inside a top-level collection will also look through all the items of its subcollections.  -## Create a Collection Tree +## Create a collection tree You can only nest collections once you have at least two collections. To create a new child collection: 1. Go to the Collections tab on the left hand navigation of the admin dashboard. -1. Click the *Add a Collection* button -1. Add the metadata as needed -1. Go to the *Parent Collection* tab across the top of the Add Collection menu +1. Click the "Add a Collection" button. +1. Add the metadata as needed. +1. Go to the "Parent Collection" tab across the top of the Add Collection menu. 1. From the dropdown menu, select the parent collection for the current collection.  @@ -35,18 +38,19 @@ To create a new child collection: To nest an existing collection: 1. Go to the Collections tab on the left hand navigation of the admin dashboard. -1. Click *Edit* below the title of the collection you want to edit. -1. Go to the *Parent Collection* tab across the top of the Add Collection menu +1. Click "Edit" below the title of the collection you want to edit. +1. Go to the "Parent Collection" tab across the top of the Add Collection menu. 1. From the dropdown menu, select the parent collection for the current collection. -## Viewing Collection Trees +## Viewing collection trees To view your collection tree, select Collection Tree in the left Admin navigation available from the Dashboard.  -If you wish, you may make the Collection Tree's hierarchy viewable to the public, go to the Appearance tab in the top Admin navigation bar. Then, click on [Navigation](../Admin/Appearance/Navigation.md), and check or uncheck the Collection Page. +If you wish, you may make the Collection Tree's hierarchy viewable to the public by adding a page to your navigation. Go to the Appearance tab in the top Admin navigation bar. Then, click on [Navigation](../Admin/Appearance/Navigation.md), and check or uncheck the Collection page. This is what a sample public page looks like: +  diff --git a/docs/Plugins/Commenting.md b/docs/Plugins/Commenting.md index a37f058..db925a2 100644 --- a/docs/Plugins/Commenting.md +++ b/docs/Plugins/Commenting.md @@ -2,12 +2,11 @@ The [Commenting plugin](https://omeka.org/classic/plugins/Commenting/){target=_blank} allows site viewers to leave comments on items and collections in an Omeka Classic site. The plugin also permits administrators to moderate those comments. -It is also possible to add commenting to pages generated by plugins such as Exhibit Builder and Simple Pages. Please see the [instructions in the plugin's README file](https://github.com/omeka/plugin-Commenting#displaying-comments){target=_blank} for more information on how to do so. - +It is also possible to add commenting to pages generated by plugins, such as Exhibit Builder and Simple Pages. Please see the [instructions in the plugin's README file](https://github.com/omeka/plugin-Commenting#displaying-comments){target=_blank} for more information on how to do so. ## Configuring -Before you can use the Commenting plugin, you must activate and configure it from the Browse Plugins page. To configure, click the blue “Configure” button beside the plugin on the Browse Plugin page. You will be prompted to select your security, moderation, and commenting preferences. +After installing the Commenting plugin, you must configure it from the "Plugins" tab at the top of the dashboard. Click the blue “Configure” button beside the plugin name. You will be prompted to select your security, moderation, and commenting preferences.  @@ -17,21 +16,21 @@ The configuration options are: **Text for comments label**: If you wish to use a label other than “Comments,” you may enter the text here. If the field is empty, the section on the page will simply be called "Comments." -**Allow public commenting**: Check this box to allow anyone, including non-registered users, to make comments. +**Allow public commenting?**: Check this box to allow anyone, including non-registered users, to make comments. **User roles that can moderate comments**: Select at least one user role to moderate comments. The list will include all possible user roles, from admin to guest. -**User roles that can comment**: Select the user roles that can leave comments. The list will inlcude all possible user roles, from admin to guest, including all roles added by other plugins. +**User roles that can comment**: Select the user roles that can leave comments. The list will inlcude all possible user roles, from admin to guest, including all roles added by other plugins. You must select at least one of these options for the plugin to work, unless you have checked the "Allow public commenting" box above. -**User roles that require moderation before publishing**: Select the user roles that will require moderation before publication. If that role is selected as one that can moderate comments, the moderation permissions will override this setting. +**User roles that require moderation before publishing**: Select the user roles that will require moderation before publication. If that role is selected as one that can moderate comments, the moderation permissions will override this setting. -**Allow the public to view comments?** Unless this box is checked, comments will not be visible on public views. +**Allow the public to view comments?**: Unless this box is checked, comments will not be visible to logged-out users - they will only appear to logged-in users, both on the public pages and in the administrative dashboard. -**User roles that can view comments** This selection restricts the visibility of comments to designated roles. +**User roles that can view comments**: This selection restricts the visibility of comments to designated roles. **WordPress API key for Akismet**: If you are allowing public, unmoderated commenting and you have a WordPress account, you can use your [Akismet](http://akismet.com/){target=_blank} API key for spam management. You may use a key you are currently implementing on a blog or another site that collects public feedback, provided that that key is not site-specific in the key settings on the Akismet site. In addition to Akistmet, you may want to set up [reCAPTCHA](../Admin/Settings/ReCaptcha.md) for your Omeka site, found in the [Security Settings](../Admin/Settings/Security_Settings.md). -**New comment notification emails**: Use this field to enter the emails to which a notification of new comments should be sent. Enter one email per line. +**New Comment Notification Emails**: Use this field to enter the email(s) to which a notification of each new comment should be sent. Enter one email per line. ## Commenting @@ -39,7 +38,7 @@ On most themes, the fields for leaving a comment will appear below item metadata  -## Moderating Comments +## Moderating comments Administrators can moderate comments from the Comments tab on the left-hand menu of the admin view. @@ -52,21 +51,20 @@ Users with permission to moderate comments may: Comments display with the name of the user in bold at the top left of the comment. Just below that is the item on which the comment was left, which functions as a link to that item's public page, and the timestamp for the comment. The text of the comment displays on its own as a block. -To the right of comment are flags for its current status, and buttons which can be used to change the status or delete the comment. +Below each comment are flags for its current status, and buttons that can be used to change the status or delete the comment. -**Moderate Single Comment**: -Use the buttons to the right of the comment, click as needed to approve, flag, or delete the comment. +**Moderate Single Comment**: Using the buttons in each comment's row, click as needed to approve, flag, or delete the comment. **Batch Moderating**: You may also batch approve or unapprove and flag submissions. -1. Check the "Select All" box found just below the Comments heading, or select multiple comments from the list. using the checkboxes to the left of the comment. +1. Check the "Select All" box found just below the Comments heading, or select multiple comment checkboxes from the list. 2. Then select the appropriate status you wish to assign to all of the comments. -3. These changes will be automatically saved +3. These changes will be automatically saved. - + -### Filtering Comments -Use the dropdown at the top of the Comments page, next to the Flag buttons, to filter which comments display. +### Filtering comments +Use the "Quick Filter" dropdown at the top of the Comments page to filter which comments to display. You can filter by: @@ -76,12 +74,12 @@ You can filter by: - Spam - Not spam - Flagged -- Not flagged +- Not flagged. This is a quick way to find comments which have been flagged by users (see below) or those which need approval. Note that the Spam flag is set by Akismet. -## User Flagging +## User flagging Logged-in users may flag any comments they feel are inappropriate or may be spam. To do that, logged-in users should click the 'Flag Inappropriate" link for the comment in question: @@ -89,6 +87,6 @@ Logged-in users may flag any comments they feel are inappropriate or may be spam  -That comment will be flagged as potential spam and/or inappropriate. It will only be visible to users with permission to manage comments. From the public interface, users with permission to manage comments can simply unflag the comment if it is not acceptable. If further action is needed, those users can go to the admin interface to unapprove or delete the comment if it is indeed inappropriate, report it as spam, or unflag it if it not spam or inappropriate. +That comment will be flagged as potential spam and/or inappropriate. It will then only be visible to users with permission to manage comments. From the public interface, users with permission to manage comments can simply unflag the comment if it is acceptable. If further action is needed, those users can go to the admin interface to unapprove or delete the comment if it is indeed inappropriate, or report it as spam. Site builders might also consider defining and publishing a set of community standards so that everyone will have guidance about what is and is not considered inappropriate. diff --git a/docs/Plugins/Contribution.md b/docs/Plugins/Contribution.md index 5d9f273..2cb2e2f 100644 --- a/docs/Plugins/Contribution.md +++ b/docs/Plugins/Contribution.md @@ -1,8 +1,8 @@ # Contribution -The [Contribution plugin](https://omeka.org/classic/plugins/Contribution/){target=_blank} provides a form to collect stories, images, and other files from the public and manage those contributions in your Omeka Classic site as items. Contributors may share and upload content anonymously, and their information will only be available to site administrators. All contributions are private by default and require a site administrator to review and make them public on the Omeka site. +The [Contribution plugin](https://omeka.org/classic/plugins/Contribution/){target=_blank} provides a form to collect textual stories and media from the public and manage those contributions in your Omeka Classic site as items. Contributors may share and upload content anonymously, and their information will only be available to site administrators. All contributions are private by default and require a site administrator to review and make them public on the site. -The plugin can also automatically add a reCAPTCHA box at the bottom of each form to prevent spam-bots from spamming your website. Contribution also offers options for users to create guest accounts that make it easier for one user to submit multiple items. +The plugin can automatically add a reCAPTCHA box at the bottom of each form to prevent spam-bots from spamming your website. Contribution also offers options for users to create guest accounts, that make it easier for one user to submit multiple items. Other plugins can be integrated into the Contribution form, such as [Simple Vocab](SimpleVocab.md) for creating dropdown menu choices, and [Geolocation](Geolocation.md) for inviting users to map their submissions or locations. @@ -13,15 +13,12 @@ Watching the [screencast](https://vimeo.com/165200216){target=_blank} we createdOmeka Classic: Contribution Plugin from Omeka on Vimeo.
-An Omeka site with the Contribution plugin requires you to upload and install two separate plugins: - -- [Guest User](GuestUser.md) (required) -- Contribution (required) +Contribution requires you to upload and install the [Guest User](GuestUser.md) plugin. If you want to collect any information from your contributors, install these two additional plugins: - [Record Relations](RecordRelations.md) (optional, only required for collecting user information) -- [User Profiles](UserProfiles.md) (optional, only required for collecting user information) +- [User Profiles](UserProfiles.md) (optional, only required for collecting user information). ## Screencast @@ -30,7 +27,7 @@ Contribution is a somewhat complex plugin to set up. In addition to the written ## Installing !!! note - You must upload and [install](../Admin/Adding_and_Managing_Plugins.md) the Guest User plugin before installing and activating Contribution. If you have uploaded the other plugins first, you will see in the plugin directory that you cannot install other Contribution-related plugins until Guest User is installed first. + You must upload and [install](../Admin/Adding_and_Managing_Plugins.md) the [Guest User](GuestUser.md) plugin before installing and activating Contribution. If you have uploaded the other plugins first, you will see in the plugin directory that you cannot install other Contribution-related plugins until Guest User is installed first. ### Guest User configuration After installing the plugin, click the "Configure" button. For more information go to the [Guest User documentation](GuestUser.md). diff --git a/docs/Plugins/Geolocation.md b/docs/Plugins/Geolocation.md index 61d7e17..36855ba 100644 --- a/docs/Plugins/Geolocation.md +++ b/docs/Plugins/Geolocation.md @@ -7,12 +7,11 @@ There is a [screencast for Geolocation (version 2.2.4) demonstrating its basic fOmeka Classic: Geolocation Plugin from Omeka on Vimeo.
- ## Configuring Once you have [installed](../Admin/Adding_and_Managing_Plugins.md) the Geolocation plugin, go to the Plugins tab in the top navigation of your admin dashboard. Scroll down to the listing for Geolocation and click *Configure* (if you do not see Configure you may need to click the *Install* or *Activate* buttons. -### General Settings +### General settings The first section for configuration are the general settings for the appearance of your maps on the public and admin sides of your site.  @@ -33,7 +32,7 @@ You can use MapBox to create your own map tiles, for example a historic map laye  -### Browse Map Settings +### Browse Map settings These settings are for the map through which users can browse all geolocated items, and for the "Search by Address function" that Geolocation enables in advanced item search.  @@ -50,48 +49,54 @@ A map with Enable marker clusters unchecked: The same map with Enable marker clusters checked:  -### Item Map Settings -These settings are for the map display on an item/show page. +### Item map settings +These settings are for the map display on an `item/show` page.  -- *Width for Item Map*: set in percent; defaults to 100% if left blank. -- *Height for Item Map*: set in pixels; defaults to 300px if left blank. +- **Width for Item Map**: set in percent; defaults to 100% if left blank. +- **Height for Item Map**: set in pixels; defaults to 300px if left blank. -### Map Integration -These settings are for integration of the geolocation map into the site menu and the [contribution](Contribution.md) plugin's form. +### Map integration +These settings are for integration of the geolocation map into the site menu and the [Contribution](Contribution.md) plugin's form.  -- *Add link to map on Items/Browse navigation*: click to make active. -- *Add map to contribution form*: click to make active. Note that this will only work if you have the Contribution plugin installed and active. +- **Add link to map on Items/Browse navigation**: click to make active. +- **Add map to contribution form**: click to make active. Note that this will only work if you have the Contribution plugin installed and active. -Adding Location to an Item +Adding location to an item ---------------------------------------------------------------- -After you have activated and configured the Geolocation plugin, you can add a location marker to your items. Note: an item can only have a single location marker; you cannot have an item associated with more than one location at a time. +After you have activated and configured the Geolocation plugin, you can add a location marker to your items. + +!!! note + An item can only have a single location marker; you cannot have an item associated with more than one location at a time. Geolocation adds a Map tab to the options for adding or editing an item (`admin/item/edit` and `admin/item/add` pages). When adding metadata for an item, click on the Map tab to add a location.  -On the tab there is a field for you to *find a location by address* and a map which you can drag to move around, zoom in and out with the plus and minus options (or the scroll wheel on a mouse), and toggle between road and satellite maps. +On the tab there is a field for you to **find a location by address** and a map which you can drag to move around, zoom in and out with the plus and minus options (or the scroll wheel on a mouse), and toggle between road and satellite maps. To find the location you want to assign to the item, you can: - Enter the address where you want the marker for the item to be placed. The plugin will automatically add a marker at that location. You can use a street address (ex `100 First St SE, Washington, DC 20543`) or geocordinates in decimal form (ex `38.888611, -77.004722`). - Zoom and scroll to navigate to where you want to place the marker, then click directly on the spot on the map where you want to place the marker. -To change the location of an item, type in the new address or click on the new location. You'll be asked if you are sure you would like to change the item location. Select OK or Cancel. +To change the location of an item, type in the new address or click on the new location. You'll be asked if you are sure you would like to change the item location. Select "OK" or "Cancel". To remove geolocation from an item, click directly on the marker. A dialog box will ask you to confirm that you want to delete the location assignment. +!!! note + Note that at this time you cannot use [CSV Import](CSV_Import.md) to add location data for use by the Geolocation plugin. Map pins can only be added manually. + Don't forget to save your changes. -## Viewing Items on the Public Map +## Viewing items on the public map Visitors to your Omeka site may use a map to browse through all of your geolocated items. -When configuring the plugin, if you selected "Add Link to Map on Items/Browse Navigation," a "Browse Map" link will be added automatically to the secondary navigation on the items/browse page. +When configuring the plugin, if you selected "Add Link to Map on Items/Browse Navigation," a "Browse Map" link will be added automatically to the secondary navigation on the `items/browse` page.  @@ -99,9 +104,9 @@ From this view, visitors may browse all mapped items, browse by tag, search for They may also locate a mapped item by clicking on the items listed in the right column of the map. -## Browse and Search Items on Admin Map +## Browse and search items on the admin map -A Map tab appears in the left navigation bar located on the left side of the Dashboard. Clicking on the Map tab takes you to a map that displays all items geolocated in your Omeka site--public and not public, and an advanced search form to locate specific items. +A "Map" tab appears in the left navigation bar located on the left side of the dashboard. Clicking on the Map tab takes you to a map that displays all geolocated items in your Omeka site, public and not public, and an advanced search form to locate specific items.  diff --git a/docs/Plugins/GuestUser.md b/docs/Plugins/GuestUser.md index 1147af1..9bf3b08 100644 --- a/docs/Plugins/GuestUser.md +++ b/docs/Plugins/GuestUser.md @@ -1,41 +1,51 @@ # Guest User -The [Guest User plugin](https://omeka.org/classic/plugins/GuestUser/){target=_blank} adds an additional user role to your Omeka Classic site. The Guest role works behind the scenes with other plugins (Commenting, and User Profiles, for example), without giving the guests admin access to your Omeka site. +The [Guest User plugin](https://omeka.org/classic/plugins/GuestUser/){target=_blank} adds an additional, low-permission user role to your Omeka Classic site. The Guest role is used behind-the-scenes by other plugins ([Contribution](Contribution.md), [Commenting](Commenting.md), and [User Profiles](UserProfiles.md), for example), without giving the guests administrative access to your Omeka site. -## Install and Configure +## Install and configure -After [installing](../Admin/Adding_and_Managing_Plugins.md) the plugin, you should be automatically redirected to the configuration settings for the plugin. You can access these again at any time by clicking the Configure button for Guest User from the Plugins menu. +When active, Guest User adds an always-visible bar to the top of your Omeka site that includes "Login" and "Register" links. Without this plugin, the [basic suite of users](../Admin/Users.md) can only log in your Omeka site using the `admin/users/login` page. + + + +After [installing](../Admin/Adding_and_Managing_Plugins.md) the plugin, you should be automatically redirected to the configuration settings for the plugin. You can configure the registration page here. You can access this page again at any time by clicking the "Configure" button for Guest User from the Plugins menu. You can enter text for the following fields: -- Registration Features: this text will appear at the top of the registration page. You can use it to explain what users are signing up to do, and what the limitations may be. +- Registration Features: this text will appear at the top of the registration page. You can use it to explain what users are signing up to do, and what the limitations may be. We recommend you customize this based on the other plugins you have chosen to use - Commenting on items, Contribution to submit stories and materials, etc. - Short Registration Features: brief text appearing as a dropdown from the user bar. - Dashboard Label: By default, this is "My Account" and will appear when the user is logged in. -- Login Text: What is displayed for the login button, defaults to Login. -- Register Text: What is displayed for the Register link, defaults to Register. +- Login Text: the text displayed for the login button; defaults to "Login". +- Register Text: the text displayed for the Register link; defaults to "Register".  There are also two checkboxes: -- Allow open registration to allow individuals to register without administrators approving their accounts. -- Allow instant access enables new users to access their accounts for 20 minutes after registering without administrator approval. +- "Allow open registration", so that users can register and begin contributing without waiting for administrators to approve their accounts. +- "Allow instant access", so that new users can use their accounts for 20 minutes after registering, without administrator approval.  If you have [ReCaptcha enabled](../Admin/Settings/ReCaptcha.md), you can require a ReCaptcha key for registration. -## Using the Plugin +## Using the plugin + +Guest User adds a registration page and a user-access bar to your public site. Most other functionality is seen in additional plugins that you will install. You will have to do additional configuration within other plugins (User Profiles, for instance) to realize the full benefits of the Guest User plugin. + +### The header bar + +When you activate Guest User, it adds a header bar with "Login" and "Register" links to the public site. -It is important to note that almost all the functionality of the will be with other plugins; Guest user does not do much on its own. You will have to do additional configuration within other plugins (User Profiles, for instance) to realize the full benefits of the Guest User plugin. +When a user is logged in, their display name appears in this bar, alongside a "Log out" link. When the display name is hovered over, a dropdown menu appears with "My account" and other entries added by plugins (such as "My contributions" from the Contribution plugin). -## Hiding the Header + -When you activate Guest User, it adds a header bar with Login and Register links to the public side of your site. If you want to hide this header bar, you will need to edit the code of the plugin. +If you want to hide this header bar, you will need to edit the code of the plugin. -From your file manager, go to the folder for the Omeka Site, then to the plugins folder and open the GuestUser folder. +From your file manager, go to the folder for the Omeka installation, then to the `plugins` folder, and open the `GuestUser` folder. -Open the file named “GuestUser.php” using a plain text editor suitable for writing and editing code. +Open the file named “GuestUser.php” using a plain-text editor suitable for writing and editing code. Comment out lines 24 and 25 . Commenting out uses `/*` and the end result should look like this: @@ -47,7 +57,7 @@ protected $_filters = array( This will remove the general login/register links which are as follows: -- Login: yoursiteurl/users/login -- Register: yoursiteurl/guest-user/user/register +- Login: `yoursiteurl/users/login` +- Register: `yoursiteurl/guest-user/user/register` -You might want to hard code those into a Simple Page or preserve the links somewhere else on your site. +If you remove the header bar, you will want to preserve and share the links somewhere else on your site. Consider your footer text, or on a dedicated Simple Page. diff --git a/docs/Plugins/ItemOrder.md b/docs/Plugins/ItemOrder.md index b6c03e7..15378e1 100644 --- a/docs/Plugins/ItemOrder.md +++ b/docs/Plugins/ItemOrder.md @@ -1,32 +1,34 @@ # Item Order -The [Item Order plugin](https://omeka.org/classic/plugins/ItemOrder/){target=_blank} allows users to use a drag-and-drop interface change the order in which items display on the public Collection browse pages of your Omeka Classic site. +The [Item Order plugin](https://omeka.org/classic/plugins/ItemOrder/){target=_blank} allows users to use a drag-and-drop interface change the order in which items display on the public Collection browse pages of your Omeka Classic site. It adds a new section to collection information pages in the administrative dashboard, where items can be manually rearranged. This screencast includes information on how Item Order can modify your item displays:Managing Collections in Omeka Classic from Omeka on Vimeo.
-## Order Items in a Collection +## Order items in a collection Item Order does not have any configuration settings, and will be available once [installed](../Admin/Adding_and_Managing_Plugins.md) and activated. -To use Item Order, go to the Collections tab in the sidebar of the admin Dashboard. Find the collection whose items you want to reorder and click on the name of the collection (note: do not click on edit). +To use Item Order, go to the Collections tab in the sidebar of the admin dashboard. Find the collection whose items you want to reorder and click on the name of the collection (do not click on "Edit"). -On the collections page (`admin/collections/show/`), scroll to the bottom of the page where you will find the heading Item Order. Click the link to *Order Items in this Collection*. +On the collections page (`admin/collections/show/`), scroll to the bottom of the page where you will find the heading "Item Order". Click the link to "Order items in this collection."  A complete list of all items in that collection will appear on the page. Drag and drop the items into the preferred order. Changes are saved automatically. -- Dragging automatically reorders the items for the public collection browse page. To see the public page, either click the link that states *click here to return to the collection show page* and then click on "View Public Page", or navigate to `yoursite.org/items/browse?collection=1` (where 1 equals the number of the collection you modified). +Dragging automatically reorders the items for the public collection browse page. + +To see the public page, either click the link that states "**Click here** to return to the collection show page" and then click on "View Public Page", or navigate to `yoursite.org/items/browse?collection=1` (where 1 equals the number of the collection you modified).  -## Restore Original Order +### Restore original order -Click the Collections tab in the sidebar of the admin Dashboard, find the collection you want to order and click on the name of the collection (note: do not edit the collection). +Click the Collections tab in the sidebar of the admin dashboard, find the collection you want to order and click on the name of the collection. -- Scroll to the bottom of the page to the heading Item Order and click the green *Reset Items to their Default Order* button. +Then, scroll to the bottom of the page to the heading "Item Order" and click the "Reset Items to their default order" button.  diff --git a/docs/Plugins/ItemRelations.md b/docs/Plugins/ItemRelations.md index 6091865..47c41e1 100644 --- a/docs/Plugins/ItemRelations.md +++ b/docs/Plugins/ItemRelations.md @@ -2,7 +2,7 @@ The [Item Relations plugin](https://omeka.org/classic/plugins/ItemRelations/){target=_blank} lets you define relations between items in your Omeka Classic site. For example, you can make one item a part of another item, where "part of" is the relation. You can also make one item a "reproduction of" or a "translation of" another item. -We've bundled the plugin with common relations derived from several formal vocabularies, including: +The plugin comes bundled with common relations derived from several formal vocabularies, including: - [Dublin Core](http://dublincore.org/documents/dcmi-terms/){target=_blank} - [FRBR](http://vocab.org/frbr/core.html){target=_blank} @@ -17,40 +17,93 @@ After you have [installed](../Admin/Adding_and_Managing_Plugins.md) the plugin, There are two configuration options: -- A checkbox to *Append to Public Items Show*. If you want to display an item's relations on its public show page, check this box. -- A dropdown menu from which you can select the format of an item's relations as it appears on the item's show page. The options are: - - prefix:localPart - - label given to the relationship. +- **Append to Public Items Show**: A checkbox to indicate if you want to display an item's relations on its public page. +- **Relation Format**: A dropdown menu, if the above is checked, to control the display of an item's relations as it appears on the item's show page. The options are: + - **prefix:localPart**: The machine-readable name of the metadata field, as in "dcterms:HasPart" + - **label**: the humean-readable name of the metadata field, as in "Has part".  -## Customize Relationship Vocabulary +## View vocabularies -On the "Item Relations" tab in the left side of the admin navigation you will find the vocabularies available and their properties (a more general term for relations). - -If you wish to create your own vocabulary, edit the "Custom" vocabulary by clicking on "Edit Custom Vocabulary" in its property show page. Here you can add, edit, and delete properties in your custom vocabulary. +On the "Item Relations" tab in the left side of the admin navigation you will find the vocabularies available and their properties.  -## Relating Items - -When adding or editing an item, click on the "Item Relations" tab, at the top of the admin/item page to relate the item to another item, or to delete existing relations. - -This tab has a table with columns for +For example, the Dublin Core properties provided for you to set relationships are: + +| Local Part | Label | Description | +|-------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| relation | Relation | A related resource. | +| conformsTo | Conforms To | An established standard to which the described resource conforms. | +| hasFormat | Has Format | A related resource that is substantially the same as the pre-existing described resource, but in another format. | +| hasPart | Has Part | A related resource that is included either physically or logically in the described resource. | +| hasVersion | Has Version | A related resource that is a version, edition, or adaptation of the described resource. | +| isFormatOf | Is Format Of | A related resource that is substantially the same as the described resource, but in another format. | +| isPartOf | Is Part Of | A related resource in which the described resource is physically or logically included. | +| isReferencedBy | Is Referenced By | A related resource that references, cites, or otherwise points to the described resource. | +| isReplacedBy | Is Replaced By | A related resource that supplants, displaces, or supersedes the described resource. | +| isRequiredBy | Is Required By | A related resource that requires the described resource to support its function, delivery, or coherence. | +| isVersionOf | Is Version Of | A related resource of which the described resource is a version, edition, or adaptation. | +| references | References | A related resource that is referenced, cited, or otherwise pointed to by the described resource. | +| replaces | Replaces | A related resource that is supplanted, displaced, or superseded by the described resource. | +| requires | Requires | A related resource that is required by the described resource to support its function, delivery, or coherence. | +| source | Source | A related resource from which the described resource is derived. | +| abstract | Abstract | A summary of the resource. | +| accessRights | Access Rights | Information about who can access the resource or an indication of its security status. | +| accrualMethod | Accrual Method | The method by which items are added to a collection. | +| accrualPeriodicity | Accrual Periodicity | The frequency with which items are added to a collection. | +| accrualPolicy | Accrual Policy | The policy governing the addition of items to a collection. | +| audience | Audience | A class of entity for whom the resource is intended or useful. | +| contributor | Contributor | An entity responsible for making contributions to the resource. | +| coverage | Coverage | The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant. | +| creator | Creator | An entity primarily responsible for making the resource. | +| description | Description | An account of the resource. | +| educationLevel | Audience Education Level | A class of entity, defined in terms of progression through an educational or training context, for which the described resource is intended. | +| extent | Extent | The size or duration of the resource. | +| format | Format | The file format, physical medium, or dimensions of the resource. | +| instructionalMethod | Instructional Method | A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. | +| language | Language | A language of the resource. | +| license | License | A legal document giving official permission to do something with the resource. | +| mediator | Mediator | An entity that mediates access to the resource and for whom the resource is intended or useful. | +| medium | Medium | The material or physical carrier of the resource. | +| provenance | Provenance | A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. | +| publisher | Publisher | An entity responsible for making the resource available. | +| rights | Rights | Information about rights held in and over the resource. | +| rightsHolder | Rights Holder | A person or organization owning or managing rights over the resource. | +| spatial | Spatial Coverage | Spatial characteristics of the resource. | +| subject | Subject | The topic of the resource. | +| tableOfContents | Table Of Contents | A list of subunits of the resource. | +| temporal | Temporal Coverage | Temporal characteristics of the resource. | +| type | Type | The nature or genre of the resource. + +### Add custom properties + +If you wish to create your own vocabulary, edit the "Custom" vocabulary by clicking on its name, then the "Edit Vocabulary" button on its "Vocabulary Properties" page. + +Here you can add, edit, and delete properties in your custom vocabulary. You can provide a label and a description for each property. This custom vocabulary will not show on the "Element sets" or other vocabulary tabs in your installation; it is only used for relationships. + + + +## Link items + +When adding or editing an item, click on the "Item Relations" tab, at the top of the item editing page, to relate the item to another item, or to delete existing relations. + +This tab has a table with columns for: - the subject of the relation (always the item being edited), -- the relation between items (a dropdown populated with all available vocabularies), +- the relation between items (a dropdown populated with all available vocabulary properties), - the object of the relationship (the item with which you are creating the relationship), and -- a delete option once a relationship has been created. +- a checkbox to delete a relationship, once it has been created and the page has been saved. -In order to relate two items, you will need to select the relationship from the dropdown and enter the item ID of the object-item. The ID is the item number - in the image below, the item number is displayed before the title of the item, and is 2558. +In order to relate two items, you will need to select the relationship from the dropdown and enter the item ID of the object-item. The ID is the item number, found in the item's URL on the admin or public pages. In the image below, the item number is displayed before the title of the item, and is 329.  -You may batch relate items using the Batch Edit function from the Browse Items pages in the admin. +You may batch-relate items using the "Batch Edit" function from the "Browse Items" pages in the admin. ## Item Relations and RDF -The plugin follows the [RDF](http://en.wikipedia.org/wiki/Resource_Description_Framework){target=_blank} model for defining relations between items. There's a subject item, a predicate (a relation/property in this case), and an object item. If we decompose the sentence: "Item 1 is a part of Item 2," "Item 1" is the subject, "is a part of" is the predicate, and "Item 2" is the object. These "triples" are the foundation of RDF. Your end users won't have to know this, but it's helpful to know it as an administrator. +The plugin follows the [RDF](http://en.wikipedia.org/wiki/Resource_Description_Framework){target=_blank} model for defining relations between items. The RDF model consists of a subject item, a predicate (a relation/property in this case), and an object item. If we decompose the sentence: "Item 1 is a part of Item 2," "Item 1" is the subject, "is a part of" is the predicate, and "Item 2" is the object. These "triples" are the foundation of RDF. -Following RDF, every formal vocabulary has a namespace prefix and namespace URI, which provide unambiguous context for its relations/properties. Every property has a local part and/or label, which are machine-readable and human-readable names of the property, respectively. As an administrator you'll only need to create labels, everything else is there for XML and RDFS compliance, to be used for future output formats. \ No newline at end of file +Following RDF, every formal vocabulary has a namespace prefix and namespace URI, which provide unambiguous context for its relations/properties. Every property has a local part and/or label, which are machine-readable and human-readable names of the property, respectively. As an administrator, you'll only need to create labels; everything else is there for XML and RDF compliance, to be used for future output formats. \ No newline at end of file diff --git a/docs/Plugins/Library_of_Congress_Suggest.md b/docs/Plugins/Library_of_Congress_Suggest.md index a4cc3d1..0976e04 100644 --- a/docs/Plugins/Library_of_Congress_Suggest.md +++ b/docs/Plugins/Library_of_Congress_Suggest.md @@ -1,26 +1,32 @@ # Library of Congress Suggest -The [LC Suggest plugin](https://omeka.org/classic/plugins/LcSuggest/){target=_blank} adds an auto-complete feature to almost any metadata field in your Omeka Classic site by pulling results from Library of Congress's list of authorities and controlled vocabularies. This functionality helps those building an Omeka site to enforce consistent metadata input and data compatibility with other databases of records. +The [LC Suggest plugin](https://omeka.org/classic/plugins/LcSuggest/){target=_blank} adds an auto-complete feature to almost any metadata field in your Omeka Classic site by pulling results from the Library of Congress's list of authorities and controlled vocabularies. This functionality helps those building an Omeka site to enforce consistent metadata input and data compatibility with other databases of records. -The plugin does not require configuration. After [installing](../Admin/Adding_and_Managing_Plugins.md) the plugin, there should be a LC Suggest tab on the left hand navigation of your admin dashboard. +The plugin does not require configuration. After [installing](../Admin/Adding_and_Managing_Plugins.md) the plugin, there should be a LC Suggest tab on the left-hand navigation of your admin dashboard. -## Choosing Vocabularies +## Create associations -The Library of Congress maintains an Authorities and Vocabularies service that controls metadata terms used in creating and maintaining records of their holdings. Choices include, LC Subject Headings, MARC Geographic Areas, and Thesaurus of Graphic Materials. See the [full list of standardized vocabularies and authorities](http://id.loc.gov/){target=_blank}. +The Library of Congress maintains an Authorities and Vocabularies service that controls metadata terms used in creating and maintaining records of their holdings. Choices include LC Subject Headings, MARC Geographic Areas, and Thesaurus of Graphic Materials. See the [full list of standardized vocabularies and authorities here](http://id.loc.gov/){target=_blank}. -- In the LC Suggestion admin page, first choose a metadata field that you wish to contain controlled vocabulary (any of the core or item type fields) from the dropdown menu. -- Assign that field a Library of Congress authority/vocabulary. -- Elements already assigned an authority/vocabulary are marked with an asterisk (`*`). -- Click Edit Suggest. +In the LC Suggestion admin page, set up your controlled metadata as follows: + +- First choose a metadata field that you wish to contain a controlled vocabulary (any of the core or item type fields) from the dropdown menu. For example, choose "Subjects" from the Dublin Core section. (Elements already assigned an authority/vocabulary are marked with an asterisk (`*`) in the dropdown list.) +- Assign that field a Library of Congress authority/vocabulary. For example, choose "Library of Congress Subject Headings" from the "Authorities" section. +- Enter as many as you want, then save the page. + +Note that you can choose only one vocabulary per metadata field, with the option to add "All authorities", "All vocabularies", or "All authorities and vocabularies" if you need to apply more than one to a single field.  +### Edit associations + +If you remove an authority/vocabulary, no metadata will be deleted or changed in the items. + +To change or remove a vocabulary/authority associated with a field go back to the LC Suggest tab. -## Edit Vocabulary and Authority Associations +- Select the metadata element you wish to edit, and choose a new Authority/Vocabulary from that menu, or, to remove a controlled set completely, choose "Select Below". +- Click "Save Changes". -- To change or remove a vocabulary/authority associated with a field go back to the LC Suggest tab. -- Select the metadata element you wish to edit, and choose a new Authority/Vocabulary from that menu, or to remove a controlled set completely choose "Select Below." -- Click Edit Suggest. If you removed an authority/vocabulary, no metadata will be deleted or changed in the items. +## Edit metadata using LC Suggest -## Adding, Editing Items with LC Suggest -When adding or editing item metadata, users must start typing in the open text box of that specific field adding the first couple of letters of the vocabulary or authority to prompt the auto-suggest feature. There might be a short delay, but a short menu will appear with choices drawn directly from the authority or vocab list you have associated with that field. +When adding items or editing item metadata, users must start typing in the open text box of that specific field, adding the first few letters of a desired word, to prompt the auto-suggest feature. There might be a short delay, but a short menu will appear with choices drawn directly from the authority or vocab list(s) you have associated with that field. For example, if "MARC List for Geographic Areas" was assigned to the "Spatial coverage" field, you could type "gre" and see options including Greece, Grenada, Greenland, and Great Britain. \ No newline at end of file diff --git a/docs/Plugins/Ngram.md b/docs/Plugins/Ngram.md index fb46467..084d8b9 100644 --- a/docs/Plugins/Ngram.md +++ b/docs/Plugins/Ngram.md @@ -1,145 +1,139 @@ # Ngram -The [Ngram plugin](https://omeka.org/classic/plugins/Ngram/){target=_blank} allows you to generate [ngrams](https://en.wikipedia.org/wiki/N-gram){target=_blank} using items in your Omeka Classic install. A corpus is generated by querying the content of a selected text element field. Corpora may then be investigated via Ngram graphs, counts, and frequencies. +The [Ngram plugin](https://omeka.org/classic/plugins/Ngram/){target=_blank} allows you to generate [ngrams](https://en.wikipedia.org/wiki/N-gram){target=_blank} using items in your Omeka Classic installation. A corpus is generated from the contents of your selected text element field. Corpora may then be investigated via ngram graphs, counts, and frequencies. -For additional information on Ngrams, please see: + + +For additional information on ngrams, please see: [Benjamin M. Schmidt, “Words Alone: Dismantling Topic Models in the Humanities,” Journal of Digital Humanities 2, no. 1 (winter 2012).](http://journalofdigitalhumanities.org/2-1/words-alone-by-benjamin-m-schmidt/){target=_blank} [Dan Cohen, “A Conversation with Data: Prospecting Victorian Words and Ideas,” dancohen.org, May 30, 2012.](http://www.dancohen.org/2012/05/30/a-conversation-with-data-prospecting-victorian-words-and-ideas/){target=_blank} -Please note, your results will be more meaningful when you are working with clean data. Before you begin, ensure that the formatting of your data fields (in particular, those that include numeric sequences like dates) are consistent. +A corpus is drawn from the items in your collection with content in a particular text element (selected on the plugin configuration page). You can then narrow the items with a Search Query, producing an "Item Pool". The Item Pool will be used to create the Corpus, by validating the items. You can choose a second metadata field for the Sequence, and the plugin will assess which items have usable data in both fields. You can then modify item metadata as necessary to include more or fewer items. + +Finally, the corpus is used to generate unigrams, bigrams, and/or trigrams for analysis. Graphs can be displayed if you set a sequence element such as a date field. + +Your results will be more meaningful when you are working with clean data. Before you begin, ensure that the formatting of your data fields (in particular, those that include numeric sequences like dates) are consistent. The plugin screens can also help you identify items in need of cleanup. -## System Requirements +## System requirements The Ngram plugin requires the following libraries and dependencies: -- [IntlBreakIterator](https://www.php.net/manual/en/class.intlbreakiterator.php){target=_blank} class (in your php) +- [IntlBreakIterator](https://www.php.net/manual/en/class.intlbreakiterator.php){target=_blank} class (in your PHP) - Make sure [your PHP path is properly configured](../Technical/Setting_PHP_Path.md). ## Configuration -Once you’ve [installed it on your site](../Admin/Adding_and_Managing_Plugins/), there are two configuration features for the Ngram plugin: +Once you’ve [installed it on your site](../Admin/Adding_and_Managing_Plugins/), configure the plugin from the Plugins tab at the top of the administrative screens. + +There are two configuration features for the Ngram plugin: **Text Element**: a dropdown menu from which you may select one text element to create an ngram corpus. In order to produce an ngram, the plugin must be directed to a particular text element. For best results, choose a Text Element by reviewing items within your collection and identify a text field that is meaningful across multiple items. -Text Elements are listed in a dropdown menu. If you have created unique metadata categories for your collection, these will also be available for selection in the dropdown. You must select a single element. This means you cannot produce ngrams from multiple text fields. +Text Elements are listed in a dropdown menu. Note that you cannot choose the "Text" field created by the [PDF Text plugin](PdfText.md) when a text layer is extracted from a PDF file upon ingest. + +If you have created unique metadata categories for your collection, these will also be available for selection in the dropdown. You can only select a single element at a time. This means you cannot produce a single ngram corpus from multiple text fields. For example, a user might choose to examine a collection of items with useful text in the Description field. Configuring the Text Element to the Description field directs the plugin to create a corpus that includes all items with text in that element. Items that do not have content in this text element will be ignored. -You may select different text elements for different corpora. However do not modify the Text Element setting while you are in the process of validating items and generating ngrams for a corpus! Doing so will break that process. Only change this once you have generated all ngrams for a corpus. +You may select different text elements for different corpora. However, do not modify the Text Element setting while you are in the process of validating items and generating ngrams for a corpus! Doing so will break that process. Only change this once you have generated all ngrams for a corpus. **Reset processes**: a checkbox that will reset any ongoing processes that are hanging or showing errors. -Be sure to click to save changes. +Be sure to save your changes to this page.  -## Add a Corpus - -### Create a Corpus - -A corpus is drawn from the items in your collection with content in a particular text element (which is selected on the plugin configuration page), it is further defined by a Search Query and Sequence elements (on the Add a Corpus page), producing an Item Pool. The Item Pool will be further refined by Validating the Items. +## Add a corpus +To create a corpus and start viewing ngrams, go to the Ngram tab on the left hand navigation of your Omeka admin dashboard. On the Browse Corpora page, click the green "Add a Corpus" button.  -To create a corpus and start viewing ngrams, go to the Ngram tab on the left hand navigation of your Omeka admin dashboard. On the Browse Corpora page, click the green Add a Corpus button. +On the "Add a Corpus" page, complete the following options: -On the Add a Corpus page, complete the following options: +**Name**: Give the corpus a name. Remember that you may change the analyzed metadata element in the future, so we recommend including the element name and other identifying information such as any filters added through search queries. -**Name**: A field in which you must give the corpus a name. Ideally, choose something that meaningfully describes the corpora, as there are no descriptions for these corpora. +**Public**: Click the checkbox to make the corpus visible on the public site. -**Public**: A check box. Click the checkbox to make the corpus visible to public users (on the public side of the site). - -**Search Query**: A field in which you refine the contents of your corpus by inputting a search query. The best way to get this search query is to perform an advanced search of the items in your collection on the Admin side of your Omeka site. Then, copy and paste the entire URL of the results, after the part that reads `admin/items/browse?`. +**Search Query**: Narrow your corpus by inputting a search query. The best way to get this search query is to perform an advanced search of the items in your collection on the administrative side of your Omeka site. Then, copy and paste the entire URL of the results, after the part that reads `admin/items/browse?`. **Sequence**: -- **Sequence Element**: select from elements but it should be something with numeric or date input. Items without the selected element field filled in (for instance, an item without a Date will not be included in the corpus). For best results, ensure consistency of metadata, and select a meaningful field. -- **Sequence type**: choose from Date by Year, Date by Month, Date by Day, or Numeric Sequence Range. The field will prompt you with the proper format for the sequence if you choose a Date type. If numeric, make sure the format matches the numeric sequence of the elements you’re drawing from. - -**Note**: Date should be entered in the YearMonthDay format and should be entered as a range. (for instance, 20010101-20160101) +A sequence will allow you to organize your ngrams visually. You do not have to have a sequence, but without one you cannot generate graphs. -**Note**: You do not have to have a sequence, but without one you cannot generate graphs. +- **Sequence Element**: Choose an element with numeric or date input, something that can be sorted chronologically or ordinally. Items without the selected element field filled in (for instance, an item without a date) will not be included in the corpus. For best results, choose a field with very clean and structured metadata. +- **Sequence Type**: choose from Date by Year, Date by Month, Date by Day, or Numeric Sequence Range. The field will prompt you with the proper format for the sequence if you choose a Date type. If numeric, make sure the format matches the numeric sequence of the elements you’re drawing from. +**Sequence Range**: Date should be entered in the Year(-Month-[Day]) format and should be entered as a range, for instance, "20010101-20160101". -**Note**: The Text Element box under the green Add Corpus button on the Add Corpus page. The Text Element was configured in the plugin panel. - -When you have completed adding your corpus, click the green Add Corpus button. +When you have completed adding your corpus, click the green "Add Corpus" button.  -### Manage your Corpus +### Manage your corpus + After you have added a corpus, the screen will update with information and options for that corpus.  -On the left the elements that were input on the Add Corpus screen are listed. +On the left the elements that were input on the "Add Corpus" screen are listed: - Public -- Search Query -- Browse search results +- Search Query, with a "Browse search results" link - Sequence Element -- Sequence Range +- Sequence Range. -**Note**: Clicking browse Search Results will open a Browse Items page with all the items based on your search term. - -On the right, buttons allow the user to Edit and Delete the corpus and Validate Items. After you have validated items, buttons here allow you to generate unigrams, bigrams, and trigrams, and to view the corpus. Below, a small pane indicates the Text Element for the corpus. At the bottom an Item Counts pane will populate a pool of items from which this corpus may be derived. +You can click "Browse search results" to open a Browse Items page with all the items that are currently included in this corpus. +On the right, buttons allow the user to Edit and Delete the corpus, and "Validate Items". After you have validated items, buttons here allow you to generate unigrams, bigrams, and trigrams, and to view the corpus. Below, a small panel indicates the Text Element for the corpus. At the bottom, an Item Counts section indicates the pool of items from which this corpus may be derived.  +## Validate the items -## Validate Items -After the Corpus has been created you must validate items before you can generate ngrams and view frequencies. To do so, click the green Validate Items button on the right hand side (just below the Delete button). - +After the Corpus has been created you must validate the set of items before you can generate ngrams and view frequencies. To do so, click the green "Validate Items" button on the right-hand side (just below the Delete button).  This will take you to a new screen with three tabs: valid items, invalid items, and out of range items. -  -**Valid items** are those items with sequence text that is readable to the plugin (See Figure 1). The table on this tab gives: +**Valid items** are those items with sequence text that is readable to the plugin. The table on this tab displays: - the item number (a link to the item), - the text in the sequence element, and -- Sequence member, or how it will be used in sequence by the plugin (Ex. when the sequence is “Date by Year” and the Sequence. - -**Invalid items** have text in the sequence element which the plugin cannot parse (See Figure 2). However, you can click on the Item ID number to go in and edit the item to correct the element text. +- Sequence member, or how it will be used in sequence by the plugin, e.g. when the sequence is “Date by Year” and a year has been recognized in the date field and sorted. Note that the year will be recognized in a "Year-Month-Day" date value, including a value using hyphens (-) and slashes (/) between each number, and including "Day/Month/Year" and other formats. -**Out of range items** have text in their sequence element which is outside the range you set (See Figure 3). The table on this tab gives: - -- the item number (a link to the item), -- the text in the sequence element, and -- Sequence member, or how it will be used in sequence by the plugin (Ex. when the sequence is “Date by Year” and the Sequence - -**Note**: to update the sequence text in these items, utilize the linked item number to modify each item. If you do not modify out of range items, they will not be included in the corpus. + -For ease of navigation, you may click to open a new tab for the invalid or out of range items you would like to modify. Refresh the list of valid and invalid items by reloading this page. Once you are done correcting invalid items, or the list of valid items looks correct, click the green Accept Valid Items button. +**Invalid items** have content in the sequence element which the plugin cannot parse. You can click on the Item ID number to edit the item and correct the element text. For example, dates may have textual values such as "circa XXXX" and "XXXX or later" that need to be removed for the item to be included in the corpus. If you do not wish to lose this textual information, do not edit the item. -**Note**: Once you click the Accept Valid Items button you will not be able to reconfigure the item pool or reset the body of valid items + -Valid Items (Figure 1) +**Out of range items** have a recognized value in their sequence element which is outside the range you set (such as the year 1624, outside the range of 1800-2020). The table on this tab displays: - +- the item number (a link to the item), +- the text in the sequence element, and +- Sequence member, or the information recognized as being in-sequence but out-of-range. -Invalid Items (Figure 2) +Utilize the linked item number to modify the items you wish to have included. Alternatively, you can go back and modify the range you set, using the "Edit" button. - + -Out of Range Items (Figure 3) +For ease of navigation, you may click to open a new tab for the invalid or out of range items you would like to modify. Refresh the list of valid and invalid items by reloading this page. Once you are done correcting invalid items, or the list of valid items looks correct, click the green "Accept Valid Items" button. - +Once you click the "Accept Valid Items" button you will not be able to reconfigure the item pool or reset the body of valid items. This is permanent - you will no longer be able to edit the corpus or change the range, etc. To start fresh (such as when new items are added to your Omeka Classic site) you will need to start a new Ngram project. -**Note**: After you have validated your items, the Item Counts pane will update to provide a count of the number of items in your corpus. +After you have validated your items, the Item Counts pane will update to provide a count of the number of items in your corpus.  -### Generate Ngrams +### Generate ngrams + After you have validated your items, click the buttons to generate unigrams (single words), bigrams (two word pairs), and trigrams (three word groups). You can only do one at a time. Refresh the page to see if the process is complete - larger corpora will take longer to process. While the ngrams are processing, these buttons will be grey and text will update to indicate which process is “In Progress.” When complete, the text will update to read “Generated.” You do not have to generate unigrams, bigrams, and trigrams in order to use the View Corpus functions. However, running all three processes before you view corpus will give you more options when analyzing the corpus. @@ -148,7 +142,8 @@ You do not have to generate unigrams, bigrams, and trigrams in order to use the  -## View Corpus +## View your corpus + Once you have created a corpus, validated the items, and generated ngrams, you can view the corpus in two ways: Ngram Search and Ngram Frequency.  @@ -190,7 +185,6 @@ Total Ngram Counts: This chart includes information about the corpus.  - **Ngram Frequency** - The Ngram Frequency Corpus view returns ngrams in order of frequency. Enter the number of results you want to return of unigram, bigrams, or trigrams (select one using the radio button). By default the number of results is set to 100. @@ -201,8 +195,8 @@ Note that the ngram plugin does not strip out stop words (a, the, of, for exampl  +## Browse corpora -## Browse Corpora Once you have at least one corpus, the page at admin/ngram/corpora (the ngram tab) will display a table of your corpora with the following information for each: - **Name** (that you give it) @@ -213,7 +207,8 @@ Once you have at least one corpus, the page at admin/ngram/corpora (the ngram ta  -## Case Studies +## Case studies + The following case studies examine the [Text Analysis](TextAnalysis.md) and Ngram plugins using data from the [September 11 Digital Archive](http://911digitalarchive.org/){target=_blank}. - [Jannelle Legg, "Experiencing the September 11 Digital Archive, Using Omeka’s Ngrams and Text Analysis Plugins," December 2017](../doc_files/911-CaseStudy-1.pdf){target=_blank} diff --git a/docs/Plugins/OaiPmhRepository.md b/docs/Plugins/OaiPmhRepository.md index 5e6eb87..3d7c4f5 100644 --- a/docs/Plugins/OaiPmhRepository.md +++ b/docs/Plugins/OaiPmhRepository.md @@ -4,9 +4,9 @@ The [OAI-PMH Repository plugin](https://omeka.org/classic/plugins/OaipmhReposito This plugin offers the reciprocal functionality provided by the [OAI-PMH Harvester plugin](OaipmhHarvester.md). -## Metadata Formats +## Metadata formats -The plugin ships with several default formats. Other plugins can alter these or add their own (see Extending below): +The plugin ships with several default metadata schema. Other plugins can alter these or add their own (see Extending, below): - [Dublin Core](http://dublincore.org){target=_blank} (`oai_dc`) - This is required by the OAI-PMH specification for all repositories. Omeka metadata fields are mapped one-to-one with fields for this output format, and it is the preferred format to use with the plugin. @@ -17,11 +17,10 @@ The plugin ships with several default formats. Other plugins can alter these or - [METS](http://www.loc.gov/standards/mets/){target=_blank} (`mets`) - The Metadata Encoding and Transmission Standard exposes files to harvesters. - [RDF](https://www.w3.org/2001/sw/wiki/RDF){target=_blank} (`rdf`) - - This format exposes metadata as RDF/XML. Unlike many of the other formats, RDF allows the repository to expose metadata from different standards all in the same output. The main practical distinction from other formats currently is that the RDF output will automatically include "qualified" data from the Dublin Core Extended plugin, if it's present. + - This format exposes metadata as RDF/XML. Unlike many of the other formats, RDF allows the repository to expose metadata from different standards all in the same output. The main practical distinction from other formats currently is that the RDF output will automatically include "qualified" data from the Dublin Core Extended plugin, if present. - Omeka XML (`omeka-xml`) - This output format uses an Omeka-specific XML output that includes all metadata elements without requiring crosswalking or subsetting, but is not well-supported by harvesters or other tools. - ## Configuration When you install the plugin, you will be automatically directed to the plugin configuration page. You can access these again at any time by going to the Plugins tab of the top navigation, scrolling down to the OAI-PMH Repository plugin in the list and clicking the blue "Configure" button. diff --git a/docs/Plugins/OaipmhHarvester.md b/docs/Plugins/OaipmhHarvester.md index e874f0b..bd3edb5 100644 --- a/docs/Plugins/OaipmhHarvester.md +++ b/docs/Plugins/OaipmhHarvester.md @@ -4,27 +4,27 @@ The [OAI-PMH Harvester plugin](https://omeka.org/classic/plugins/OaipmhHarvester Some online repositories expose their metadata through OAI-PMH. This plugin makes it possible to harvest that metadata, mapping it to the Omeka data model. The plugin can be used for one-time data transfers, or to keep up-to-date with changes to an online repository. -Currently the plugin is able to import [Dublin Core](http://dublincore.org/documents/dces/){target=_blank}, [CDWA Lite](http://www.getty.edu/research/conducting_research/standards/cdwa/cdwalite.html){target=_blank} metadata, and [METS](http://www.loc.gov/standards/mets/){target=_blank}. Dublin Core is an internationally recognized standard for describing any resource. +Currently the plugin is able to import [Dublin Core](http://dublincore.org/documents/dces/){target=_blank}, [CDWA Lite](https://www.getty.edu/publications/categories-description-works-art/cdwa-lite/){target=_blank} metadata, and [METS](http://www.loc.gov/standards/mets/){target=_blank}. -Every OAI-PMH data provider should implement this standard. CDWA Lite is a standard for describing works of art and material culture. Very few repositories expose CDWA Lite, but the standard is getting more and more popular. METS is developed as an initiative of the Digital Library Federation and maintained in the Network Development and MARC Standards Office of the Library of Congress. +Dublin Core is an internationally recognized standard for describing any resource that every OAI-PMH data provider should implement, and the others are well-supported structures used frequently in heritage institutions. CDWA Lite is a standard for describing works of art and material culture. Very few repositories expose CDWA Lite, but the standard is getting more and more popular. METS is developed as an initiative of the Digital Library Federation and maintained in the Network Development and MARC Standards Office of the Library of Congress. -This plugin offers the reciprocal functionality provided by the [OAI-PMH Repository plugin](OaiPmhRepository.md), which turns your Omeka site into a place that others can harvest OAI-PMH metadata. +This plugin offers the reciprocal functionality provided by the [OAI-PMH Repository plugin](OaiPmhRepository.md), which turns your Omeka site into a place where others can harvest OAI-PMH metadata. ## System requirements -Your server must have [PHP-CLI](http://www.php-cli.com/){target=_blank} installed. +Your server must have [PHP-CLI](http://www.php-cli.com/){target=_blank} installed. This is a standard utility used by many Omeka batch-processing functions and jobs. [Test and set up PHP with these instructions](../Technical/Setting_PHP_Path.md). -## Instructions +## Harvest data -### Performing a harvest To perform a harvest, go to the OAI-PMH Harvester tab in the left-hand navigation bar. -- Enter an OAI-PMH base URL, click "View Sets" Not all repository utilize METS. However, if you are accessing a repository utilizing a mets metadata library, you will be given the choice to harvest either oai-dc or mets. Select the type of data you will harvest from the dropdown menu. +- Enter an OAI-PMH base URL, and click "View Sets". +- Select the type of data you will harvest from the dropdown menu. If you are accessing a repository utilizing a METS metadata library, you will be given the choice to harvest either OAI-DC or METS.  -- To harvest the entire repository, select Go. -- To harvest single sets within a repository, select the type of data you are harvesting from an individual set, mets or oai-dc (if the choice exists) and select the Go link associated with that set. +- To harvest the entire repository, select "Go". +- To harvest single sets within a repository, select the type of data you are harvesting from an individual set, METS or OAI-DC (if the choice exists), and select the "Go" link associated with that set.  @@ -32,7 +32,7 @@ The harvest process runs in the background and may take a while. Go to the harve If you encounter errors, [submit the base URL and status messages to the Omeka forums](https://forum.omeka.org/c/omeka-classic/plugins/10){target=_blank}. -### Re-harvesting and updating +### Sync data The harvester includes the ability to make multiple successive harvests from a single repository, keeping in sync with changes to that repository. @@ -41,27 +41,29 @@ After a repository or set has been successfully harvested, a "Re-harvest" button Manually specifying the exact same harvest to be run again (same base URL, set, and metadata prefix) will result in the same behavior. ### Duplicate items + Duplicate items (multiple Omeka items corresponding to the same repository record) can be created if an item in a repository is a member of several OAI-PMH sets. This will also occur if a repository is harvested using more than one metadata prefix. In this case, the duplicate items are independent, and changes to one will not propagate to the others. However, the duplicate items, if any, can be accessed from the admin item show page. If an item has duplicates, they will be shown in an infobox on the right-hand side of the page titled "Duplicate Harvested Items." -### Delete Harvest -It is possible to undo a harvest, deleting all imported items. +### Delete harvest + +It is possible to undo a harvest, which will delete imported items. To do so: -- Click on the OAI-PMH Harvester in the left hand navigation of your admin dashboard. There will be a table of completed and in-progress Harvests; the far right column is Status. -- Click on the status (Completed) of the harvest you wish to undo. Do not click the green re-harvest button. -- The next page will give you a report on the harvest. Click the Delete Items button at the bottom of the table. +- Click on the OAI-PMH Harvester in the left hand navigation of your admin dashboard. There will be a table of completed and in-progress Harvests; the far right column is "Status". +- Click on the status ("Completed") of the harvest you wish to undo. Do not click the green "Re-harvest" button. +- The next page will give you a report on the harvest. Click the "Delete Items" button at the bottom of the table. The plugin will return you to the OAI-PMH Harvester tab. The displayed status of the harvest will not change until all harvested items are complete, at which point status will be “Deleted.” Deleted harvests do not have a green Re-Harvest button. ## Upgrading from Omeka Classic 1.x -The data stored by the harvester plugin has changed between versions, so when upgrading, it is necessary to uninstall the old version of the plugin first. This will remove data stored by the harvester, but the harvested items themselves will remain. +The data stored by the OAI-PMH Harvester plugin has changed between versions, so when upgrading, it is necessary to uninstall the old version of the plugin first. This will remove data stored by the harvester, but the harvested items themselves will remain. To upgrade the plugin: 1. Uninstall the old version of the OAI-PMH Harvester plugin from the admin panel. -2. Replace the OaipmhHarvester directory with the updated version. -3. Install the now-updated OAI-PMH Harvester plugin from the admin panel. +2. Replace the "OaipmhHarvester" directory, installed in the "plugins" folder of your installation, with the updated version. +3. Install the now-updated OAI-PMH Harvester plugin from the admin panel. \ No newline at end of file diff --git a/docs/Plugins/PdfText.md b/docs/Plugins/PdfText.md index 744a3f2..7dcbfee 100644 --- a/docs/Plugins/PdfText.md +++ b/docs/Plugins/PdfText.md @@ -13,19 +13,21 @@ You may need to contact your server administrator to install it. You can then install the PDF Text plugin from the plugins directory. -## Using the PDF Text module +## Using the PDF Text plugin -- Add PDF file(s) to a new or existing item -- Save the item +- Add PDF file(s) to a new or existing item. +- Save the item. - PDF Text will extract any text layers from the PDF(s) and input the text to the Text metadata field attached to the file (not the item).  You can view the extracted text in the admin side, on the File page, or when editing the file, on the "PDF Text" tab. On the public side, this field will show on the file display. +Note that PDF Text will fail to extract text from any PDF that contains emojis. This will result in no extracted text being saved. This will also cause an import error on [CSV Import](CSV_Import.md) when PDF Text is working on PDF files added through the import process. + ### Configure  The PDF Text "Configure" page, accessible from the Plugins page, allows you to run a batch-text-extraction process on all PDF files already in your Omeka database. -Check the *Process Existing PDF files* box and save changes. This will run the text extraction process on all PDF file attachments. \ No newline at end of file +Check the "Process Existing PDF files" box and save changes. This will run the text extraction process on all PDF file attachments. \ No newline at end of file diff --git a/docs/Technical/Backing_up_an_Omeka_Database.md b/docs/Technical/Backing_up_an_Omeka_Database.md index 2f31aac..25a3b8d 100644 --- a/docs/Technical/Backing_up_an_Omeka_Database.md +++ b/docs/Technical/Backing_up_an_Omeka_Database.md @@ -1,6 +1,6 @@ # Backing up an Omeka Classic Database -WordPress has terrific documentation on their website about [Backing up Your Database](https://wordpress.org/support/article/backing-up-your-database/){target=_blank} that will help guide you through this process. You can go ahead and do this one of two ways: directly executing mysql commands on the command line, or using PHPMyAdmin. +WordPress has terrific documentation on their website about [Backing up Your Database](https://web.archive.org/web/20250218163904/https://developer.wordpress.org/advanced-administration/security/backup/database/){target=_blank} that will help guide you through this process. You can go ahead and do this one of two ways: directly executing mysql commands on the command line, or using PHPMyAdmin. ## mysqldump diff --git a/docs/css/extra.css b/docs/css/extra.css index 5f6fddf..b9449fc 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -11,6 +11,19 @@ a:visited { color: #cc4d41; } +img + em { +display:block; +text-align:center; +} + +.wy-nav-top { +background:#541D1D; +} + +.wy-nav-top a { + color: #fff; +} + .wy-nav-content { max-width:1400px; } diff --git a/docs/doc_files/filesError.png b/docs/doc_files/filesError.png new file mode 100644 index 0000000..1d1072a Binary files /dev/null and b/docs/doc_files/filesError.png differ diff --git a/docs/doc_files/filesMP3.png b/docs/doc_files/filesMP3.png new file mode 100644 index 0000000..5930e8c Binary files /dev/null and b/docs/doc_files/filesMP3.png differ diff --git a/docs/doc_files/filesMP4.png b/docs/doc_files/filesMP4.png new file mode 100644 index 0000000..d643c51 Binary files /dev/null and b/docs/doc_files/filesMP4.png differ diff --git a/docs/doc_files/filesMetadata.png b/docs/doc_files/filesMetadata.png index 3926ebe..4d2d908 100644 Binary files a/docs/doc_files/filesMetadata.png and b/docs/doc_files/filesMetadata.png differ diff --git a/docs/doc_files/filesReorder.png b/docs/doc_files/filesReorder.png new file mode 100644 index 0000000..17b09de Binary files /dev/null and b/docs/doc_files/filesReorder.png differ diff --git a/docs/doc_files/filesThumbnails.png b/docs/doc_files/filesThumbnails.png new file mode 100644 index 0000000..cf9b1b7 Binary files /dev/null and b/docs/doc_files/filesThumbnails.png differ diff --git a/docs/doc_files/htmleditor.png b/docs/doc_files/htmleditor.png deleted file mode 100644 index e0f45e5..0000000 Binary files a/docs/doc_files/htmleditor.png and /dev/null differ diff --git a/docs/doc_files/plugin_images/GuestUser_bar.png b/docs/doc_files/plugin_images/GuestUser_bar.png new file mode 100644 index 0000000..edecf64 Binary files /dev/null and b/docs/doc_files/plugin_images/GuestUser_bar.png differ diff --git a/docs/doc_files/plugin_images/GuestUser_bar2.png b/docs/doc_files/plugin_images/GuestUser_bar2.png new file mode 100644 index 0000000..57fc4b7 Binary files /dev/null and b/docs/doc_files/plugin_images/GuestUser_bar2.png differ diff --git a/docs/doc_files/plugin_images/commenting-flagged.png b/docs/doc_files/plugin_images/commenting-flagged.png index d094c37..5b069c3 100644 Binary files a/docs/doc_files/plugin_images/commenting-flagged.png and b/docs/doc_files/plugin_images/commenting-flagged.png differ diff --git a/docs/doc_files/plugin_images/itemrelCustom.png b/docs/doc_files/plugin_images/itemrelCustom.png new file mode 100644 index 0000000..e1bf571 Binary files /dev/null and b/docs/doc_files/plugin_images/itemrelCustom.png differ diff --git a/docs/doc_files/shortcodeSimplePage.png b/docs/doc_files/shortcodeSimplePage.png index dfa5b55..c404f45 100644 Binary files a/docs/doc_files/shortcodeSimplePage.png and b/docs/doc_files/shortcodeSimplePage.png differ diff --git a/docs/doc_files/sitePlanning.png b/docs/doc_files/sitePlanning.png new file mode 100644 index 0000000..3c0fabb Binary files /dev/null and b/docs/doc_files/sitePlanning.png differ diff --git a/docs/index.md b/docs/index.md index 2470e4d..5eb081f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,10 @@ # Omeka Classic User Manual -This user manual is for the current version of Omeka Classic. +This user manual is for the current version of Omeka Classic (version 3.1.2). - -Introduction to Omeka 2.0 from Omeka on Vimeo.
+It contains the following sections: -**Getting Started** +**Getting started** [Planning your Omeka site](GettingStarted/Site_Planning_Tips/), [examples and case studies](GettingStarted/UsingOmeka), [hosting suggestions](GettingStarted/Hosting_Suggestions), and our [Accessibility Statement](GettingStarted/Accessibility_Statement). **Installing** @@ -15,7 +14,10 @@ Information for [installing](Installation/Installing) and [upgrading](Installati Building the content of an Omeka site, including [items](Content/Items), [collections](Content/Collections), [tags](Content/Tags), and [item types](Content/Item_Types). The topics in this section correspond to options on the left-hand navigation of the Omeka admin dashboard. **Administration** -Managing your installation's [appearance](Admin/Appearance/Appearance_Settings/), [plugins](Admin/Adding_and_Managing_Plugins), [users](Admin/Users), and [site settings](Admin/Settings/General_Settings/); in Omeka, these options are only available to SuperUsers. The topics in this section correspond to the top navigation of the Omeka administrative dashboard. +Managing your installation's [appearance](Admin/Appearance/Appearance_Settings/), [plugins](Admin/Adding_and_Managing_Plugins), [users](Admin/Users), and [site settings](Admin/Settings/General_Settings/); in Omeka, these options are only available to Super Users. The topics in this section correspond to the top navigation of the Omeka administrative dashboard. + + +Introduction to Omeka from Omeka on Vimeo.
**Plugins** Documentation for plugins produced by the Omeka team. The [Plugins directory on the website](https://omeka.org/classic/plugins/){target=_blank} includes many user-supplied plugins from our community; we have only documented plugins that we support. If you cannot find information for a specific plugin here, please check on our registered plugins directory, or on its independent download page, as documentation may be in a ReadMe or on a separate site. Independent plugins may not be registered in our directory. diff --git a/mkdocs.yml b/mkdocs.yml index 7b42bf2..21ebd6a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,12 +17,13 @@ nav: - index.md - Getting Started: - GettingStarted/Site_Planning_Tips.md - - GettingStarted/UsingOmeka.md + - GettingStarted/Examples.md - GettingStarted/Hosting_Suggestions.md - GettingStarted/Feature_List.md - GettingStarted/Accessibility_Statement.md - GettingStarted/Screencasts.md - GettingStarted/Searching.md + - Content/Working_with_Dublin_Core.md - Installation: - Installation/System_Requirements.md - Installation/Installing.md @@ -32,12 +33,11 @@ nav: - Content: - Content/Items.md - Content/Files.md - - Content/Working_with_Dublin_Core.md - - Content/Using_HTML_Editor-TinyMCE.md - - Content/Item_Types.md - Content/Collections.md + - Content/Item_Types.md - Content/Tags.md - Content/Shortcodes.md + - Content/Using_HTML_Editor-TinyMCE.md - Administration: - Admin/Adding_and_Managing_Plugins.md - Admin/Appearance/Themes.md