SORT user guide for Linguists, March 2016mcafee-sort.brandtservices.com/sort/helpdoc/SORT User... · 2018-07-17 · SORT user guide for Linguists, March 2016 3 Introduction This is

SORT user guide for Linguists, March 2016

1

Contents

Contents ................................................................................................................................................... 1

List of tables.......................................................................................................................................... 2 Table of figures ..................................................................................................................................... 2

Introduction .............................................................................................................................................. 3

Home page ............................................................................................................................................... 3

Accepting and completing tasks ........................................................................................................... 5 Downloading screenshots from the Home Page .................................................................................. 6 Notifications and global settings .......................................................................................................... 8

Screenshot Detail page ........................................................................................................................... 10

Screenshot Data: Annotations, Description, Bugs and OCR output text ............................................ 11 Screenshot Toolbar ............................................................................................................................. 13 Compare Mode ................................................................................................................................... 17 Logging bugs ....................................................................................................................................... 18 Screenshot tags .................................................................................................................................. 20 Screenshot status icons ...................................................................................................................... 21

Search ..................................................................................................................................................... 22

Example: Finding all annotated screenshots ...................................................................................... 23 Example: Finding all screenshots you have not seen ......................................................................... 23 Downloading search result ................................................................................................................. 23


2

List of tables Table 1 Screenshot toolbar options explained ....................................................................................... 16

Table of figures Figure 1 SORT Product Home Page ....................................................................................................... 3

Figure 2 SORT Project Home Page .......................................................... Error! Bookmark not defined.

Figure 3 Screenshot thumbnail view ..................................................................................................... 4

Figure 4 Screenshot thumbnail view - Marking review task completed ............................................ 6

Figure 5 Download icon.......................................................................................................................... 6

Figure 6 Download screenshots dialog ................................................................................................. 6

Figure 7 Notifications and Settings icons .............................................................................................. 8

Figure 8 Edit Preferences ....................................................................................................................... 8

Figure 9 Screenshot detail screen ........................................................................................................ 10

Figure 10 Next screenshot pop-up ...................................................................................................... 11

Figure 11 Screenshot data, Annotations and Bugs ............................................................................. 11

Figure 12 Screenshot OCR text ............................................................................................................ 12

Figure 13 Edit on-screen text ............................................................................................................... 12

Figure 14 Screenshot toolbar ............................................................................................................... 13

Figure 15 Apply annotations dialog .................................................................................................... 15

Figure 16 Compare Mode ....................................................................................................................... 17

Figure 17 Create bug ............................................................................................................................ 18

Figure 18 Bugs logged for a screenshot .............................................................................................. 19

Figure 19 Adding screenshot tags ....................................................................................................... 20

Figure 20 Screenshot status icons ....................................................................................................... 21

Figure 21 Search page .......................................................................................................................... 22


3

Introduction

This is a user guide for translators and reviewers on using Brandt Technologies SORT

platform for linguistic review, or as a reference during translation. SORT is short for

Shadow Online Review Tool, and was developed with a goal to optimise localisation

projects translation and language review tasks. Using parallel screenshots for

different languages, it enables full consistency of coverage between languages

during language review. It is also used to provide UI context to translators during

initial translation phase, and thereby increase original translation quality.

Home page

Log in with your SORT user credentials. You will have either received them from your

PM, or through an automated notification from the system.

Note that the colour scheme and logo are company specific.

Figure 1 SORT Product Home Page

All available products are displayed on the Home page. Click the Actions dropdown

menu on the left (highlighted blue in the diagram) to select Projects without product

or All projects list view.


4

Figure 2 SORT Project Home Page

Click on any of the project links to display project components. Click on any of the components to display it's screenshots.

Each translator typically has permissions to view their own language and English

screenshots. For a majority of localisation projects, English is set as the source

language, but this can be configured differently if needed. It is your SORT project

administrator that configures language parameters during project creation.

Figure 3 Screenshot thumbnail view


5

The Project name is displayed at the top left, under the navigation bar. In above

example it is Demo Project. Clicking the Project link will bring you back to the

Projects Home Page. The Components are displayed beside the project name, in this

example Component1_Excel. The dropdown menu allows you to quickly navigate

between components.

The option Download Selected, at the top right of the screen, is greyed out by

default. When you select one or more screenshots by clicking the checkboxes below

the thumbnails, this option will become active, and allow you to download selected

screenshots. The screenshots can be downloaded as originals, or with annotations.

We will cover annotations later in this document.

The scheduled project completion date is entered into the system by your SORT

administrator or project PM at project creation, and visible for each component on

the Screenshot Thumbnail Page. Please check this date when you start the project,

and query any scheduling issues with your PM.

There is a quick navigation bar at the bottom of the screen, where you can adjust the

number of thumbnails displayed on each screen, and quickly move between pages.

NOTE: If screenshots are not synchronised between languages, i.e. if some of the

screenshots are missing in some languages, but are present in others, there will be a

Not Available placeholder displayed in the place of the missing screenshot.

Accepting and completing tasks

The language you are assigned to review will also have an Accept task link when you

first view it, as shown in


6

Figure 3 Screenshot thumbnail view. Click the Accept task link to accept the task and

start the review.

After the review has been accepted, the link changes to Mark completed. Please use

this to mark your review completed.

Figure 4 Screenshot thumbnail view - Marking review task completed


7

When the task has been marked completed, you will no longer be able to annotate

screenshots or report bugs for them.

Downloading screenshots from the Home Page

You can download the full set of project screenshots, if this function is selected for

the project by the PM, using the Download icon, available on the Project Home

Page, and shown below:

All available languages are displayed in the Languages menu. Project components

are displayed in the Components menu.

You must select at least one language, and at least one component. To select more than one option from each box, press the Ctrl key and then select desired options.

In the Screenshot Types drop-down menu, select the type of screenshots you wish to download:

Originals screenshots only downloads the original screenshot images for selected languages and components.

Annotated screenshots only downloads only the annotated screenshots. If there are no annotated screenshots within the project, a text file named No Image! appears in the download dialog.

Originals/Annotated option downloads a full set of selected screenshots; with any annotations available on them.

Annotated localised with corresponding en_US option downloads annotated screenshots with the corresponding source screenshots for reference.

Figure 5 Download icon

Figure 6 Download screenshots dialog


8

Below the screenshot type dropdown menu you can select whether or not you wish

to include the OCR data.

The screenshots are downloaded in a zip file called yymmdd_projectName. Within

this they are organised in component folders that contain subfolders for each

language.


9

Notifications and global settings

Figure 7 Notifications and Settings icons

System notifications, and other project related communication (provided that SORT

is used to communicate project related information), can be accessed from the top

right (envelope icon) when logged into SORT. Use the global settings (gear icon) to

change your password if required, and to set up the appearance of the review work

space or adjust some of the most frequently used annotation elements (stroke

width, font size and colour).

Figure 8 Edit Preferences


10

Selecting the Synchronized to Toolbar checkbox applies changes made here to the

Screenshot Toolbar in view projects mode.

You can also link your SORT account to your YouTube account, if required. This is an

experimental option, used primarily by content creator users, and allows for

rudimentary product demo creation using the screenshots within the SORT.

The Compare Options section allows you to select or deselect the Fit to Screen

Option and the Highlight Diff Option when in compare mode. These are two of

several options available in Compare Mode. See Compare Mode section for more

detail.


11

Screenshot Detail page

Figure 9 Screenshot detail screen

When you open a screenshot to begin reviewing the first thing to note is that the

Component, under the navigation bar at the top of the page, changes to a hyper link

when the screenshot is displayed in full size. Clicking this link will bring you back to

the thumbnail view for this component.

Use the Previous and Next buttons to move between screenshots or alternatively

you can use the shortcut Ctrl + ← and Ctrl + →. The language you are viewing is

displayed above the screenshot. Click the language dropdown to display the

screenshot in other available languages or use the shortcuts Ctrl + ↑ and Ctrl + ↓ to

scroll through languages. Above the Previous / Next buttons, you can see the

screenshot number, total number of screenshots within this component, and the

screenshot name. The screenshot number appears a dropdown menu, allowing you

to quickly navigate between screenshots.

When you click Next on the final screenshot of the component you're working on, a

pop-up will appear with the option of either moving onto the Next component or

going back to the First screenshot of the current component. Similarly ,when you


12

click previous on the first screenshot of a component a pop-up will appear with the

option of either moving to the last screenshot of the Previous component or the

Last screenshot of the current component. This is useful if you are reviewing

screenshots in reverse order.

Figure 10 Next screenshot pop-up

Screenshot Data: Annotations, Description, Bugs and OCR output text

Each screenshot is accompanied by screenshot data, which is displayed under the

screenshot. This data consists of:

Annotations: the text for any annotations that have been added accompanied by the date the annotation was added and the name of the user who added it.

Bugs for this screenshot: bugs logged for this screenshot.

Description: Only available if screenshot descriptions were added by Project Manager or Administrator. Otherwise, this section will not be visible.

Figure 11 Screenshot data, Annotations and Bugs

Screenshot text contains the OCR output of the screenshot. Note that the OCR

output is not 100% precise. The OCR output is used to search screenshots for specific

text. The Search functionality will be covered later in this document. The Screenshot

text section can be activated by clicking on the Screenshot Text icon (highlighted in

the image above).


13

Figure 12 Screenshot OCR text

Clicking the Edit button at the top right of the Screenshot text section will bring you to XML edit mode. In this mode each string of text from the screenshot will appear as a numbered hyperlink. Clicking on these will open a new tab (shown in the diagram below). Here you can use the Previous and Next buttons to navigate through each string of text. NOTE: Although the Edit button appears when logged in as a linguist, linguist users do not have sufficient privileges to edit the OCR text. The PM and admin users can edit the OCR text.

Figure 13 Edit on-screen text


14

Screenshot Toolbar

The screenshot toolbar contains screenshot annotation options and viewing mode

options. The table below describes all available toolbar functionality in more detail.

Figure 14 Screenshot toolbar

Option name Icon Description

Select

Select enables editing of the annotations previously

added to the screenshot. You can move, resize or delete

each annotation as needed. When done, click the Save

button on the toolbar.

Colour

Use the Colour option to adjust the colour of the

elements you are inserting on the screenshot. Different

colours can be selected for different elements.

Stroke Width

Use the Stroke Width option to adjust the stroke width of

the elements you are drawing on the screenshot.

Line

Use the Line option to draw a line on the screenshot.

Arrow

Use the Arrow option to draw an arrow on the

screenshot.

Rectangle

Use the Rectangle option to draw a rectangle on the

screenshot.

Ellipse

Use the Ellipse option to draw an ellipse on the

screenshot.


15

Text

Select the Text option to insert text on the screenshot.

With the mouse cursor, draw an area where you want to

insert text and then type in the text.

Font Size

Use the Font Size option to adjust the font size of the

text.

Resize Canvas

By default, the annotation area, where you can add

comments on the screenshot, is set to the same size as

the screenshot. With the Resize Canvas option, you can

extend it as needed. This is useful for small screenshots,

where there is not enough room on the screenshot to

add review comments.

Undo

The Undo option removes the inserted annotations one

by one, starting with the annotation which was inserted

last.

If you log out of the application, and log back in at some

later stage, it will still be possible to remove annotations

you inserted previously using the Undo option.

Redo

The Redo option brings back the annotations that were

removed using the Undo option.

Preview

The Preview option displays the screenshot in preview

mode. You can navigate between screenshots in preview

mode by using Back and Next arrows. Use the zoom

options to zoom the screenshot in or out.

Save

After you have annotated the screenshot with all

necessary comments, use the Save option to save them.

If you forget to save the annotations, and try to navigate

to the next or previous screenshot, there will be a

warning reminding you to save your comments.


16

Copy

annotation(s)

to...

This option allows the user to propagate selected

annotations across all screenshots within the current

component, or across the same screenshot for other

languages.

Figure 15 Apply annotations dialog

Select the annotation elements you wish to propagate,

and click Save.

Trash

Trash option will remove all annotations from the

screenshot.

Download

The Download option downloads the screenshot you are

currently viewing. Be sure to save the annotated

screenshot before downloading, if you want to download

the screenshot with annotations.

Log Bug

Log Bug option redirects you to the Bug Tracker Login

page, where you can log in to the bug tracking system

and submit bugs. See Logging bugs section for more

detail.

NOTE: Bug tracker access must be preconfigured when the

SORT application is set up. If your company is using a bug

tracker integrated with SORT, your project manager will

provide you with all necessary bug tracker access details.


17

Screenshot

Text

Screenshot Text option will display the OCR output of the

screenshot. This was covered earlier in the document.

Mini-Search

Use this option to quickly access the screenshot text

search. The search opens in an independent pop-up

window and you do not need to leave your current work

space.

Crops

Crops define exclusion areas in an image or a group of

images. They can also be used to specify certain UI

elements to be used as queries in advanced search.

Compare

The Compare option splits the viewing area in two to

display localised and English screenshots side by side.

Always select compare mode while viewing a target

language screenshot, and by default, the left hand side

will display your target language, and the right hand side

will display the English screenshot. When in Compare

mode, a new toolbar becomes available. See Compare

mode section for more detail.

Edit OCR text

Although the edit OCR text icon appears when logged in

as a linguist, linguists are in fact not able to edit the OCR

text; as noted previously in this guide.

Share

This option allows you to see the full URL for a particular

screenshot, which you can use to share a direct link to

the screenshot with another project participant.

Close

The Close option on the right hand side on the toolbar

hides the toolbar. When the toolbar is hidden, the Show

toolbar button will appear above the screenshot to

display the toolbar again.

Table 1 Screenshot toolbar options explained


18

Compare Mode

The Compare option splits the viewing area in two to display localised and English

screenshots side by side. Always select compare mode while viewing a target

language screenshot, and by default, the left hand side will display your target

language, and the right hand side will display the English screenshot. Note that

there is a dropdown menu above the screenshot on the right, allowing you to select

any of the languages you have access to.

Figure 16 Compare Mode

When in Compare mode, a new toolbar becomes available. The L icon ensures you

are in Language Compare mode. The V icon will bring you to Version Compare

mode. This mode is for comparing older versions of the screenshot with the latest

version. Selecting the Diff checkbox when in Version Compare mode will highlight

the differences between the two screenshots. The Toggle OCR Comparison icon

displays the OCR below the two screenshots for comparison. The strings that match

on each side will be highlighted white, while the strings that do not match will be

highlighted yellow. The Pop compare screenshot icon opens the English screenshot

in a separate tab. The Internal compare screenshot icon brings you back to

comparing both screenshots in the same tab. The Fit checkbox resizes the two

screenshots to fit side by side.


19

Logging bugs

The Log bug option allows users to log bugs directly to Bugzilla and Jira. If your

company is using a bug tracker integrated with SORT, your project manager will

provide you with all necessary bug tracker access details.

To log a bug, click the Log bug option. This will display the Bug Tracker login page.

Enter your user name and password, and then click Login. You will now be redirected

to the Create bug page.

Figure 17 Create bug

The left hand side of the page shows the screenshot you were viewing, and for which

you want to submit a bug. The screenshot you were viewing will automatically be

selected as attachment to the bug (indicated by a green frame around the

screenshot thumbnail in the image above). If you wish to also attach the English

screenshot to the bug as a reference, please select it by clicking on its thumbnail. To

select or deselect all available languages, use Select all / Deselect all links.


20

The right hand side of the page, Bug info displays fields directly from the Bug Tracker

system you are connected to. Depending on what system your company is using,

these fields will differ.

Enter all bug information as per your company guidelines, and click Submit Current

Bug button. This will send the information to the Bug Tracker and redirect you back

to the screenshot detail page.

There may be cases where different languages have different bugs for the same

screenshot. To submit the bugs this way, select a language and then complete the

bug form. Then, use the links at the top of the page to display the same screenshot

in another language, and complete the bug form. Then click Submit All Bugs button.

If you wish to reuse some of the bug field entries for same screenshot across

different languages, please use Apply to all links available in top right of each Bug

info sub-section.

When a bug has been submitted for a screenshot, it is indicated in the Bug info

section, and also on the thumbnails page and screenshot detail page. Use the Open

in Bug Tracker link to view or edit the bug directly in the bug tracking system.

Figure 18 Bugs logged for a screenshot


21

Screenshot tags

You can use screenshot tags to bookmark the screenshots you are reviewing, or to

add classifications to the screenshots.

For example, you can tag screenshots you have queries about as "query

outstanding". When you query your questions with your PM, they can search for

screenshots you have added tags to, and provide an answer more efficiently. Or you

could tag screenshots containing hard coded strings which you cannot find in your

language resources during review.

You can also classify screenshots in a certain way - for example tag all screenshots

containing, or missing a certain option or a certain feature. You can then use these

tags to narrow down screenshot text searches.

Screenshots can also be tagged by your PM when they create the project on SORT.

This is useful if there are specific issues that you need to look out for during review.

Figure 19 Adding screenshot tags


22

Screenshot status icons

On the screenshot thumbnail page, there are icons that indicate screenshot status.

Figure 20 Screenshot status icons

The eye symbol at the top left indicates that you have viewed this screenshot.

Below the thumbnail, further options are available. Use the Preview option

(magnifying glass icon), to preview the screenshot in a new tab. You can also see if

there is OCR text available for this screenshot, whether there are any bugs logged for

it, and if there are any tags associated with it.


23

Search

The Search page can be accessed from the main toolbar from any of the pages

within SORT. The purpose of this page is to search through the screenshot OCR text

output. This enables translators and reviewers to find which screenshots specific

strings appear in, and thereby provide the most suitable translation, or find a specific

string in all contexts. Both English and localised screenshots can be searched.

Figure 21 Search page

Select your product, project, language and component in the corresponding drop-

down menus. Type a search query in the Enter key-phrase field. Use asterisk * as a

wild card character.

In the Advanced options section you can select several different options. To search

only annotated screenshots, use the Show marked screenshots only. To search only

screenshots you have not seen, use Show screenshots I have not seen option. Leave

both of these options unchecked if you want to search all screenshots.

Selecting In Progress projects only will narrow your search to in progress projects

only.

Search annotation text enables you to search through your annotations.

Full word only and Case sensitive options can be used to further refine the search.

NOTE: By selecting All in the Select project and Component drop-down menus, you

can search through all available projects and components simultaneously. However,

the search can be slowed down if there is a lot of data in the projects. The search is

most efficient if each project is searched separately.


24

Example: Finding all annotated screenshots

To display all annotated screenshots, type an asterisk in the Enter key-phrase field,

and select Show annotated screenshots only in the Advanced options section.

Example: Finding all screenshots you have not seen

To display all screenshots you have not opened yet, type an asterisk in the Enter key-

phrase field, and select Show screenshots I have not seen in the Advanced options

section.

Downloading search result

It is possible to download the search result by clicking the Download Result button.

SORT user guide for Linguists, March 2016mcafee-sort.brandtservices.com/sort/helpdoc/SORT User... · 2018-07-17 · SORT user guide for Linguists, March 2016 3 Introduction This is

Documents