Difference between revisions of "InContext Installation"

From Lingoport Wiki
Jump to: navigation, search
(Chrome Extension Installation)
(Using Multiple Displays with Google Chrome)
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Pre-Requisites ==
 
== Pre-Requisites ==
In order to use Lingoport InContext QA, the user must have access to the Google Chrome Browser. Lingoport InContext QA is based off a Chrome extension and other browsers do not have the same capability. Firefox or Internet Explorer can not be used as the browser in this situation.
+
In order to use Lingoport InContext QA, the user must have access to the Google Chrome browser. Lingoport InContext QA is based off a Chrome extension and other browsers do not have the same capability. Firefox or Internet Explorer can not be used as the browser in this situation.
 
*LRM must be installed and
 
*LRM must be installed and
 
* the G11n Continuous System's Jenkins server must be accessible from the reviewer's system.
 
* the G11n Continuous System's Jenkins server must be accessible from the reviewer's system.
   
The reviewer needs to have the following information, usually received in an IT email:
+
The reviewer needs to have the following information which should be set up by the Jenkins administrator:
 
* The Jenkins URL
 
* The Jenkins URL
* Their Jenkins user name
+
* A Jenkins username and password.
* Their Jenkins API token
+
* To get the API token and verify the Jenkins account:
  +
** Log in to Jenkins using the reviewer username and password.
  +
** Select the pull down next to username at the top of the window and select '''Configure'''.
  +
*** Under API Token, '''Show API Token...'''. Copy the token.
   
 
In addition, the reviewer will need:
 
In addition, the reviewer will need:
Line 15: Line 18:
 
From within the Google Chrome Browser:
 
From within the Google Chrome Browser:
 
* Make sure you are signed in to Chrome Web Store with an authorized Google account: https://chrome.google.com/webstore/category/extensions
 
* Make sure you are signed in to Chrome Web Store with an authorized Google account: https://chrome.google.com/webstore/category/extensions
* Lingoport will give permissions to access the extension, based on the email address given to Lingoport.
+
* Lingoport will give permissions to access the extension, based on the email address given to Lingoport. This is the email address that must be used when signing into the Chrome Web Store.
 
* Navigate to https://chrome.google.com/webstore/detail/lingoport-incontext-qa/jboelmhkcjgogedegacfnhabhgpamiam
 
* Navigate to https://chrome.google.com/webstore/detail/lingoport-incontext-qa/jboelmhkcjgogedegacfnhabhgpamiam
* If this gives an error or a "URL was not found" message,
+
* If this gives an error or a "URL was not found" message:
** Check to make sure you are logged in as the correct Chrome user. Return to google.com and select the upper-right icon. This should match the login given to Lingoport. If it does not, sign out and sign in as the correct user.
+
** In the Chrome Web Store, verify that you are logged in using the correct email address . If this does not work, please contact support@lingoport.com.
[[File:google.png|600px]]
+
[[File:UserSignin.png|600px]]
  +
* click on '''Add to Chrome Extension'''
** If this does not work, please contact support@lingoport.com.
 
  +
You should see the Lingoport swirl [[File:swirl.png|35px]] at the top of the Chrome browser window.
* click on 'Add to Chrome Extension"
 
You should see a new Chrome Extension with the Lingoport swirl.
 
 
Note: If you are using multiple screens, you may want to invoke Chrome the following way:
 
* <code>"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" /high-dpi-support=1 /force-device-scale-factor=1. --allow-file-access-from-files</code>
 
   
 
== Chrome Extension Configuration ==
 
== Chrome Extension Configuration ==
  +
* Before configuring the Chrome InContext extension, a username needs to be created in Jenkins.
* Click on the Lingoport swirl of the Chrome Extension (top right corner of your Chrome)
 
  +
* Click on the Lingoport swirl [[File:swirl.png|35px]] for the Chrome Extension (top right corner of your Chrome)
 
* Click on the 'Option' icon (☰) of the dialog.
 
* Click on the 'Option' icon (☰) of the dialog.
* Fill in the data as per the Pre-Requisites above:
+
* Fill in the data, using the username and API token and '''Save Credentials'''
  +
[[File:Incontext credentials.png|300px]]
** Jenkins URL
 
  +
** Jenkins user name
 
  +
You should be ready to do InContext reviews.
** Jenkins user API Token
 
  +
** Reviewer's email address
 
  +
== Loading Local Files in Google Chrome ==
* Click on 'Save Credentials'
 
  +
Due to security reasons Chrome will not load local files by default. You'll need to launch the Google Chrome browser from the command line window with the additional argument ''–allow-file-access-from-files'' as well as allowing local files access within the Chrome Extension.
  +
* Determine where chrome.exe is located on your machine by entering ''chrome://version'' into your Chrome Browser and search for ''Executable Path''.
  +
* Launch the Google Chrome browser from the command line window with the additional argument ''–allow-file-access-from-files''.
  +
: <code>>"path to your chrome installation\chrome.exe" --allow-file-access-from-files</code>
  +
* Within the Chrome Browser right-click on the Lingoport Incontext QA Chrome Extension and choose '''Manage Extensions'''
  +
[[File:ManageExtensions.png|200px]]
  +
* Move the ''Allow access to file URLs'' switch to the right.
  +
[[File:UserAllowAccess.png|400px]]
  +
  +
== Using Multiple Displays with Google Chrome ==
  +
In order for multiple high resolution displays to work properly with Google Chrome you'll need to launch the Google Chrome browser from the command line with additional arguments. You may want to create/change the Chrome shortcut to include the options rather than opening from a command line each time.
  +
* Determine where chrome.exe is located on your machine by entering ''chrome://version'' into your Chrome Browser and search for ''Executable Path''.
  +
* Launch the Google Chrome browser from the command line window with additional scaling directives ''/high-dpi-support=1 /force-device-scale-factor=1''.
  +
: <code>>"path to your chrome installation\chrome.exe" /high-dpi-support=1 /force-device-scale-factor=1</code>
  +
: Note: arguments are single spaced. If you need to load local files then add ''–allow-file-access-from-files'' to the argument list.

Revision as of 17:01, 27 July 2018

Pre-Requisites

In order to use Lingoport InContext QA, the user must have access to the Google Chrome browser. Lingoport InContext QA is based off a Chrome extension and other browsers do not have the same capability. Firefox or Internet Explorer can not be used as the browser in this situation.

  • LRM must be installed and
  • the G11n Continuous System's Jenkins server must be accessible from the reviewer's system.

The reviewer needs to have the following information which should be set up by the Jenkins administrator:

  • The Jenkins URL
  • A Jenkins username and password.
  • To get the API token and verify the Jenkins account:
    • Log in to Jenkins using the reviewer username and password.
    • Select the pull down next to username at the top of the window and select Configure.
      • Under API Token, Show API Token.... Copy the token.

In addition, the reviewer will need:

  • Their email address

Chrome Extension Installation

From within the Google Chrome Browser:

UserSignin.png
  • click on Add to Chrome Extension

You should see the Lingoport swirl Swirl.png at the top of the Chrome browser window.

Chrome Extension Configuration

  • Before configuring the Chrome InContext extension, a username needs to be created in Jenkins.
  • Click on the Lingoport swirl Swirl.png for the Chrome Extension (top right corner of your Chrome)
  • Click on the 'Option' icon (☰) of the dialog.
  • Fill in the data, using the username and API token and Save Credentials
 Incontext credentials.png

You should be ready to do InContext reviews.

Loading Local Files in Google Chrome

Due to security reasons Chrome will not load local files by default. You'll need to launch the Google Chrome browser from the command line window with the additional argument –allow-file-access-from-files as well as allowing local files access within the Chrome Extension.

  • Determine where chrome.exe is located on your machine by entering chrome://version into your Chrome Browser and search for Executable Path.
  • Launch the Google Chrome browser from the command line window with the additional argument –allow-file-access-from-files.
>"path to your chrome installation\chrome.exe" --allow-file-access-from-files
  • Within the Chrome Browser right-click on the Lingoport Incontext QA Chrome Extension and choose Manage Extensions

ManageExtensions.png

  • Move the Allow access to file URLs switch to the right.

UserAllowAccess.png

Using Multiple Displays with Google Chrome

In order for multiple high resolution displays to work properly with Google Chrome you'll need to launch the Google Chrome browser from the command line with additional arguments. You may want to create/change the Chrome shortcut to include the options rather than opening from a command line each time.

  • Determine where chrome.exe is located on your machine by entering chrome://version into your Chrome Browser and search for Executable Path.
  • Launch the Google Chrome browser from the command line window with additional scaling directives /high-dpi-support=1 /force-device-scale-factor=1.
>"path to your chrome installation\chrome.exe" /high-dpi-support=1 /force-device-scale-factor=1
Note: arguments are single spaced. If you need to load local files then add –allow-file-access-from-files to the argument list.