Skip to content

Add contextual user guide help buttons across mapped pages and dialogs #303

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
apodacaduron wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add contextual user guide help buttons across mapped pages and dialogs #303

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
18b4b47
add contextual user guide help buttons across mapped pages and dialogs
apodacaduron Mar 27, 2026
32011cd
Merge branch 'main' into add-contextual-help-and-tooltips
level09 Mar 31, 2026
2d2462d
Merge branch 'main' into add-contextual-help-and-tooltips
level09 Apr 15, 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
4 changes: 4 additions & 0 deletions enferno/admin/templates/admin/activity.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@
<v-toolbar-title>{{ _('System Activity') }}</v-toolbar-title>
<v-divider class="mx-4" inset vertical></v-divider>
<v-btn @click="toggleAdvSearch" prepend-icon="mdi-ballot">{{ _('Filter Options') }}</v-btn>
<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/activity.html', help_title='Activity Monitor' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
</v-toolbar>
</template>

Expand Down
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/actor-fields.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
hide-details v-model="ui.search" clearable></v-text-field>

<div class="d-flex ga-4 align-center">
{% with help_url='https://docs.bayanat.org/guide/dynamic-fields.html', help_title='Dynamic Fields' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn
class="outlined-btn"
prepend-icon="mdi-history"
Expand Down Expand Up @@ -164,4 +167,4 @@
window.app = app;
});
</script>
{% endblock %}
{% endblock %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/actors.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@


<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/actors.html', help_title='Actors' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
{% if current_user.roles_in(['Admin','DA']) %}
<v-btn @click="editItem" color="primary" variant="elevated"
class="ma-2">{{ _('New Actor') }}</v-btn>
Expand Down
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/bulletin-fields.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
hide-details v-model="ui.search" clearable></v-text-field>

<div class="d-flex ga-4 align-center">
{% with help_url='https://docs.bayanat.org/guide/dynamic-fields.html', help_title='Dynamic Fields' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn
class="outlined-btn"
prepend-icon="mdi-history"
Expand Down Expand Up @@ -170,4 +173,4 @@
window.app = app;
});
</script>
{% endblock %}
{% endblock %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/bulletins.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@
></v-text-field>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/bulletins.html', help_title='Bulletins' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
{% if current_user.roles_in(['Admin','DA']) %}
<v-btn
@click="editItem"
Expand Down
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/eventtypes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
<v-toolbar-title>{{ _('Event Types') }}</v-toolbar-title>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/events.html', help_title='Events' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn
color="primary"
Expand Down
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/incident-fields.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
hide-details v-model="ui.search" clearable></v-text-field>

<div class="d-flex ga-4 align-center">
{% with help_url='https://docs.bayanat.org/guide/dynamic-fields.html', help_title='Dynamic Fields' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn
class="outlined-btn"
prepend-icon="mdi-history"
Expand Down Expand Up @@ -164,4 +167,4 @@
window.app = app;
});
</script>
{% endblock %}
{% endblock %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/incidents.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@


<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/incidents.html', help_title='Incidents' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
{% if current_user.roles_in(['Admin','DA']) %}
<v-btn @click="editItem" color="primary" variant="elevated" class="ma-2"
>{{ _('New Incident') }}</v-btn
Expand Down
4 changes: 3 additions & 1 deletion enferno/admin/templates/admin/jsapi.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ tfaAuthentication_ : "{{ _('2FA Authentication') }}",
recoveryCodes_ : "{{ _('Recovery Codes') }}",
securityKeys_ : "{{ _('Security Keys') }}",
userGuides_ : "{{ _('User Guides') }}",
learnAbout_: (topic) => "{{ _('Learn about {topic}') }}".replace("{topic}", topic),
support_ : "{{ _('Support') }}",
reportABug_ : "{{ _('Report a Bug') }}",
logout_ : "{{ _('Logout') }}",
Expand Down Expand Up @@ -76,6 +77,7 @@ clickRetryOCR_: "{{ _('Click retry to attempt OCR processing again') }}",
ocrProcessingFailed_: "{{ _('OCR Processing Failed') }}",
retryOCR_: "{{ _('Retry OCR') }}",
ocrStatus_: "{{ _('OCR Status') }}",
ocrAndTextExtraction_: "{{ _('OCR & Text Extraction') }}",
thisMediaHasBeenMarkedAsUnreadableByAReviewer_: "{{ _('This media has been marked as unreadable by a reviewer') }}",
thisMediaWasManuallyTranscribedByAReviewer_: "{{ _('This media was manually transcribed by a reviewer') }}",
thisMediaHasBeenReviewedAndAccepted_: "{{ _('This media has been reviewed and accepted') }}",
Expand Down Expand Up @@ -380,6 +382,7 @@ documentationDate_: "{{ _('Documentation Date') }}",
sourceLink_: "{{ _('Source Link') }}",
comments_ : "{{ _('Comments') }}",
logHistory_: "{{ _('Log History') }}",
revisionHistory_: "{{ _('Revision History') }}",

// actors
fullName_: "{{ _('Full Name') }}",
Expand Down Expand Up @@ -842,4 +845,3 @@ translations['whisperModels'] = [
{"en": "{{ model['model_label'] }}", "tr": "{{ _(model['model_label']) }}"},
{% endfor %}
];

3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/labels.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
</v-text-field>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/labels.html', help_title='Labels' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn-toggle v-model="viewMode" mandatory density="compact" class="ma-2">
<v-btn value="table" icon="mdi-table"></v-btn>
Expand Down
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/locations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
</v-text-field>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/locations.html', help_title='Locations' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn
@click="newItem"
Expand Down
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/media-dashboard.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,9 @@
</div>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/ocr.html', help_title='OCR & Text Extraction' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
</v-toolbar>

<!-- Bulk Actions Bar -->
Expand Down Expand Up @@ -551,4 +554,4 @@
window.app = app;
});
</script>
{% endblock %}
{% endblock %}
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/partials/actor_dialog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
<v-spacer></v-spacer>

<template #append>
<v-btn @click="validateForm" :disabled="saving" :loading="saving" variant="elevated" class="mx-2" >
{% with help_url='https://docs.bayanat.org/guide/actors.html', help_title='Actors' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn @click="validateForm" :disabled="saving" :loading="saving" variant="elevated" class="mx-2" >
{{ _('Save Actor') }}
</v-btn>
<v-btn icon="mdi-close" @click="confirmClose">
Expand Down
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/partials/bulletin_dialog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@
</v-toolbar-title>

<template #append>
{% with help_url='https://docs.bayanat.org/guide/bulletins.html', help_title='Bulletins' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn @click="validateFormAndSave" :disabled="saving" :loading="saving" variant="elevated" class="mx-2">
{{ _('Save Bulletin') }}
</v-btn>
Expand Down
20 changes: 20 additions & 0 deletions enferno/admin/templates/admin/partials/contextual_help_fab.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{% if help_url %}
<v-tooltip location="bottom">
<template #activator="{ props }">
<v-btn
v-bind="props"
icon="mdi-help-circle-outline"
variant="plain"
href="{{ help_url }}"
target="_blank"
rel="noopener noreferrer"
class="mr-2"
></v-btn>
</template>
{% if help_title %}
{{ _('Learn about') }} {{ _(help_title) }}
{% else %}
{{ _('User Guides') }}
{% endif %}
</v-tooltip>
{% endif %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/partials/incident_dialog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
<v-toolbar-title>${formTitle} <span v-if="editedItem.id"> ${editedItem.id}</span>
</v-toolbar-title>
<template #append>
{% with help_url='https://docs.bayanat.org/guide/incidents.html', help_title='Incidents' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn variant="elevated" @click="validateForm" :disabled="saving" :loading="saving" class="mx-2"
>{{ _('Save Incident') }}
Expand Down
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/partials/media_dialog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@
<v-spacer></v-spacer>

<template #append>
{% with help_url='https://docs.bayanat.org/guide/media.html', help_title='Media' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn variant="elevated" class="mx-2" :disabled="!enableAttach" @click="attachMedia"
>{{ _('Attach Media') }}</v-btn
>
Expand Down
5 changes: 4 additions & 1 deletion enferno/admin/templates/admin/roles.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
<v-toolbar-title>{{ _('User Groups') }}</v-toolbar-title>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/permissions.html', help_title='Permissions' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn
@click="newItem"
Expand Down Expand Up @@ -348,4 +351,4 @@
window.app = app;
});
</script>
{% endblock %}
{% endblock %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/sources.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
></v-text-field>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/sources.html', help_title='Sources' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn
color="primary"
Expand Down
2 changes: 1 addition & 1 deletion enferno/admin/templates/admin/system-administration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1426,4 +1426,4 @@ <h4 class="subtitle-2 mb-n1">{{ _('Enable Mail System') }}</h4>
</script>


{% endblock %}
{% endblock %}
3 changes: 3 additions & 0 deletions enferno/admin/templates/admin/users.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
<v-toolbar-title>{{ _('System Users') }}</v-toolbar-title>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/access-control.html', help_title='Access Control' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn @click.once="forceGlobalReset" class="ma-2" color="error" variant="elevated">
{{ _('Force Global Password Reset') }}
Expand Down
3 changes: 3 additions & 0 deletions enferno/data_import/templates/import-log.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
<v-toolbar flat color="white">
<v-toolbar-title>{{ _('Import Log') }}</v-toolbar-title>
<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/data-import.html', help_title='Data Import' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
</v-toolbar>
</template>

Expand Down
3 changes: 3 additions & 0 deletions enferno/data_import/templates/media-import.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@
</v-tooltip>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/data-import.html', help_title='Data Import' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn size="small" class="mx-2 hidden-sm-and-down"
@click="toStepTwo"
Expand Down
3 changes: 3 additions & 0 deletions enferno/data_import/templates/sheets-import.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,9 @@ <h6 class="font-italic text--black mb-2">{{ _('Sample Data') }}</h6>
</v-select>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/data-import.html', help_title='Data Import' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}
<v-btn v-if="mapid" @click="deleteMap" prepend-icon="mdi-delete" color="error" variant="outlined"
class="mx-2">{{ _('Delete') }}</v-btn>
<v-btn v-if="mapid" :disabled="!isMapPopulated" @click="updateMap" prepend-icon="mdi-pencil" variant="outlined"
Expand Down
3 changes: 3 additions & 0 deletions enferno/deduplication/templates/deduplication.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
</v-toolbar-title>

<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/deduplication.html', help_title='Video Deduplication' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

<v-btn @click="process" class="ma-2" :disabled="processOn" color="green" variant="elevated">
<v-icon left>mdi-play</v-icon>
Expand Down
3 changes: 3 additions & 0 deletions enferno/export/templates/export-dashboard.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
<v-toolbar flat color="white">
<v-toolbar-title>{{ _('Exports') }}</v-toolbar-title>
<v-spacer></v-spacer>
{% with help_url='https://docs.bayanat.org/guide/data-export.html', help_title='Data Export' %}
{% include 'admin/partials/contextual_help_fab.html' %}
{% endwith %}

</v-toolbar>
</template>
Expand Down
17 changes: 17 additions & 0 deletions enferno/static/js/components/ActorCard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,23 @@ const ActorCard = Vue.defineComponent({
<v-btn fab :loading="hloading" @click="loadRevisions" size="small" class="elevation-0 align-content-center">
<v-icon>mdi-history</v-icon>
</v-btn>
<v-tooltip location="bottom">
<template #activator="{ props }">
<v-btn
v-bind="props"
icon
variant="plain"
size="small"
class="ml-1"
href="https://docs.bayanat.org/guide/revision-history.html"
target="_blank"
rel="noopener noreferrer"
>
<v-icon>mdi-help-circle-outline</v-icon>
</v-btn>
</template>
{{ translations.learnAbout_(translations.revisionHistory_) }}
</v-tooltip>
</h3>

<template v-for="(revision,index) in revisions">
Expand Down
15 changes: 15 additions & 0 deletions enferno/static/js/components/BulletinCard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,21 @@ const BulletinCard = Vue.defineComponent({
{{ translations.logHistory_ }}

</v-btn>
<v-tooltip location="bottom">
<template #activator="{ props }">
<v-btn
v-bind="props"
icon="mdi-help-circle-outline"
variant="plain"
size="small"
class="ml-1"
href="https://docs.bayanat.org/guide/revision-history.html"
target="_blank"
rel="noopener noreferrer"
></v-btn>
</template>
{{ translations.learnAbout_(translations.revisionHistory_) }}
</v-tooltip>
</v-toolbar-title>
</v-toolbar>

Expand Down
17 changes: 17 additions & 0 deletions enferno/static/js/components/IncidentCard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,23 @@ const IncidentCard = Vue.defineComponent({
<v-btn fab :loading="hloading" @click="loadRevisions" class="elevation-0 align-content-center">
<v-icon>mdi-history</v-icon>
</v-btn>
<v-tooltip location="bottom">
<template #activator="{ props }">
<v-btn
v-bind="props"
icon
variant="plain"
size="small"
class="ml-1"
href="https://docs.bayanat.org/guide/revision-history.html"
target="_blank"
rel="noopener noreferrer"
>
<v-icon>mdi-help-circle-outline</v-icon>
</v-btn>
</template>
{{ translations.learnAbout_(translations.revisionHistory_) }}
</v-tooltip>
</h3>

<template v-for="(revision,index) in revisions">
Expand Down
Loading
Loading