Multi-languages string: Polystring
draft-bouilland-polystring-00

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2019-02-03
Stream (None)
Intended RFC status (None)
Formats pdf htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                       A. Bouilland
Internet-Draft                                                          
Intended status: Experimental                          February 01, 2019
Expires: August 5, 2019

                    Multi-languages string: Polystring
                      draft-bouilland-polystring-00

Abstract

   Managing multi-languages support for a service with different parts
   can be complex.  Having its internal parts be polyglot, and coalece
   to end-user's language only when necessary is one solution.

   In this paper we discuss a format to store, exchange, and consume
   multi-language strings to this goal.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on August 5, 2019.

Copyright Notice

   Copyright (c) 2019 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Bouilland                Expires August 5, 2019                 [Page 1]
Internet-Draft                 Polystring                  February 2019

Table of Contents

   1. Introduction  . . . . . . . . . . . . . . . . . . . . . . . . .  2
      1.1. Conventions  . . . . . . . . . . . . . . . . . . . . . . .  2
   2. Polystring  . . . . . . . . . . . . . . . . . . . . . . . . . .  3
      2.1. ABNF grammar . . . . . . . . . . . . . . . . . . . . . . .  3
      2.2. Identifier . . . . . . . . . . . . . . . . . . . . . . . .  3
      2.3. String . . . . . . . . . . . . . . . . . . . . . . . . . .  3
      2.4. Base . . . . . . . . . . . . . . . . . . . . . . . . . . .  4
   3. Security consideration  . . . . . . . . . . . . . . . . . . . .  4
   4. Consumer algorithm  . . . . . . . . . . . . . . . . . . . . . .  5
   5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . .  6
   6. References  . . . . . . . . . . . . . . . . . . . . . . . . . .  6
      6.1. Normative References . . . . . . . . . . . . . . . . . . .  6
      6.2. Informative References . . . . . . . . . . . . . . . . . .  6
   7. Author's Address  . . . . . . . . . . . . . . . . . . . . . . .  6

1. Introduction

   Managing multi-languages support for a service with different parts,
   platforms, runtime, back-ends, and front-end; each having its proper
   way to achieve this, without a standardized way to collaborate
   between them can be complex.  Having a service's internal parts be
   polyglot, and coalesce to end-user's language only when necessary
   is one solution to this complexity.

   A common way of storing multi-languages is to split localization into
   different "packages", splitting strings with the same meaning and
   formatting apart, and away from theirs context.  This makes
   translation and maintenance efforts harder and more error-prone.

   To exchange text, one part must also know the end-user's language
   beforehand, requiring tight collaboration with other parts;
   for example a server-side API must know client-side's language before
   exchanging a proper response or error, or it might use integer codes.

   In this paper we present a format to 1) store multi-language strings
   keeping them together in source, and 2) exchange and consume
   them without requiring prior knowledge of the end-user's locale.

1.1. Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
   NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
   "MAY", and "OPTIONAL" in this document are to be interpreted as
   described in BCP 14 [RFC2119] [RFC8174] when, and only when, they
   appear in all capitals, as shown here.

   The grammatical rules in this document are to be interpreted as
   described in [RFC5234].

Bouilland                Expires August 5, 2019                 [Page 2]
Internet-Draft                 Polystring                  February 2019
Show full document text