pageflow-linkmap-page 0.2.0 → 1.0.0

data/app/views/pageflow/linkmap_page/areas/_div.html.erb

@@ -1,7 +1,7 @@
-<%= content_tag(:div, class: "linkmap_areas") do %>
+<%= content_tag(:div, class: "linkmap_areas", data: data_attributes) do %>
   <% (configuration['linkmap_areas'].presence || []).each_with_index do |attributes, index| %>
-    <%= linkmap_area(entry, attributes, index) do %>
-      <%= background_image_div_with_size(configuration, 'visited_image', class: 'visited_image', style_group: :panorama) %>
+    <%= linkmap_area(entry, attributes, index, configuration['background_type']) do %>
+      <canvas class="visited_image"></canvas>
 
       <% if configuration['background_type'] == 'hover_video' &&
             !Pageflow::ImageFile.find_by_id(configuration['hover_image_id']) %>
@@ -11,10 +11,7 @@
                                            file_type: 'video_file',
                                            class: 'hover_image') %>
       <% else %>
-        <%= background_image_div_with_size(configuration,
-                                           'hover_image',
-                                           class: 'hover_image',
-                                           style_group: :panorama) %>
+        <canvas class="hover_image"></canvas>
       <% end %>
 
       <div class="linkmap_marker <%= attributes['marker'] %>">

data/config/locales/de.yml

@@ -2,9 +2,11 @@ de:
   activerecord:
     attributes:
       pageflow/linkmap_page/area:
-        link_description: ! 'Linkbeschreibung: Text'
-        link_title: ! 'Linkbeschreibung: Titel'
+        inverted: Invertieren
+        link_description: 'Linkbeschreibung: Text'
+        link_title: 'Linkbeschreibung: Titel'
         marker: Linkmarkierung
+        mask_perma_id: Maske
         name: Bezeichnung
         page_transition: Seitenwechsel-Animation
         target_id: Ziel
@@ -18,22 +20,30 @@ de:
           audio_file: Audio Datei
           external_site: Externer Verweis
           page: Seitenverweis
+          text_only: Nur Text
   pageflow:
     linkmap_page:
-      default_page_transition: (Standard)
+      color_map:
+        too_many_components: Das ausgewählte Bild enthält zu viele verschiedene Farbtöne. Es können maximal 20 Bereiche durch das Maskenbild bestimmt werden. Stellen Sie sicher, dass bei der Erstellung des Maskenbildes keine Kantenglättung verwendet wurde, da dies die Zahl der im Bild auftretenden Farbtöne stark erhöhen kann.
+      default_page_transition: "(Standard)"
       editor:
         area_types:
           audio_file: Audio Datei
           external_site: Externer Verweis
           page: Seitenverweis
+          text_only: Nur Text
         templates:
           edit_area:
             back: Zurück
             destroy: Löschen
           embedded:
             area_item:
-              edit: Bearbeiten
-              toggle_marker: Linkmarkierung aktivieren
+              edit: DELETE
+              hide_marker: Linkmarkierung deaktivieren
+              set_mask: Maske auswählen
+              show_marker: Linkmarkierung aktivieren
+              toggle_marker: DELETE
+              unset_mask: Frei positionierbar machen
           file_area_item:
             edit: Bearbeiten
             remove: Entfernen
@@ -41,20 +51,182 @@ de:
           file_areas:
             add: Hinzufügen
             label: Audios
+          select_area_position_hint:
+            cancel: Abbrechen
         views:
+          area_mask_input_view:
+            present: "(Aktiv)"
           areas_list:
             add: Hinzufügen
             label: Bereiche
           edit_area_view:
             confirm_destroy: Bereich wirklich löschen?
+          embedded:
+            area_item:
+              external_link_disabled: Externe Links sind im Editor deaktiviert.
+          scaled_on_phone_hint:
+            orientations:
+              both: Phone Layout
+              landscape: Landscape Phone Layout
+              portrait: Portrait Phone Layout
+            text: Das Panorama wird im %{orientation} skaliert, um eine Mindestgröße der Hotspots für die Touch-Eingabe zu gewährleisten. Hotspots vergrößern, um Skalierung zu vermeiden.
+          select_area_position_hint:
+            drag_hint: Wähle einen Bereich für den Hotspot durch Klicken und Ziehen mit der Maus.
+            select_mask_hint: Klicke auf einen der farbigen Bereiche des Masken-Bildes, um einen Bereich für den Hotspot auszuwählen.
+            select_mask_or_drag_hint: Klicke auf einen der farbigen Bereiche des Masken-Bildes oder wähle einen frei positionierten Bereich durch Klicken und Ziehen mit der Maus.
       help_entries:
         page_type:
           menu_item: Hotspots
-          text: ! "# Hotspots\n\n*Verweise mit konfigurierbaren Klickbereichen*\n    \nHotspots können Audio-Dateien abspielen, interne Verweise auf andere Seiten im Pageflow sein oder auf externe Seiten verlinken. Es können so viele Hotspots angelegt werden wie gewünscht. \n\nDer Panorama Typ entscheidet darüber, ob die Seite ein Hintergrund-Bild oder Hintergrund-Video zeigt. (Beachte, dass Hintergrund-Videos auf mobilen Geräten nicht abgespielt werden, deshalb wähle ein zusätzliches Panorama-Bild für die mobile Version) \n\nDie Hotspot-Seite ermöglicht auch die Nutzung von Panorama-Bildern, die größer sind, als der sichtbare Bildschirmbereich. So können Nutzer diese Seiten auch horizontal oder vertikal durch scrollen erkunden.\n\nUm einen Hotspot zu erstellen, klicke auf „Bereiche“ und wähle zwischen „Audio“, „Seitenverweis“ oder „Externer Verweis“.\n\nDiese „Bereiche\" können auf zwei unterschiedliche Arten dargestellt werden:\n\n##  Hotspots als Kreise\n\nEin weißer Kreis, dessen Position und Größe frei gewählt werden kann, markiert den Hotspot. Hierzu klicke beim entsprechenden Hotspot auf den Button mit dem Auge-Symbol und ziehe den Kreis dann an die gewünschte Position. Bei Auswahl einer Audio-Datei erscheint innerhalb des Kreises ein Kopfhörer-Symbol mit einem Inline-Audio-Player. Dessen Größe hängt von der Größe des Kreises ab. Je näher der Mauszeiger Richtung Kreis bewegt wird, desto heller/sichtbarer wird dieser. Mit Klick auf den Kopfhörer wird der Audio-Player gestartet und gestoppt. \n\n## Individuell gestaltete Hotspots\n\nAlternativ kann ein zweites Panorama-Bild verwendet werden, um das Aussehen der Hotspots zu bestimmen, über denen sich der Cursor befindet. Es müssen zwei Panorama-Bilder vorbereitet werden:\n\n1. Ein Bild mit allen Hotspots im inaktiven Modus (z.B. eine Karte, auf der Städte mit schwarzen Punkten markiert sind)\n2. Ein Bild mit allen Hotspots im aktiven Zustand (z.B. die selbe Karte, aber mit roten Punkten als Markierung)\n\nDie rechteckigen Bereiche der Hotspots werden nun so positioniert, dass sie die graphischen Darstellungen der Hotspots im Bild überdecken. Befindet sich der Cursor über einem der Bereiche, wird genau in diesem Ausschnitt der entsprechende Teil des Hover-Bildes gezeigt. Der Hotspot erscheint daher aktiv, während alle anderen Hotspots weiterhin inaktiv dargestellt werden.\n\nAn Stelle von Bildern können auch Videos verwendet werden. Folgende Kombinationen sind möglich:\n\n1. Hintergrund-Bild mit Hover-Bild\n2. Hintergrund-Video mit Hover-Bild\n3. Hintergrund-Bild mit Hover-Video\n\nFalls die vom User bereits besuchten Bereiche anschliessend anders dargestellt werden sollen, kann ein „Visited-Bild“ festgelegt werden, das dann zum Beispiel einen bestimmten Hotspot nach dem Klick in einer abgeschwächten Farbe zeigt.\n\n## Textoptionen\n\nDie Hotspots können mit einem Titel benannt und mit weiteren Text versehen werden. Der Text kann in fett, kursiv und unterstrichen formatiert werden.\n\n## Atmo Optionen\n\nWie bei den anderen Seitentypen auch, kann im Hintergrund ein zusätzliches Audiofile abgespielt werden. Für die Kombination mit Audio-Hotspots ist es neben “Ausblenden” und “Weiterspielen” zudem möglich, die Option “Leiser weiterspielen” auszuwählen. Das kann sinnvoll sein, wenn zum Beispiel ein im Hintergrund laufender Titel von einem kurzen Interview überlagert wird.\n\n## Weitere Optionen\n\nUnter „Optionen\" können folgende Regeln definiert werden:\n\nScrollbereich auf aktive Bereiche beschränken: Hierbei wird verhindert, dass die User sich in Bildbereiche ausserhalb der Hotspots bewegen können.\n\nScrollumgebung erzwingen: Hierbei wird der sichtbare Bereich so verkleinert, dass User sich durch die Seite scrollen müssen, um alle Hotspots zu sehen.\n\nAm Bildrand scrollen deaktivieren: Hierbei wird das sonst automatische Scrollen unterdrückt, sobald User die Maus zum Bildrand bewegen.\n\nTypische Anwendungsbeispiele: Menüseite, Multiple Choice, Entdeckungstour"
+          text: |-
+            # Hotspots
+
+            *Verweise mit konfigurierbaren Klickbereichen*
+
+            Hotspots können Audio-Dateien abspielen, interne Verweise auf andere
+            Seiten im Pageflow sein oder auf externe Seiten verlinken. Es können
+            so viele Hotspots angelegt werden wie gewünscht.
+
+            Der Panorama Typ entscheidet darüber, ob die Seite ein
+            Hintergrund-Bild oder Hintergrund-Video zeigt. (Beachte, dass
+            Hintergrund-Videos auf mobilen Geräten nicht abgespielt werden,
+            deshalb wähle ein zusätzliches Panorama-Bild für die mobile Version)
+
+            Die Hotspot-Seite ermöglicht auch die Nutzung von Panorama-Bildern,
+            die größer sind, als der sichtbare Bildschirmbereich. So können Nutzer
+            diese Seiten auch horizontal oder vertikal durch scrollen erkunden.
+
+            Um einen Hotspot zu erstellen, klicke auf „Bereiche“ und wähle
+            zwischen „Audio“, „Seitenverweis“ oder „Externer Verweis“.
+
+            Diese „Bereiche" können auf zwei unterschiedliche Arten dargestellt
+            werden:
+
+            ##  Hotspots als Kreise
+
+            Ein weißer Kreis, dessen Position und Größe frei gewählt werden kann,
+            markiert den Hotspot. Hierzu klicke beim entsprechenden Hotspot auf
+            den Button mit dem Auge-Symbol und ziehe den Kreis dann an die
+            gewünschte Position. Bei Auswahl einer Audio-Datei erscheint innerhalb
+            des Kreises ein Kopfhörer-Symbol mit einem Inline-Audio-Player. Dessen
+            Größe hängt von der Größe des Kreises ab. Je näher der Mauszeiger
+            Richtung Kreis bewegt wird, desto heller/sichtbarer wird dieser. Mit
+            Klick auf den Kopfhörer wird der Audio-Player gestartet und gestoppt.
+
+            ## Individuell gestaltete Hotspots
+
+            Alternativ kann ein zweites Panorama-Bild verwendet werden, um das
+            Aussehen der Hotspots zu bestimmen, über denen sich der Cursor
+            befindet. Es müssen zwei Panorama-Bilder vorbereitet werden:
+
+            1. Ein Bild mit allen Hotspots im inaktiven Modus (z.B. eine Karte, auf der Städte mit schwarzen Punkten markiert sind)
+            2. Ein Bild mit allen Hotspots im aktiven Zustand (z.B. die selbe Karte, aber mit roten Punkten als Markierung)
+
+            Die rechteckigen Bereiche der Hotspots werden nun so positioniert,
+            dass sie die graphischen Darstellungen der Hotspots im Bild
+            überdecken. Befindet sich der Cursor über einem der Bereiche, wird
+            genau in diesem Ausschnitt der entsprechende Teil des Hover-Bildes
+            gezeigt. Der Hotspot erscheint daher aktiv, während alle anderen
+            Hotspots weiterhin inaktiv dargestellt werden.
+
+            An Stelle von Bildern können auch Videos verwendet werden. Folgende
+            Kombinationen sind möglich:
+
+            1. Hintergrund-Bild mit Hover-Bild
+            2. Hintergrund-Video mit Hover-Bild
+            3. Hintergrund-Bild mit Hover-Video
+
+            Falls die vom User bereits besuchten Bereiche anschliessend anders
+            dargestellt werden sollen, kann ein „Visited-Bild“ festgelegt werden,
+            das dann zum Beispiel einen bestimmten Hotspot nach dem Klick in einer
+            abgeschwächten Farbe zeigt.
+
+            ## Frei geformte Hotspots
+
+            Es ist nicht immer möglich, die visuellen Elemente eines
+            Panorama-Bildes so mit rechteckigen Hotspots zu überdecken, dass sich
+            keine Überschneidungen ergeben. Möchte man zum Beispiel die Länder auf
+            einer Landkarte als Hotspots verwenden, so dass stets das unter dem
+            Cursor befindliche Land in einer anderern Farbe angezeigt wird, lässt
+            sich dies mit einem einzelnen Hover-Bild nicht umsetzen: Sobald der
+            Bereich eines Hotspots über die Landesgrenze hinausragt, erscheint
+            auch immer ein Teil des Nachbarlandes in der aktiven Farbe.
+
+            Für diese Fälle kann ein sogenanntes Masken-Bild eingesetzt werden, um
+            die Umrisse der Hotspots frei zu bestimmen. Es sollte sich dabei um
+            ein PNG-Bild mit transparentem Hintergrund handeln, auf dem die
+            gewünschten Hotspot-Bereiche durch einfarbige Flächen dargestellt
+            sind. Die Abmessungen des Bildes müssen denen des Panorama- und des
+            Hover-Bildes entsprechen.
+
+            Für das Landkarten-Beispiel könnte also eine identisch proportionierte
+            Karte verwendet werden, auf der die Länder jeweils mit einem einzelnen
+            Farbton gefüllt sind, Meere und Landesteile, die nicht mit einem
+            Hotspot versehen werden sollen, aber transparent bleiben.
+
+            Nachdem das Masken-Bild ausgewählt wurde, kann beim Erstellen eines
+            Hotspots nicht nur ein Bereich mit der Maus gezogen, sondern auch ein
+            vordefinierter farbiger Bereich aus dem Masken-Bild angeklickt werden.
+
+            Die Umrisse des Hotspots entsprechen dann genau dem ausgewählten
+            farbigen Bereich im Masken-Bild. Entsprechend wird das Hover-Bild nur
+            innerhalb dieses Bereiches dargestellt.
+
+            Bei der Zuordnung der Bereiche ist dabei nur die Farbe
+            ausschlaggebend: der Bereich eines Hotspots muss keine
+            zusammenhängende Fläche darstellen. So können, um das Karten-Beispiel
+            ein letztes Mal aufzugreifen, auch die zu einem Land gehörenden Inseln
+            zusammen mit dem Festland hervorgehoben werden, ohne dass das Meer,
+            welches die Inseln umgibt, Teil des anklickbaren Bereichs sein
+            müsste.
+
+            Wichtig: Bei der Erstellung des Masken-Bildes muss in der
+            Grafik-Anwendung Kantenglättung deaktiviert werden, da zur präzisen
+            Abgrenzung der Bereiche scharf getrennte Farbbereiche nötig
+            sind. Kantenglättung führt zur Entstehung kleiner Farbverläufe im
+            Bild, die dann als mehrere Bereiche erkannt werden. Für Bilder mit
+            einer zu großen Zahl an Farbtönen wird bei Auswahl als Masken-Bild
+            eine Fehlermeldung gezeigt.
+
+            Im Moment ist es nicht möglich, die Masken-Bild-Funktion zusammen mit
+            einem Hover-Video zu verwenden.
+
+            ## Textoptionen
+
+            Die Hotspots können mit einem Titel benannt und mit weiteren Text
+            versehen werden. Der Text kann in fett, kursiv und unterstrichen
+            formatiert werden.
+
+            ## Atmo Optionen
+
+            Wie bei den anderen Seitentypen auch, kann im Hintergrund ein
+            zusätzliches Audiofile abgespielt werden. Für die Kombination mit
+            Audio-Hotspots ist es neben “Ausblenden” und “Weiterspielen” zudem
+            möglich, die Option “Leiser weiterspielen” auszuwählen. Das kann
+            sinnvoll sein, wenn zum Beispiel ein im Hintergrund laufender Titel
+            von einem kurzen Interview überlagert wird.
+
+            ## Weitere Optionen
+
+            Unter „Optionen" können folgende Regeln definiert werden:
+
+            Scrollbereich auf aktive Bereiche beschränken: Hierbei wird
+            verhindert, dass die User sich in Bildbereiche ausserhalb der Hotspots
+            bewegen können.
+
+            Scrollumgebung erzwingen: Hierbei wird der sichtbare Bereich so
+            verkleinert, dass User sich durch die Seite scrollen müssen, um alle
+            Hotspots zu sehen.
+
+            Am Bildrand scrollen deaktivieren: Hierbei wird das sonst automatische
+            Scrollen unterdrückt, sobald User die Maus zum Bildrand bewegen.
+
+            Typische Anwendungsbeispiele: Menüseite, Multiple Choice, Entdeckungstour
       manage_sites: Verweise verwalten
       page:
+        scroll_down: Nach unten scrollen
         scroll_left: Nach links scrollen
         scroll_right: Nach rechts scrollen
+        scroll_up: Nach oben scrollen
       page_attributes:
         add_environment:
           inline_help: Panorama etwas vergrößern, um Scrollen in beide Richtungen zu erlauben.
@@ -84,6 +256,9 @@ de:
           label: Verlinkte Seiten
         linkmap_areas:
           label: Verweisbereiche
+        linkmap_color_map_image_id:
+          inline_help: Bild mit farbigen Bereichen, die die Umrisse von Hotspots bestimmen. Weitere Hinweise im Hilfe-Eintrag des Hotspot-Seitentyps.
+          label: Masken-Bild
         margin_scrolling_disabled:
           inline_help: Panorama nicht automatisch scrollen, wenn der Cursor bewegt wird.
           label: Am Bildrand scrollen deaktivieren
@@ -111,8 +286,11 @@ de:
           areas: Bereiche
       inline_help:
         pageflow/linkmap_page/area:
+          inverted: Dunkle Piktogramme für die Verwendung auf hellen Hintergründen anzeigen.
           link_title: Die Beschreibung wird in einem Overlay angezeigt, wenn sich der Cursor über dem Hotspot befindet.
           marker: Wähle die visuelle Darstellung des Hotspots.
+          mask_perma_id: Farbiger Bereich im Maskenbild, der die Form des Hotspots bestimmt.
+          mask_perma_id_disabled: Farbiger Bereich im Maskenbild, der die Form des Hotspots bestimmt. Nur verfügbar, wenn ein Masken-Bild im 'Dateien'-Tab der Hotspot-Seite festgelegt wurde und als Panorama-Typ nicht 'Hover Video' ausgewählt wurde.
           name: Gib hier eine Bezeichnung ein, um später bei in der Verweis-Übersicht direkt zu erkennen, um welchen Verweis es sich handelt. Die Bezeichnung ist für die Leser nicht sichtbar.
           page_transition: Wähle hier den Effekt, der beim Übergang zur Zielseite des Verweises benutzt werden soll.
           target_id: Objekt auf das der Hotspot verlinkt.

data/config/locales/en.yml

@@ -2,9 +2,11 @@ en:
   activerecord:
     attributes:
       pageflow/linkmap_page/area:
+        inverted: Invert
         link_description: Link decription text
         link_title: Link description title
         marker: Link display
+        mask_perma_id: Mask
         name: Label
         page_transition: Page transition
         target_id: Target
@@ -18,22 +20,30 @@ en:
           audio_file: Audio file
           external_site: External link
           page: Page link
+          text_only: Text only
   pageflow:
     linkmap_page:
-      default_page_transition: (Default)
+      color_map:
+        too_many_components: The selected image contains too many different color values. There is a maximal number of 20 areas that can be determined via the mask image. Make sure that anti aliasing was turned off while creating the mask image. Anti aliasing leads to color gradients inside the image which prevent usage as mask image.
+      default_page_transition: "(Default)"
       editor:
         area_types:
           audio_file: Audio file
           external_site: External link
           page: Page link
+          text_only: Text only
         templates:
           edit_area:
             back: Back
             destroy: Delete
           embedded:
             area_item:
-              edit: Edit
-              toggle_marker: Toggle display
+              edit: DELETE
+              hide_marker: Hide marker
+              set_mask: Select mask
+              show_marker: Show marker
+              toggle_marker: DELETE
+              unset_mask: Detach from mask
           file_area_item:
             edit: Edit
             remove: Remove
@@ -41,20 +51,146 @@ en:
           file_areas:
             add: Add
             label: Label
+          select_area_position_hint:
+            cancel: Cancel
         views:
+          area_mask_input_view:
+            present: "(Active)"
           areas_list:
             add: Add
             label: Areas
           edit_area_view:
             confirm_destroy: Really delete this area?
+          embedded:
+            area_item:
+              external_link_disabled: External links are deactivated inside the editor.
+          scaled_on_phone_hint:
+            orientations:
+              both: phones
+              landscape: phones in landscape orientation
+              portrait: phones in portrait orientation
+            text: The panorama will be scaled on %{orientation} to ensure minimum hotspot size for touch interaction. Increase hotspot size to prevent scaling.
+          select_area_position_hint:
+            drag_hint: Select the hotspot's dimension by clicking and dragging somewhere inside the panorama.
+            select_mask_hint: Click on one of the colored areas of the mask image to determine the hotspots shape and position.
+            select_mask_or_drag_hint: Click on one of the colored areas of the mask image or select the hotspot's dimensions by clicking and dragging somewhere inside the panorama.
       help_entries:
         page_type:
           menu_item: Hotspots
-          text: ! "# Hotspots\n\nLinks with configurable click areas.\n\nHotspots can play audio files, link to other pages in a Pageflow or to external websites. You can define as many hotspots as you want.\n\nDecide if you want to show a background image or a background video. (Keep in mind, that background videos will not be played on mobile devices, therefore use an additional fallback image for the mobile version)\n\nThe hotspot page type allows to use panoramic images that are wider and taller than the screen-size. It enables users to explore these images by horizontal or vertical scrolling.\n\nTo add a Hotspot just click on „Areas“ and choose between „Audio“, „Internal link“, or „External link“. \n\nThere are two ways to display hotspot areas:\n\n##  Hotspots as circles\n\nDisplay a white circle whose position and size can be defined by dragging. Click on the eye-symbol button of the corresponding hotspot and move this circle onto the desired position. If you use an audio file, a headphone-symbol will appear within the circle. The size of the symbol depends on the circle´s size. The circle becomes more visible when the cursor moves closer to it.\n\n## Individually designed hotspots\n\nAlternatively, an additional panorama image can be used to determine the look of hotspots when the cursor hovers above them. Two images have to be prepared:\n\n1. An image with all hotspots in an inactive state (e.g. a map with cities represented by black dots)\n2. An image with all hotspots in an active state (e.g. the same map with red dots representing cities)\n\nNow the rectangular hotspot areas are positioned to cover the graphic representations of the hotspots. When the cursor hovers above one of the hotspots, the corresponding part of the hover-image will be displayed inside the hotspot's area. That way the hotspot is displayed in its active state while all others remain inactive.\n\nIt is also possible to use videos instead of images. The following combinations are possible:\n\n1. Background image with hover image\n2. Background video with hover image\n3. Background image with hover video\n\nIf you wish to mark hotspots as \"already visited\" you can also upload a „Visited-Image“ which then shows a certain spot in a different color after visiting the linked page.\n\n## Text options\n\nBoth of these hotspot types can be entitled and have additional text/description.\nThe description editor contains basic formatting options like bold, italic & underline.\n\n## Atmo options\n\nEvery Hotspot page, can play an additional backround sound that can optionally stop or continue playing (at the same or a lower volume) while an audio-Hotspot is playing.\n\n## Further options\n\nRestrict scrolling to hotspot areas: Only scroll between hotspots.\n\nForce scrolling: Ensure there is a margin which ensures the panorama can be scrolled both vertically and horizontally.\n\nDeactivate scrolling at image border: Do not scroll in panorama view when user moves the cursor.\n\nExamples of application: Menu site, multiple choice, exploration tour"
+          text: |-
+            # Hotspots
+
+            Links with configurable click areas.
+
+            Hotspots can play audio files, link to other pages in a Pageflow or to external websites. You can define as many hotspots as you want.
+
+            Decide if you want to show a background image or a background video. (Keep in mind, that background videos will not be played on mobile devices, therefore use an additional fallback image for the mobile version)
+
+            The hotspot page type allows to use panoramic images that are wider and taller than the screen-size. It enables users to explore these images by horizontal or vertical scrolling.
+
+            To add a Hotspot just click on „Areas“ and choose between „Audio“, „Internal link“, or „External link“.
+
+            There are two ways to display hotspot areas:
+
+            ##  Hotspots as circles
+
+            Display a white circle whose position and size can be defined by dragging. Click on the eye-symbol button of the corresponding hotspot and move this circle onto the desired position. If you use an audio file, a headphone-symbol will appear within the circle. The size of the symbol depends on the circle´s size. The circle becomes more visible when the cursor moves closer to it.
+
+            ## Individually designed hotspots
+
+            Alternatively, an additional panorama image can be used to determine the look of hotspots when the cursor hovers above them. Two images have to be prepared:
+
+            1. An image with all hotspots in an inactive state (e.g. a map with cities represented by black dots)
+            2. An image with all hotspots in an active state (e.g. the same map with red dots representing cities)
+
+            Now the rectangular hotspot areas are positioned to cover the graphic representations of the hotspots. When the cursor hovers above one of the hotspots, the corresponding part of the hover-image will be displayed inside the hotspot's area. That way the hotspot is displayed in its active state while all others remain inactive.
+
+            It is also possible to use videos instead of images. The following combinations are possible:
+
+            1. Background image with hover image
+            2. Background video with hover image
+            3. Background image with hover video
+
+            If you wish to mark hotspots as \"already visited\" you can also upload a „Visited-Image“ which then shows a certain spot in a different color after visiting the linked page.
+
+            ## Free form hotspots
+
+            It's not always possible to cover the visual elements of a
+            panorama image with rectangular hotspots without creating
+            overlapping hotspot areas. For example, trying to turn the
+            countries on a map into clickable areas that change color
+            when the cursor hovers a country is not possible with a
+            single hover image: soon as a hotspot is not properly
+            contained inside a county's borders, a part of the
+            neighbor country changes its color together with the
+            hovered country.
+
+            For cases like this, we can use a so called mask image,
+            allowing us to freely determine the shape of our
+            hotspots. We need to create PNG image with transparent
+            background on which the desired hotspot areas are
+            represented as unicolor areas. The dimensions of the image
+            have to match those of the panorama and hover images.
+
+            For the map example, we could come up with an identically
+            proportioned map image, in which each country's shape is
+            filled with a different color leaving oceans and other
+            non-clickable parts transparent.
+
+            Once the map image has been selected, we can not only
+            create new hotspots by dragging rectangular shapes, but
+            also by clicking on of predefined colored areas given in
+            the mask image.
+
+            The shape of the hotspot corresponds exactly to the
+            selected color area. Also when the hotspot is hovered the
+            hover image is displayed cropped to that shape.
+
+            When determining hotspot areas, only the area's color is
+            taking into account: areas do not need to be connected.
+
+            Hence, turning to the map example one last time, islands
+            belonging to a country can also be highlighted together
+            with the mainland when it is hovered, while the sea
+            surrounding those islands need not be part of the
+            clickable area.
+
+            Important: Make sure that anti aliasing is turned off in
+            your image composing application while preparing the mask
+            image. We require a mask image with sharp edges and
+            clearly separated areas. Anti aliasing on the other hand
+            creates tiny color gradients which are then treated as
+            multiple pixel sized areas. If an image contains too many
+            different color values, trying to select it as a mask
+            image leads to an error message inside the editor.
+
+            At the moment, it is not possible to use mask images in
+            combintation with hover images.
+
+            ## Text options
+
+            Both of these hotspot types can be entitled and have additional text/description.
+            The description editor contains basic formatting options like bold, italic & underline.
+
+            ## Atmo options
+
+            Every Hotspot page, can play an additional backround sound that can optionally stop or continue playing (at the same or a lower volume) while an audio-Hotspot is playing.
+
+            ## Further options
+
+            Restrict scrolling to hotspot areas: Only scroll between hotspots.
+
+            Force scrolling: Ensure there is a margin which ensures the panorama can be scrolled both vertically and horizontally.
+
+            Deactivate scrolling at image border: Do not scroll in panorama view when user moves the cursor.
+
+            Examples of application: Menu site, multiple choice, exploration tour
       manage_sites: Manage links
       page:
+        scroll_down: Scroll down
         scroll_left: Scroll left
         scroll_right: Scroll right
+        scroll_up: Scroll up
       page_attributes:
         add_environment:
           inline_help: Zoom panorama to allow scrolling in both directions.
@@ -64,7 +200,7 @@ en:
         background_type:
           label: Panorama type
           values:
-            hover_video: Backgrund image/hover video
+            hover_video: Background image/hover video
             image: Background image/hover image
             video: Background video/hover image
         hover_image_id:
@@ -79,11 +215,14 @@ en:
             label: Hover video
         limit_scrolling:
           inline_help: Enable scrolling only if there hotspot areas outside the view port.
-          label: Restict to hotspot areas
+          label: Restrict to hotspot areas
         linked_linkmap_page_perma_ids:
           label: Page links
         linkmap_areas:
           label: Link areas
+        linkmap_color_map_image_id:
+          inline_help: Image with colored areas which determine the shape of hotspots. Further instructions can be found in the help entry of the hotspot page type.
+          label: Mask image
         margin_scrolling_disabled:
           inline_help: Do not scroll panorama when the cursor moves.
           label: Disable autoscroll in page margin
@@ -111,8 +250,11 @@ en:
           areas: Areas
       inline_help:
         pageflow/linkmap_page/area:
+          inverted: Display dark pictograms to improve visibility on light backgrounds.
           link_title: The description is displayed inside an overlay when the cursor hovers the hotspot.
-          marker: ! 'Choose the hotspot''s visual appearance. '
+          marker: 'Choose the hotspot''s visual appearance. '
+          mask_perma_id: Colored area inside mask image which determines the shape of the hotspot.
+          mask_perma_id_disabled: Colored area inside mask image which determines the shape of the hotspot. Only available if a mask image has been selected on the hotspot page's 'Files' tab and the panorama type is not 'Hover video'.
           name: Choose a label to recognize the link within the overview. This label is for your orientation only and will not be displayed to the reader.
           page_transition: Choose the animation, that will be used to transition to the link's target page.
           target_id: Object the hotspot links to.

data/config/routes.rb

@@ -1,5 +1,5 @@
 Pageflow::LinkmapPage::Engine.routes.draw do
-  resources :entries, only: [], shallow: true do
-    resources :sites
+  resources :image_files, only: [] do
+    resource :mask_sprite, only: [:show, :create]
   end
 end

data/db/migrate/20170330201200_create_mask_sprites.rb

@@ -0,0 +1,12 @@
+class CreateMaskSprites < ActiveRecord::Migration
+  def change
+    create_table   :pageflow_linkmap_page_mask_sprites do |t|
+      t.belongs_to :image_file
+      t.string     :attachment_file_name
+      t.string     :attachment_content_type
+      t.integer    :attachment_file_size, limit: 8
+      t.datetime   :attachment_updated_at
+      t.timestamps
+    end
+  end
+end

data/lib/generators/pageflow_linkmap_page/install/install_generator.rb

@@ -15,6 +15,7 @@ module PageflowLinkmapPage
     end
 
     def install_migrations
+      rake "pageflow_#{engine_name_suffix}:install:migrations"
       rake 'pageflow_external_links:install:migrations'
     end
 

data/lib/pageflow/linkmap_page/version.rb

@@ -1,5 +1,5 @@
 module Pageflow
   module LinkmapPage
-    VERSION = '0.2.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/pageflow-linkmap-page.gemspec

@@ -9,28 +9,27 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Codevise Solutions Ltd.']
   spec.email         = ['info@codevise.de']
   spec.summary       = 'Pageflow page type for a page that contains customizable link areas'
-  spec.homepage      = 'http://github.com/codevise/pageflow-linkmap-page'
+  spec.homepage      = 'https://github.com/codevise/pageflow-linkmap-page'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'pageflow', '~> 0.10'
-  spec.add_runtime_dependency 'pageflow-external-links', '~> 0.3'
+  spec.required_ruby_version = '~> 2.1'
 
-  # Using translations from rails locales in javascript code.
-  spec.add_runtime_dependency 'i18n-js'
+  spec.add_runtime_dependency 'pageflow', ['>= 0.10', '< 13']
+  spec.add_runtime_dependency 'pageflow-external-links', ['>= 0.3', '< 2']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.0'
-  spec.add_development_dependency 'factory_girl_rails'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'factory_girl_rails', '~> 4.5'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
 
   # Browser like integration testing
-  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'capybara', '~> 2.13'
 
   # Semantic versioning rake tasks
-  spec.add_development_dependency 'semmy', '~> 0.2.1'
+  spec.add_development_dependency 'semmy', '~> 1.0'
 end