Opened 3 years ago

Last modified 3 years ago

#4489 closed change

Shorten <fix> translation string variable syntax in CMS — at Version 5

Reported by: juliandoucette Assignee:
Priority: Unknown Milestone:
Module: Sitescripts Keywords:
Cc: kvas, fhd, saroyanm, trev, lisabielik Blocked By:
Blocking: Platform: Unknown / Cross platform
Ready: no Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

Description (last modified by juliandoucette)

Background

We surround all brand names and numbers within translated strings in our CMS with <fix> tags so that they appear as variables within crowdin.

Although this is effective, it is inconvenient because:

  • It requires HTML syntax inside of Markdown
  • It is awkward to type repetitively

What to change

Support an alternative <fix> format.

Suggestions

[fixed]
=fixed=
-fixed-
{fixed}

Change History (5)

comment:1 Changed 3 years ago by juliandoucette

  • Description modified (diff)

comment:2 Changed 3 years ago by juliandoucette

  • Description modified (diff)

comment:3 Changed 3 years ago by trev

Convert all markdown pre tags (created by surrounding text with a single backtick) into translation string variables.

I just verified that Markdown module for Python produces <code> tags for backticks. Anything else would be very surprising as <pre> is a block-level tag and should never be placed within a paragraph.

Now I'm not sure what your first suggestion is about. Should we wrap brand names in <code> tags? Or should the CMS strip <code> tags? If the latter, what should we use when talking about filters or URLs on https://adblockplus.org/en/filters?

insert some combination of one or two non-shift characters

What for example? My keyboard doesn't have too many non-shift characters other than letters, it's only <,.-#+. I can only imagine using # here, and that one requires pressing Shift on US keyboards. Note also how Markdown already claimed all usable non-shift characters on US keyboards.

comment:4 Changed 3 years ago by juliandoucette

I just verified that Markdown module for Python produces <code> tags for backticks. Anything else would be very surprising as <pre> is a block-level tag and should never be placed within a paragraph.

Verified. I was wrong about this :/ .

Now I'm not sure what your first suggestion is about. Should we wrap brand names in <code> tags? Or should the CMS strip <code> tags? If the latter, what should we use when talking about filters or URLs on ​https://adblockplus.org/en/filters?

No. I was suggesting we override Markdown's conversion of backticks to pre tags. This was an invalid suggestion.

What for example? My keyboard doesn't have too many non-shift characters other than letters, it's only <,.-#+. I can only imagine using # here, and that one requires pressing Shift on US keyboards. Note also how Markdown already claimed all usable non-shift characters on US keyboards.

Good question.

A few suggestions:

non-shift

[fixed]
=fixed=
-fixed-

shift

{fixed}

comment:5 Changed 3 years ago by juliandoucette

  • Description modified (diff)
Note: See TracTickets for help on using tickets.