JSON files

File description

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write and for machines to parse and generate. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language.

Good to know

• JSON needs to be put in a .json extension file with an UTF-8 without BOM encoding
• All letters outside the English alphabet in a JSON file need to be coded before using the file with POEditor
• Expected format:
  • term (type string) - required
  • definition (type string or associative array) - optional
    Keys that can be used for associative array: zero, one, two, few, many, other

    "definition": {
            "one": "Just one user online",
            "other": "There are %d users online"
    }

  • context (type string) - optional
  • term_plural (type string) - optional
  • reference (type string) - optional
  • comment (type string) - optional
  
  Example of a file with a single term and its translation:

  [
      {
          "term": "app.name",
          "definition": "TODO List"
      }
  ]

Documentation

Official JSON documentation website: http://json.org/

Sample file

[
  {
    "term": "app.name",
    "definition": "TODO List",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": "Please don't change the name of the application"
  },
  {
    "term": "app.login.text",
    "definition": "Enter your credentials below to login",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.message.success",
    "definition": "Login successful !\nWelcome back %s !",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.message.error",
    "definition": "Make sure you've entered the correct username and password",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.password.forget",
    "definition": "I forgot my password",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.password.reset",
    "definition": "Enter your address in the field below. A new password will be sent to your inbox.",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.register.text",
    "definition": "Sign up for free! No credit card required!",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.register.message.success",
    "definition": "Thank you for signing up !\nPlease check your email address to activate your account.",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.register.message.error",
    "definition": "We were unable to sign you up.\nPlease correct the marked fields.",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.menu.terms",
    "definition": "Terms and conditions",
    "context": "",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.text",
    "definition": "Username",
    "context": "form_label",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.users.active",
    "definition": {
      "one": "Just one user online",
      "other": "There are %d users online"
    },
    "context": "",
    "term_plural": "app.users.active",
    "reference": "\/app\/modules\/views",
    "comment": ""
  },
  {
    "term": "app.login.pass",
    "definition": "Password",
    "context": "form_label",
    "term_plural": "",
    "reference": "\/app\/modules\/views",
    "comment": ""
  }
]

See also: