Omeka S Tour from Omeka on Vimeo.
diff --git a/docs/modules/csvimport.md b/docs/modules/csvimport.md index 4ddd0066..55e96616 100644 --- a/docs/modules/csvimport.md +++ b/docs/modules/csvimport.md @@ -689,7 +689,7 @@ The following are known errors that can occur during an import: Some other modules add functionality to the CSV import process. If you have these modules installed and active, you will have access to the following options when using CSV Import. ### Mapping -If you have [Mapping](../mapping/) (minimum version 1.1.0) installed and active, you will have two additional options in the "Map to Omeka S data" tab when importing Items. Note that these options do not appear for any other import type, including Mixed Resources. +If you have [Mapping](mapping) (minimum version 1.1.0) installed and active, you will have two additional options in the "Map to Omeka S data" tab when importing Items. Note that these options do not appear for any other import type, including Mixed Resources. ![Add mapping drawer with additional options for "Resource location" and "default map view"](../modules/modulesfiles/csvimport_mapping1.png) @@ -708,7 +708,7 @@ If you have [Mapping](../mapping/) (minimum version 1.1.0) installed and active, - **Default zoom** must be a number between 1 (most zoomed out) and 18 (most zoomed in). ### File Sideload -If you have [File Sideload](../filesideload) (minimum version 1.2.0) installed and active, you can use it as a source for media when running a CSV import. +If you have [File Sideload](filesideload) (minimum version 1.2.0) installed and active, you can use it as a source for media when running a CSV import. Everything on the **Map to Omeka S data** tab will be the same. When you add a mapping and choose the "Media source" option, you will see that there is now an option for "Sideload". @@ -717,7 +717,7 @@ Everything on the **Map to Omeka S data** tab will be the same. When you add a m For the data in this column, you need to include the full file name, including extension. So, for example, if you want to import a JPG file named "Jekyll_and_Hyde_Title", then the data in the media column of the CSV you are importing should be `Jekyll_and_Hyde_Title.jpg`. ### Numeric Data Types -If you have [Numeric Data Types](../numericdatatypes) installed and active, it will add the option to set a column data type as numeric data. +If you have [Numeric Data Types](numericdatatypes) installed and active, it will add the option to set a column data type as numeric data. Options are: @@ -756,4 +756,4 @@ Use the following formats for importing [durations](https://en.wikipedia.org/wik ### Custom Vocab -If you have [Custom Vocab](../customvocab) installed and active, it will add your custom vocabularies as data types in Omeka. You can select these data types during your CSV Import. +If you have [Custom Vocab](customvocab) installed and active, it will add your custom vocabularies as data types in Omeka. You can select these data types during your CSV Import. diff --git a/docs/modules/fedoraconnector.md b/docs/modules/fedoraconnector.md index 8762eb28..22026af3 100644 --- a/docs/modules/fedoraconnector.md +++ b/docs/modules/fedoraconnector.md @@ -11,7 +11,7 @@ There are two options for configuring Fedora Connector, both of which enable the The first checkbox offers the option to import the Fedora Vocabulary into your Omeka S install’s Vocabularies. The second checkbox offers the option to import the Linked Data Platform Vocabulary into your Omeka S install’s Vocabularies. If you do so, data in these vocabularies will also be imported into Omeka S. -You can check these boxes when you first install Fedora Connector, or at a later point via the "Configure" button in the [Modules](../modules/index.md#managing-modules) list. +You can check these boxes when you first install Fedora Connector, or at a later point via the "Configure" button in the [Modules](index) list. ## Import data To use Fedora Connector, navigate to the section labelled "Fedora Connector" under Modules in the left-hand navigation of the admin dashboard. This will automatically take you to the Import page. diff --git a/docs/modules/numericdatatypes.md b/docs/modules/numericdatatypes.md index 9a065b16..a1547cff 100644 --- a/docs/modules/numericdatatypes.md +++ b/docs/modules/numericdatatypes.md @@ -73,7 +73,7 @@ Clicking on this dropdown will reveal multiple options, including all of the pro ![The contents of the dropdown, with the normal options in addition to eight properties using numeric data types.](../modules/modulesfiles/ndt-browsesort2.png) ## Bulk edit numeric data -The module adds an additional option to the [item batch edit](../../content/items/#batch-editing): Convert to Numeric. +The module adds an additional option to the [item batch edit](../content/items.md#batch-editing): Convert to Numeric. The Convert to Numeric option lets you convert an existing text input property to a numeric data type. It will not work on properties where the data is currently an Omeka resource or a URI. diff --git a/docs/modules/scripto.rst b/docs/modules/scripto.rst new file mode 100644 index 00000000..c53b25a1 --- /dev/null +++ b/docs/modules/scripto.rst @@ -0,0 +1,9 @@ +========= + Scripto +========= + +.. toctree:: + :glob: + :maxdepth: 2 + + scripto/* diff --git a/docs/modules/scripto/index.md b/docs/modules/scripto/index.md index c77c2ae7..8757dcb4 100644 --- a/docs/modules/scripto/index.md +++ b/docs/modules/scripto/index.md @@ -22,7 +22,7 @@ To install Scripto, you must: - be running Omeka S v2.0.0 or higher - have a [MediaWiki](https://www.mediawiki.org/wiki/MediaWiki) installation running on the same server as the Omeka S installation. Minimum MediaWiki version is 1.30.0. -Create the MediaWiki installation on your server using [their instructions](https://www.mediawiki.org/wiki/Manual:FAQ#Installation_and_configuration). Install the Scripto module using the [documentation for installing modules](../../modules/#installing-modules). +Create the MediaWiki installation on your server using [their instructions](https://www.mediawiki.org/wiki/Manual:FAQ#Installation_and_configuration). Install the Scripto module using the [documentation for installing modules](../index.md#installing-modules). Once you have installed the module and created your MediaWiki installation, go to the Modules tab of your Omeka S installation and activate the Scripto module. diff --git a/docs/modules/scripto/scriptoPublicView.md b/docs/modules/scripto/scriptoPublicView.md index 7a9ee78c..25c22bea 100644 --- a/docs/modules/scripto/scriptoPublicView.md +++ b/docs/modules/scripto/scriptoPublicView.md @@ -13,12 +13,12 @@ For an example of how to orient community members to the interface, see the [Gui ## Linking between Scripto and an Omeka S site While the Scripto public interface exists somewhat separately from the sites you build in your Omeka S installation, it is possible to move between them. -From your Omeka S sites, you can create direct links to your Scripto projects using the [custom link](../../../sites/site_navigation/#custom-link) in site Navigation or as a link in any [HTML page block text](../../../sites/site_pages/#html). +From your Omeka S sites, you can create direct links to your Scripto projects using the [custom link](../../sites/site_navigation.md#add-a-custom-link) in site Navigation or as a link in any [HTML page block text](../../sites/site_pages.md#html). ### Scripto page block -When you add the Scripto module, it creates a new [page block](../../../sites/site_pages/#page-blocks) called "Scripto" +When you add the Scripto module, it creates a new [page block](../../sites/site_pages.md#page-blocks) called "Scripto" -The Scripto page block offers a drop-down to let you select from all available Scripto [projects](../scriptoproject/). Select the project you want to link from the dropdown. +The Scripto page block offers a drop-down to let you select from all available Scripto [projects](scriptoproject). Select the project you want to link from the dropdown. ![Dropdown with a single site option](../modulesfiles/scripto-pageBlock.png) @@ -56,7 +56,7 @@ The list of watched pages displays the following information: ## Public project browse On the upper right of the browser, near the "Log In" buttons or, when logged in, the user icon, is a link to browse all projects in the Scripto instance. -This browse page shows the project title, a representative icon determined by the first item in the project, and the project's description (set in the [configuration options](../scriptoproject/#configuration-options)), if any. +This browse page shows the project title, a representative icon determined by the first item in the project, and the project's description (set in the [configuration options](scriptoproject.md#configuration-options)), if any. ![Project browse showing three projects, only two of which have a description.](../../modules/modulesfiles/scripto-publicBrowse.png) Clicking on any project's title or representative thumbnail takes you to the project's view. @@ -71,7 +71,7 @@ Across the top of the page, just under the Scripto navigation options (project b - a browse items links; and - a search bar to search the items in the project (this is a full-text search for the metadata of the items and media). -Below this is a table of the items in the project. The table will be labeled Items unless you selected from the Item type dropdown in the project's [configuration options](../scriptoproject/#configuration-options). +Below this is a table of the items in the project. The table will be labeled Items unless you selected from the Item type dropdown in the project's [configuration options](scriptoproject.md#configuration-options). The table has two display options. The default view is set in the project's configuration options. diff --git a/docs/modules/scripto/scriptoproject.md b/docs/modules/scripto/scriptoproject.md index dee58e40..a02b1502 100644 --- a/docs/modules/scripto/scriptoproject.md +++ b/docs/modules/scripto/scriptoproject.md @@ -81,7 +81,7 @@ If you select Media, the content created in Scripto will appear in the media met - Translation ### Reviewers -Add [Omeka S users](../../../admin/users/) to your Scripto project as reviewers, who can can access private projects, and mark media as approved and unapproved. You can manage users after adding a project (see below). +Add [Omeka S users](../../admin/users) to your Scripto project as reviewers, who can can access private projects, and mark media as approved and unapproved. You can manage users after adding a project (see below). Only Omeka users with **site administrator** and g**lobal administrator** roles can sync and import projects, due to the destructive potential of those actions. @@ -258,7 +258,7 @@ The next section is **Review status**. You can toggle the drawer open and closed using the open arrow `>` button in the middle of the divider between the drawer and the main work area. -#### Media status: +### Media status: * **Complete**: Community users have the ability to mark a media they are working on as "complete." This serves as a flag to notify the project team that the media is ready for review. If a media is not completely transcribed/translated/described, adminstrators can reverse the Complete status. * **Approved**: Approval is granted by administrators and indicates that every media is complete and satisfactory. Items can only be considered approved when all child media are approved. diff --git a/docs/s-planning-tips.md b/docs/s-planning-tips.md index 03b0b64b..5814623b 100644 --- a/docs/s-planning-tips.md +++ b/docs/s-planning-tips.md @@ -1,6 +1,6 @@ # Planning Tips -In Omeka S, you build your [sites](../sites) page by page, using already existing resources on your installation. While it is best to have some resources before you start building out the pages, you can begin planning your site before you create the first item or item set. +In Omeka S, you build your [sites](sites/index) page by page, using already existing resources on your installation. While it is best to have some resources before you start building out the pages, you can begin planning your site before you create the first item or item set. What follows are some questions and ideas to help guide you as you plan your sites in Omeka S. @@ -13,27 +13,27 @@ What follows are some questions and ideas to help guide you as you plan your sit ## Resources **What will you do with items in this website?** -[Items](../content/items/) are the building blocks of Omeka S. What sort of [resource templates](../content/resource-template/) will you want to create and use to fully describe your items? Any item you include on an Omeka S will have a public item show page, so try to ensure that the information in an item's metadata can stand on its own. +[Items](content/items) are the building blocks of Omeka S. What sort of [resource templates](content/resource-template) will you want to create and use to fully describe your items? Any item you include on an Omeka S will have a public item show page, so try to ensure that the information in an item's metadata can stand on its own. **What will you do with item sets?** -You can use [item sets](../content/item-sets) to group items to be included on a [site](../sites), and they can be a way to guide visitors' browsing on your sites. For some sites, item sets are robust resources themselves. +You can use [item sets](content/item-sets) to group items to be included on a [site](sites/index), and they can be a way to guide visitors' browsing on your sites. For some sites, item sets are robust resources themselves. How do you want to group items into sets? What metadata fields will your item sets use? Do your item sets have relations to each other or to items? **What do you want your data to do?** -What properties are you going to want to consistently describe in your site? Do you want some of these to display with a different label - for example 'author' instead of 'creator' for books? Use a [resource template](../content/resource-template/) and change the label of the property. +What properties are you going to want to consistently describe in your site? Do you want some of these to display with a different label - for example 'author' instead of 'creator' for books? Use a [resource template](content/resource-template) and change the label of the property. In Omeka S, items and item sets can use other resources - items, item sets, and media - as properties; for example, you can make an item for William Shakespeare and have that item fill the 'creator' property for a 'Hamlet' item. How can your resources use this functionality? -Do you want to use a set of terms (controlled vocabulary) for certain items? You might want to use [Custom Vocab](../modules/customvocab/). Or do you want to use a terms list created by the Library of Congress or the Getty? Then you might use [Vocab Suggest](../modules/valuesuggest/). +Do you want to use a set of terms (controlled vocabulary) for certain items? You might want to use [Custom Vocab](modules/customvocab). Or do you want to use a terms list created by the Library of Congress or the Getty? Then you might use [Vocab Suggest](modules/valuesuggest). ## Building a site With Omeka S you will build your site from the ground up, which means you need to give some thought to how you want to organize your site. **What pages do you want to include?** What kind of content do you want on these pages? How do you want to arrange them? Try sketching out a sample menu or wireframes for the site. Use that as a guide as you build your pages. -Pages are made up of [blocks](../sites/site_pages/#page-blocks), which can include text, images, and much more. What kind of content do you want on the pages you build? Bear in mind that you can rearrange page blocks as you build, so you can play around with the order of the content on your pages if you need to. +Pages are made up of [blocks](sites/site_pages.md#page-blocks), which can include text, images, and much more. What kind of content do you want on the pages you build? Bear in mind that you can rearrange page blocks as you build, so you can play around with the order of the content on your pages if you need to. -**How do you want to interact with your visitors on your site?** Do you want to [collect](../modules/collecting/) resources from your visitors? Allow them to [share](../modules/sharing/) your content on social media? +**How do you want to interact with your visitors on your site?** Do you want to [collect](modules/collecting) resources from your visitors? Allow them to [share](modules/sharing) your content on social media? Will you require users to create accounts on your site? Familiarize yourself with [user roles and permissions](admin/users.md). diff --git a/docs/sites/index.md b/docs/sites/index.md index 607634b0..4493ba21 100644 --- a/docs/sites/index.md +++ b/docs/sites/index.md @@ -29,7 +29,7 @@ The "New site" page has two tabs: **Info** and **Theme**. * Give your site a **title** (required). * Create a **slug** for the site’s url. The url will be `youromekainstall.org/s/slug`. This is optional - if you leave this field blank, Omeka S will create a slug based on the site title. -* Create a **summary** for your site: a brief description of what it is about. The summary text will appear on your installation's landing page and on the [list of sites](../sites/site_pages#list-of-sites) page block. +* Create a **summary** for your site: a brief description of what it is about. The summary text will appear on your installation's landing page and on the [list of sites](site_pages.md#list-of-sites) page block. * Upload a **thumbnail** for your site, which will replace the summary text on the landing page or in the list of sites block. ![Admin tab for a new site with nothing entered](../sites/sitesfiles/sitesadd_admin.png) @@ -70,4 +70,4 @@ Site admin left hand navigation options are: - [Resources](../sites/site_resources.md), - [User permissions](../sites/site_users.md), - [Theme](../sites/site_theme.md), and -- Settings added by modules, if installed. \ No newline at end of file +- Settings added by modules, if installed. diff --git a/index.rst b/index.rst new file mode 100644 index 00000000..6dd5c218 --- /dev/null +++ b/index.rst @@ -0,0 +1,101 @@ +===================== + Omeka S User Manual +===================== + +Omeka S is a web publication system for universities, galleries, libraries, +archives, and museums. It creates a local network of independently curated +exhibits sharing a collaboratively built pool of items and their metadata. + +The sections of this manual correspond to the navigation sections on the +left-hand side of the :doc:`administrative dashboard