diff --git a/.gitignore b/.gitignore index 8b03c06b..058d5560 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ +_build/ +locales/**/*.mo site/ .DS_Store diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/README.md b/README.md index ff545004..52af3295 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,6 @@ If you are cloning the user manuals to your local computer and creating a branch **Links** should be composed as relative to the current file. They will look something like `../modules/csvimport.md` if you are linking to a page that sits within a folder, or `../admin/users.md#manage-users` if you are linking to a section of a page. Do not forget the `.md` part of the page. -Links to external websites require the full URL as well as the addition of "{target=_blank}" after the link syntax: for example, `[create a new issue](https://github.com/omeka/omeka-s-enduser/issues){target=_blank}`. - **Images** for a page go into the `files` folder of the directory in which the page sits (so, for "Content" pages, images go into the `contentfiles` directory). Name images clearly, starting with an indicator of the relevant page, and use an underscore to separate out the image's purpose (for example, `items_addItem.png`). Images should never give information that is not provided in the text (or in the image alt text and title). No one with vision problems should be missing out. Think of images as a shortcut, not the only route, to understanding how to do something. diff --git a/_docmap.md b/_docmap.md deleted file mode 100644 index bc7b3274..00000000 --- a/_docmap.md +++ /dev/null @@ -1,18 +0,0 @@ -Documentation Map - -- admin dashboard -- glossary -- settings -- users -- content: - - items - - item sets - - media - - resource templates - - vocabularies -- sites - - sites management - - pages management -- modules - - modules (managing) - - individual modules documentation \ No newline at end of file diff --git a/_static/js/custom.js b/_static/js/custom.js new file mode 100644 index 00000000..184b5ae8 --- /dev/null +++ b/_static/js/custom.js @@ -0,0 +1,3 @@ +$(document).ready(function () { + $('a.external').attr('target', '_blank'); +}); diff --git a/conf.py b/conf.py new file mode 100644 index 00000000..9c9dcac0 --- /dev/null +++ b/conf.py @@ -0,0 +1,66 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Omeka S end user manual' +copyright = '2021, Omeka Team' +author = 'Omeka Team' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'myst_parser' +] + +myst_heading_anchors = 3 + +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [ + '_build', + 'Thumbs.db', + '.DS_Store', + 'README.md', + 'style-guide.md', + 'translation.md', +] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] +html_js_files = ['js/custom.js'] + +gettext_compact = False diff --git a/deploy b/deploy index bf696816..27ef216e 100644 --- a/deploy +++ b/deploy @@ -1,2 +1,2 @@ -mkdocs build -rsync -rv --delete site/ /websites/omekaorg/www/s/docs/user-manual \ No newline at end of file +make clean html +rsync -rv --delete _build/html /websites/omekaorg/www/s/docs/user-manual diff --git a/docs/accessibility.md b/docs/accessibility.md deleted file mode 100644 index 0c154bc5..00000000 --- a/docs/accessibility.md +++ /dev/null @@ -1,27 +0,0 @@ -# Accessibility Statement - -The Omeka team is committed to making Omeka S an accessible option for building collections and exhibits online. We are working to make the core code accessible and will continue to make accessibility for persons with disabilities a priority as we develop the code. Omeka strives to adhere to [W3C web design standards](http://www.w3.org/standards/){target=_blank} and to be compliant with [Section 508](http://www.section508.gov/){target=_blank} of the Americans with Disabilities Act. - -For more information, please review the following reports: - -- Omeka S version 3.x [Accessibility Conformance Report, using VPAT 2.4 Revised International Standards](files/OmekaS3x_ACR.pdf){target=_blank} (pdf), October 2020. -- Omeka S version 2.x [Accessibility Conformance Report using VPAT version 2.0](files/VPAT_OmekaS2-0-1.pdf){target=_blank} (pdf), August 2019. -- Omeka S version 1.x [Accessibility Conformance Report using VPAT version 1.1](files/VPAT2.0-OmekaS1-1.pdf){target=_blank} (pdf), April 2018. - -The following statements apply to Omeka S version 1.0.1 and higher: - -## Front end (Public view) - -The Omeka S themes produced by the Omeka team have the following features to improve accessibility: - -- [ARIA](http://www.w3.org/WAI/intro/aria){target=_blank} (Accessible Rich Internet Applications) landmarks for tabbing through page content, when not using a mouse or using a screen reader. -- Semantic HTML5 markup. - -Please note that although the core code for Omeka S conform to the above standards, installations of Omeka S which have been customized or which are using non-RRCHNM modules and themes may lack some or all of these options. While we encourage developers to consider accessibility, we cannot guarantee that their code includes ARIA Landmarks, SkipNav, or other accessibility considerations. - -## Back end (Administrative view) - -The administrative dashboard of Omeka S has the following features for accessibility: - -- ARIA landmarks for screen readers on the Admin Dashboard, designating the header, navigation, main content, and footers. -- Semantic HTML5 markup. diff --git a/docs/accessibility.rst b/docs/accessibility.rst new file mode 100644 index 00000000..4509b934 --- /dev/null +++ b/docs/accessibility.rst @@ -0,0 +1,36 @@ +Accessibility Statement +======================= + +The Omeka team is committed to making Omeka S an accessible option for building +collections and exhibits online. We are working to make the core code +accessible and will continue to make accessibility for persons with +disabilities a priority as we develop the code. Omeka strives to adhere to `W3C +web design standards `_ and to be compliant with +`Section 508 `_ of the Americans with Disabilities +Act (pdf). + +For more information, please review the following reports: + +* Omeka S version 3.x :download:`Accessibility Conformance Report, using VPAT 2.4 Revised International Standards ` (pdf), October 2020. +* Omeka S version 2.x :download:`Accessibility Conformance Report using VPAT version 2.0 ` (pdf), August 2019. +* Omeka S version 1.x :download:`Accessibility Conformance Report using VPAT version 1.1 ` (pdf), April 2018. + +The following statements apply to Omeka S version 1.0.1 and higher: + +Front end (Public view) +----------------------- + +The Omeka S themes produced by the Omeka team have the following features to improve accessibility: + +* `ARIA `_ (Accessible Rich Internet Applications) landmarks for tabbing through page content, when not using a mouse or using a screen reader. +* Semantic HTML5 markup. + +Please note that although the core code for Omeka S conform to the above standards, installations of Omeka S which have been customized or which are using non-RRCHNM modules and themes may lack some or all of these options. While we encourage developers to consider accessibility, we cannot guarantee that their code includes ARIA Landmarks, SkipNav, or other accessibility considerations. + +Back end (Administrative view) +------------------------------ + +The administrative dashboard of Omeka S has the following features for accessibility: + +* ARIA landmarks for screen readers on the Admin Dashboard, designating the header, navigation, main content, and footers. +* Semantic HTML5 markup. diff --git a/docs/admin-dashboard.md b/docs/admin-dashboard.md index ecdfd429..d2cb8105 100644 --- a/docs/admin-dashboard.md +++ b/docs/admin-dashboard.md @@ -2,7 +2,7 @@ The administrative dashboard manages the content shared by all Omeka S sites and the core functionalities of the Omeka S installation. -This [screencast](https://vimeo.com/455708039){target=_blank} walks you through the main features of the dashboard and navigating your Omeka S installation: +This [screencast](https://vimeo.com/455708039) walks you through the main features of the dashboard and navigating your Omeka S installation:

Navigating Omeka S from Omeka on Vimeo.

diff --git a/docs/admin/settings.md b/docs/admin/settings.md index beae7641..11f777bf 100644 --- a/docs/admin/settings.md +++ b/docs/admin/settings.md @@ -29,7 +29,7 @@ Settings are divided into two sections: **General** and **Security** settings. **Default site**: This dropdown gives you control over where people land when they navigate to the base url of your install. You can either display a list of all sites in the install (default) or select a specific site from the dropdown, to which people will be redirected. -**Locale**: A dropdown that lets you select from a dropdown of [available languages](https://www.transifex.com/omeka/omeka-s/){target=_blank} for the Omeka S core to change the language in which your installation's admin side displays. +**Locale**: A dropdown that lets you select from a dropdown of [available languages](https://www.transifex.com/omeka/omeka-s/) for the Omeka S core to change the language in which your installation's admin side displays. **Enable version notifications**: Check this box to enable warning banners for new versions of Omeka S, themes, and modules. If it is unchecked, no user (at any role) will see update warnings, not even the Global Administrator. If it is checked, every applicable user can see them (i.e. Supervisor users who can see the Modules page, Site Managers who can see the Themes pages, and every user on the `/admin` homepage). @@ -39,7 +39,7 @@ Settings are divided into two sections: **General** and **Security** settings. **Suggested languages for values**: List of languages to facilitate filling of the values in the resource form. -**Media alt text property**: Select a field (for example, `dc:title` or `dc:description`) from the media description to use as alternative text if no alt text is explicitly set. [Alt text](https://webaim.org/techniques/alttext/){target=_blank} is used in lieu of images (including thumbnails on browsing and search results pages) when a user is employing a screen reader and is an important part of meeting accessibility expectations. +**Media alt text property**: Select a field (for example, `dc:title` or `dc:description`) from the media description to use as alternative text if no alt text is explicitly set. [Alt text](https://webaim.org/techniques/alttext/) is used in lieu of images (including thumbnails on browsing and search results pages) when a user is employing a screen reader and is an important part of meeting accessibility expectations. **Index full-text search**: Check this box to run an index of your installation's resources and sites as soon as you click "Save". You should only need to run this process if you are having issues with searching. @@ -47,7 +47,7 @@ Settings are divided into two sections: **General** and **Security** settings. ![Security settings with fields as described below](adminfiles/settings_security.png) -- **Use HTMLPurifier** checkbox. If checked, the service [HTMLPurifier](http://htmlpurifier.org/){target=_blank} will clean up any user-entered HTML. +- **Use HTMLPurifier** checkbox. If checked, the service [HTMLPurifier](http://htmlpurifier.org/) will clean up any user-entered HTML. - **Disable file validation**: a checkbox, unchecked by default. When unchecked, file uploads are limited by the following two fields. When this box is checked, any type of media or MIME type can be uploaded. - **Allowed media types**: The default list contains the most common media types. Only files with media types included in this list may be uploaded to the installation. - Separate additions to the list with a comma. @@ -56,7 +56,7 @@ Settings are divided into two sections: **General** and **Security** settings. - Separate additions to the list with a comma. - To return to defaults, click the "Restore default extensions" button. -The final two fields relate to setting up [Google reCAPTCHA](https://www.google.com/recaptcha/intro/index.html){target=_blank} for your site. You will need both a site key and a secret key. Enter them in the corresponding fields after signing up with reCAPTCHA: +The final two fields relate to setting up [Google reCAPTCHA](https://www.google.com/recaptcha/intro/index.html) for your site. You will need both a site key and a secret key. Enter them in the corresponding fields after signing up with reCAPTCHA: - **reCAPTCHA site key** enables display of the widget on your install's sites. - **reCAPTCHA secret key** allows communication between your install and reCAPTCHA's server. diff --git a/docs/admin/users.md b/docs/admin/users.md index b97c157b..4164d581 100644 --- a/docs/admin/users.md +++ b/docs/admin/users.md @@ -101,7 +101,7 @@ On this tab, create a new password. It must be entered twice, in both the New Pa ![Empty password reset fields for the user outreach](adminfiles/users_password.png) -To see the password requirements, click the arrow next to the New Password field. This will display a list of [requirements](../../configuration) if any have been configured. +To see the password requirements, click the arrow next to the New Password field. This will display a list of [requirements](../configuration) if any have been configured. ### API keys Use this tab to generate an API key for the user. To generate one, you must provide a label for the key - this could be a date or the purpose of the key. Save the page to generate the key. diff --git a/docs/configuration.md b/docs/configuration.md index cfaadaf7..58af68b2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2,7 +2,7 @@ The following are commonly requested options which can be configured in the file `local.config.php`, located in the `/config` directory. -For a full list of available configuration keys, please see the [developer documentation page on configuration settings](https://omeka.org/s/docs/developer/configuration/){target=_blank}. +For a full list of available configuration keys, please see the [developer documentation page on configuration settings](https://omeka.org/s/docs/developer/configuration/). ## Password settings You can change the requirements for user passwords. The options include minimum length, number of upper and lowercase letters, and setting allowed symbols. @@ -57,9 +57,9 @@ The default thumbnailer is `Omeka\File\Thumbnailer\ImageMagick`. Also available You can also set the thumbnailer to `Omeka\File\Thumbnailer\NoThumbnail`, which will prevent your Omeka S installation from generating thumbnails. -[GD](https://secure.php.net/manual/en/intro.image.php){target=_blank} is a basic graphic library installed by default with PHP. It can create thumbnails for common image formats only (jpeg, gif, png). +[GD](https://secure.php.net/manual/en/intro.image.php) is a basic graphic library installed by default with PHP. It can create thumbnails for common image formats only (jpeg, gif, png). -[Imagick and ImageMagick](https://www.imagemagick.org){target=_blank} are the same library and can create thumbnails for more than 200 formats. Imagick is integrated into PHP and ImageMagick is the command-line version. +[Imagick and ImageMagick](https://www.imagemagick.org) are the same library and can create thumbnails for more than 200 formats. Imagick is integrated into PHP and ImageMagick is the command-line version. ImageMagick may require you to manually set a path in `imagemagick_dir`, whereas Imagick and GD do not require paths. @@ -104,7 +104,7 @@ If you have downloaded the file in order to edit it, be sure to upload the chang The `mail` key can be used to configure how Omeka S sends emails. Omeka sends emails to users upon registration and when they reset their passwords; modules can add other email functions, such as [confirming submissions](modules/collecting.md). -The default is to use [sendmail](https://en.wikipedia.org/wiki/Sendmail){target=_blank}, where the server is responsible for having mail delivery configured and set up. Sendmail generally requires no configuration on the Omeka S side. Another option for some servers is to configure a direct SMTP connection for sending mail. +The default is to use [sendmail](https://en.wikipedia.org/wiki/Sendmail), where the server is responsible for having mail delivery configured and set up. Sendmail generally requires no configuration on the Omeka S side. Another option for some servers is to configure a direct SMTP connection for sending mail. An example configuration, to be added at the end of `local.config.php`, will look something like this: @@ -128,4 +128,4 @@ An example configuration, to be added at the end of `local.config.php`, will loo ], ``` -See the [laminas-mail documentation](https://docs.laminas.dev/laminas-mail/transport/smtp-options/){target=_blank} for clarification. \ No newline at end of file +See the [laminas-mail documentation](https://docs.laminas.dev/laminas-mail/transport/smtp-options/) for clarification. \ No newline at end of file diff --git a/docs/content/item-sets.md b/docs/content/item-sets.md index ffdda0e5..add58f4c 100644 --- a/docs/content/item-sets.md +++ b/docs/content/item-sets.md @@ -61,7 +61,7 @@ In the image below, the first property (Title) is public as indicated by the ope ![As described](contentfiles/item_propviz.png) ### Text -Text fields are entered with text. The keyboard at the top of the field input indicates text. You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes){target=_blank} code for the language in which the text is written. +Text fields are entered with text. The keyboard at the top of the field input indicates text. You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code for the language in which the text is written. ### Omeka Resource These fields create an internal link between the resource you are creating and the resource which fills that field. You have the option to use either another item or an item set. Once you select an item or item set, detailed information will load, and you must click "Select resource" to finish linking the resources. You can also click the "X" button in the upper right-hand corner to go back to the list of items or item sets. @@ -104,7 +104,7 @@ When you input a value for a property associated for a resource, you are making - Certainty: What is the confidence of this fact? - Type: What type of concept/thing is this fact? -In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification){target=_blank}. Each value can have any number of annotations. +In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification). Each value can have any number of annotations. To create an annotation, click on the ellipsis on the right side of the value input interface, and then click on the annotation icon (a dialogue bubble). @@ -125,7 +125,7 @@ By default, Omeka S will use the media from the first item added to an item set ![Thumbnail tab with no asset selected. The tab displays a message about thumbnail creation and a button to "select" an asset](contentfiles/itemset_thumb1.png) -The assets you select from and upload as thumbnails in this tab are the same as those created for [site logos](../../sites/site_theme/#settings-options). +The assets you select from and upload as thumbnails in this tab are the same as those created for [site logos](../sites/site_theme.md#settings-options). To assign an asset as a thumbnail, click on the "Select" button in the main work area of the tab. This will open a drawer on the right side. diff --git a/docs/content/items.md b/docs/content/items.md index 3eb6ca99..2d8e1d57 100644 --- a/docs/content/items.md +++ b/docs/content/items.md @@ -85,7 +85,7 @@ Text fields allow for unformatted text entry. ![image of text input field with keyboard icon indicating text input, the globe icon for setting language, and a trashcan delete icon](contentfiles/items_textedit.png) -You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} code for the language in which the text is written. +You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) code for the language in which the text is written. ![Red arrow points to the globe icon and a text entry field highlighted in blue](contentfiles/item_lang.png) @@ -132,7 +132,7 @@ When you input a value for a property associated for a resource, you are making - Certainty: What is the confidence of this fact? - Type: What type of concept/thing is this fact? -In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification){target=_blank}. Each value can have any number of annotations. +In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification). Each value can have any number of annotations. To create an annotation, click on the ellipsis on the right side of the value input interface, and then click on the annotation icon (a dialogue bubble). @@ -149,7 +149,7 @@ Input the annotation, and click Set Annotations to finalize the process. Sites include a setting to indicate whether or not value annotations are visible to the public. #### Language -You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} for the language in which the text is written. +You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for the language in which the text is written. ![Red arrow points to the globe icon and a text entry field highlighted in blue](contentfiles/item_lang.png) @@ -170,7 +170,7 @@ Using the buttons on the **Add New Media** menu on the right side of the screen, - **URL**: import media via a URI. - **HTML**: add html content as a media resource for your item. - **IIIF**: Add an IIIF image via URL. -- **oEmbed**: insert an embedded representation of an external URL. Note that this will only work with content from [existing oEmbed implementations](http://oembed.com/#section7){target=_blank} - use the URL in your browser’s location bar. +- **oEmbed**: insert an embedded representation of an external URL. Note that this will only work with content from [existing oEmbed implementations](http://oembed.com/#section7) - use the URL in your browser’s location bar. - **YouTube**: add a link to embed a YouTube video. Use the URL from your browser’s location bar (with `/watch/` in it) rather than the `youtu.be` link. You can edit media later by going by editing an item, navigating to the **Media** tab, and clicking the edit button (pencil) for a media when editing the item. @@ -214,7 +214,7 @@ By default, Omeka S will use the topmost media to generate a thumbnail for the i When you use an asset thumbnail instead of uploading media, the asset thumbnail does not display on the item's public show page. This makes such thumbnails useful for items which have no media but which would benefit from a thumbnail for the browse view, or for items whose media does not render an elegant thumbnail, such as audio or video files. -The assets you select from and upload as thumbnails in this tab are the same as those created for [site logos](../../sites/site_theme/#settings-options). +The assets you select from and upload as thumbnails in this tab are the same as those created for [site logos](../sites/site_theme.md#settings-options). To assign an asset as a thumbnail, click on the Select button in the main work area of the tab. This will open a drawer on the right side. diff --git a/docs/content/media.md b/docs/content/media.md index 68f39905..0b8668f2 100644 --- a/docs/content/media.md +++ b/docs/content/media.md @@ -27,7 +27,7 @@ Media are displayed in a table. Each media is a row, with columns for: Options for navigating and creating items display above the table of items: - On the left side is a display for the number of pages of media, with forward and back arrows. The current page number is an editable field - enter any valid page number and hit return/enter on your keyboard to go to that page. -- In the center top is a button for [Advanced Search](../../search#media-advanced-search). +- In the center top is a button for [Advanced Search](../search.md#media-advanced-search). - Just above the table on the right are options for sorting media, with two dropdown menus. The first lets you select between **Title**, **Class**, **Owner**, **(date) Created**, and **Size**; the second allows you to sort ascending or descending. To apply, click the "Sort" button. Clicking on the title of any media will take you to its metadata page. This page displays any metadata in the main work area, with a sidebar on the right listing the visibility, associated item (an active link), date created, MIME type, Size, Ingester, Source, and links to the file derivatives. @@ -57,7 +57,7 @@ To edit existing media, you can: - Go to the Media browse page, click on the title to view the media's metadata and then click the "Edit media" button in the upper right hand corner - Click on the media's name in the right-hand sidebar of an item's page to go to the media's metadata, and then click on "Edit media" from there. -Editing media is very similar to editing [items](../../content/items) or [item sets](../../content/item-sets). +Editing media is very similar to editing [items](../content/items) or [item sets](../content/item-sets). ![Edit media page, with no properties loaded](../content/contentfiles/media_edit.png) @@ -78,7 +78,7 @@ Note that if you add the property `dcterms:title`, its contents will replace the ![image of text input field with keyboard icon indicating text input, the globe icon for setting language, and a trashcan delete icon](contentfiles/items_textedit.png) -You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe icon to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes){target=_blank} code for the language in which the text is written. +You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe icon to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code for the language in which the text is written. ![Red arrow points to the globe icon and a text entry field highlighted in blue](contentfiles/item_lang.png) @@ -118,7 +118,7 @@ When you input a value for a property associated for a resource, you are making - Certainty: What is the confidence of this fact? - Type: What type of concept/thing is this fact? -In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification){target=_blank}. Each value can have any number of annotations. +In the world of linked data, this process is know as [reification](https://www.w3.org/wiki/RdfReification). Each value can have any number of annotations. To create an annotation, click on the ellipsis on the right side of the value input interface, and then click on the annotation icon (a dialogue bubble). @@ -134,7 +134,7 @@ Input the annotation, and click "Set Annotations" to finalize the process. Sites include a setting to indicate whether or not value annotations are visible to the public. -**Language**: You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes){target=_blank} code for the language in which the text is written. +**Language**: You can indicate the language for the content of an input using the globe symbol above the input (see the red arrow in the image below). Click on the globe to activate a text field, then enter the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code for the language in which the text is written. ![Red arrow points to the globe icon and a text entry field highlighted in blue](contentfiles/item_lang.png) diff --git a/docs/content/resource-template.md b/docs/content/resource-template.md index 48656ee0..fce6406d 100644 --- a/docs/content/resource-template.md +++ b/docs/content/resource-template.md @@ -12,13 +12,13 @@ On the right side above the table are two drop-down menus which let you sort res You can use the icons in each template’s row to: **edit** (pencil), **delete** (trash can), or **view details** (ellipsis). If you click on the number of items listed for a template, it will take you to a list of all those items. -[This screencast](https://vimeo.com/290924872){target=_blank} gives an overview of creating and applying resource templates: +[This screencast](https://vimeo.com/290924872) gives an overview of creating and applying resource templates:

Omeka S Resource Templates from Omeka on Vimeo.

## Base Resource -All Omeka S installations include a "Base Resource" template which maps to the metadata fields required by the [Digital Public Library of America (DPLA)](https://dp.la/){target=_blank}. It will display in the table of resource templates as "Base Resource" with no owner. +All Omeka S installations include a "Base Resource" template which maps to the metadata fields required by the [Digital Public Library of America (DPLA)](https://dp.la/). It will display in the table of resource templates as "Base Resource" with no owner. ![Base resource template displayed in the table of templates](contentfiles/templates_base1.png) diff --git a/docs/content/vocabularies.md b/docs/content/vocabularies.md index 639ab38a..a8705ae0 100644 --- a/docs/content/vocabularies.md +++ b/docs/content/vocabularies.md @@ -6,16 +6,16 @@ For example, you can find ontologies for describing [audio signals](https://lov. > *"A vocabulary in LOV gathers definitions of a set of classes and properties (together simply called terms of the vocabulary), useful to describe specific types of things, or things in a given domain or industry, or things at large but for a specific usage." (Source: )* -The most-used [Linked Open Vocabulary](https://lov.linkeddata.es/dataset/lov/about){target=_blank} is Dublin Core Terms (`dcterms:`). +The most-used [Linked Open Vocabulary](https://lov.linkeddata.es/dataset/lov/about) is Dublin Core Terms (`dcterms:`). !!! note Vocabularies in Omeka S are not the same thing as controlled vocabularies or authority files, which consist of terms and concepts, rather than Classes and Properties. In Omeka S, controlled vocabularies can be managed using the [Value Suggest](../modules/valuesuggest.md) and [Custom Vocab](../modules/customvocab.md) modules. Global Administrators can manage their installation’s vocabularies from the **Vocabularies** tab on the left hand navigation of the Admin Dashboard. Supervisors can add, edit, and delete their own vocabularies. -Omeka S comes pre-loaded with the following vocabularies: [Dublin Core](http://purl.org/dc/terms/){target=_blank}; [Dublin Core Type](http://purl.org/dc/dcmitype/){target=_blank}; [Bibliographic Ontology](https://bibliontology.com/){target=_blank}; and [Friend of a Friend](https://en.wikipedia.org/wiki/FOAF_(ontology)){target=_blank}. +Omeka S comes pre-loaded with the following vocabularies: [Dublin Core](http://purl.org/dc/terms/); [Dublin Core Type](http://purl.org/dc/dcmitype/); [Bibliographic Ontology](https://bibliontology.com/); and [Friend of a Friend](https://en.wikipedia.org/wiki/FOAF_(ontology)). -This [screencast](https://vimeo.com/449764902){target=_blank} walks through managing and adding vocabularies: +This [screencast](https://vimeo.com/449764902) walks through managing and adding vocabularies:

Omeka S Vocabularies from Omeka on Vimeo.

@@ -36,7 +36,7 @@ New vocabularies must be imported from an existing metadata standard source. In The New vocabulary page has three sections: Basic Info, File, and Advanced. -Note that you may have to research in order to find the prefix, namespace URI, and label for the vocabulary, as these are not standardized. In addition to the vocabulary's website, you might consult {target=_blank}. +Note that you may have to research in order to find the prefix, namespace URI, and label for the vocabulary, as these are not standardized. In addition to the vocabulary's website, you might consult . After you have imported a vocabulary, you can use the Edit function to modify the vocabulary's Label and Comment, and to upload an updated vocabulary RDF file. diff --git a/docs/frontpage.md b/docs/frontpage.md index d89f437f..3a46c8b4 100644 --- a/docs/frontpage.md +++ b/docs/frontpage.md @@ -12,4 +12,4 @@ If you want this index page to be hidden from site visitors, a Global Administra - Under the "Default site" option, use the dropdown menu to select one of your current sites. - To remove a selected site and revert back to the index page, click the small "X" on the right side of the dropdown. -You can customize a branded site index for your installation by creating a site, creating a page, and then using the ["List of sites" page block](sites/site_pages.md#page-blocks) to generate a list of all the sites in the installation. Then, use the "Default site" option to point to that site. \ No newline at end of file +You can customize a branded site index for your installation by creating a site, creating a page, and then using the ["List of sites" page block](sites/site_pages.md#page-blocks) to generate a list of all the sites in the installation. Then, use the "Default site" option to point to that site. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index e8f1a44f..00000000 --- a/docs/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# 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 [administrative dashboard](admin-dashboard.md) of an Omeka S installation: - -**Sites** -Creating, editing, and managing sites, the public-facing parts of an Omeka S installation. - -**Resources** -Creating, editing, and managing the content of an installation: items, item sets, media, vocabularies, and resource templates. - -**Admin** -Access to functionality in the administrative interface varies by user role, but can include: users, jobs, assets, and settings. - -**Modules** -This section opens with basic information on managing the modules that extend the functionality of your Omeka S installation and sites. It then offers specific documentaiton for Omeka S modules created by the Omeka Team, listed in alphabetial order. - -This manual also includes a [glossary](glossary.md), instructions on conducting [searches](search.md), and how to turn on [error logging](errorLogging.md). - -Screencasts to supplement the documentation are linked from relevant pages, and can be browsed in the [Omeka S collection on Vimeo](https://vimeo.com/showcase/4215056){target=_blank}. - -
-

Omeka S Tour from Omeka on Vimeo.

diff --git a/docs/install.md b/docs/install.md index 78c363e6..692cf131 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,12 +4,12 @@ In order to install Omeka S, you will need a server running the following: - Linux -- Apache (with [AllowOverride](https://httpd.apache.org/docs/2.4/mod/core.html#allowoverride){target=_blank} set to "All" and [mod_rewrite](http://httpd.apache.org/docs/current/mod/mod_rewrite.html){target=_blank} enabled) +- Apache (with [AllowOverride](https://httpd.apache.org/docs/2.4/mod/core.html#allowoverride) set to "All" and [mod_rewrite](http://httpd.apache.org/docs/current/mod/mod_rewrite.html) enabled) - MySQL, minimum version 5.6.4 (or MariaDB, minimum version 10.0.5) -- PHP, minumum version 7.2, with [PDO](http://php.net/manual/en/intro.pdo.php){target=_blank}, [pdo_mysql](http://php.net/manual/en/ref.pdo-mysql.php){target=_blank}, and [xml](http://php.net/manual/en/intro.xml.php){target=_blank} extensions installed +- PHP, minumum version 7.2, with [PDO](http://php.net/manual/en/intro.pdo.php), [pdo_mysql](http://php.net/manual/en/ref.pdo-mysql.php), and [xml](http://php.net/manual/en/intro.xml.php) extensions installed - Optional, to create thumbnails: ImageMagick version 6.7.5 or greater, the PHP `imagick` extension, or the PHP `gd` extension. -[GD](https://secure.php.net/manual/en/intro.image.php){target=_blank} is a basic graphic library installed by default with PHP. It can create thumbnails for common image formats only (jpeg, gif, png). [Imagick and ImageMagick](https://www.imagemagick.org){target=_blank} are the same library and can create thumbnails for more than 200 formats. For more information, see the [Configuration page](configuration.md#thumbnails). +[GD](https://secure.php.net/manual/en/intro.image.php) is a basic graphic library installed by default with PHP. It can create thumbnails for common image formats only (jpeg, gif, png). [Imagick and ImageMagick](https://www.imagemagick.org) are the same library and can create thumbnails for more than 200 formats. For more information, see the [Configuration page](configuration.md#thumbnails). ## Installation methods @@ -18,7 +18,7 @@ In order to install Omeka S, you will need a server running the following: !!! note Before you install Omeka S, you need to create a MySQL database and user. Omeka S must have a dedicated database; you cannot use a prefix for a database used by another system or Omeka S or Classic installation. For more information on creating a database and user, please see your hosting's support documentation or talk to your system administrator. -1. [Download the latest release from the release page](https://omeka.org/s/download/){target=_blank}. +1. [Download the latest release from the release page](https://omeka.org/s/download/). 1. Extract this downloaded zip file to your computer. 1. Inside the directory, open the `config/database.ini` file and add your MySQL username, password, database name, and host name. The user and database must be created before this step. 1. Upload this entire directory to your server, into the folder of your choice. For example, if your server is `https://yourwebsite.org/`, you may wish to install Omeka S into a folder located at `https://yourwebsite.org/myomekas/`. Make sure it has your updated `database.ini` file (do not upload the original zip file you downloaded). @@ -27,21 +27,21 @@ In order to install Omeka S, you will need a server running the following: ### Installing from GitHub -Basic instructions for installing and updating from GitHub can be found in the [ReadMe](https://github.com/omeka/omeka-s/blob/develop/README.md){target=_blank} of the Omeka S GitHub repository. +Basic instructions for installing and updating from GitHub can be found in the [ReadMe](https://github.com/omeka/omeka-s/blob/develop/README.md) of the Omeka S GitHub repository. Then, in your web browser, navigate to the admin page for your Omeka S installation (`https://yourwebsite.org/myomekas/admin`), where you can complete the installation. ### One-click installation -Hosting companies that use [Softaculous](https://softaculous.com/){target=_blank} should offer a one-click install of [Omeka Classic](https://www.softaculous.com/softaculous/apps/educational/Omeka){target=_blank} and [Omeka S](https://www.softaculous.com/softaculous/apps/others/Omeka_S){target=_blank}. The one-click installation process through Softaculous may allow you to create a database and user at the same time, and will edit the `config/database.ini` file for you. +Hosting companies that use [Softaculous](https://softaculous.com/) should offer a one-click install of [Omeka Classic](https://www.softaculous.com/softaculous/apps/educational/Omeka) and [Omeka S](https://www.softaculous.com/softaculous/apps/others/Omeka_S). The one-click installation process through Softaculous may allow you to create a database and user at the same time, and will edit the `config/database.ini` file for you. Suggestions from our users include: -- [Reclaim Hosting](https://reclaimhosting.com/){target=_blank} - offers [simple Omeka S installations](https://support.reclaimhosting.com/hc/en-us/sections/204007617-Omeka){target=_blank} with some steps (including [manually setting the PHP path](#test-and-set-the-php-path)), and support for other open-source software platforms -- [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. +- [Reclaim Hosting](https://reclaimhosting.com/) - offers [simple Omeka S installations](https://support.reclaimhosting.com/hc/en-us/sections/204007617-Omeka) with some steps (including [manually setting the PHP path](#test-and-set-the-php-path)), and support for other open-source software platforms +- [Dotblock](http://www.dotblock.com) - uses Softaculous +- [HostGator](http://hostgator.com) - uses Softaculous +- [TMD Hosting](https://www.tmdhosting.com) - uses Softaculous +- [Webuzo](http://webuzo.com) - uses Softaculous. ## Initial setup @@ -75,7 +75,7 @@ Omeka S uses background jobs for some long-running tasks that operate on many it Omeka S by default will try to automatically detect the path to the PHP CLI on the server, but for some servers this detection doesn't work, or there are multiple different `php` commands to choose from. -If you are [using Reclaim Hosting](#one-click-installation), you will have to manually set the PHP path when you install. See [their instructions here](https://support.reclaimhosting.com/hc/en-us/articles/1500005620481#omeka-s){target=_blank}. +If you are [using Reclaim Hosting](#one-click-installation), you will have to manually set the PHP path when you install. See [their instructions here](https://support.reclaimhosting.com/hc/en-us/articles/1500005620481#omeka-s). If you begin to see errors once you start working with Omeka, particularly errors with something like "PHP-CLI error: invalid PHP path", you will need to manually set the PHP path. See [Configuration Options](configuration.md) to learn about modifying thumbnail generation, setting the PHP path manually, and more. @@ -97,10 +97,10 @@ If you begin to see errors once you start working with Omeka, particularly error ### Updating from GitHub -Basic instructions for installing and updating from GitHub can be found in the [ReadMe](https://github.com/omeka/omeka-s/blob/develop/README.md){target=_blank} of the Omeka S GitHub repository. +Basic instructions for installing and updating from GitHub can be found in the [ReadMe](https://github.com/omeka/omeka-s/blob/develop/README.md) of the Omeka S GitHub repository. ## Install on Windows or Mac OS (development only) -Omeka S does not support proprietary or closed-source operating systems. However, for **basic development purposes** or for quick training, Omeka can run with [WAMP](http://www.wampserver.com){target=_blank}, [MAMP](https://www.mamp.info){target=_blank}, or similar tools. +Omeka S does not support proprietary or closed-source operating systems. However, for **basic development purposes** or for quick training, Omeka can run with [WAMP](http://www.wampserver.com), [MAMP](https://www.mamp.info), or similar tools. Follow the standard installation instructions. You will need to make the following [configuration](configuration.md) changes to the file `config/local.config.php` to work. diff --git a/docs/modules/collecting.md b/docs/modules/collecting.md index 31b8bf84..fe16d17a 100644 --- a/docs/modules/collecting.md +++ b/docs/modules/collecting.md @@ -1,6 +1,6 @@ # Collecting -The [Collecting module](https://omeka.org/s/modules/Collecting/){target=_blank} allows you to gather public contributions through your sites. Users can upload files or submit textual entries along with some identifying metadata, which your site administrators can then moderate and approve for inclusion. +The [Collecting module](https://omeka.org/s/modules/Collecting/) allows you to gather public contributions through your sites. Users can upload files or submit textual entries along with some identifying metadata, which your site administrators can then moderate and approve for inclusion. Once activated on the [modules](index.md) tab of the admin dashboard, Collecting is configured on a site-by-site basis. It adds a section to your Site Settings page, and adds a link under each Site for Collecting forms. Forms are added to site pages by way of [page blocks](../sites/site_pages.md#page-blocks). diff --git a/docs/modules/csseditor.md b/docs/modules/csseditor.md index 16ba54b6..9679b184 100644 --- a/docs/modules/csseditor.md +++ b/docs/modules/csseditor.md @@ -1,14 +1,14 @@ # CSS Editor -The [CSS Editor module](https://omeka.org/s/modules/CSSEditor){target=_blank} allows you to write CSS from the Omeka S admin interface. +The [CSS Editor module](https://omeka.org/s/modules/CSSEditor) allows you to write CSS from the Omeka S admin interface. -Once activated on the [modules](https://omeka.org/s/docs/user-manual/modules/){target=_blank} section of the admin dashboard, CSS Editor is used on a site-by-site basis. +Once activated on the [modules](https://omeka.org/s/docs/user-manual/modules/) section of the admin dashboard, CSS Editor is used on a site-by-site basis. If you are new to working with CSS, we recommend the following free resources for getting started: -* [Mozilla's "Learn CSS"](https://developer.mozilla.org/en-US/docs/Web/CSS){target=_blank} -* [Codecademy's "Learn CSS" course](https://www.codecademy.com/learn/learn-css){target=_blank} -* [Marksheet's "CSS Basics"](https://marksheet.io/css-basics.html){target=_blank} +* [Mozilla's "Learn CSS"](https://developer.mozilla.org/en-US/docs/Web/CSS) +* [Codecademy's "Learn CSS" course](https://www.codecademy.com/learn/learn-css) +* [Marksheet's "CSS Basics"](https://marksheet.io/css-basics.html) The easiest way to learn Omeka S page components for the sake of CSS editing is to use your browser's Inspect tool when looking at your chosen theme. @@ -34,7 +34,7 @@ To remove external stylesheets, either clear the text inputs, or click on the tr ## Tutorial: Using a Google webfont -You can make your Omeka S site more distinct by using a custom font. [Google provides a free library of webfonts](https://fonts.google.com/){target=_blank}, and this tutorial will demonstrate how to apply a webfont to an Omeka S site using the "Default" theme through the CSS Editor interface. +You can make your Omeka S site more distinct by using a custom font. [Google provides a free library of webfonts](https://fonts.google.com/), and this tutorial will demonstrate how to apply a webfont to an Omeka S site using the "Default" theme through the CSS Editor interface. For reference, the "Default" theme begins looking like this, using the "Open Sans" font. @@ -42,7 +42,7 @@ For reference, the "Default" theme begins looking like this, using the "Open San This tutorial will override "Open Sans" with the "Lato" font family. -1. Navigate to [Google Fonts](https://fonts.google.com/){target=_blank}. Find the "Lato" font family and click on the orange "+" button to select it. +1. Navigate to [Google Fonts](https://fonts.google.com/). Find the "Lato" font family and click on the orange "+" button to select it. ![Google Fonts main page with "Lato" font family highlighted](modulesfiles/csseditor_tutorial1.jpg)
2. A bar labeled "1 Family Selected" will appear in the lower right corner. Click on this bar. ![Cropped view of Google Fonts page with selected font family bar highlighted](modulesfiles/csseditor_tutorial2.jpg)
diff --git a/docs/modules/csvimport.md b/docs/modules/csvimport.md index 4ddd0066..28c25e47 100644 --- a/docs/modules/csvimport.md +++ b/docs/modules/csvimport.md @@ -1,6 +1,6 @@ # CSV Import -The [CSV Import module](https://omeka.org/s/modules/CSVImport){target=_blank} allows you to import items, item sets, media, and users into your Omeka S install from a CSV (comma-separated values), TSV (tab-separated values), or ODF (open document format) file. This module is only available to [Global Administrator and Supervisor users](../admin/users.md). +The [CSV Import module](https://omeka.org/s/modules/CSVImport) allows you to import items, item sets, media, and users into your Omeka S install from a CSV (comma-separated values), TSV (tab-separated values), or ODF (open document format) file. This module is only available to [Global Administrator and Supervisor users](../admin/users.md). @@ -136,7 +136,7 @@ Column options are in addition to mappings. If you add options without also mapp This will open a drawer on the right side of the browser window with the following options: - **Use multivalve separator**: Check this box to use the multivalue separator for data in this column. You set the multivalue separator in the initial import page, but you can change it in the Basic Settings tab. -- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} for the language in which the text is written. This will override what you have entered in basic settings. +- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for the language in which the text is written. This will override what you have entered in basic settings. - **Data type**: A dropdown with at least three options, which correspond to the [values](../content/items.md#values) one can use when adding properties to an item: - Import as text (default). - Import as URI reference. You can set the label for a URI by including the desired text after a space, for example: `http://example.com Label Text Goes Here`. @@ -170,7 +170,7 @@ These settings apply to the entire CSV you are importing. Note that some of thes - **Sites**: Add the imported items to the specified site or sites. Global and user-specific default sites will be preselected here. - **Multivalue separator**: Enter the multivalue separator character here, if you have used one. - The columns of data in your CSV should be separated by commas, however within those columns you can add a special character to create multiple inputs, for example a semicolon. This is where you can specify multiple creators, multiple subjects, or other common uses. -- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank}. +- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag). !!! note If you are uploading different formats of data (for example, some text-based creator names and some URI-based creator links) into the same field (`dcterms:creator`, in this case), use two columns (named something helpful like "dcterms:creator-text" and "dcterms:creator-uri"), and upon import, map those two columns to different data types. Use the wrench icon to open up column mappings and select the correct data type for each column. @@ -262,7 +262,7 @@ Column options are in addition to mappings. If you add options without also mapp This will open a drawer on the right side of the browser window with the following options: - **Use multivalve separator**: Check this box to use the multivalue separator for data in this column. You set the multivalue separator in the initial import page, but you can change it in the Basic Settings tab. -- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} for the language in which the text is written. This will override what you have entered in basic settings. +- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for the language in which the text is written. This will override what you have entered in basic settings. - **Data type**: A dropdown with at least three options, which correspond to the [values](../content/items.md#values) one can use when adding properties to an item: - Import as text (default). - Import as URL reference. You can set the label for the URI by including the desired text after a space, for example: `http://example.com This Is The Label` @@ -293,7 +293,7 @@ These settings apply to the entire CSV which you are importing. Note that some o - **Open/closed to additions**: Set whether users other than the owner (and site & global admins) will be able to add or edit the item sets. - **Multivalue separator**: Enter the multivalue separator character here, if you have used one. - The columns of data in your CSV should be separated by commas, however within those columns you can add a special character to create multiple inputs, for example a semicolon. -- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank}. +- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag). ### Item Set import advanced settings @@ -401,7 +401,7 @@ Column options are in addition to mappings. If you add options without also mapp This will open a drawer on the right side of the browser window with the following options: - **Use multivalve separator**: Check this box to use the multivalue separator for data in this column. You set the multivalue separator in the initial import page, but you can change it in the Basic Settings tab. -- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} for the language in which the text is written. This will override what you have entered in basic settings. +- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for the language in which the text is written. This will override what you have entered in basic settings. - **Data type**: A dropdown with at least three options, which correspond to the [values](../content/items.md#values) one can use when adding properties to an item: - Import as text (default). - Import as URL reference. You can set the label for the URI by including the desired text after a space, for example: `http://example.com This Is The Label`. @@ -431,7 +431,7 @@ These settings apply to the entire CSV which you are importing. Note that some o - **Visibility**: Set the visibility of the imported media as public or private. - **Multivalue separator**: Enter the multivalue separator character here, if you have used one. - The columns of data in your CSV should be separated by commas; however, within those columns you can add a special character to create multiple inputs, for example a semicolon. -- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank}. +- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag). ### Media import advanced settings There are two options on this tab which are only for advanced use. @@ -542,7 +542,7 @@ Column options are in addition to mappings. If you add options without also mapp This will open a drawer on the right side of the browser window with the following options: - **Use multivalue separator**: Check this box to use the multivalue separator for data in this column. You set the multivalue separator character in the initial import page, but you can change it in the Basic Settings tab. -- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank} for the language in which the text is written. This will override what you have entered in basic settings. +- **Language**: Set the language for this column using the [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for the language in which the text is written. This will override what you have entered in basic settings. - **Data type**: A dropdown with at least three options, which correspond to the [values](../content/items.md#values) one can use when adding properties to an item: - Import as text (default). - Import as URL reference. You can set the label for the URI by including the desired text after a space, for example: `http://example.com This Is The Label`. @@ -575,7 +575,7 @@ These settings apply to the entire CSV you are importing. Note that some of thes - **Sites for items**: Select one or more of your existing sites to add new items as resources. - **Multivalue separator**: Enter the multivalue separator character here, if you have used one. - The columns of data in your CSV should be separated by commas, however within those columns you can add a special character to create multiple inputs, for example a semicolon. -- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag){target=_blank}. +- **Language**: Set the language of the values in the spreadsheet using the appropriate [IETF Language tag](https://en.wikipedia.org/wiki/IETF_language_tag). ### Mixed resources import advanced settings There are two options on this tab which are only for advanced use. @@ -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: @@ -730,30 +730,30 @@ Options are: When importing data as numeric, it must be formatted precisely. Always check to be sure your data has imported correctly into the format of your choice; CSV Import will leave values empty if the formatting isn't recognized. -Use the following formats for importing [dates](https://en.wikipedia.org/wiki/ISO_8601#Dates){target=_blank}, including dashes between values: +Use the following formats for importing [dates](https://en.wikipedia.org/wiki/ISO_8601#Dates), including dashes between values: - `2022` - `2022-08` (year and month, no date) - `2022-08-18`. -Use the following formats to add [times](https://en.wikipedia.org/wiki/ISO_8601#Times){target=_blank} to your date values: +Use the following formats to add [times](https://en.wikipedia.org/wiki/ISO_8601#Times) to your date values: -- `2022-08-18T17:26:49+00:00` ([time offset from UTC](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC){target=_blank}) -- `2022-08-18T17:26:49Z` ([coordinated universal time](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)){target=_blank}). +- `2022-08-18T17:26:49+00:00` ([time offset from UTC](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC)) +- `2022-08-18T17:26:49Z` ([coordinated universal time](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC))). You cannot omit the year while providing a month and/or day. You cannot supply ordinal dates (as in, `2000-175` for the 175th day of the year 2000). -Use the following formats for importing [intervals](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals){target=_blank} either as start and end points, or with one time point and a duration: +Use the following formats for importing [intervals](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) either as start and end points, or with one time point and a duration: - `2007-03-01T13:00:00Z/2008-05-11T15:30:00Z` (Start and end) - `2007-03-01T13:00:00Z/P1Y2M10DT2H30M` (Start time/date and duration) - `P1Y2M10DT2H30M/2008-05-11T15:30:00Z` (Duration and end time/date). -Use the following formats for importing [durations](https://en.wikipedia.org/wiki/ISO_8601#Durations){target=_blank}, expressed as number of years, number of months, number of days, etc.: +Use the following formats for importing [durations](https://en.wikipedia.org/wiki/ISO_8601#Durations), expressed as number of years, number of months, number of days, etc.: - `P23DT23H` (23 days & 23 hours) - `P3Y6M4DT12H30M5S` (3 years, 6 months, 4 days, 12 hours, 30 minutes, & 5 seconds). ### 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/customvocab.md b/docs/modules/customvocab.md index 625df82c..f91e0be2 100644 --- a/docs/modules/customvocab.md +++ b/docs/modules/customvocab.md @@ -1,6 +1,6 @@ # Custom Vocab -The [Custom Vocab module](https://omeka.org/s/modules/CustomVocab){target=_blank} allows you to create a controlled vocabulary and add it to a specific property in a resource template. When using that template for an item, the property will load with a dropdown limited to the options of the controlled vocabulary, rather than a text entry box. +The [Custom Vocab module](https://omeka.org/s/modules/CustomVocab) allows you to create a controlled vocabulary and add it to a specific property in a resource template. When using that template for an item, the property will load with a dropdown limited to the options of the controlled vocabulary, rather than a text entry box. For example, you may want to create an institution-specific list of locations that correspond to different collections on your campus, or a controlled list of people or places related to your holdings. This can help reduce typos and name variations, and can allow you to offer [metadata browsing](../modules/metadatabrowse.md) for more fields. @@ -17,7 +17,7 @@ The Add Custom Vocab page has four fields: Label, Language, Vocab Type, and Term ![Add Custom Vocab with data entered in the label and terms fields](../modules/modulesfiles/customVocab-add-URI.png) - **Label**: A name for the vocabulary, which you will use to find it when adding to a resource template. -- **Language** (optional): The language of the vocab, using the [ISO 639-1 language code](http://www.iso.org/iso/language_codes){target=_blank}. +- **Language** (optional): The language of the vocab, using the [ISO 639-1 language code](http://www.iso.org/iso/language_codes). You can set the controlled vocabulary terms to a list of entered terms, to a list of existing items, or to a list of external URIs with or without labels: diff --git a/docs/modules/datacleaning.md b/docs/modules/datacleaning.md index c8262e51..bf27915b 100644 --- a/docs/modules/datacleaning.md +++ b/docs/modules/datacleaning.md @@ -3,7 +3,7 @@ title: Data Cleaning --- # Data Cleaning -The [Data Cleaning module](https://omeka.org/s/modules/DataCleaning){target=_blank} is for low-level auditing and cleaning of resource metadata. It is designed to prepare resource metadata for use in visualizations. +The [Data Cleaning module](https://omeka.org/s/modules/DataCleaning) is for low-level auditing and cleaning of resource metadata. It is designed to prepare resource metadata for use in visualizations. Changes made by Data Cleaning cannot be easily undone, and can be destructive. Due to the powerful nature of the module, it can only be used by Global Administrators. diff --git a/docs/modules/datarepositoryconnector.md b/docs/modules/datarepositoryconnector.md index 28b3a006..28737607 100644 --- a/docs/modules/datarepositoryconnector.md +++ b/docs/modules/datarepositoryconnector.md @@ -1,6 +1,6 @@ # Data Repository Connector -The [Data Repository Connector module](../modules/datarepositoryconnector.md){target=_blank} allows users to import records and/or data files from several different data repository platforms: Dataverse, Zenodo, and CKAN. +The [Data Repository Connector module](../modules/datarepositoryconnector.md) allows users to import records and/or data files from several different data repository platforms: Dataverse, Zenodo, and CKAN. To install Data Repository Connector, follow the instructions for [Installing Modules](../modules/index.md#installing-modules) on the Modules documentation. diff --git a/docs/modules/datavisualization.md b/docs/modules/datavisualization.md index c494a65f..cfdf4461 100644 --- a/docs/modules/datavisualization.md +++ b/docs/modules/datavisualization.md @@ -3,7 +3,7 @@ title: Data Visualization --- # Data Visualization -The [Data Visualization module](https://omeka.org/s/modules/Datavis){target=_blank} allows site administrators are able to generate datasets and render diagrams that reflect their data. Once installed and activated on the Modules section of the admin dashboard, Data Visualization is managed on a site-by-site basis. You can add your data diagrams to site pages using page blocks. +The [Data Visualization module](https://omeka.org/s/modules/Datavis) allows site administrators are able to generate datasets and render diagrams that reflect their data. Once installed and activated on the Modules section of the admin dashboard, Data Visualization is managed on a site-by-site basis. You can add your data diagrams to site pages using page blocks. ## Data visualizations by site If the Data Visualization module is active, a section for Data Visualization will appear in the menu for individual sites. Clicking this link will take you to a list of all visualizations created for the site. diff --git a/docs/modules/dspaceconnector.md b/docs/modules/dspaceconnector.md index 35538883..bbe85ba7 100644 --- a/docs/modules/dspaceconnector.md +++ b/docs/modules/dspaceconnector.md @@ -1,6 +1,6 @@ # DSpace Connector -The [DSpace Connector module](https://omeka.org/s/modules/DspaceConnector){target=_blank} allows you to connect an Omeka S instance to a [DSpace repository](https://duraspace.org/dspace/){target=_blank} to import items from that repository. In addition to importing information, the Omeka S item will include a link back to the original item. +The [DSpace Connector module](https://omeka.org/s/modules/DspaceConnector) allows you to connect an Omeka S instance to a [DSpace repository](https://duraspace.org/dspace/) to import items from that repository. In addition to importing information, the Omeka S item will include a link back to the original item. Note that DSpace Connector only works with DSpace versions 5.6 and higher. This connector relies on the DSpace API and its site-by-site configuration. @@ -42,7 +42,7 @@ To import the entire repository, click "Import entire repository" at the top of * On the initial "Import Settings" menu, set **Limit** to a smaller number, such as 50 or 25. * Run the import at night and/or whenever there may be less traffic on the DSpace server. -* Consider temporarily inserting [a `sleep()` function](https://www.w3schools.com/php/func_misc_sleep.asp){target=_blank} between the import of each record in `Import.php` to slow the process down slightly (not recommended for production). +* Consider temporarily inserting [a `sleep()` function](https://www.w3schools.com/php/func_misc_sleep.asp) between the import of each record in `Import.php` to slow the process down slightly (not recommended for production). You can track the status of imports by navigating to the DSpace Connector "Past Imports" tab, or on the [Jobs](../admin/jobs.md) page of the admin dashboard. diff --git a/docs/modules/extractmetadata.md b/docs/modules/extractmetadata.md index 7f589e6d..aebca53a 100644 --- a/docs/modules/extractmetadata.md +++ b/docs/modules/extractmetadata.md @@ -1,6 +1,6 @@ # Extract Metadata -The [Extract Metadata module](https://omeka.org/s/modules/ExtractMetadata){target=_blank} allows site administrators to extract embedded metadata from media files. +The [Extract Metadata module](https://omeka.org/s/modules/ExtractMetadata) allows site administrators to extract embedded metadata from media files. The module adds a new "Extract metadata" tab to each media page, which will allow you to manually extract any embedded metadata found on the file. It also adds an "Extract metadata" field to the batch-editing page. When enabled, it automatically works on newly uploaded files. @@ -15,7 +15,7 @@ When configuring the module, you can: - Configure the metadata crosswalk for the JSON Pointer mapper (if enabled). If you decide to use the JSON pointer mapper, you will need to define the metadata crosswalk. 1. Click the "Add map +" button. 1. Select the Resource, Extractor, and Property from dropdown menus. - 1. Provide a Pointer formatted using a JSON pointer as defined by the [IETF standard](https://datatracker.ietf.org/doc/html/rfc6901){target=_blank}. + 1. Provide a Pointer formatted using a JSON pointer as defined by the [IETF standard](https://datatracker.ietf.org/doc/html/rfc6901). 1. If you would like to replace the metadata values through this pointer, make sure to select the checkbox to the right of these fields. When you are finished configuring the module, click the "Submit" button in the upper right corner of the screen. @@ -60,19 +60,19 @@ Extractors extract metadata from files. Note that extractors must be enabled on ### ExifTool -Used to extract many types of metadata from many types of files. Requires the [ExifTool](https://exiftool.org/){target=_blank} command-line application. +Used to extract many types of metadata from many types of files. Requires the [ExifTool](https://exiftool.org/) command-line application. ### Exif -Used to extract EXIF metadata that is commonly found in JPEG and TIFF files. Requires PHP's [exif](https://www.php.net/manual/en/book.exif.php){target=_blank} extension. +Used to extract EXIF metadata that is commonly found in JPEG and TIFF files. Requires PHP's [exif](https://www.php.net/manual/en/book.exif.php) extension. ### getID3 -Used to extract many types of metadata from many types of files. Uses the [getID3](https://github.com/JamesHeinrich/getID3){target=_blank} PHP library, which comes with this module. +Used to extract many types of metadata from many types of files. Uses the [getID3](https://github.com/JamesHeinrich/getID3) PHP library, which comes with this module. ### Tika -Used to extract many types of metadata from many types of files. Requires the [Apache Tika](https://tika.apache.org/){target=_blank} content analysis toolkit. Java must be installed and the path to the `tika-app-*.jar` file must be configured in `config/module.config.php` under `[extract_metadata_extractor_config][tika][jar_path]`. +Used to extract many types of metadata from many types of files. Requires the [Apache Tika](https://tika.apache.org/) content analysis toolkit. Java must be installed and the path to the `tika-app-*.jar` file must be configured in `config/module.config.php` under `[extract_metadata_extractor_config][tika][jar_path]`. ## Mappers @@ -82,7 +82,7 @@ Mappers map extracted metadata to resource values. Note that a mapper must be en ### JSON pointer -You can map extracted metadata to media metadata properties using [JSON pointers](https://datatracker.ietf.org/doc/html/rfc6901){target=_blank}. You must define your own metadata crosswalk in the module configuration page under the "JSON Pointer crosswalk" tab. +You can map extracted metadata to media metadata properties using [JSON pointers](https://datatracker.ietf.org/doc/html/rfc6901). You must define your own metadata crosswalk in the module configuration page under the "JSON Pointer crosswalk" tab. You may wish to extract metadata from a few files first and see what information can be pointed to, then test some options on where best to map them. diff --git a/docs/modules/extracttext.md b/docs/modules/extracttext.md index b1e12a7e..1bb8fc14 100644 --- a/docs/modules/extracttext.md +++ b/docs/modules/extracttext.md @@ -1,6 +1,6 @@ # Extract Text -The [Extract Text module](https://omeka.org/s/modules/ExtractText){target=_blank} will extract text from files to make them searchable and machine readable. The extracted text will be added to a property called "extracted text" in a vocabulary unique to that module. +The [Extract Text module](https://omeka.org/s/modules/ExtractText) will extract text from files to make them searchable and machine readable. The extracted text will be added to a property called "extracted text" in a vocabulary unique to that module. When enabled, Extract Text adds a new metadata field, with a textual data type, at the item level and at the media level, with the name "extracted text" and the slug `extracttext:extracted_text`. It is set to public by default on item view pages. diff --git a/docs/modules/facetedbrowse.md b/docs/modules/facetedbrowse.md index 5fab1666..f61190f7 100644 --- a/docs/modules/facetedbrowse.md +++ b/docs/modules/facetedbrowse.md @@ -1,6 +1,6 @@ # Faceted Browse -The [Faceted Browse module](https://omeka.org/s/modules/FacetedBrowse){target=_blank} lets you create "browse resource" pages with facets - filter and sort functions - that site visitors can use. +The [Faceted Browse module](https://omeka.org/s/modules/FacetedBrowse) lets you create "browse resource" pages with facets - filter and sort functions - that site visitors can use. With this module, site managers are able to configure faceted browse pages and add them to their sites. End users are then able to browse through categories of resources and use the facets to narrow the results in a logical and intuitive manner. This functionality is similar to the filtering options on many websites and should be easy for users to manage as long as you have clear language. diff --git a/docs/modules/fedoraconnector.md b/docs/modules/fedoraconnector.md index 8762eb28..dc2fa5fb 100644 --- a/docs/modules/fedoraconnector.md +++ b/docs/modules/fedoraconnector.md @@ -1,6 +1,6 @@ # Fedora Connector -The [Fedora Connector module](https://omeka.org/s/modules/FedoraConnector){target=_blank} allows you to connect an Omeka S instance to a [Fedora](https://duraspace.org/fedora/){target=_blank} 4 repository in order to import items from containers in that repository. In addition to importing information, the Omeka S item will include a link back to the original item. +The [Fedora Connector module](https://omeka.org/s/modules/FedoraConnector) allows you to connect an Omeka S instance to a [Fedora](https://duraspace.org/fedora/) 4 repository in order to import items from containers in that repository. In addition to importing information, the Omeka S item will include a link back to the original item. Note that Fedora Connector only works with version 4 of Fedora. @@ -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/filesideload.md b/docs/modules/filesideload.md index 9876d4a7..160c6f0d 100644 --- a/docs/modules/filesideload.md +++ b/docs/modules/filesideload.md @@ -1,6 +1,6 @@ # File Sideload -The [File Sideload module](https://omeka.org/s/modules/FileSideload){target=_blank} adds the ability to add media files that are already stored on the server where your Omeka S installation lives. +The [File Sideload module](https://omeka.org/s/modules/FileSideload) adds the ability to add media files that are already stored on the server where your Omeka S installation lives. File Sideload is compatible with [CSV Import](../modules/csvimport.md). When installed, your CSV Import options will include the ability to add media via Sideload. diff --git a/docs/modules/index.md b/docs/modules/index.md index 564542a4..856eb63b 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -1,6 +1,6 @@ # Modules Management -Modules extend the functionality of your Omeka S installation and sites. A list of modules available for download is on the [Modules Directory](https://omeka.org/s/modules/){target=_blank}. Instructions are available on each module's documentation page. +Modules extend the functionality of your Omeka S installation and sites. A list of modules available for download is on the [Modules Directory](https://omeka.org/s/modules/). Instructions are available on each module's documentation page. !!! Note Not every module will work with every version of Omeka, especially newer modules on old installations. Older versions of modules may be available on their Github pages. Use the Modules Directory to find the "Github" link on the right side of the screen for each plugin, then look on the right hand side of the Github page for the "Releases" section. @@ -28,7 +28,7 @@ When a module has a new release, it will display on the browse page with a messa ## Adding modules to Omeka S In order to appear in the **Modules** section of the admin dashboard for your Omeka S installation, module files must be manually added to the `/modules` folder of the installation, using an FTP program or SSH connection. -Modules registered with Omeka are available on the [Modules](https://omeka.org/s/modules/){target=_blank} directory of the Omeka S site. Other modules may be made available by their authors in other locations. +Modules registered with Omeka are available on the [Modules](https://omeka.org/s/modules/) directory of the Omeka S site. Other modules may be made available by their authors in other locations. To add a module to the site using FTP: @@ -40,7 +40,7 @@ To add a module to the site using FTP: !!! note The folder that appears in the `/modules` folder should show the name of the module, without any version numbers. If you are having issues installing a module, check that you have unzipped the module correctly, without creating extra folder levels. -Please note that if you are downloading the folder for a module from GitHub rather than the [Module Directory](https://omeka.org/s/modules/){target=_blank}, you need to be sure to download the [latest release](https://help.github.com/en/articles/linking-to-releases){target=_blank} rather than the version in active development. If you are unsure how to do this, please consult the [GitHub help files](https://help.github.com/en){target=_blank}. +Please note that if you are downloading the folder for a module from GitHub rather than the [Module Directory](https://omeka.org/s/modules/), you need to be sure to download the [latest release](https://help.github.com/en/articles/linking-to-releases) rather than the version in active development. If you are unsure how to do this, please consult the [GitHub help files](https://help.github.com/en). You can also use SSH to clone a module directly from that module's git repository. Do this only if you are comfortable with git, GitHub, and working with SSH. @@ -91,4 +91,4 @@ To update a module using FTP: If you are concerned about problems with the update, be sure to keep the older version of the module on your local machine in case you have to switch them back. Follow the same update steps with the earlier version of the module. -If you run into problems while updating, turn on [error logging](../errorLogging) and post on the [Omeka Forum](https://forum.omeka.org/c/omeka-s/modules){target=_blank}. +If you run into problems while updating, turn on [error logging](../errorLogging) and post on the [Omeka Forum](https://forum.omeka.org/c/omeka-s/modules). diff --git a/docs/modules/itemcarouselblock.md b/docs/modules/itemcarouselblock.md index c56b8f7b..43643d7e 100644 --- a/docs/modules/itemcarouselblock.md +++ b/docs/modules/itemcarouselblock.md @@ -1,6 +1,6 @@ # Item Carousel Block -The [Item Carousel Block module](https://omeka.org/s/modules/ItemCarouselBlock){target=_blank} allows you to add a slideshow block to [Site Pages](../sites/site_pages.md#page-blocks). +The [Item Carousel Block module](https://omeka.org/s/modules/ItemCarouselBlock) allows you to add a slideshow block to [Site Pages](../sites/site_pages.md#page-blocks). Once activated, Item Carousel Block adds an "Item Carousel" page block to the list available from the page editing interface. diff --git a/docs/modules/mapping.md b/docs/modules/mapping.md index 375c8d74..3f5e3533 100644 --- a/docs/modules/mapping.md +++ b/docs/modules/mapping.md @@ -1,6 +1,6 @@ # Mapping -The [Mapping module](https://omeka.org/s/modules/Mapping){target=_blank} allows you to geolocate Omeka S items. Maps can also include timelines that allow you to scroll through items on a map in chronological order. +The [Mapping module](https://omeka.org/s/modules/Mapping) allows you to geolocate Omeka S items. Maps can also include timelines that allow you to scroll through items on a map in chronological order. ![Map with timeline](../modules/modulesfiles/mapping-timelinePublic1.png) @@ -125,7 +125,7 @@ Within the preview map, there are five buttons: ### WMS overlays - Add, edit, and delete [Web Map Service (WMS)](https://mapserver.org/ogc/wms_server.html){target=_blank} overlays. + Add, edit, and delete [Web Map Service (WMS)](https://mapserver.org/ogc/wms_server.html) overlays. * **Label**: Create a unique, descriptive label for the map overlay. This will be visible to visitors and should be used to differentiate between overlays. * **Base URL**: Add a URL to the WMS map. diff --git a/docs/modules/metadatabrowse.md b/docs/modules/metadatabrowse.md index 07ef4cb8..8d4a4a00 100644 --- a/docs/modules/metadatabrowse.md +++ b/docs/modules/metadatabrowse.md @@ -1,8 +1,8 @@ # Metadata Browse -The [Metadata Browse module](https://omeka.org/s/modules/MetadataBrowse){target=_blank} makes it possible to browse all resources that share a value for a particular metadata property. +The [Metadata Browse module](https://omeka.org/s/modules/MetadataBrowse) makes it possible to browse all resources that share a value for a particular metadata property. -It does this by either turning selected properties into a link, or by adding a link below properties that reads "See all items with this value". These links appear only on item view pages. When the link is clicked, the module returns the results of that search (property value is equal to input). It is similar to the Omeka Classic plugin [Search by Metadata](http://omeka.org/add-ons/plugins/search-by-metadata/){target=_blank}. +It does this by either turning selected properties into a link, or by adding a link below properties that reads "See all items with this value". These links appear only on item view pages. When the link is clicked, the module returns the results of that search (property value is equal to input). It is similar to the Omeka Classic plugin [Search by Metadata](http://omeka.org/add-ons/plugins/search-by-metadata/). ![The item "Sense and Sensibility". The date property displays as a link, and is indicated with a blue arrow.](../modules/modulesfiles/mdbr-directlinkYes.png) diff --git a/docs/modules/numericdatatypes.md b/docs/modules/numericdatatypes.md index 9a065b16..34046a70 100644 --- a/docs/modules/numericdatatypes.md +++ b/docs/modules/numericdatatypes.md @@ -1,6 +1,6 @@ # Numeric Data Types -The [Numeric Data Type module](https://omeka.org/s/modules/NumericDataTypes){target=_blank} allows you to set certain properties as numeric data, using resource templates. You can designate properties as either date and time (ISO) or integers. +The [Numeric Data Type module](https://omeka.org/s/modules/NumericDataTypes) allows you to set certain properties as numeric data, using resource templates. You can designate properties as either date and time (ISO) or integers. ## Create numeric properties To implement the module, you will need to create or edit a [resource template](../content/resource-template.md) to set specific properties as having numeric data types. @@ -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/omekaCimporter.md b/docs/modules/omekaCimporter.md index ae1c1038..86aa1ea6 100644 --- a/docs/modules/omekaCimporter.md +++ b/docs/modules/omekaCimporter.md @@ -1,6 +1,6 @@ # Omeka Classic Importer -The [Omeka Classic Importer module](https://omeka.org/s/modules/Omeka2Importer){target=_blank} (a.k.a. the Omeka 2 Importer) enables you to import items and collections from an Omeka Classic 2.x site into an Omeka S installation. The source site needs to be Classic version 2 or greater in order to offer an API endpoint for this module to use. +The [Omeka Classic Importer module](https://omeka.org/s/modules/Omeka2Importer) (a.k.a. the Omeka 2 Importer) enables you to import items and collections from an Omeka Classic 2.x site into an Omeka S installation. The source site needs to be Classic version 2 or greater in order to offer an API endpoint for this module to use. Once installed, the Omeka 2 Importer module should appear toward the bottom of the left navigation menu on the main admin dashboard. When selected, there are sub-menu items for **Import** and **Past Imports**. diff --git a/docs/modules/ositemimporter.md b/docs/modules/ositemimporter.md index 31415bca..108e1f32 100644 --- a/docs/modules/ositemimporter.md +++ b/docs/modules/ositemimporter.md @@ -1,6 +1,6 @@ # Omeka S Item Importer -The [Omeka S Item Importer module](https://omeka.org/s/modules/Osii){target=_blank} makes it possible to import items from one Omeka S installation into another Omeka S installation. Transfering data from one installation to another creates a situation where there is significant potential for data loss, but careful planning and preparation by the user of the receiving installation can prevent that from happening. +The [Omeka S Item Importer module](https://omeka.org/s/modules/Osii) makes it possible to import items from one Omeka S installation into another Omeka S installation. Transfering data from one installation to another creates a situation where there is significant potential for data loss, but careful planning and preparation by the user of the receiving installation can prevent that from happening. ## Prepare for your import diff --git a/docs/modules/persistentidentifiers.md b/docs/modules/persistentidentifiers.md index eeb08a08..c091a509 100644 --- a/docs/modules/persistentidentifiers.md +++ b/docs/modules/persistentidentifiers.md @@ -1,6 +1,6 @@ # Persistent Identifiers -The [Persistent Identifiers module](https://omeka.org/s/modules/PersistentIdentifiers/){target=_blank} allows users to create or import persistent identifiers (PIDs) and assign them to Omeka S items. These PIDs can be assigned at item creation, via the item edit screen, or by batch edit. They can also be removed using the item edit or batch edit screens. PIDs may also be "extracted" from existing metadata fields. Once assigned, accessing an item's PID in-browser resolves to a stable, non-site-specific landing page containing the item's metadata, media, and any sites the item is assigned to. +The [Persistent Identifiers module](https://omeka.org/s/modules/PersistentIdentifiers/) allows users to create or import persistent identifiers (PIDs) and assign them to Omeka S items. These PIDs can be assigned at item creation, via the item edit screen, or by batch edit. They can also be removed using the item edit or batch edit screens. PIDs may also be "extracted" from existing metadata fields. Once assigned, accessing an item's PID in-browser resolves to a stable, non-site-specific landing page containing the item's metadata, media, and any sites the item is assigned to. The current PID services available for this module are: @@ -39,7 +39,7 @@ When completing the configuration process for DataCite, you will need to provide ### DataCite required metadata -DataCite requires five descriptive metadata values in order to generate a DOI: Title, Creators, Publisher, Publication Year, and Resource Type. All of these fields must be mapped to an existing metadata field that you select from the list of available vocabularies in your Omeka S instance. The Resource Type General property must conform to a [ResourceTypeGeneral controlled vocabulary](https://support.datacite.org/docs/datacite-metadata-schema-v44-mandatory-properties#101-resourcetypegeneral){target=_blank} value exactly. +DataCite requires five descriptive metadata values in order to generate a DOI: Title, Creators, Publisher, Publication Year, and Resource Type. All of these fields must be mapped to an existing metadata field that you select from the list of available vocabularies in your Omeka S instance. The Resource Type General property must conform to a [ResourceTypeGeneral controlled vocabulary](https://support.datacite.org/docs/datacite-metadata-schema-v44-mandatory-properties#101-resourcetypegeneral) value exactly. ## Minting and removing PIDs diff --git a/docs/modules/redactvalues.md b/docs/modules/redactvalues.md index 77aaaad9..997b4dee 100644 --- a/docs/modules/redactvalues.md +++ b/docs/modules/redactvalues.md @@ -1,6 +1,6 @@ # Redact Values -The [Redact Values module](https://omeka.org/s/modules/RedactValues/){target=_blank} allows administrators to hide certain pieces of metadata. Logged-out users will always be unable to see the values that are hidden; logged-in users at editor, supervisor, or global admin levels will always be able to see what has been redacted. The module allows admin to set viewability for users at the author or researcher level. +The [Redact Values module](https://omeka.org/s/modules/RedactValues/) allows administrators to hide certain pieces of metadata. Logged-out users will always be unable to see the values that are hidden; logged-in users at editor, supervisor, or global admin levels will always be able to see what has been redacted. The module allows admin to set viewability for users at the author or researcher level. Administrators will be able to choose a resource type, build a query to filter the resources, select the property from which to redact text, select the pattern to use for redaction, and enter the replacement text. @@ -53,7 +53,7 @@ You can customize the patterns available for redactions by selecting "Patterns" ![Add Pattern form for Redact Values module including Label and Pattern fields.](../modules/modulesfiles/redactValues_add-pattern.png) -For the pattern, you must enter the regular expression pattern that identifies the sequence of characters that will be redacted. You must enclose the pattern with [delimiters](https://www.php.net/manual/en/regexp.reference.delimiters.php){target=_blank}. You may use [modifiers](https://www.php.net/manual/en/reference.pcre.pattern.modifiers.php){target=_blank}. For more information on regular expressions, see [Regular-Expressions.info](https://www.regular-expressions.info/){target=_blank} and [PCRE Patterns](https://www.php.net/manual/en/pcre.pattern.php). To validate your pattern, try [RegExr](https://regexr.com/){target=_blank}. +For the pattern, you must enter the regular expression pattern that identifies the sequence of characters that will be redacted. You must enclose the pattern with [delimiters](https://www.php.net/manual/en/regexp.reference.delimiters.php). You may use [modifiers](https://www.php.net/manual/en/reference.pcre.pattern.modifiers.php). For more information on regular expressions, see [Regular-Expressions.info](https://www.regular-expressions.info/) and [PCRE Patterns](https://www.php.net/manual/en/pcre.pattern.php). To validate your pattern, try [RegExr](https://regexr.com/). Once you have added this information, click "Submit" in the upper right corner. Your added pattern should now appear in the Pattern dropdown menu when adding a redaction. 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..3b2b368d 100644 --- a/docs/modules/scripto/index.md +++ b/docs/modules/scripto/index.md @@ -1,6 +1,6 @@ # Set up Scripto -The [Scripto module](https://omeka.org/s/modules/Scripto/){target=_blank} allows you to create projects that allow members of the public to transcribe, translate, or describe media attached to items in your Omeka S installation. +The [Scripto module](https://omeka.org/s/modules/Scripto/) allows you to create projects that allow members of the public to transcribe, translate, or describe media attached to items in your Omeka S installation. The items and media are organized into an item set and then synced with a project in Scripto. Content made within Scripto can be periodically imported into Omeka S as item and media metadata. @@ -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..f7826f9e 100644 --- a/docs/modules/scripto/scriptoPublicView.md +++ b/docs/modules/scripto/scriptoPublicView.md @@ -8,17 +8,17 @@ The admin side is `youromekaurl.net/admin/scripto` and the public side is `youro All transcription activity takes place on the **public** side of the Scripto project. You cannot edit a transcription from the admin dashboard. -For an example of how to orient community members to the interface, see the [Guide to transcribing the *Papers of the War Department*](http://wardepartmentpapers.org/s/home/page/transcribing-guide){target=_blank}. +For an example of how to orient community members to the interface, see the [Guide to transcribing the *Papers of the War Department*](http://wardepartmentpapers.org/s/home/page/transcribing-guide). ## 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..2b6cf849 100644 --- a/docs/modules/scripto/scriptoproject.md +++ b/docs/modules/scripto/scriptoproject.md @@ -3,7 +3,7 @@ Scripto is made up of projects. Every transcription, translation, or description effort you create can, and should, have its own project. ## Create a Project -This [screencast](https://vimeo.com/422818763){target=_blank} walks you through the process of creating a Scripto project in Omeka S: +This [screencast](https://vimeo.com/422818763) walks you through the process of creating a Scripto project in Omeka S:

Creating a Scripto project from Omeka on Vimeo.

@@ -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. @@ -157,7 +157,7 @@ To find items which have been edited and are ready for review, filter all items You can edit your project using the Actions dropdown in the upper right hand corner of the screen. It offers the same two tabs you used when [creating your project](#create-a-project) - [Configuration](#configuration-options) and [Reviewers](#reviewers). ## Admin Item Review -[This screencast](https://vimeo.com/431828023){target=_blank} shows the process of reviewing an item and its media: +[This screencast](https://vimeo.com/431828023) shows the process of reviewing an item and its media:

Reviewing Scripto Content from Omeka on Vimeo.

@@ -258,11 +258,11 @@ 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. -* **Protected**: Protection is a [MediaWiki function](https://www.mediawiki.org/wiki/Manual:Administrators#Protection){target=_blank}. In the context of Scripto, it is a way for project owners to close editing on a media or item at a certain point, either because it is complete or because of a need to deal with that particular media or item (bad scan, for example). +* **Protected**: Protection is a [MediaWiki function](https://www.mediawiki.org/wiki/Manual:Administrators#Protection). In the context of Scripto, it is a way for project owners to close editing on a media or item at a certain point, either because it is complete or because of a need to deal with that particular media or item (bad scan, for example). * Protection can be limited to users, confirmed users, or administrators. In addition, you can choose to protect the media infinitely or for a set amount of time: 1 hour; 1 day; 1 week; 2 weeks; 1 month; 3 months; 6 months; or 1 year. ### Revision History diff --git a/docs/modules/scripto/troubleshootingScripto.md b/docs/modules/scripto/troubleshootingScripto.md index 41f8476f..434d7fb8 100644 --- a/docs/modules/scripto/troubleshootingScripto.md +++ b/docs/modules/scripto/troubleshootingScripto.md @@ -13,7 +13,7 @@ $wgGroupPermissions['*']['edit'] = false; to the file `LocalSettings.php`. -For more information, see the [MediaWiki manual on preventing access](https://www.mediawiki.org/wiki/Manual:Preventing_access){target=_blank}. +For more information, see the [MediaWiki manual on preventing access](https://www.mediawiki.org/wiki/Manual:Preventing_access). ## Troubleshooting ### Project sync stuck diff --git a/docs/modules/sharing.md b/docs/modules/sharing.md index c8b680b0..0538cf8c 100644 --- a/docs/modules/sharing.md +++ b/docs/modules/sharing.md @@ -1,6 +1,6 @@ # Sharing -The [Sharing module](https://omeka.org/s/modules/Sharing){target=_blank} allows you to add buttons to site pages which visitors can use to share and embed content from your site on social media or via email. +The [Sharing module](https://omeka.org/s/modules/Sharing) allows you to add buttons to site pages which visitors can use to share and embed content from your site on social media or via email. Currently, Sharing supports the following options: diff --git a/docs/modules/valuesuggest.md b/docs/modules/valuesuggest.md index adfd337c..7487c80b 100644 --- a/docs/modules/valuesuggest.md +++ b/docs/modules/valuesuggest.md @@ -1,6 +1,6 @@ # Value Suggest -The [Value Suggest module](https://omeka.org/s/modules/ValueSuggest){target=_blank} adds an auto-complete feature to specific properties in a resource template, and draws on controlled vocabularies (see the end of this page for a complete list) to help users fill them out. Value Suggest appears when a user is editing the metadata of a resource (an item, a piece of media, or an item set) that uses the enabled resource template. +The [Value Suggest module](https://omeka.org/s/modules/ValueSuggest) adds an auto-complete feature to specific properties in a resource template, and draws on controlled vocabularies (see the end of this page for a complete list) to help users fill them out. Value Suggest appears when a user is editing the metadata of a resource (an item, a piece of media, or an item set) that uses the enabled resource template. This functionality helps those building an Omeka site encourage consistent metadata input and data compatibility with other databases of records. Note that Value Suggest offers, but cannot require, that users select values from the autosuggest feature. Users will always have the option of creating their own value instead. @@ -58,40 +58,40 @@ This module includes the following vocabularies: - UNESCO - Les vocabulaires du Ministère de la Culture. -### [Dublin Core (DCMI Metadata Terms)](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/){target=_blank} +### [Dublin Core (DCMI Metadata Terms)](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/) - Classes - Elements - Terms - Types. -### [Gemeinsame Normdatei (GND)](http://lobid.org/gnd){target=_blank} +### [Gemeinsame Normdatei (GND)](http://lobid.org/gnd) - The GND contains standardized entries for persons, corporations, congresses, geographical areas, key words and work titles. -### [GeoNames](http://www.geonames.org/){target=_blank} +### [GeoNames](http://www.geonames.org/) - The GeoNames geographical database. -### [The Getty Vocabularies](http://vocab.getty.edu/){target=_blank} +### [The Getty Vocabularies](http://vocab.getty.edu/) - The Art & Architecture Thesaurus (AAT) - The Getty Thesaurus of Geographic Names (TGN) - The Union List of Artist Names (ULAN). -### [Homosaurus](http://homosaurus.org/){target=_blank} +### [Homosaurus](http://homosaurus.org/) - Homosaurus.org linked data vocabulary. -### [IdRef](https://www.idref.fr/){target=_blank} +### [IdRef](https://www.idref.fr/) - The French national database of identifiers for research (all repositories) - Person names - Corporations - Conferences - Subject headings (all) -- Subject headings [RAMEAU](https://rameau.bnf.fr){target=_blank} (Répertoire d’autorité-matière encyclopédique et alphabétique unifié, or Unified encyclopaedic and alphabetical list of subject authorities) -- Subject headings [F-MeSH](http://mesh.inserm.fr/FrenchMesh){target=_blank} (French version of the medical subject headings) +- Subject headings [RAMEAU](https://rameau.bnf.fr) (Répertoire d’autorité-matière encyclopédique et alphabétique unifié, or Unified encyclopaedic and alphabetical list of subject authorities) +- Subject headings [F-MeSH](http://mesh.inserm.fr/FrenchMesh) (French version of the medical subject headings) - Geographic names - Family names - Titles @@ -100,7 +100,7 @@ This module includes the following vocabularies: - PPN (unique identifier used for any item in all the database) - Libraries (RCR: Répertoire des centres de ressources). -### [Library of Congress Linked Data Service](http://id.loc.gov/){target=_blank} +### [Library of Congress Linked Data Service](http://id.loc.gov/) - AFS Ethnographic Thesaurus - All @@ -121,7 +121,7 @@ This module includes the following vocabularies: - Subject Headings - Thesaurus for Graphic Materials. -### [Nuovo Soggettario](https://thes.bncf.firenze.sbn.it/){target=_blank} +### [Nuovo Soggettario](https://thes.bncf.firenze.sbn.it/) - Agenti: Organismi - Agenti: Organizzazioni @@ -137,21 +137,21 @@ This module includes the following vocabularies: - Cose: Strutture - Tempo. -### [OCLC Metadata Services](https://www.oclc.org/en/services/a-z.html/:F2664:/){target=_blank} +### [OCLC Metadata Services](https://www.oclc.org/en/services/a-z.html/:F2664:/) - Faceted Application of Subject Terminologies (FAST) - The Virtual International Authority File (VIAF). -### [PACTOLS of Frantiq](https://pactols.frantiq.fr/){target=_blank} +### [PACTOLS of Frantiq](https://pactols.frantiq.fr/) - The entire PACTOLS thesaurus - The subject group only. -### [PeriodO](http://perio.do/en/){target=_blank} +### [PeriodO](http://perio.do/en/) - A gazetteer of period definitions for linking and visualizing data. -### [RDA Value Vocabularies](http://www.rdaregistry.info/termList/){target=_blank} +### [RDA Value Vocabularies](http://www.rdaregistry.info/termList/) #### RDA Reference value vocabularies @@ -216,11 +216,11 @@ This module includes the following vocabularies: - Sensory Mode - Storage Medium Format. -### [RightsStatements.org](https://rightsstatements.org/){target=_blank} +### [RightsStatements.org](https://rightsstatements.org/) - Provides a set of standardized rights statements for cultural heritage institutions that can be used to communicate the copyright and re-use status of digital objects to the public. -### [Tesauros del patrimonio cultural de España](http://tesauros.mecd.es/tesauros){target=_blank} +### [Tesauros del patrimonio cultural de España](http://tesauros.mecd.es/tesauros) - Diccionario de Bienes Culturales - Diccionario de Materias @@ -232,13 +232,13 @@ This module includes the following vocabularies: - Diccionario de Numismática - Diccionario de Mobiliario. -### [UNESCO](http://skos.um.es/){target=_blank} +### [UNESCO](http://skos.um.es/) - Tesauro - Nomenclatura de Ciencia y Tecnología - Biblioteca Digital Floridablanca. -### [Les vocabulaires du Ministère de la Culture](http://data.culture.fr/thesaurus/){target=_blank} +### [Les vocabulaires du Ministère de la Culture](http://data.culture.fr/thesaurus/) - Catégories techniques et domaines - Inventaire/MH - Domaines archivistiques pour l'indexation des circulaires diff --git a/docs/modules/zoteroimport.md b/docs/modules/zoteroimport.md index 67d054a5..ec21244e 100644 --- a/docs/modules/zoteroimport.md +++ b/docs/modules/zoteroimport.md @@ -1,6 +1,6 @@ # Zotero Import -The [Zotero Import module](https://omeka.org/s/modules/ZoteroImport){target=_blank} allows you to connect an Omeka S instance to a Zotero library and import items from that library. +The [Zotero Import module](https://omeka.org/s/modules/ZoteroImport) allows you to connect an Omeka S instance to a Zotero library and import items from that library. ## Prepare your Zotero Library In order to import from a Zotero library, you must have API access to the library. To use Zotero Import, you will need the ID for the group or user: 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/docs/sites/site_theme.md b/docs/sites/site_theme.md index 69eddfd2..6672d16b 100644 --- a/docs/sites/site_theme.md +++ b/docs/sites/site_theme.md @@ -113,12 +113,12 @@ Select how to display items within their browse views. #### Foundation theme settings -Foundation is a theme that comes with a few default stylesheets for fast prototyping or getting started with modifying themes. As a result, it has some unique settings. For more information on using Foundation, including working with Sass, see the [theme ReadMe file](https://github.com/omeka-s-themes/foundation-s/blob/master/README.md){target=_blank}. +Foundation is a theme that comes with a few default stylesheets for fast prototyping or getting started with modifying themes. As a result, it has some unique settings. For more information on using Foundation, including working with Sass, see the [theme ReadMe file](https://github.com/omeka-s-themes/foundation-s/blob/master/README.md). Settings not described above: * **Stylesheet:** The theme provides 4 style options. - * **Default** uses ZURB Foundation's default styles for prototyping, which are all viewable in their documentation under the [Kitchen Sink](https://get.foundation/sites/docs/kitchen-sink.html){target=_blank}. + * **Default** uses ZURB Foundation's default styles for prototyping, which are all viewable in their documentation under the [Kitchen Sink](https://get.foundation/sites/docs/kitchen-sink.html). * **Revolution** aims to capture the feel of old documents and juxtaposes it with a bright red accent. It includes a textured paper background image. * **Sea Foam** offers a clean, friendly look with a teal palette. * **Inkwell** features a high contrast serif family for its typography, as well as sunny yellow accents. diff --git a/docs/translateOmekaS.md b/docs/translateOmekaS.md index f31ded1a..a169cb23 100644 --- a/docs/translateOmekaS.md +++ b/docs/translateOmekaS.md @@ -5,10 +5,10 @@ We need the community's help translating English text in Omeka S into new langua ## Getting started ### Sign up on Transifex.com -Omeka S uses [Transifex.com](https://www.transifex.com){target=_blank} to manage translations. To start helping to translate Omeka into other languages, you will first need to [sign up for an account](https://www.transifex.com/signup/){target=_blank}. Transifex.net offers several plans, but since Omeka is an open-source project, you can use the Free plan. +Omeka S uses [Transifex.com](https://www.transifex.com) to manage translations. To start helping to translate Omeka into other languages, you will first need to [sign up for an account](https://www.transifex.com/signup/). Transifex.net offers several plans, but since Omeka is an open-source project, you can use the Free plan. ### Join or start a language team -Once you have registered for an account, visit the [Omeka S project page](https://www.transifex.com/omeka/omeka-s/){target=_blank} and click on the "Help Translate Omeka S" or "Join Team" button. +Once you have registered for an account, visit the [Omeka S project page](https://www.transifex.com/omeka/omeka-s/) and click on the "Help Translate Omeka S" or "Join Team" button. Here, you can choose among all the languages that are already being worked on. If you want to start work on a translation into a new language which isn't listed, you need to request that language first. Click "cancel" and scroll down to the bottom of the page and click the "request language" link, and select the language that you want to work on. @@ -16,9 +16,9 @@ On the other hand, if someone has already created a team for the language you wa Once a coordinator has approved you to the team, you can go to the Omeka S dashboard and click on the "Translate" button to begin translating. -If you want to check your translation or anything else you need to make an mo file from your po file, you can do it with msgfmt from the [GNU gettext package](http://www.gnu.org/software/gettext/){target=_blank}. +If you want to check your translation or anything else you need to make an mo file from your po file, you can do it with msgfmt from the [GNU gettext package](http://www.gnu.org/software/gettext/). -For Transifex-specific issues, please see their [documentation](http://docs.transifex.com/){target=_blank}. +For Transifex-specific issues, please see their [documentation](http://docs.transifex.com/). ## Translation guidelines 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 `. +of an Omeka S installation: + +Sites + Creating, editing, and managing sites, the public-facing parts of an Omeka S + installation. + +Resources + Creating, editing, and managing the content of an installation: items, item + sets, media, vocabularies, and resource templates. + +Admin + Access to functionality in the administrative interface varies by user role, but can + include: users, jobs, assets, and settings. + +Modules + This section opens with basic information on managing the modules that + extend the functionality of your Omeka S installation and sites. It then + offers specific documentaiton for Omeka S modules created by the Omeka Team, + listed in alphabetial order. + +This manual also includes a :doc:`glossary `, instructions on +conducting :doc:`searches `, and how to turn on :doc:`error +logging `. + +Screencasts to supplement the documentation are linked from relevant pages, and +can be browsed in the `Omeka S collection on Vimeo +`_. + +.. raw:: html + +
+ +`Omeka S Tour `_ from `Omeka `_ on `Vimeo `_. + +.. toctree:: + :hidden: + + docs/accessibility + docs/s-planning-tips + docs/install + docs/admin-dashboard + docs/glossary + docs/search + docs/frontpage + +.. toctree:: + :hidden: + :caption: Sites + + docs/sites/index + docs/sites/site_settings + docs/sites/site_pages + docs/sites/site_navigation + docs/sites/site_resources + docs/sites/site_users + docs/sites/site_theme + +.. toctree:: + :hidden: + :caption: Resources + + docs/content/items + docs/content/item-sets + docs/content/media + docs/content/vocabularies + docs/content/resource-template + +.. toctree:: + :hidden: + :caption: Admin + + docs/admin/users + docs/admin/jobs + docs/admin/settings + docs/admin/assets + +.. toctree:: + :hidden: + :glob: + :caption: Modules + + docs/modules/index + docs/modules/* + +.. toctree:: + :hidden: + :caption: Miscellaneous + + docs/errorLogging + docs/translateOmekaS + docs/configuration diff --git a/make.bat b/make.bat new file mode 100644 index 00000000..2119f510 --- /dev/null +++ b/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 089b4898..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,78 +0,0 @@ -site_name: Omeka S User Manual -theme: - name: 'readthedocs' - custom_dir: 'omeka/' - include_homepage_in_sidebar: false -site_url: 'https://omeka.org/s/' -repo_url: 'http://github.com/omeka/omeka-s-enduser' -extra_css: - - css/extra.css -markdown_extensions: - - admonition - - attr_list - - toc: - permalink:  -nav: - - index.md - - accessibility.md - - s-planning-tips.md - - install.md - - admin-dashboard.md - - glossary.md - - search.md - - frontpage.md - - Sites: - - sites/index.md - - sites/site_settings.md - - sites/site_pages.md - - sites/site_navigation.md - - sites/site_resources.md - - sites/site_users.md - - sites/site_theme.md - - Resources: - - content/items.md - - content/item-sets.md - - content/media.md - - content/vocabularies.md - - content/resource-template.md - - Admin: - - admin/users.md - - admin/jobs.md - - admin/settings.md - - admin/assets.md - - Modules: - - modules/index.md - - modules/collecting.md - - modules/csseditor.md - - modules/csvimport.md - - modules/customvocab.md - - modules/datacleaning.md - - modules/datavisualization.md - - modules/datarepositoryconnector.md - - modules/dspaceconnector.md - - modules/extractmetadata.md - - modules/extracttext.md - - modules/facetedbrowse.md - - modules/fedoraconnector.md - - modules/filesideload.md - - modules/itemcarouselblock.md - - modules/mapping.md - - modules/metadatabrowse.md - - modules/numericdatatypes.md - - modules/omekaCimporter.md - - modules/ositemimporter.md - - modules/persistentidentifiers.md - - modules/redactvalues.md - - Scripto: - - modules/scripto/index.md - - modules/scripto/scriptoproject.md - - modules/scripto/themeingScripto.md - - modules/scripto/scriptoPublicView.md - - modules/scripto/troubleshootingScripto.md - - modules/sharing.md - - modules/valuesuggest.md - - modules/zoteroimport.md - - Miscellaneous: - - errorLogging.md - - translateOmekaS.md - - configuration.md diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..8c10e435 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +sphinx==3.5.4 +sphinx-intl==2.0.1 +sphinx_rtd_theme==0.5.2 +myst-parser==0.15.1 +docutils<0.17 diff --git a/translation.md b/translation.md new file mode 100644 index 00000000..4a87c1d3 --- /dev/null +++ b/translation.md @@ -0,0 +1,13 @@ +# How to translate documentation + +Steps to follow to translate in french: + +1. make gettext +2. sphinx-intl update --language fr +3. Translate the PO with Poedit +4. sphinx-intl build +5. make -e SPHINXOPTS="-D language='fr'" clean html + +## Sphinx configuration for translation + +https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-internationalization