scholarslab / neatlinewaypoints Goto Github PK

Add an item-browser tray to Neatline exhibits.

JavaScript 75.19% PHP 23.01% CSS 1.79%

neatlinewaypoints's Introduction

NeatlineWaypoints

NeatlineWaypoints makes it possible to add an list of clickable "waypoints" to an exhibit. Waypoints can be put into a specific order, making it possible to guide users through an exhibit in a linear sequence.

Installation

Download the latest version of the plugin from the Omeka add-ons repository.
Uncompress the .zip archive.
Move the NeatlineSimile into the /plugins folder in you Omeka installation.
In the Omeka administrative interface, click on Plugins in the top navigation bar and find the listing for "Neatline Widget ~ Waypoints". Click on "Install."

Note: Since NeatlineWaypoints is a "sub-plugin" that extends the core functionality of Neatline (itself a plugin), Neatline has to be installed in order to install NeatlineWaypoints.

Usage

Enabling the widget

NeatlineWaypoints adds a "widget" to your installation of Neatline that can be turned on and off for each individual exhibit. Widgets can be activated when an exhibit is first created or by clicking on the "Exhibit Settings" link for an exhibit in the main browse view, which opens the same form that is dispalyed when the exhibit is created. In either case:

Scroll down to the "Widgets" field. Click on the input box to display a list of available widgets.
Click on the listing for "Waypoints." Once selected, the listing will be displayed as a box in the input.
To add the widget, click "Save Exhibit" at the bottom of the form.

Adding waypoints

Once you've enabled the widget for an exhibit, individual records can be added to the waypoints panel, a small list of record titles displayed at the top right of the screen:

Open the edit form for the record you want to add to the list of waypoints.
Open the Style tab and find the "Widgets" field in the "Groups" field set.
Activate the "Waypoints" option.
Click the "Save" button at the bottom of the form.

As soon as a record is added, the list of waypoints will automatically update to include the new listing.

Ordering waypoints

To change the order of the listings in the waypoints panel, click on the Plugins tab in the editor and select the Waypoints in the drop-down menu. To change the order, just click on any of the waypoints in the list and drag it up or down. When you're done, click the "Save" button to commit the change.

neatlinewaypoints's People

Contributors

Stargazers

Watchers

Forkers

joephayes

neatlinewaypoints's Issues

Error in Internet Explorer

Hello:

I have a Neatline exhibit using Waypoints within a larger Omeka instance (http://theillustratedword.com/neatline/fullscreen/the-frost-farm).

It works properly in every browser except IE.

When I click on a waypoint title, the corresponding record does not appear.

The IE debugger reports the following after line 482 in the neatline-public.js file:

                }
                if (p)
                    try  {
                        return _.apply(c, o.querySelectorAll(p)), c;

SyntaxError
} catch (q) {
} finally {
l || b.removeAttribute("id");
}
}

Each record will appear if I reload the file, but that is not really a solution.

Is there anything I could do to correct this?

Thanks!
Emily

Waypoints box fighting with Layer Selector popup

From jenbartle performant-software/Neatline#327

Hi--
When using the Waypoints widget, the Layer Selector popup box works as expected the first time only. After that, it is pushed behind the the Waypoints box and cannot be used again (it will open and close, but you cannot select a different layer a second time because the popup is pushed behind the Waypoints box.
[Omeka v.2.2.2; Neatline v.2.3.0; Neatline Waypoints v.2.0.2.]
Thanks!
Jen

Plugin installation instructions need correction

Step 3 of the plugin installation instructions states:

Move the NeatlineSimile into the /plugins folder in you Omeka installation.

When I downloaded the zip file, the name of the uncompressed folder was NeatlineWaypoints. The name of the folder should be updated.

Sub-waypoints

We got a feature request for "sub-waypoints" today in a show-and-tell demo. Right now the plugin can order the elements, but they would like to have a feature to express a parent-child relationship. From a front-end perspective, I think if we added the ability to pull waypoints left and right we could accomplish this (ignoring the actual implementation details of the tree structure).

CSS and JavaScript errors

In Omeka 2.5.1 (with Waypoints 2.0.2), the

/plugins/NeatlineWaypoints/views/shared/css/dist/waypoints-public.css
/plugins/NeatlineWaypoints/views/shared/css/dist/waypoints-public.js

Are throwing an net::ERR_ABORTED error. In the request dump (see below), it looks like the 'Action "neatlinewaypoints" does not exist...'.

When you attempt to directly access the resource (e.g. http://new.breadnutislandpen.net/plugins/NeatlineWaypoints/views/shared/css/dist/waypoints-public.css) Omeka throws an error.

Any ideas on what might be going on here?

=========

Request URI: /plugins/NeatlineWaypoints/views/shared/css/dist/waypoints-public.css
Params:
Array
(
    [controller] => plugins
    [action] => NeatlineWaypoints
    [views] => shared
    [css] => dist
    [module] => default
    [exception] => exception 'Zend_Controller_Action_Exception' with message 'Action "neatlinewaypoints" does not exist and was not trapped in __call()' in /home/breadnut/omeka-2.5.1/application/libraries/Zend/Controller/Action.php:485
Stack trace:
#0 /home/breadnut/omeka-2.5.1/application/libraries/Zend/Controller/Action.php(518): Zend_Controller_Action->__call('neatlinewaypoin...', Array)
#1 /home/breadnut/omeka-2.5.1/application/libraries/Zend/Controller/Dispatcher/Standard.php(308): Zend_Controller_Action->dispatch('neatlinewaypoin...')
#2 /home/breadnut/omeka-2.5.1/application/libraries/Zend/Controller/Front.php(954): Zend_Controller_Dispatcher_Standard->dispatch(Object(Zend_Controller_Request_Http), Object(Zend_Controller_Response_Http))
#3 /home/breadnut/omeka-2.5.1/application/libraries/Zend/Application/Bootstrap/Bootstrap.php(105): Zend_Controller_Front->dispatch()
#4 /home/breadnut/omeka-2.5.1/application/libraries/Zend/Application.php(384): Zend_Application_Bootstrap_Bootstrap->run()
#5 /home/breadnut/omeka-2.5.1/application/libraries/Omeka/Application.php(77): Zend_Application->run()
#6 /home/breadnut/omeka-2.5.1/index.php(23): Omeka_Application->run()
#7 {main}
    [exception_type] => EXCEPTION_NO_ACTION
)

Reading waypoints-public.js

Hi, we are trying to customize the pop-up when clicking on a NeatlineWaypoints element, and it points to waypoints-public.js.

We are specifically trying to customize (add info) or remove the "title" pop-up which shows "on mouse over" the waypoint list (it seems redundant).

The file we see in our server is differen from the one on github. 'm assuming it processed somehow, but we're not knowledgeable enough.

We ended up removing the "mouserenter" "mouseleave" line and it worked, but we're wondering how to contribute this and any customization ideas appropriately. Thanks!

Not a valid plugin

On latest Omeka, get a warning that this plugin is not a valid plugin.