Skip to content

Commit

Permalink
More
Browse files Browse the repository at this point in the history
Also closes #60
  • Loading branch information
allanaaa committed Sep 18, 2023
1 parent 0afadb3 commit 309df25
Show file tree
Hide file tree
Showing 9 changed files with 103 additions and 36 deletions.
4 changes: 2 additions & 2 deletions docs/Admin/Adding_and_Managing_Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Manage plugins from the Plugins page found at the top of your Dashboard. Plugins

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

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

Expand All @@ -39,7 +39,7 @@ If you are using a hosting provider that offers cPanel and online file managemen
!!! Note
You can also use `git clone` or the Github interface to download the latest plugin code directly from Github into a folder in your `/plugins` folder. Be sure to watch for extra folder levels or incorrect folder names in this case, such as a folder starting with `plugin-` or ending with `-master`. Rename the folder to remove things like `plugin-` and/or `-master` from the folder name, as in `git clone https://github.com/omeka/plugin-Timeline.git Timeline`.

Upgrading plugins
Upgrade plugins
-----------------
When an active plugin is out of date, a notification will appear at the bottom of the plugin's entry on your Plugins page. The notification reads "A new version of this plugin is available. Get the new version." with a link.

Expand Down
8 changes: 5 additions & 3 deletions docs/Admin/Appearance/Appearance_Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Derivative Size Constraints
----------------------------------------------------------------
In this section, you can set the maximum image sizes for the derivative images Omeka creates when you upload a file.

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

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

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

Expand All @@ -28,9 +30,9 @@ Display Settings
----------------------------------------------------------------
These settings relate to the display of results on the public and admin sides and some aspects of metadata display on the public side.

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

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

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

Expand Down
8 changes: 4 additions & 4 deletions docs/Admin/Appearance/Navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Omeka includes links to Browse Items and Browse Collections by default. If you h

You may arrange navigation items in any order by dragging and dropping.

Managing navigation links
Manage navigation links
----------------------------------------------------

The checkbox located to the left of each section or page title indicates when a navigation link is visible on the public site. This is useful for both default pages, plugin-added pages, and temporarily turning custom links on and off. For example, if you don’t want "Browse Collections" to display, uncheck the box.
Expand All @@ -25,7 +25,7 @@ Edit the word or phrase that appears in the Label text box. For instance, you ma

To add menu navigation for a specific collection, exhibit, or item, see the section on links, below.

Adding navigation links
Add navigation links
----------------------------------------------------------------
In the section, "Add a Link to the Navigation," you may add links to other content, whether on your site or elsewhere.

Expand All @@ -36,15 +36,15 @@ Click "Add Link."
![Adding link](../../doc_files/navAddLink.png)


Choosing a homepage
Choose a homepage
--------------------------------------------------------------
You may change the homepage of your installation by selecting a page from the dropdown menu located under the heading "Select a Homepage" found on the right side of the screen. The dropdown lists all of the public navigation links you created. "[Default]" will display the Homepage as set up in the Theme's settings (so, if you change themes, you will need to re-enter Homepage information if you are utilizing this feature).

Select the desired page from the list and click "Save Changes" to designate a new homepage.

![Choose homepage dropdown with multiple options](../../doc_files/navHomepage.png)

Resetting the navigation
Reset the navigation
--------------------
To reset the navigation back to the Omeka default, click the "Reset Navigation" button below the "Save Changes" button and Homepage dropdown. **All customizations will be lost**: custom links will be deleted, and navigation item order and custom labels will revert to Omeka defaults.

Expand Down
6 changes: 3 additions & 3 deletions docs/Admin/Appearance/Themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There is a screencast that covers theme selection and customization, as well as
<div style="padding:49.51% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/103132986?h=281e743414" style="position:absolute;top:0;left:0;width:100%;height:100%;" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
<p><a href="https://vimeo.com/103132986">Omeka Classic: Modifying Appearance</a> from <a href="https://vimeo.com/omeka">Omeka</a> on <a href="https://vimeo.com">Vimeo</a>.</p>

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

Expand All @@ -30,7 +30,7 @@ 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
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.

Expand All @@ -51,7 +51,7 @@ 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.

Expand Down
33 changes: 16 additions & 17 deletions docs/Admin/Users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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.
The Users section allows site administrators 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.

![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")

Expand All @@ -12,9 +12,9 @@ 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; for example, you could search for any username containing "jam". 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.
Expand Down Expand Up @@ -46,42 +46,41 @@ Contributor users have control over their own content but can only view content

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

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
Add users
-------------------------------------------------------------

To Add a User, select the green button in the upper left hand corner.
To add a user, select the green button in the upper left hand corner.

![Add user form](../doc_files/Usersaddnew.png "Add user form")

- 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.
- 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.
- To edit user information, including changing passwords, Super and Admin users may click on the "Edit" button below the username.

Edit Users
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 User form](../doc_files/UserEdit.png "Edit User form")

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

![User API form](../doc_files/Usapi.png "User API form")

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.
4 changes: 2 additions & 2 deletions docs/Content/Collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Now that you have created a collection you may associate an item with this colle

![A screenshot of the Add a Collection page, with no metadata entered](../doc_files/collectionAdd.png "A screenshot of the Add a Collection page, with no metadata entered")

Adding items to collections
Add items to collections
-------------------------------------------------------------

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.
Expand All @@ -52,7 +52,7 @@ Edit a collection

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.
Expand Down
74 changes: 70 additions & 4 deletions docs/Content/Item_Types.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,72 @@ Pre-defined item types

![The item types browse view](../doc_files/itemTypeBrowse.png "The item types browse view")


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

Edit an existing item type
---------------------------------------------------------------
You can edit existing item types to modify their metadata fields.
Expand All @@ -45,15 +111,15 @@ To create a new item type, click the green "Add an Item Type" button above the t

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
## Create and add 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.

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

### To add an existing element to an item type:
### Add an existing element to an item type

1. In the Add Element block, select the **Existing** option.
1. Click the green "Add Element" button.
Expand All @@ -65,14 +131,14 @@ When adding elements to item types, there are two options: add an existing eleme

Note that an element can be created with a duplicate name, and the page can be saved, but that new element will disappear when the page is reloaded.

### To add a new element to an item type:
### Add a new element to an item type

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.
![New element block with no input](../doc_files/itemTypeNewElm.png "New element block with no input")

### Managing elements
### Manage elements

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.

Expand Down
Loading

0 comments on commit 309df25

Please sign in to comment.