Merge pull request #24 from omeka/develop

Develop

Install.md

@@ -19,6 +19,6 @@ For the first user, enter:
 * confirm the *password*
 * a *display name* for the User
 
-Note that you can change all of these later in the [User](/user.md) management section of your install.
+Note that you can change all of these later in the [User](/users.md) management section of your install.
 
 You also need to enter an *Installation Title* and select your installation’s *Time Zone* from the dropdown. You can later changes these in the [Settings](/settings.md) section of your [Admin Dashboard](/admin-dashboard.md)

content/media.md

@@ -9,7 +9,7 @@ To view the metadata for media, click on the media’s name in the  right-hand s
 
 Adding media includes uploading a file, or directly attaching content with oEmbed, YouTube URLs, or writing HTML.
 
-Media can only be added via the [item](../content/Items.md). 
+Media can only be added via the [item](../content/items.md). 
 
 ## Edit Media
 To edit an existing media, go to its metadata page and select the *Edit media* button in the upper right corner of the page. 

content/vocabularies.md

@@ -17,15 +17,17 @@ You can use the icons at the right of the Label field to manage individual vocab
 
 When editing a vocabulary, you can make changes to the *label* and add *comments*. 
 
-## Add a vocabulary
+### Adding a vocabulary
 New vocabularies must be imported from an existing metadata standard source. In order to import a new vocabulary, you must have a vocabulary file (RDF/XML with an .rdf extension).
 
-After specifying the vocabulary file to upload using your browser’s file chooser, enter the vocabulary’s:
+After specifying the vocabulary file to upload using your browser’s file chooser, enter the follow values for the vocabulary:
 - prefix
 - namespace uri
 - label
 - and any comments you have.
 
+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 <http://lov.okfn.org/dataset/lov/vocabs>.
+
 ### Vocabulary Import
 Omeka S will import properly formatted vocabularies/ontologies. rdfs:Class and rdfs:Property data will be available. 
 

modules/dspaceconnector.md

@@ -2,15 +2,15 @@
 title: DSpace Connector
 ---
 
-DSpace Connector is a [module](modules/modules.md) for Omeka S which allows you to connect an Omeka S instance to a DSpace repository to import items from that repository. In addition to importing information, the Omeka S item will include a link back to the original item.
+DSpace Connector is a [module](modules.md) for Omeka S which allows you to connect an Omeka S instance to a DSpace repository to import items from that repository. In addition to importing information, the Omeka S item will include a link back to the original item.
 
-To install DSpace Connector, follow the instructions for [Installing Modules](../modules/modules.md#installing-modules) on the Modules documentation.
+To install DSpace Connector, follow the instructions for [Installing Modules](modules.md#installing-modules) on the Modules documentation.
 
 Note that DSpace Connector only works with DSpace versions 4 and higher.
 
 You can view past imports by going to the DSpace Connector tab on the left-hand navigation of the admin dashboard and clicking the *Past Imports* sub-tab.
 
-![DSpace Connector navigation option with two sub-tab options for Import and Past Imports](../modules/modulesfiles/mods_dspacenav.png)
+![DSpace Connector navigation option with two sub-tab options for Import and Past Imports](modulesfiles/mods_dspacenav.png)
 
 ## Import Data
 To use DSpace Connector, navigate to the tab labelled *DSpace Connector* on the left-hand navigation of the admin dashboard. This will automatically take you to the Import sub-tab.
@@ -24,7 +24,7 @@ You should see a screen with the following options:
  * Note that the Item Set must already exist in order to import into it.
 * *Comment* for example, any notes to yourself or other users of the installation (optional);
 
-![Screenshot of the field options for DSpace Connector with collections loaded from a university library](../modules/modulesfiles/mods_dspaceconnect.png)
+![Screenshot of the field options for DSpace Connector with collections loaded from a university library](modulesfiles/mods_dspaceconnect.png)
 
 To import from a DSpace Repository:
  1.  Enter a URL into the *DSpace site URL* field and then click either *Get Collections* or *Get Communities*, depending on your preference. Note that you have to enter the entire url, including the “http://“. This will load the collections or communities below the other options. 
@@ -40,14 +40,14 @@ Go to the DSpace Connector tab on the left-hand navigation of the admin dashboar
 
 This page displays a table of Past DSpace Imports, with a checkbox option to *Undo*, the *Job ID* for the import, the repository’s *Dspace Collection Link*, any *Comments* made during import, the number of *Items* imported, the *Date* of the import, the import *Status*, and the *Owner*, or user who initiated the import.
 
-![Table of past imports showing two from mars.gmu.edu](../modules/modulesfiles/mods_dspacepast.png)
+![Table of past imports showing two from mars.gmu.edu](modulesfiles/mods_dspacepast.png)
 
 ## Undo an Import
 To undo a completed import and remove all associated items, go to the DSpace Connector tab on the left-hand navigation of the admin dashboard, click on DSpace Connector and then click on Past Imports, which should appear below the DSpace Connector tab.
 
 You will see a table of all post imports.
 
-![Table of past imports showing two from mars.gmu.edu](../modules/modulesfiles/mods_dspacepast.png)
+![Table of past imports showing two from mars.gmu.edu](modulesfiles/mods_dspacepast.png)
 
 Check the box for each import you wish to undo and click submit.
 

modules/modules.md

@@ -4,27 +4,27 @@ title: Modules
 
 Modules extend the functionality of your Omeka S installation and sites. 
 
-[List of modules](../modules/modules_list.md)
+[List of modules](modules_list.md)
 
 ## Managing Modules
 
 To see what modules are installed on your Omeka S site, click on the Modules link on the left-hand navigation of your [admin dashboard](../admin-dashboard.md)
 
 Note that only Global Administrators can install and manage modules. Site Administrators can browse installed modules. Other users do not have access to this tab.
 
-![Screen capture of admin dashboard showing Modules tab active.](../modules/modulesfiles/modulesbrowse.png)
+![Screen capture of admin dashboard showing Modules tab active.](modulesfiles/modulesbrowse.png)
 
 Any modules which have been installed on the Omeka S install should appear in the list of Modules. Each module displays the name of the module with the version number, creator, and a summary of its function. 
 
-![CSV import module label. It is version 0.1 alpha, created by RRCHNM, and is summaries as "import content from a CSV file."](../modules/modulesfiles/moduleLabel.png)
+![CSV import module label. It is version 0.1 alpha, created by RRCHNM, and is summaries as "import content from a CSV file."](modulesfiles/moduleLabel.png)
 
 
 There are multiple buttons which can appear to the right of a module’s label. Each button has both an icon and a label describing its action:
 * *Configure* (a wrench icon): some modules have settings which can be adjusted. Click this icon to adjust settings for the module in this row.
 * *Activate/Deactivate* (sliding switch): when a module is active, the slider area background is transparent and the switch is to the left. When inactive, the background of the slider area background is opaque and the switch is to the right.
 * *Install/Uninstall* (arrow and rectangle): use this button to install or uninstall a module. When the arrow is coming from the rectangle, the button will uninstall the module. When the arrow is pointing into the rectangle, the button will install the module.
 
-![Icons described above, from right to left: configure, activate and deactivate, install and uninstall](../modules/modulesfiles/moduleButtons.png)
+![Icons described above, from right to left: configure, activate and deactivate, install and uninstall](modulesfiles/moduleButtons.png)
 
 ## Installing Modules
 ### Add the Module to Omeka S
@@ -49,7 +49,7 @@ Find the module in the table and click the install button.
 
 The module is now installed. You should see a success message once the page reloads. For modules with configuration options, you will be taken immediately to the configuration page for that module. For all other modules the Modules page will simply reload. On the Modules page, the *Status* of the module should change from “Not Installed” to “Not Active”
 
-![Success message with green highlight reading “The module was successfully installed”](../modules/modulesfiles/mods_insuccess.png)
+![Success message with green highlight reading “The module was successfully installed”](modulesfiles/mods_insuccess.png)
 
 Modules are automatically activated when installed. 
 
@@ -58,7 +58,7 @@ If you have a module which is installed but inactive, click the activate button
 
 You should see a success message once the page reloads, and the *Status* of the module should change from “Not Active” to “Active”
 
-![Success message with green highlight reading “The module was successfully activated”](../modules/modulesfiles/mods_acsuccess.png)
+![Success message with green highlight reading “The module was successfully activated”](modulesfiles/mods_acsuccess.png)
 
 ## Configuring a module
 Some, but not all, modules include the option to configure settings for that module. If an active module displays the *configure* (wrench) button, you may configure that module.
@@ -71,6 +71,6 @@ Removing a module is essentially installing in reverse:
 1. Uninstall the module by clicking the *uninstall* button
 1. A drawer will open on the right side of the window asking you to confirm that you want to uninstall the module. Click “Confirm Uninstall” to continue.
 
-![Uninstall module dialogue with the message “Are you sure you would like to uninstall this module?”](../modules/modulesfiles/mods_confirmuninstall.png)
+![Uninstall module dialogue with the message “Are you sure you would like to uninstall this module?”](modulesfiles/mods_confirmuninstall.png)
 
 The uninstalled module will continue to appear on your Modules page unless the folder for the module is removed from the /modules folder on the Omeka S installation, which can be done via FTP or SSH.

modules/valuesuggest.md

@@ -0,0 +1,40 @@
+---
+title: ValueSuggest
+keyword: module
+date: 07/02/2017
+---
+
+The ValueSuggest module adds an auto-complete feature to a specific property in a resource template and draws on controlled vocabularies from Library of Congress and Getty Collection.
+This functionality helps those building an Omeka site to enforce consistent metadata input and data compatibility with other databases of records.
+
+To install ValueSuggest follow the instructions for Installing Modules on the Modules documentation.
+
+Create a Resource Template
+--------------------
+ValueSuggest vocabularies are applied through Resource Templates. For additional information on Resource Templates, see the [Resource Template Documentation](../content/resource-template.md).
+
+1. From the Resources Templates tab in the Admin Dashboard, click the Add new resource template button. Add a label and assign a class. 
+2. Add properties from the list of vocabularies in the menu on the right side of the screen. To add a vocabulary from the Library of Congress or Getty Collections to a property, select the data type for the element. Whichever you choose will be automatically loaded once someone selects that Resource Type and they will only be able to use this data type for the element. (For instance, selecting the Getty: Union List of Artist Names as the data type for the Creator property will auto-complete the metadata entry of an artist’s name for an item with this Template applied.)
+3. If desired, add an alternate label and alternate comment for the element. 
+4. When done, click Add to Save.
+
+![Resource template with Data Type Value Suggest: Getty: The Art and Architecture Thesaurus (AAT) selected for the Medium property.](../modules/modulesfiles/ValSug-ResTemplate1.png)
+
+When you click the title of a Resource Template to see its details, the ValueSuggest vocabulary will appear under the Data Type table heading.
+
+![Resource Template "Fashion Illustrations" with Value Suggest:Getty: The Union List of Artist Names(ULAN) applied to Creator.](../modules/modulesfiles/ValSug-ResTemplate2.png)
+
+
+Adding ValueSuggest to an Item
+--------------------
+When this Resource Template is used in an Item or Item Set, the designated properties will auto-suggest vocabulary. Users must start typing in the open text box of that specific property to prompt the auto-suggest feature. There may be a slight delay, but a drop-down menu will appear with choices drawn directly from the authority or vocabulary list you have associated with that property.
+
+![Item property Subject with "fashion" typed in the field. A dropdown menu auto-suggests terms, including "fashion design," which is selected.](../modules/modulesfiles/ValSug-ItemProperty1.png)
+
+Hover over selections in the dropdown menu for a description of that vocabulary.
+
+![Item property Material with "lithograph" typed in the field. A dropdown menu auto-suggests terms, including "color lithographs," which is selected. Helper text in a small overlaid window reads, "Lithographs printed in several colors."](../modules/modulesfiles/ValSug-ItemProperty2.png)
+
+Note: after selecting a Getty or LC property, a box containing a URL should appear under the value. This link will direct visitors to a webpage with additional information on the value selected. This box can be removed by clicking the “X”.
+
+![Item property Work Type with "Fashion Illustrations (layout features)" selected. Below, in red is a hyperlink to Getty Collections, with a small red "X".](../modules/modulesfiles/ValSug-ItemProperty3.png)

modules/zoteroimport.md

@@ -2,9 +2,9 @@
 title: Zotero Import
 ---
 
-Zotero Import is a [module](modules/modules.md) for Omeka S which allows you to connect an Omeka S instance to a Zotero library and import items from that library.
+Zotero Import is a [module](modules.md) for Omeka S which allows you to connect an Omeka S instance to a Zotero library and import items from that library.
 
-To install Zotero Import, follow the instructions for [Installing Modules](../modules/modules.md#installing-modules) on the Modules documentation.
+To install Zotero Import, follow the instructions for [Installing Modules](modules.md#installing-modules) on the Modules documentation.
 
 ## Prepare your Zotero Library
 Ensure that your Zotero library is published. Login to Zotero, go to settings, and then to privacy. Make sure that 'publish entire library' is checked. The 'publish notes' box can also be checked.
@@ -21,7 +21,7 @@ You may also want to have the id for a specific collection and an API key to imp
 
 To import, go to the Zotero Import tab on the left-hand navigation of the admin dashboard of your Omeka S install. This will automatically take you to the Import sub-tab, also in the left-hand navigation.
 
-![Zotero Import options](../modules/modulesfiles/zoteroimport_new.png)
+![Zotero Import options](modulesfiles/zoteroimport_new.png)
 
 To import from a Zotero library:
 * Choose an Item Set for imported items (required); 
@@ -42,7 +42,7 @@ Managing Past Imports
 ---------------------------------
 To view and manage past imports, click on the Zotero Import tab in the left-hand navigation, and then click on the "Past Imports" sub-tab.
 
-![red arrow points to past imports tab](../modules/modulesfiles/zoteroimport_pasttab.png)
+![red arrow points to past imports tab](modulesfiles/zoteroimport_pasttab.png)
 
 The Past Imports shows a table of previous imports, whether successful, failed on error, or undone. The table has the following columns:
 - *Zotero Library* giving the User or Group library name;
@@ -53,6 +53,6 @@ The Past Imports shows a table of previous imports, whether successful, failed o
 
 To Undo an import, click the *Undo* button to the left of the *Items Added Before* timestamp. This will open a sidebar dialog asking you to confirm that you want to undo the import and delete all imported items. Click *Confirm* to continue. 
 
-![past imports tab with sidebar open to confirm undo](../modules/modulesfiles/zoteroimport_undo.png)
+![past imports tab with sidebar open to confirm undo](modulesfiles/zoteroimport_undo.png)
 
 Past Imports which have already been undone will have a job status "Undo Import Completed".

sites/site_pages.md

@@ -59,7 +59,7 @@ Creates a block with one or more pieces of media associated with items in the it
 
 ![media block with no media attached](../sites/sitesfiles/sitepg_media.png)
 
-To add media, click the *add attachment* 
+To add media, click the *add attachment*. 
 On loading, the drawer will show a list of your items, most recent first. You can select form the first page, page through using the forward and back arrows, or search using the search bar.
 
 ![Select item drawer](../sites/sitesfiles/sitepg_selectitem.png)
@@ -114,7 +114,7 @@ Line break creates a transparent or opaque line break on the page, clearing all
 HTML blocks wrap around Media blocks and at times you may want to clear the page. You might also want to create a visual break on the page. 
 
 ### Item with Metadata
-This block displays an item along with all associated metadata (entered when creating or editing the [item](../content/items.md).
+This block displays an item along with all associated metadata (entered when creating or editing the [item](../content/items.md)).
 
 ![Item with metadata block with nothing attached](../sites/sitesfiles/sitepg_iwm.png)
 

sites/site_resources.md

@@ -11,7 +11,7 @@ Item Pool is where you can set the items available for selection and browse in y
 
 Item Sets is where you select the sets which will show up on the  Browse Item Sets page, should you choose to include it 
 
-![A window open to a site's resources tab](../sites/sitesfiles/site_resourcesview.md)
+![A window open to a site's resources tab](../sites/sitesfiles/site_resourcesview.png)
 
 **Note** The two tabs operate independently from each other. The selections made on one will have no effect on the other.
 

sites/sites.md

@@ -106,9 +106,9 @@ A drawer on the right hand side of the screen shows all of the users for your in
 To add a user, click on their name. 
 
 Then select their role from the dropdown:
-*Viewer*: user can see the site’s backend but cannot edit.
-*Editor*: user can access and edit the site’s backed.
-*Admin*: user has full administrative privileges for the site, including adding users and deleting the site.
+* *Viewer*: user can see the site’s backend but cannot edit.
+* *Editor*: user can access and edit the site’s backend.
+* *Admin*: user has full administrative privileges for the site, including adding users and deleting the site.
 
 Once you've added one or more users, click the Save button located in the upper right hand corner. You can add or revoke privileges for users by going back to the User permissions tab and selecting or deselecting the boxes and clicking Save. Users can be deleted from the site by clicking the trash can icon on their row.