bug: Maintain Keyboard Package Name Case in Navigation Breadcrumbs

[dyacob]

I noticed this under the help site, but may also be found elsewhere. I was a litte surrprised to see the keyboard name "GFF Amharic" become "Gff amharic" in the breadcrump path for the help page as seen here:

My personal preference would be to maintain the name as in the keyboard package, under the KPS <Info><Name> tags. This seems to be the name applied but then with the lowercasing applied after the first letter. GFF I see as semantically different from Gff, which is gibberish.

[darcywong00]

If I recall correctly, the PHP breadcrumb code is merely auto-capitalizing the path (and replacing underscore with spaces)

and those correspond to the keyboard package ID's from the keyboards repo.

Your example corresponds to
https://github.com/keymanapp/help.keyman.com/blob/master/keyboard/gff_amharic/3.2/gff_amharic.php

[mcdurdin]

This is harder than it seems, because it would involve adding metadata for breadcrumbs, which is a big job.

[mcdurdin]

Agree it isn't ideal.

[Linsner]

I started looking into this issue. I propose following solution: The breadcrump is NOT built by the filename but by the site's title as defined in the markdown.

For the current page we have this information anyhow, but to get the titles of the parents, we would need to parse all the index files up to the root. This is probably not ideal but the index files look rather simple, so it should not cause a significant delay.

[Linsner]

Here are two examples how it will look like if we take the breadcrump from the title:

In some cases the breadcrump becomes significantly longer because the title is more verbose.

[ermshiperete]

For comparison, currently this looks like:

and

[mcdurdin]

In some cases the breadcrump becomes significantly longer because the title is more verbose.

Yes, the new titles are not really as clear as the old titles, so we replace one problem with another!

This is probably not ideal but the index files look rather simple, so it should not cause a significant delay.

Note that we have index.md and index.php files which we would need to parse (title: header in .md, 'title' => for .php, and fallback to folder name if neither of those are found in the file).

I think it would also be good to support a breadcrumb: header in the .md and 'breadcrumb' => in the .php, so that we can support shorter titles for the breadcrumbs, particularly for higher-level index pages.

I think a build-time step would be worthwhile (note we also already have __index.txt which we use to tweak the order of files in the menu on the left of a page).

At build time, we visit each folder in the folder tree and generate a __breadcrumb.txt (to match __index.txt pattern, or we could use a more common .breadcrumb / .page-index filename and just rename the existing references to __index.txt?) for each folder:

1. Find the breadcrumb:
   a. Check index.md (breadcrumb:, title:, fallback to folder name), or
   b. Check index.php (breadcrumb =>, title =>, fallback to folder name), or
   c. Fallback to folder name
2. Write the breadcrumb to .breadcrumb / __breadcrumb.txt

We'd also add .breadcrumb / __breadcrumb.txt to .gitignore