Skip to content

USE-504: Adding tab tracking to event names #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
djanelle-mit wants to merge 3 commits into
base: main
Choose a base branch
from
Open

USE-504: Adding tab tracking to event names #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f55763
Adding tab tracking to event names
djanelle-mit Apr 10, 2026
4efc671
Fixing missed browzine link event name
djanelle-mit Apr 10, 2026
2f6bea2
Updated documentation
djanelle-mit Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions app/javascript/matomo_tracking.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
//
// CLICK TRACKING
// Add `data-matomo-click="Category, Action, Name"` to any element to track
// clicks as Matomo events. The Name segment is optional. We have a convention
// of using semicolons inside Name to divide multiple values.
// clicks as Matomo events. We have a convention of using semicolons inside Name
// to divide multiple values. This is purely for consistency.
//
// This tracking can be placed directly on an interactive element.
// Tracking also works if placed on a container. The script will look
Expand All @@ -16,22 +16,22 @@
//
// Examples:
// <a href="/file.pdf" data-matomo-click="Downloads, PDF Click, My Paper">Download</a>
// <button data-matomo-click="Search, Boolean Toggle">AND/OR</button>
// <button data-matomo-click="Search, Boolean Toggle, Off">AND/OR</button>
//
// Event delegation on `document` means this works for elements loaded
// asynchronously (Turbo frames, content-loader, etc.) without re-binding.
//
// SEEN TRACKING
// Add `data-matomo-seen="Category, Action, Name"` to any element to fire a
// Matomo event when that element becomes visible in the viewport. The Name
// segment is optional. We have a convention of using semicolons inside Name
// to divide multiple values. Each element fires at most once per page load.
// Matomo event when that element becomes visible in the viewport. We have
// a convention of using semicolons inside Name to divide multiple values.
// Each element fires at most once per page load.
// Works for elements present on initial page load and for elements injected
// later by Turbo frames or async content loaders.
//
// Examples:
// <div data-matomo-seen="Impressions, Result Card, Alma">...</div>
// <a data-matomo-seen="Promotions, Banner Shown">...</a>
// <a data-matomo-seen="Promotions, Banner Shown, Banner Type">...</a>
//
// DYNAMIC VALUES
// Wrap a helper name in double curly braces anywhere inside a segment to have
Expand Down
4 changes: 2 additions & 2 deletions app/views/layouts/_site_header.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="institute-bar" data-matomo-seen="Navigation, Header Links Seen" data-matomo-click="Navigation, Header Links Engaged, Link: {{getElementText}}">
<div class="institute-bar" data-matomo-seen="Navigation, Header Links Seen, Tab: {{getActiveTabName}}" data-matomo-click="Navigation, Header Links Engaged, Link: {{getElementText}}">
<div class="wrapper">
<a class="link-logo-mit" href="https://www.mit.edu" ><span class="sr">MIT Logo</span>
<img src="https://cdn.libraries.mit.edu/files/branding/local/mit_logo_std_rgb_white.svg" height="24" alt="MIT logo" >
Expand Down Expand Up @@ -26,5 +26,5 @@
<% end %>
</header>
<%= render partial: 'search/form' unless Feature.enabled?(:geodata) %>
</div>
</div>
</div>
4 changes: 2 additions & 2 deletions app/views/layouts/application.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<%= render partial: "layouts/global_alert" %>

<%= render partial: "layouts/site_header" %>

<div class="wrap-outer-content layout-band">
<div class="wrap-content">
<%= render partial: "layouts/flash" %>
Expand All @@ -22,7 +22,7 @@
</div>
</div>

<footer data-matomo-seen="Navigation, Footer Links Seen" data-matomo-click="Navigation, Footer Links Engaged, Link: {{getElementText}}">
<footer data-matomo-seen="Navigation, Footer Links Seen, Tab: {{getActiveTabName}}" data-matomo-click="Navigation, Footer Links Engaged, Link: {{getElementText}}">
<%= render partial: "layouts/libraries_footer" %>
<%= render partial: "layouts/institute_footer" %>
</footer>
Expand Down
22 changes: 12 additions & 10 deletions app/views/search/_form.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,32 @@
<input id="tab-to-target" type="hidden" name="tab" value="<%= @active_tab %>">
<button type="submit" class="btn button-primary">Search</button>
</div>
<div class="search-actions" data-matomo-click="Search, Advanced Search Engaged">
<div class="search-actions" data-matomo-click="Search, Advanced Search Engaged, Tab: {{getActiveTabName}}">
<a href="https://libraries.mit.edu/search-advanced">Advanced search</a>
</div>
</form>

<% if Feature.enabled?(:boolean_picker) %>
<aside class="panel panel-info">
<div class="panel-heading">
<% if cookies[:boolean_type].present? %>
<p>Your boolean preference for this session is: <%= cookies[:boolean_type] %></p>
<% else %>
<p>No preference is set. Default boolean preference (`AND`) is enabled.</p>
<% end %>
<p>
<% if cookies[:boolean_type].present? %>
Your boolean preference for this session is: <%= cookies[:boolean_type] %>
<% else %>
No preference is set. Default boolean preference (`AND`) is enabled.
<% end %>
</p>
</div>
<div class="panel-body">
<p>Change to:</p>
<ul>
<% ENV.fetch('BOOLEAN_OPTIONS', 'AND,OR').split(',').each do |opt| %>
<li><%= link_to(opt, boolpref_path(boolean_type: opt)) %></li>
<% end %>
<% ENV.fetch('BOOLEAN_OPTIONS', 'AND,OR').split(',').each do |opt| %>
<li><%= link_to(opt, boolpref_path(boolean_type: opt)) %></li>
<% end %>
<li><%= link_to('Clear preference', boolpref_path()) %></li>
</ul>
</div>
</aside>
</aside>
<% end %>

<%= render partial: 'search/source_tabs' if params[:q].present? %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/search/_results_callouts.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="callout-wrapper" data-track-content data-content-name="Search Suggestions" data-matomo-seen="Search Suggestions, Search Suggestions Seen" data-matomo-click="Search Suggestions, Search Suggestions Engaged, Link: {{getElementText}}">
<div class="callout-wrapper" data-track-content data-content-name="Search Suggestions" data-matomo-seen="Search Suggestions, Search Suggestions Seen, Tab: {{getActiveTabName}}" data-matomo-click="Search Suggestions, Search Suggestions Engaged, Link: {{getElementText}}">
<% if ['cdi', 'alma', 'all'].include?(@active_tab) %>
<%= render partial: "results_callout_component", locals: {
fa_name: 'magnifying-glass',
Expand Down
2 changes: 1 addition & 1 deletion app/views/search/_results_sidebar.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<aside id="results-sidebar">
<%= render partial: "results_callouts" %>
<div class="core-sidebar-items" data-track-content data-content-name="Sidebar Links" data-matomo-seen="Sidebar Links, Sidebar Links Seen" data-matomo-click="Sidebar Links, Sidebar Links Engaged, Link: {{getElementText}}">
<div class="core-sidebar-items" data-track-content data-content-name="Sidebar Links" data-matomo-seen="Sidebar Links, Sidebar Links Seen, Tab: {{getActiveTabName}}" data-matomo-click="Sidebar Links, Sidebar Links Engaged, Link: {{getElementText}}">
<div>
<i class="fa-light fa-message"></i>
<div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/search/results.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<%= render(partial: 'trigger_tacos') if tacos_enabled? %>

<%= turbo_frame_tag "search-results", data: { turbo_action: "advance" } do %>
<div id="results-section" data-matomo-seen="Search, Search Performed">
<div id="results-section" data-matomo-seen="Search, Search Performed, Tab: {{getActiveTabName}}">

<% if @show_primo_continuation %>

Expand Down
2 changes: 1 addition & 1 deletion app/views/tacos/analyze.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<% if @suggestions.present? && !Feature.enabled?(:geodata) %>
<div id="hint" aria-live="polite" data-matomo-seen="Interventions, Intervention Shown" data-track-content data-content-name="Intervention">
<div id="hint" aria-live="polite" data-matomo-seen="Interventions, Intervention Shown, Tab: {{getActiveTabName}}" data-track-content data-content-name="Intervention">
<aside class="mitlib-suggestion-panel">
<div class="panel-content">
<h2 class="panel-type">Suggested resource</h2>
Expand Down
2 changes: 1 addition & 1 deletion app/views/thirdiron/browzine.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<% if ThirdIron.enabled? && @browzine.present? %>
<% if @browzine[:browzine_link].present? %>
<div class="libkey-actions">
<%= link_to @browzine[:browzine_link][:text], @browzine[:browzine_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, Browzine Link Seen", matomo_click: "Results, Browzine Link Engaged, Link: {{getElementText}}", content_piece: @browzine[:browzine_link][:text] } %>
<%= link_to @browzine[:browzine_link][:text], @browzine[:browzine_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, Browzine Link Seen, Tab: {{getActiveTabName}}", matomo_click: "Results, Browzine Link Engaged, Link: {{getElementText}}", content_piece: @browzine[:browzine_link][:text] } %>
</div>
<% end %>
<% end %>
8 changes: 4 additions & 4 deletions app/views/thirdiron/libkey.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<% if ThirdIron.enabled? && @libkey.present? %>
<% if @libkey[:pdf_link].present? || @libkey[:html_link].present? %>
<% if @libkey[:pdf_link].present? %>
<%= link_to( @libkey[:pdf_link][:text], @libkey[:pdf_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:pdf_link][:text] } ) %>
<%= link_to( @libkey[:pdf_link][:text], @libkey[:pdf_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen, Tab: {{getActiveTabName}}", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:pdf_link][:text] } ) %>
<% end %>

<% if @libkey[:html_link].present? %>
<%= link_to( @libkey[:html_link][:text], @libkey[:html_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:html_link][:text] } ) %>
<%= link_to( @libkey[:html_link][:text], @libkey[:html_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen, Tab: {{getActiveTabName}}", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:html_link][:text] } ) %>
<% end %>

<%# If we don't have direct links, fall back to best_integrator_link. This allows for things like Article Galaxy links %>
<% elsif @libkey[:best_integrator_link].present? %>
<%= link_to( @libkey[:best_integrator_link][:text], @libkey[:best_integrator_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:best_integrator_link][:text] } ) %>
<%= link_to( @libkey[:best_integrator_link][:text], @libkey[:best_integrator_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, LibKey Link Seen, Tab: {{getActiveTabName}}", matomo_click: "Results, LibKey Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:best_integrator_link][:text] } ) %>
<% end %>

<%# Display browzine link if available. This should always display if we have it regardless of other links. %>
<% if @libkey[:browzine_link].present? %>
<div class="libkey-actions">
<%= link_to @libkey[:browzine_link][:text], @libkey[:browzine_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, Browzine Link Seen", matomo_click: "Results, Browzine Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:browzine_link][:text] } %>
<%= link_to @libkey[:browzine_link][:text], @libkey[:browzine_link][:link], class: 'button libkey-link', data: { matomo_seen: "Results, Browzine Link Seen, Tab: {{getActiveTabName}}", matomo_click: "Results, Browzine Link Engaged, Link: {{getElementText}}", content_piece: @libkey[:browzine_link][:text] } %>
</div>
<% end %>

Expand Down
Loading