Difference between revisions of "LingoBot Users Guide"

From Lingoport Wiki
Jump to: navigation, search
m
Line 4: Line 4:
 
=== Universal ===
 
=== Universal ===
 
==== Duplicate Project: ====
 
==== Duplicate Project: ====
* duplicate project[ --force] <group>.<project>:<branch>
+
* <code>duplicate project[ --force] <group>.<project>:<branch></code>
 
** If the force flag is included, a new git branch of the same name will also be created.
 
** If the force flag is included, a new git branch of the same name will also be created.
 
* Creates a child project based on the branch name (source cannot be a child project).
 
* Creates a child project based on the branch name (source cannot be a child project).
 
* Shorthand: dup proj, -f
 
* Shorthand: dup proj, -f
 
==== Delete Project: ====
 
==== Delete Project: ====
* delete project <group>.<project>:<branch>
+
* <code>delete project <group>.<project>:<branch></code>
 
* Deletes the specified child project.
 
* Deletes the specified child project.
 
* Shorthand: del proj
 
* Shorthand: del proj
 
==== Update Dashboard: ====
 
==== Update Dashboard: ====
* update dashboard <group>.<project>[:<branch>]
+
* <code>update dashboard <group>.<project>[:<branch>]</code>
 
* Updates the dashboard with the latest information from the specified project/branch.
 
* Updates the dashboard with the latest information from the specified project/branch.
 
* Shorthand: up dash
 
* Shorthand: up dash
 
==== Show Dashboard: ====
 
==== Show Dashboard: ====
* show dashboard[ <group>.<project>[:<branch>]]
+
* <code>show dashboard[ <group>.<project>[:<branch>]]</code>
 
* Displays the URL of the dashboard corresponding to the specified project.
 
* Displays the URL of the dashboard corresponding to the specified project.
 
* Shorthand: show dash
 
* Shorthand: show dash
 
==== List Projects: ====
 
==== List Projects: ====
* list projects[ <query>]
+
* <code>list projects[ <query>]</code>
 
* Displays list of active projects (optionally containing )
 
* Displays list of active projects (optionally containing )
 
==== Ping: ====
 
==== Ping: ====
* ping
+
* <code>ping</code>
 
* Replies with "PONG"
 
* Replies with "PONG"
 
==== Help: ====
 
==== Help: ====
* help[ <query>]
+
* <code>help[ <query>]</code>
 
* Displays a list of all available commands, filtered by query if it is specified.
 
* Displays a list of all available commands, filtered by query if it is specified.
 
=== LRM Only ===
 
=== LRM Only ===
 
==== Critical Errors: ====
 
==== Critical Errors: ====
* show errors <group>.<project>[:<branch>]
+
* <code>show errors <group>.<project>[:<branch>]</code>
 
* Displays top 10 LRM-critical errors in the specified project/branch.
 
* Displays top 10 LRM-critical errors in the specified project/branch.
 
==== Pseudo-localize: ====
 
==== Pseudo-localize: ====
* pseudoloc <group>.<project>:<branch>
+
* <code>pseudoloc <group>.<project>:<branch></code>
 
* Pseudo-localizes the specified project.
 
* Pseudo-localizes the specified project.
 
==== Prep Kit: ====
 
==== Prep Kit: ====
* prep kit <group>.<project>:<branch>
+
* <code>prep kit <group>.<project>:<branch></code>
 
* If there are no errors in the specified project/branch, sends the project to the translation vendor.
 
* If there are no errors in the specified project/branch, sends the project to the translation vendor.
 
* Alternative: translate
 
* Alternative: translate
 
==== Translation Status: ====
 
==== Translation Status: ====
* translation status <group>.<project>[:<branch>]
+
* <code>translation status <group>.<project>[:<branch>]</code>
 
* Displays a summary of the current status of translations on the specified project/branch.
 
* Displays a summary of the current status of translations on the specified project/branch.
 
* Shorthand: tran stat
 
* Shorthand: tran stat
 
==== Notify: ====
 
==== Notify: ====
 
* Manages the notification dispatch system for translation imports
 
* Manages the notification dispatch system for translation imports
* notify me <group>.<project>[:<branch>]
+
* <code>notify me <group>.<project>[:<branch>]</code>
 
** Adds sender (user or room) to recipient list
 
** Adds sender (user or room) to recipient list
* notify who <group>.<project>[:<branch>]
+
* <code>notify who <group>.<project>[:<branch>]</code>
 
** Displays recipient list
 
** Displays recipient list
* notify stop <group>.<project>[:<branch>]
+
* <code>notify stop <group>.<project>[:<branch>]</code>
 
** Removes sender (user or room) from recipient list
 
** Removes sender (user or room) from recipient list
 
=== Globalyzer Lite Only ===
 
=== Globalyzer Lite Only ===
 
==== I18n Scan: ====
 
==== I18n Scan: ====
* i18n scan <group>.<project>:<branch>
+
* <code>i18n scan <group>.<project>:<branch></code>
 
* Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results.
 
* Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results.
   

Revision as of 20:40, 15 August 2017

Available Commands Overview

LingoBot allows developers and i18n/l10n managers to make use of Lingoport's product suite without ever having to leave their collaboration environment. With a variety of easy-to-understand commands, users can scan their codebase for potential i18n and l10n issues, gain quick access to the Lingoport dashboard, as well as send resource files for translation and retrieve translation status reports. Here you will find a summary list of the commands which LingoBot will recognize as well as a brief description of each command. Further down you will find in-depth breakdowns of the commands, their use cases, as well as examples of each command in use. If you have any questions that this document doesn't answer, be sure to check out the FAQ page for additional information.

Universal

Duplicate Project:

  • duplicate project[ --force] <group>.<project>:<branch>
    • If the force flag is included, a new git branch of the same name will also be created.
  • Creates a child project based on the branch name (source cannot be a child project).
  • Shorthand: dup proj, -f

Delete Project:

  • delete project <group>.<project>:<branch>
  • Deletes the specified child project.
  • Shorthand: del proj

Update Dashboard:

  • update dashboard <group>.<project>[:<branch>]
  • Updates the dashboard with the latest information from the specified project/branch.
  • Shorthand: up dash

Show Dashboard:

  • show dashboard[ <group>.<project>[:<branch>]]
  • Displays the URL of the dashboard corresponding to the specified project.
  • Shorthand: show dash

List Projects:

  • list projects[ <query>]
  • Displays list of active projects (optionally containing )

Ping:

  • ping
  • Replies with "PONG"

Help:

  • help[ <query>]
  • Displays a list of all available commands, filtered by query if it is specified.

LRM Only

Critical Errors:

  • show errors <group>.<project>[:<branch>]
  • Displays top 10 LRM-critical errors in the specified project/branch.

Pseudo-localize:

  • pseudoloc <group>.<project>:<branch>
  • Pseudo-localizes the specified project.

Prep Kit:

  • prep kit <group>.<project>:<branch>
  • If there are no errors in the specified project/branch, sends the project to the translation vendor.
  • Alternative: translate

Translation Status:

  • translation status <group>.<project>[:<branch>]
  • Displays a summary of the current status of translations on the specified project/branch.
  • Shorthand: tran stat

Notify:

  • Manages the notification dispatch system for translation imports
  • notify me <group>.<project>[:<branch>]
    • Adds sender (user or room) to recipient list
  • notify who <group>.<project>[:<branch>]
    • Displays recipient list
  • notify stop <group>.<project>[:<branch>]
    • Removes sender (user or room) from recipient list

Globalyzer Lite Only

I18n Scan:

  • i18n scan <group>.<project>:<branch>
  • Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results.

LingoBot Command Breakdown

Universal

LRM Only

Globalyzer Lite Only