Skip to content

Introduction

This Documentation is Work in Progress

Parts of it might be outdated, incomplete or missing. If you can't find the solution for your question or problem, just contact us!

Version Differences

This documentation is meant to cover all recent versions of our Grammar Library. The latest changes incompatible with certain versions of the library are marked as follows.

≥1.6.0Features only available starting at a certain version of the library are marked like this.

<1.6.0Features no longer available starting at a certain version of the library are marked like this.

Please note that this does not necessarily cover bugfixes or minor additions and we might remove older markings over time to keep the documentation as clean as possible.

The Lingoona Grammar Engine is a middleware solution written in C++ to provide fast, reliable, and flexible text formatting across multiple languages. In contrast to basic text concatenation and text formatting abilities provided by all major programming and scripting languages, this library abstracts potentially problematic details, such as punctuation or declension, away from both software implementers as well as original content creators and translators, while still respecting and applying them.

Features

  • Written in cross-platform ready C/C++ code
  • Works on Windows, Linux, MacOS X, mobile phones, and consoles
  • Very easy and straightforward to use interface
  • Self-contained native code (<750KB) that requires no external dependencies, additional dictionary files, or training
  • Allows authors and translators to write natural sentences rather than complex markup
  • Uses optional named parameters for easier recognition
  • Provides optional markup expressions for more control in unique or rare scenarios
  • Properly inserts variables into placeholder text
  • Creates plural forms of passed nouns, if required
  • Generates thousands of grammatically correct names based on freely defined and combined components

Licensing

  • Individually adjusted to fit your needs
  • Royalty-free model on a project by project basis
  • Optional full source code access

Documentation Structure

This documentation is split into the following major sections:

  • The Introduction you're reading right now.
  • Motivation will try to explain you some of the ideas and motivations behind this library's creation.
  • Developers includes implementation details as well as a full list of API functions.
  • Authors & Translators may use the last section for reference, looking up descriptions, explanations, examples, and useful cheatsheets.

Contact us

Should you have any questions or encounter any issues while implementing, evaluating, or using the Grammar Engine, feel free to drop us a line at grammar@lingoona.com and we'll get back to you as soon as possible!


Last update: February 11, 2021