search

thunderbird / knowledgebase-issues

for tracking Thunderbird Desktop SUMO Knowledge Base issues
Mozilla Public License 2.0
4 stars 1 forks source link

INVESTIGATE: case sensitivity in SUMO intra-wiki links and templates #60

Open rtanglao opened 1 month ago

rtanglao commented 1 month ago

Checklist:

Details

(hat tip @AliceWyman and @ artist )

11 articles which should be edited to use ≡ instead of [[Image:Fx57menu]]

AliceWyman commented 1 month ago

The 11 articles can also be fixed by fixing the capitalization error [[Image:Fx57menu]] in each article... to make it [[Image:Fx57Menu]] - the correct title shown in https://support.mozilla.org/en-US/gallery/image/29075

Another possible solution is to create and upload a new image with the title Fx57menu ... which I did just now. See https://support.mozilla.org/en-US/gallery/image/52732

It didn't seem to work though (unless it takes awhile) since the new image doesn't show any articles that use it. If it doesn't work without additional steps (such as an "empty edit" in each affected article to make the new image display) then the 11 articles should be updated to fix the capitalization error.

rtanglao commented 1 month ago

@AliceWyman The best solution is to get rid of the image in each article and use the unicode character ≡, correct? I don't see how using an image is better, if it is what am I missing Alice?

The 11 articles can also be fixed by fixing the capitalization error [[Image:Fx57menu]] in each article... to make it [[Image:Fx57Menu]] - the correct title shown in https://support.mozilla.org/en-US/gallery/image/29075

Another possible solution is to create and upload a new image with the title Fx57menu ... which I did just now. See https://support.mozilla.org/en-US/gallery/image/52732

AliceWyman commented 1 month ago

@AliceWyman The best solution is to get rid of the image in each article and use the unicode character ≡, correct? I don't see how using an image is better, if it is what am I missing Alice?

I don't know (and others also might not know) how to enter a unicode character for the hamburger menu or other icons/symbols used in KB articles. (I did a google search and found this code for the hamburger menu symbol: ☰ which displays as ☰ What is the code you used?) Can you edit one of the 11 articles and use the unicode character you want to use but don't approve it? I think using an image would be easier for most editors but that's my opinion (You could check with SUMO staff).

rtanglao commented 1 month ago

@AliceWyman i copy/paste ≡ (which I think is https://www.compart.com/en/unicode/U+2261 )from https://support.mozilla.org/en-US/kb/new-thunderbird-115-supernova/,; not sure what the hex code is. it's way easier than dealing with a unicode character than an image. because it's just a glyph i.e. a normal character and doesn't require SUMO image markup.

rtanglao commented 1 month ago

From #sumo-team slack (link will break in 6 months as per data retention policies_ which of course requires an NDA:

I was proposing it just for hamburger because a) the hamburger icon is everywhere and b) we have an exact equivalent. The other icons I would suggest to use images for now unless somebody has time to search for unicode equivalents (and if Unicode characters for those icons exist) for the other icons!

AliceWyman commented 1 month ago

I don't have access to Slack but if a decision was made to use the code ☰ for the hamburger menu icon ☰ instead of an image, I think that this should be mentioned by Abby or another staff member on the SUMO KB article discussion forum, https://support.mozilla.org/en-US/forums/knowledge-base-articles/. I would also consider adding a note about using code instead of an image for common icons, (or just for the hamburger icon) to some contributor articles related to KB markup (e.g., https://support.mozilla.org/en-US/kb/markup-chart). By the way, I think that the code I'm using is referred to as HTML code. Ref: https://www.compart.com/en/unicode/html.

AliceWyman commented 1 month ago

P.S. I think your unicode U+2261 symbol ≡ code ≡ is better than the one I found, symbol ☰ code ☰ Your symbol is smaller and looks closer to the current hamburger menu we're using in Firefox, [[Image:Fx89menuButton]] - see https://support.mozilla.org/en-US/gallery/image/41988
The one I found, symbol ☰ code ☰ is closer to the old [[Image:Fx57Menu]] - see https://support.mozilla.org/en-US/gallery/image/29075

rtanglao commented 1 month ago

thanks for your excellent comments @AliceWyman

  1. we'll stick with HTML entity (I've called them entities since the 1990s if there's a better term please let me know) ☰
  2. Updated the SUMO KB article: Markup Chart and posted in the Knowledge Base Forum
Mozinet-fr commented 1 month ago

The term “HTML entity” refers specifically to the named character reference, like ˙.

See Wikipedia:

In HTML and XML, a numeric character reference refers to a character by its Universal Character Set/Unicode code point, and uses the format:

&#xhhhh;

or

&#nnnn;

where the x must be lowercase in XML documents, hhhh is the code point in hexadecimal form, and nnnn is the code point in decimal form. […] In contrast, a character entity reference refers to a sequence of one or more characters by the name of an entity which has the desired characters as its replacement text. […] HTML Entity Sets Early versions of HTML built in small subsets of these, relating to characters found in three Western 8-bit fonts. […] XML Entity Sets The W3C MathML Working Group took over maintenance of the ISO public entity sets, combined with the MathML and documents them in XML Entity Definitions for Characters. This set can support the requirements of XHTML, MathML and as an input to future versions of HTML. HTML5 HTML5 adopts the XML entities as named character references, however it restates them without reference to their sources and does not group them into sets. The HTML5 specification additionally provides mappings from the names to Unicode character sequences using JSON.

Numerous other entity sets have been developed for special requirements, and for major and minority scripts. However, the advent of Unicode has largely superseded them.

rtanglao commented 1 month ago

ROFL it's not an HTML entity it's an Numeric character reference I stand corrected thanks @AliceWyman :-) !

Mozinet-fr commented 1 month ago

≡ is the hexadecimal numeric character reference, and the HTML entity is ≡.

I knew the answer because I had done some research to use the right expression in the summary of a revision on SUMO.

AliceWyman commented 1 month ago

Some unicode characters may not display for eveyone so I would rethink using them. See https://support.mozilla.org/en-US/kb/tab-overview-menu/discuss/12381 Close a tab: {button 🞩} icon doesn't display for everyone? ... and the reply from moz_contrib

AliceWyman commented 1 month ago
Updated the SUMO KB article: [Markup Chart](https://support.mozilla.org/en-US/kb/markup-chart/compare?locale=en-US&to=283339&from=278304) and [posted in the Knowledge Base Forum](https://support.mozilla.org/en-US/forums/knowledge-base-articles/717097)

I have a revision pending review to edit the Markup chart article to remove the {button } markup. The Menu button ☰ HTML unicode ☰ should be used by itself, as we currently do for articles that use the Menu button image. See https://support.mozilla.org/en-US/kb/markup-chart/discuss/12386 Use of HTML unicode for Menu button and {button } markup

I also posted a comment to https://support.mozilla.org/en-US/forums/knowledge-base-articles/717097 Decision: Please use {button ☰} for hamburger menu instead an image for Thunderbird and Firefox desktop articles