login | sign up

Your session has timed out due to inactivity.

You can go back to the overview without login or use the login form to login again before redirect

Knowledge Base / Getting Started with one2edit™ v4 / For Everyone – v4

Glossary of Terms

Created on 16th May 2023 at 14:21 by Jamie O'Connell



In this glossary, you will find the terms and definitions used within one2edit™.

Action Button

Action Buttons appear in the bottom-right corner of a section as a square button.

They are typically used for creating new items in that section, or for performing bulk actions when multiple items are selected.

NOTE: Sometimes the Action Button does not appear until multiple items are selected (e.g. in the Structure Panel).

Asset Project

An Asset Project is a storage location for assets (InDesign files, images, etc.) on a one2edit™ system, and is defined as a folder on an Asset Server.

NOTE: An Asset Project should not be confused with a standard one2edit Project, which links to an InDesign file.

Asset Server

An Asset Server is a location defined on a storage device, which one2edit (and its users) can access.

NOTE: one2edit users cannot access any files on the storage outside of this defined location.

Asset Space

Asset Space is another term for Asset Project.

Client Workspace

A Client Workspace (or just a Workspace) is a section of the one2edit™ system to which specified users have access. A one2edit system must contain at least one Client Workspace, but may contain multiple Client Workspaces in a multi-client configuration (one Workspace per end-client).

Access is granted to users by assigning them to a User Group within the Client Workspace. Users cannot see nor access any Client Workspace to which they are not explicitly assigned. The users can then be assigned to Jobs within that Client Workspace, or granted administrator privileges.

Content Group

A Content Group defines what content in the document can be edited in a Job. If content is in a Content Group, then it can be edited in the Job; if content is not in a Content Group, then it cannot be edited.

Content Group types are either Edit or Translation, where a Translation-type Content Group will have the source language of any text content defined.

A Project can contain multiple Content Groups (e.g. one Content Group per target language in a multi-language document). Each Content Group will be assigned a Workflow, leading to separate Jobs on each part of the document.

Content Rules (Policies)

Content Rules define how content can be edited during a Job. For example, if the user can re-style text, or replace/edit images.

NOTE: If no Content Rules are assigned, users cannot re-style text, or edit/replace images.

Dock (aka Thumbnail Dock)

The Dock is located at the bottom of all Editor windows (unless suppressed via the JSI in a portal implementation). The Dock contains thumbnails of the spreads in the document, and can be used for navigation through the document.

NOTE: In the Master Document Editor, the Master Spreads of the INDD file are shown. In the Job Editor, these Master Spreads are only shown if they contain content that has been added to a Content Group.

Font Package

A Font Package is a ZIP archive file containing one or more font files. These files can be uploaded to a Client Workspace, allowing documents in that Client Workspace to use those fonts.

NOTE: Fonts uploaded to one Client Workspace cannot be accessed by documents in a different Client Workspace.

Frame Rules

Frame Rules define how (and if) frames can be edited during a Job. Frame Rules can be set for all frames in a document or for specific frames.

NOTE: Only frames that contain editable content (i.e. text or images) can be edited in a Job.

InDesign Preflight Profiles

InDesign Preflight Profiles are defined in, and exported from, Adobe® InDesign®. They are used for quality checking documents.

NOTE: You can find out more about preflighting here.

Job

Starting a Workflow on a document will create a Job.

  • The content of the Job (i.e. what document-content can be edited during the Job) is the content that has been assigned to the Content Group of the same name.
  • The users who will see the Job in their Jobs List are defined by the users assigned to the steps in the Workflow for that Content Group.

NOTE: If the Content Group has no content assigned to it, and/or if no users are assigned to the Workflow, then no Job can be created.

Job Editor

The Job Editor is used when opening a document for editing via the Jobs List.

The Job Editor is a fully-controlled environment. The user can only edit content that has been added to the Content Group for the Job, and Content Rules control how the user can edit this content. The design of the document cannot be changed when using the Job Editor (e.g. frames cannot be added or deleted, snippets cannot be placed, segmentation cannot be changed, etc.). The user marks content items as Done/Approved/Rejected when they are finished editing them, allowing these content items to be committed to the next step in the Workflow.

Jobs List

The Jobs List is the list of active Jobs assigned to the logged-in user. It is accessed via the Jobs option of the Navigation Menu.

NOTE: Once all active items in a Job have been marked as Done/Approved/Rejected, the items are no longer active for this user, and the Job will no longer be shown in the Jobs List.

Language Sets

A Language Set is a set of languages that have their own Translation Memory (TM) database.

The Translation Memory of a Language Set can be populated with translations from finished jobs using the Commit Translations Workflow Action. Alternatively, TMX (Translation Memory eXchange) files, or even Microsoft Excel XML files, can be imported to populate the TM database in the Language Set.

Master Document

The Master Document, or Source-Language Document, is the parent Adobe® InDesign® document in a one2edit™ Project.

The design for all of the Version Documents (i.e. the child documents) in a Project flows from the Master Document (e.g. number of spreads, layer details, text segmentation, etc.). All Content Groups for a Project are created and set up within the Master Document, as are Content Rules, Frame Rules, etc.

Master Document Editor

The Master Document Editor (MDE) is used when opening a document for editing via the Projects area.

The Master Document Editor allows extensive changes to be made to the Master Document, and those changes to be pushed to the Version Documents in the Project.  These changes can be design changes (e.g. adding/deleting frames, re-ordering layers, changing segmentation), as well as content changes.

Note Groups

Note Groups are used as a color-coding mechanism for notes. They help to distinguish (by name and color) which notes are meant for whom within a Job.

Notifications

Clicking the bell icon in the top-right of the window in your Menu Bar opens your list of Notifications.

You receive Notifications when actions you queue up have completed (e.g. exporting a PDF), when Jobs are assigned to you, when a Checkout has completed, etc.

Option Menu

Option Menus are context menus that are accessed by clicking on the kebab menu (3 vertical dots) to the right of an item. These menus present the options available to the user with regards to that item.

NOTE: When multiple items are selected, you must use the Action Menu to perform a bulk action on all selected items. Clicking on an item's Option Menu will re-select only that item.

PDF Presets

A PDF Preset is used by Adobe® InDesign® (and Adobe® InDesign® Server) to create a PDF file. These files contain the settings appropriate to the printer, e.g., bleed, slug, dpi, etc.

PDF Presets are exported from Adobe InDesign, with a .joboption file extension, and then imported to a one2edit™ Client Workspace.

NOTE: You can find out more about PDFs and PDF Presets here.

Project

A Project is the wrapper containing any Master and Version Documents within one2edit™. It is possible to have a Project that consists solely of a Master Document.

NOTE: While it is possible to create a Project that does not contain any documents, this is not a typical use-case. Documents are required to be linked for the Project to be meaningful.

Segment

A Segment is a chunk of text, which can be a sentence, paragraph, or sentence-like unit (heading, title, element in a list). Segments are also referred to as Translation Units.

Breaking the text of a document into Segments (through the use of Segmentation Rules) allows for more efficient translation of that text when using a Translation Memory.

Segmentation

Segmentation involves using Segmentation Rules to partition the stories in an InDesign® document into smaller segments for translation purposes.

By default, the text in a Master Document is segmented into paragraphs when a Project is created. You must ensure that your Master Document is segmented in the same way as the translation units in your Translation Memory.

NOTE: The Segmentation is performed at the one2edit™ level, not in the InDesign document itself. This means that the original InDesign stories are left intact for purposes of text flow, etc.

Segmentation Rules

Segmentation Rules are rules defined by sets of regular expressions (regex or regexp) that use pattern-matching to break the text of a document into Segments (often into sentences or sentence-like units) for more efficient translation.

SRX (Segmentation Rules eXchange) files can be imported and used in a Client Workspace. It is also possible to customise imported or default Segmentation Rules according to your project requirements.

NOTE: Segmentation Rules are language specific, and are typically required for the source language of a Project only, as the segmentation is performed on the text in the Master (i.e. Source-Language) Document.

NOTE: Default Segmentation Rules are provided, and should be tested to ensure that they perform Segmentation that matches that in your existing Translation Memory.

Status Marker

Each element in a Job has a Status Marker (or Status Bubble) beside it.

At the start of a Job, each Status Marker is coloured orange. When a user marks the item as Done, the Status-Marker colour changes to green. If an item is marked as Rejected (in a Review Job), the Status-Marker colour will change to red.

Template

Templates (or Job Templates) allow users to self-start Jobs, without the users requiring any access to Projects, Master Documents, Workflows, etc.

Starting a Template typically spawns a Version Document, and assigns a specific Workflow to that Version Document. This Workflow is then automatically started, to create a Job. Templates can also be used to create a duplicate of a Master Document, and assign the Workflow to that duplicate to create a Job on a Master Document instead of a Version Document.

Translation Memory

A Translation Memory, or TM, is a database that stores matches of Segment translations. It is used for both automatic pre-translation actions in a Workflow, and as an aid for human translators.

Each Segment (or Translation Unit) in the TM is matched to the equivalent Segment in one or more other languages. Translated Segments should only be committed to the Translation Memory after they have been translated, reviewed, and approved.

Each Language Set contains its own Translation Memory, and TMX (Translation Memory eXchange) files can be imported to populate the Translation Memory of a Language Set.

NOTE: It is common to only need one Language Set/Translation Memory in a one2edit™ Client Workspace.

User Menu

The User Menu is where you can update your preferences (e.g. theme) and your user details (e.g. password). You also log out from your session via this menu.

The menu is located in the top-right corner of the window, near the Notifications.

User Permissions

User Permissions (or User Privileges) define what a user has access to within one2edit™, but outside of the document-editing process. These permissions define a user's access to areas, folders, options in the Settings menu, etc.

User Permissions are typically defined by the user's user group, but can also be set directly in folders and Templates.

NOTE: User Permissions have no effect on what the user can or cannot do when editing a document. Content Rules dictate editing-permissions for all users.

Version Document

A Version Document is a child document in a one2edit™ Project. Each Version Document starts its life as a copy of the Master Document. The design (e.g. number of frames) and Text-Segmentation of the Version Document is defined through the Master Document.

The content of a Version Document can be edited/translated in accordance with the Content Groups and Content Rules set up in the Master Document.

NOTE: It is possible to define multiple Content Groups within a single Master Document, and assign them to different users, resulting in different users have access to different parts of the same Version Document.

Workflow

Workflows define the user(s) who will perform a Job (i.e. edit/translate/review content), along with any automated actions and when they will trigger. A Workflow consists of one or more Workflow Tracks, one for each populated Content Group defined in the Master Document.

When a Workflow is assigned to a document and then started, the Job is created for the user(s) defined in the Workflow, allowing them to work on the content assigned to the Content Group.

The document to which a workflow is assigned must be either:

  • a Master Document containing populated Content Groups
  • a Version Document created from a Master Document that contains populated Content Groups.

NOTE: If a Content Group has no content assigned to it, no Job can exist for that Content Group.

Workflow Track

A Workflow Track defines the characteristics of a Job for the content of a specific Content Group in a document. A Workflow Track must have the same name (case sensitive) as the Content Group that will be edited by the users in the track. The Workflow Track is then assigned by its name to the Content Group of the same name.

Workflow Tracks defines:

  • a target language (for a Content Group of type Translation)
  • the users assigned to each step of the Workflow (i.e. each Job)
  • any automated actions that will take place during the Job

NOTE: A Workflow Track with a defined target language must have the name of a Content Group of type Translation. If the Content Group is of type Edit, then you must leave the target-language field blank.

NOTE: If no users are assigned to a step, that step is skipped (i.e. ignored). It is as if the step does not exist, even if it has actions assigned to it.




© 2009-2024 1io BRANDGUARDIAN GmbH · All rights Reserved · Legal / Privacy Policy


top