Textlibrary

Introduction

Welcome to Textlibrary, a powerful tool designed to enhance your document editing process with standardized text blocks. Textlibrary allows users to create, search, and insert specific text elements directly from the text editor. With features that enable grouping of text, users can streamline their editing workflow by limiting selections to relevant text blocks, ensuring consistency and efficiency in document creation.

Getting Started: The Basics

Before diving into the creation of text elements, it’s essential to familiarize yourself with the prerequisites. These foundational steps are crucial for beeing able to register text elements in Textlibrary:

Fonts: Register font identifiers to define the visual style of your text
Styles: Define the appearance of text elements through various formatting options
Groups: Organize text elements into groups for structured selection in the editor

Fonts

Font registration is a simple process of identifying each font with a unique name. To add a font:

Click Add Font. Enter a name for the font (e.g., “Body normal”, “Headline1”, “Headline 2”, “Body bold”)

Textlib_font!

After saving, the font will appear in your list. Use the menu button for further editing or deletion.

📝 Note: It is important to use fonts that are supported by the document engine. You can get this information from your system administrator.

In order to get a list of valid fonts on the document engine it is possible to run this REST API which will list available fonts to use: https://api.webeditor-v3.stage.metaforcelabs.com/Development/getinfo

Example of result:

    "Fonts": {
        "Fonts": {
            "@xmlns": "",
            "Typeface": [
                {
                    "@Name": "Source Sans 3 ExtraLight",
                    "@Points": "Vector",
                    "Type": [
                        {
                            "@Style": "Normal",
                            "@TtfName": "C:\\Metahome\\Fonts\\Ttf\\SourceSans3-ExtraLight.ttf",
                            "@Weight": "Normal"
                        },
                        {
                            "@Style": "Italic",
                            "@TtfName": "C:\\Metahome\\Fonts\\Ttf\\SourceSans3-ExtraLightItalic.ttf",
                            "@Weight": "Normal"
                        }
                    ]
                },
                {
                    "@Name": "Source Sans 3 Light",
                    "@Points": "Vector",
                    "Type": [
                        {
                            "@Style": "Normal",
                            "@TtfName": "C:\\Metahome\\Fonts\\Ttf\\SourceSans3-Light.ttf",
                            "@Weight": "Normal"
                        },
                        {
                            "@Style": "Italic",
                            "@TtfName": "C:\\Metahome\\Fonts\\Ttf\\SourceSans3-LightItalic.ttf",
                            "@Weight": "Normal"
                        }
                    ]
                }
            ]
        }
    }

Styles

Styles determine how text appears in the Textlibrary editor. To create a new style:

Select Add Style to open the style registration screen

Textlib_styles!

Fill in the following details:

Name: Choose a descriptive name for the style (e.g., “Normal”, “Headline 1”)
Type: Specify the style type (paragraph, character, or list)
Formatting: Select a previously registered font to apply to the style

Textlib_styles!

Styles can also include properties like bold, italic, underline, color, and alignment to fully customize the appearance of your text.

Groups

Groups help maintain structured text organization. They allow templates in the editor to limit selectable text to specific groups, ensuring relevance and consistency.

Textlib_group!

Texts

Adding, editing, or deleting text elements is straightforward:

Navigate to the text menu

Specify details for each text element:

Name: A unique, descriptive name
Identifier: A unique command identifier for editor insertion (e.g., “A12”, “B2”)
Group: Assign the text to a group
Language: Define the text’s language for editor search functionality
Description: Provide a brief description of the text
Text: Type your text and apply styles by highlighting text and selecting the desired style. Style effects are immediately visible

Textlib_textelement!

Import and Export

The import and export features facilitate the transfer of text libraries between environments, ideal for moving registrations from production to test environments without redoing the registration process. Access these options through the texts menu, where you can manage and transfer your text library effortlessly.

List Signature