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

Discourage placeholders in I18N documentation

    XMLWordPrintable

Details

    • Bug
    • Status: Closed (View Workflow)
    • P2
    • Resolution: Done
    • 5.0.1
    • 6.2.0
    • core
    • stripes-force 114, stripes-force 115
    • Stripes Force
    • 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

            relates to

            Bug - A problem which impairs or prevents the functions of the product. ERM-1628 Expand emptyAccordion.* {type} for correct translations

            • TBD - To be determined
            • Closed

            Task - A task that needs to be done. STRIPES-748 Add example section to doc/i18n.md

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. STSMACOM-453 Cannot translate {type} placeholder in ControlledVocab

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Activity

              People

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

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases