Skip to main content
All CollectionsEditor
How to handle tags
How to handle tags
Updated over a week ago

This article aims to assist you in comprehending how to effectively utilize tags in Bureau Works.



Tags - Definition and usage

Tags serve as the fundamental formatting tool employed in HTML and various other markup languages like XML.

Within Bureau Works, you will encounter various tag types, including formatting tags and structural tags.

  • A tag is a metadata that is included in a content/file

  • There are different reasons for having tags within a file, such as: Content formatting (bold, Italic, superscript, etc), creating hyperlinks to redirect users to a certain URL (https://app.bureauworks.com/) and other tags are structural tags/entity references that are required for certain applications/software to read/process the content properly (XML tags, for example).

When we talk about the .XML extension, for example, some characters have a special meaning, so if we place a character like "<" inside an XML element, it will generate an error because the parser interprets it as the start of a new element.

Below there is an example of a text with a special character that is part of an XML file:

<message>Words < 1000</message>

To avoid errors, in the XML file, the < character was replaced with an entity reference &lt; so that the parser could interpret the content correctly. In the XML file, the content will show as:

<message>Words &lt; 1000</message>

The following table shows some examples of entity references in XML to prevent similar errors from occurring with other special characters:

Entity Reference

Special Character

Meaning/Function

&lt;

<

less than

&gt;

>

greater than

&amp;

&

ampersand

As you can see, there are numerous reasons for a tag to be added to a file, and there are hundreds of different tags that could be used. When it comes to content localization, it is important to ensure that existing tags in the source language have also been added to the translation.


Missing tags can affect the translated content formatting, hyperlinks, or potentially prevent an application from functioning properly.

⚠️ It's worth noting that there are a few exceptional cases where certain tag types may not hinder the file's download or cause corruption. Nevertheless, the overarching guideline emphasizes that tags from the source should consistently be integrated into the target content.


How to handle tags in Bureau Works Editor

Having gained a deeper understanding of tags, their functionality, and their significance within a file, let's now delve into the topic of tags within Bureau Works Editor.

2.1. Expanded tags option

Bureau Works offers two methods for displaying tags within the editor, each with its own set of advantages. However, when it comes to dealing with tags, we strongly recommend enabling the "Expanded Tags" option.

To activate the "Expanded Tags" option, follow these simple steps: Open the Editor Menu and click on the "Document" tab. Located just beneath the "Viewing Preferences" section, you will find the "Expanded Tags" option:

How to handle tags - 1.png




If disabled, the tags will solely display their index number, providing information only regarding the order they should follow. On the other hand, when they are expanded, additional context will be presented, giving linguists a clearer understanding of the tag's purpose.

Below is an example of how the tags appear with this option turned off:

Here, you can observe the distinction between the two choices:

How to handle tags - gif 1.gif

2.2. Tag mismatches

When there is a tag mismatch due to tag differences between source and target, the user will receive a warning message when trying to confirm the segment:

missing_tag.png

Then, the user has two options:

Click on the Red button ❌ to go back to the segment and make the adjustments needed before trying to confirm it again or click on the Green button ✅ to mark the segment as confirmed, ignoring the mismatch alert

As previously explained, missing tags can affect the translated content, formatting, and hyperlinks, or potentially prevent an application from functioning properly.

So the user should be aware of the impact that ignoring a tag mismatch may have on the final translation.
On occasions when a formatting tag is not applicable for a given language, it is ok to ignore the alert by clicking on the Green button ✅

⚠️ It's important to be aware that you can configure the project's translation settings to hide these warnings, but they will still be displayed when running the QA Check tool.

2.3. Fixing missing tags

To fix missing tags, the user has two options:

  • Manually drag and drop the missing tags from the source to the target, and drop the tags in the correct position in the translation.

In the example above, it is certain that the tags should be around "A:". With that in mind, the user can easily identify where to add the tags to keep them in the same position as in the source content.

You can manually drag them or use the Fix Tags feature from our Augmented Actions menu:

How to handle tags - Gif 1.gif
How to handle tags - Gif 2.gif
  • The user can also use the keyboard shortcuts below (the shortcuts will be automatically adjusted for MAC users)

shortcuts.png


These shortcuts will only work if both tags are missing (opening and closing tags). If only one is missing, the user can easily drag and drop the missing tag from the source content.

opening_tag_closing_tag.png

3. Takeaways

  • Tags are important and should always be added/kept in the translation (in some occasions, some formatting tags are not applicable for certain languages)

  • Missing tags can impact the text formatting, and URLs or even prevent an application from running properly

  • Users will always be alerted when there are missing tags in the translation

  • Fixing missing tags is simple as dragging and dropping the tags to the correct position in the target content

Did this answer your question?