Bug 33907 - Improve translation of title tags: OPAC part 1
Summary: Improve translation of title tags: OPAC part 1
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: Templates (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Owen Leonard
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks: 33906 36095
  Show dependency treegraph
 
Reported: 2023-06-06 15:43 UTC by Owen Leonard
Modified: 2024-04-29 08:23 UTC (History)
2 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 33913: Improve translation of title tags: Circulation, holds, and ILL (24.46 KB, patch)
2023-06-06 18:27 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 33907: Improve translation of title tags: OPAC part 1 (31.40 KB, patch)
2024-02-14 16:47 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 33907: Improve translation of title tags: OPAC part 1 (31.45 KB, patch)
2024-04-29 07:26 UTC, David Nind
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Owen Leonard 2023-06-06 15:43:30 UTC
This patch will modify OPAC templates, including self checkout and self checkin, so that translatable strings in the <title> tag are wrapped in the correct translation function, e.g. [% t('Translate me') %]
Comment 1 Owen Leonard 2023-06-06 18:27:30 UTC Comment hidden (obsolete)
Comment 2 Owen Leonard 2024-02-14 16:47:54 UTC
Created attachment 162157 [details] [review]
Bug 33907: Improve translation of title tags: OPAC part 1

This patch updates a batch of OPAC templates so that title tags can
be more easily translated. Some templates have been updated for
consistency as well: Harmonizing page title, breaddrumb navigation, and
page headers.

To test, apply the patch and confirm that the following pages have
correct title tags:

- Log in to the OPAC by navigating directly to a user page like
    /cgi-bin/koha/opac-user.pl
- From your user summary page, click "Charges."
- Check the advanced search page.
- Search for a bibliographic record and view the details, and then click
  "MARC view" and "ISBD view."
- From this page click "Save to your lists" and check the title in the
  popup window."
- Still on a detail page, click "Add to your cart." Open the cart and
  check that page.
- Go to authority search (must have OpacAuthorities enabled).
  - Perform an authority search which will return results.
  - View the detail page for one of the results, and check the MARC view
    as well.
- With UseCourseReserves enabled, view the course reserves page, then
  the course reserve detail page.
- Search for a subscription which has patron notification enabled.
  - View the detail page, then open the "Subscriptions" tab. Click "More
    details."
    - On this page you should see a "Subscribe to email notification"
      button. Click it to open the subscription page.
- Check both /cgi-bin/koha/opac-browse.pl and
  /cgi-bin/koha/opac-browser.pl. Whether or not the features are enabled
  you should be able to check the title.
- Check /cgi-bin/koha/ilsdi.pl as well as one or more views linked to on
  that page.
- Navigate to a page in the OPAC which doesn't exist to test the error
  page template.
- Go to Administration -> System preferences and enable the
  OpacMaintenance preference.
  - Go to the OPAC and check the system maintenance page.
Comment 3 David Nind 2024-04-29 07:26:26 UTC
Created attachment 165720 [details] [review]
Bug 33907: Improve translation of title tags: OPAC part 1

This patch updates a batch of OPAC templates so that title tags can
be more easily translated. Some templates have been updated for
consistency as well: Harmonizing page title, breaddrumb navigation, and
page headers.

To test, apply the patch and confirm that the following pages have
correct title tags:

- Log in to the OPAC by navigating directly to a user page like
    /cgi-bin/koha/opac-user.pl
- From your user summary page, click "Charges."
- Check the advanced search page.
- Search for a bibliographic record and view the details, and then click
  "MARC view" and "ISBD view."
- From this page click "Save to your lists" and check the title in the
  popup window."
- Still on a detail page, click "Add to your cart." Open the cart and
  check that page.
- Go to authority search (must have OpacAuthorities enabled).
  - Perform an authority search which will return results.
  - View the detail page for one of the results, and check the MARC view
    as well.
- With UseCourseReserves enabled, view the course reserves page, then
  the course reserve detail page.
- Search for a subscription which has patron notification enabled.
  - View the detail page, then open the "Subscriptions" tab. Click "More
    details."
    - On this page you should see a "Subscribe to email notification"
      button. Click it to open the subscription page.
- Check both /cgi-bin/koha/opac-browse.pl and
  /cgi-bin/koha/opac-browser.pl. Whether or not the features are enabled
  you should be able to check the title.
- Check /cgi-bin/koha/ilsdi.pl as well as one or more views linked to on
  that page.
- Navigate to a page in the OPAC which doesn't exist to test the error
  page template.
- Go to Administration -> System preferences and enable the
  OpacMaintenance preference.
  - Go to the OPAC and check the system maintenance page.

Signed-off-by: David Nind <david@davidnind.com>
Comment 4 David Nind 2024-04-29 08:23:47 UTC
I've listed below the updated breadcrumb, page title, and browser page title information after the patch is applied.

I've noted a couple of minor things - I'll leave it up to you whether these are warranted or not.

Advanced search results page
- Maybe the browser page title should include 'Advanced search':
  . Current breadcrumb: Home > Advanced search > Results of search for 'perl'
  . Current browser page title: Results of search for 'perl' > Koha online catalog
  . Suggestion: Results of search for 'perl' > Advanced search > Koha online catalog

Detail views for a record - minor changes for more consistency
- Suggested changes are:
  . Breadcrumb (add for): Home > MARC view for: <title>
  . Breadcrumb (add colon): Home > ISBD view for: <title>
- Current wording with the patch:
  . Breadcrumb: Home > Details for: <title>
  . Breadcrumb: Home > MARC view: <title>
  . Breadcrumb: Home > ISBD view for <title>
  . Browser page title: Details for: <title> > Koha online catalog
  . Browser page title: MARC view for: <title> > Koha online catalog
  . Browser page title: ISBD view for: <title> > Koha online catalog

Authority search details page - MARC view
- Maybe the browser page title should include 'Authority search':
  . Current breadcrumb: Home > Authority search > <authority term title> (Type of term) > MARC view
  . Current browser page title: MARC view > <authority term title> (Type of term) > Koha online catalog
  . Suggestion: MARC view > <authority term title> (Type of term) > Authority search > Koha online catalog

Course reserves detail page
- Maybe the browser page title should include 'Course reserves':
  . Current breadcrumb: Home > Course reserves > Course reserves for '<course reserves title>'
  . Current browser page title: Course reserves for '<course reserves title>' > Koha online catalog
  . Suggestion: Course reserves for '<course reserves title>' > Course reserves > Koha online catalog

Subscription which has patron notification
- Not sure that it needs the 'Subscription alerts' heading, but not bothered either way
  . Current breadcrumb: Home > Details for <title> > Subscribe to a subscription alert
  . Current page title:
       Subscription alerts
       Subscribe to a subscription alert
  . Current browser page title: Subscribe to a subscription alert > <title> > Koha online catalog

I didn't test any translation things.

Breadcrumb, page titles, and browser title information after patch applied
==========================================================================

User account charges section:
- Breadcrumb: Home > <username> > Your charges
- Page title: Your charges
- Browser page title: Your charges > Koha online catalog

Advanced search:
- Breadcrumb: Home > Advanced search
- Page title: Advanced search
- Browser page title: Advanced search > Koha online catalog

Search results (from the advanced search page):
- Breadcrumb: Home > Advanced search > Results of search for 'perl'
- Page title: Your search returned XX results. Atom/RSS icon to subscribe
- Browser page title: Results of search for 'perl' > Koha online catalog

Normal view:
- Breadcrumb: Home > Details for: <title>
- Page title: <title> <author(s)/contributer(s)>
- Browser page title: Details for: <title> > Koha online catalog

MARC view:
- Breadcrumb: Home > MARC view: <title>
- Page title: <title> (Record no. XXXX)
- Browser page title: MARC view for: <title> > Koha online catalog

ISBD view:
- Breadcrumb: Home > ISBD view for <title>
- Page title: <title>
- Browser page title: ISBD view for: <title> > Koha online catalog

Cart (pop-up window):
- Breadcrumb: None
- Page title: Your cart
- Browser page title: Your cart > Koha online catalog

Authorty search:
- Breadcrumb: Home > Authority search
- Page title: Authority search
- Browser page title: Authority search > Koha online catalog

Authority search results:
- Breadcrumb: Home > Authority search > Results
- Page title: Authority search results
- Browser page title: Results > Authority search > Koha online catalog

Authority search details page:
- Breadcrumb: Home > Authority search > <authority term title> (Type of term)
- Page title: <authority term title> (Type of term)* 
- Browser page title: <authority term title> (Type of term) > Authority search > Koha online catalog

Authority search details page - MARC view:
- Breadcrumb: Home > Authority search > <authority term title> (Type of term) > MARC view
- Page title: Entry <Type of term>*
- Browser page title: MARC view > <authority term title> (Type of term) > Koha online catalog

* Term type, such as Topical Term, Personal Name

Course reserves:
- Breadcrumb: Home > Course reserves
- Page title: Courses reserves
- Browser page title: Course reserves > Koha online catalog

Course reserves detail page:
- Breadcrumb: Home > Course reserves > Course reserves for '<course reserves title>'
- Page title: Course reserves for '<course reserves title>'
- Browser page title: Course reserves for '<course reserves title>' > Koha online catalog

Subscription which has patron notification (created a new serial and added some new issues):
- Breadcrumb: Home > Details for <title> > Subscribe to a subscription alert
- Page title: Subscription alerts
              Subscribe to a subscription alert
- Browser page title: Subscribe to a subscription alert > <title> > Koha online catalog

Browse search (/cgi-bin/koha/opac-browse.pl):
- Breadcrumb: Home > Browse search
- Page title: Browse search
- Browser page title: Browse search > Koha online catalog

OPAC browser (/cgi-bin/koha/opac-browser.pl):
- Breadcrumb: Home > Browse our catalog
- Page title: Browse our catalog
- Browser page title: Browse our catalog > Koha online catalog

ILS-DI (/cgi-bin/koha/ilsdi.pl):
- Breadcrumb: Home >  ILS-DI
- Page title: ILS-DI
- Browser page title: ILS-DI > Koha online catalog

ILS-DI detail, using GetAvailability (/cgi-bin/koha/ilsdi.pl?service=Describe&verb=GetAvailability):
- Breadcrumb: Home > ILS-DI > GetAvailability
- Page title: ILS-DI
              GetAvailability 
- Browser page title: GetAvailability > ILS-DI > Koha online catalog

Page not found:
- Breadcrumb: Home > An error has occurred
- Page title: Sorry, the requested page is not available
              Error 404
- Browser page title: An error has occurred > Koha online catalog

System maintenance:
- Breadcrumb: None
- Page title: System maintenace (and message in a box with rounded corners)
- Browser page title: System maintenace > Koha online catalog