Bug 8178 - Excessive HTML titles in documentation
Summary: Excessive HTML titles in documentation
Status: CLOSED FIXED
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: 4.18.0
Assignee: Bugzilla mail exporter
URL:
Keywords: linma_tester, prosaic
Depends on:
Blocks:
 
Reported: 2023-06-22 13:05 CEST by Pierre Ossman
Modified: 2024-10-03 09:28 CEST (History)
2 users (show)

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2023-06-22 13:05:18 CEST
Right now, our page <title>:s in the TAG are these very excessive things:

> Printer Features — The ThinLinc Administrator's Guide 4.14.0post build 3293 documentation

This is very likely to be cropped in usage, so it really should be a more sensible length. Most things will likely crop from the end, though, meaning the important parts are likely not hidden.

For comparison, the same page had this title before the switch to ReST:

> Chapter 5. Printer Features

Much shorter, but lacks any reference to ThinLinc so is likely a bit too short.
Comment 1 William Sjöblom cendio 2024-03-06 14:03:44 CET
Most search engines truncate titles containing more than 70 characters. Incomplete and shortened titles look unappealing to users and won't entice them to click on your page. For more information, please see this Google article:

https://developers.google.com/search/docs/appearance/title-link
Comment 2 William Sjöblom cendio 2024-03-13 17:37:21 CET
Another interesting aspect here is that the HTML titles do not work especially well in search engines. For example:

  https://www.cendio.com/resources/docs/tag/tldc_introduction.html

That link shows up as "Introduction — The ThinLinc Administrator's Guide ... - Cendio" in Google, despite it not being a general introduction but rather an introduction to TLDC. This is probably out-of-scope of this issue, but is still something worth considering.
Comment 4 William Sjöblom cendio 2024-09-11 11:21:31 CEST
The HTML titles have now been drastically reduced in length.

Pierre's example above now looks like this:
> Printer features — ThinLinc Administrator's Guide

Marking as resolved.
Comment 6 Linn cendio 2024-09-17 10:08:32 CEST
Discussion from https://git.cendio.se/wilsj/guten-tag/-/merge_requests/2

--------------------------
Created by: aeneby

Could we even use "TAG" in place of "ThinLinc Administrator's Guide", everywhere except the main/index page? Or would that be too confusing for new users?

--------------------------
Created by: williamsjoblom

We want to make it clear what these pages are when displayed in search engines. A hit showing up as Server Installation - TAG in Google is probably not the most helpful. Especially as our domain name is cendio.com and not thinlinc.com. Hence -- I'd personally prefer something more verbose.

There are some instances where <section> is longer than 36 characters. For example "Building custom Linux desktops with the ThinLinc Desktop Customizer". In my opinion, these overly long titles would benefit from being shortened anyway. I, personally, see shortening those as a separate issue.

--------------------------
Comment 7 Linn cendio 2024-09-17 11:06:35 CEST
Tested by accessing the TAG in the browser and can confirm it uses "ThinLinc Administrator's Guide" as its new suffix.

Code changes also look good and minimal.

Note You need to log in before you can comment on or make changes to this bug.