Uploaded image for project: 'Stripes'
  1. Stripes
  2. STRIPES-708

Discourage placeholders in I18N documentation

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed (View Workflow)
    • Priority: P2
    • Resolution: Done
    • Affects Version/s: 5.0.1
    • Fix Version/s: 6.2.0
    • Component/s: core
    • Labels:
    • Template:
    • Sprint:
      stripes-force 114, stripes-force 115
    • Development Team:
      Stripes Force
    • Affected Institution:
      GBV, University of Leipzig

      Description

      The I18n best practices document
      https://github.com/folio-org/stripes/blob/v5.0.1/doc/i18n.md#examples
      encourages to use placeholders in translation strings by showing examples from ControlledVocab in the example section:

      "cv.cannotDeleteTermMessage": "This {type} cannot be deleted, as it is in use by one or more records.",
      "cv.numberOfObjects": "# of {objects}",
      "cv.termDeleted": "The {type} <b>{term}</b> was successfully <b>deleted</b>"
      

      See STSMACOM-453 why this cannot be translated for many type values in some languages.
      The type influences other words of the translation in some languages.
      If the type or the (complete or some fraction of the) list of types is known at development time a type specific translation key should be used.

      Task:
      Remove the cv.* example from the documentation.
      Explain why placeholders should be avoided.

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                Unassigned Unassigned
                Reporter:
                julianladisch Julian Ladisch
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases