Módulos

Os módulos permitem que os aplicativos estendam a interface do usuário Crowdin, criem integrações com serviços externos, etc.

Módulos suportados

  • Integrations module – insert a new integration page in Crowdin.
  • Editor-panels module – create additional panels in the Editor.
  • Resources module – create an additional panel in the project owner’s resources.
  • Project menu module – create a new tab in the project.
  • Custom MT module – connect machine translation engines, that aren’t supported in Crowdin by default yet.

Mais módulos do Crowdin Apps serão disponibilizados em breve.

Módulo de integração

O módulo de integrações oferece a possibilidade de criar e inserir uma nova integração dentro do projeto Crowdin. You can find it in your project’s Applications tab. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Estrutura do módulo de integração:

{
  "integrations": [
    {
      "key": "minha-chave-do-módulo",
      "name": "Nome do módulo",
      "description": "Descrição do módulo",
      "logo": "/logo.png",
      "url": "/página-de-integração"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

description

Tipo: string

Descrição: A descrição legível por humanos do que o módulo faz.
A descrição estará visível na interface do usuário do Crowdin.

logo

Tipo: string

Requerido: sim

Descrição: A URL relativa ao logotipo da integração, que será exibida na UI do Crowdin.
A resolução recomendada é de 48x48 pixels.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Módulo de painéis do editor

O módulo de painéis do editor oferece a possibilidade de criar guias adicionais no Editor. Ao usar este módulo em seu aplicativo para Crowdin, você pode escolher o modo editor onde deseja que as guias adicionais sejam exibidas. O módulo de painéis do editor está disponível apenas para os membros do projeto que têm acesso ao Editor.

Estrutura do módulo do painel do editor:

{
  "editor-panels": [
    {
      "key": "minha-chave-do-módulo",
      "position": "right",
      "name": "Nome do módulo",
      "modes": ["translate", "proofread"],
      "url": "/página-do-editor"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

position

Tipo: string

Requerido: sim

Valores permitidos: right

Descrição: A posição onde o módulo será colocado.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

modes

Tipo: array

Requerido: sim

Valores permitidos: assets, review, translate, proofread

Descrição: A lista de modos do Editor onde o módulo estará disponível.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Módulo de recursos

O módulo de recursos oferece a possibilidade de criar um painel adicional nos recursos do proprietário do projeto. Este módulo está disponível apenas para o proprietário do projeto.

Estrutura do módulo de recursos:

{
  "resources": [
    {
      "key": "minha-chave-do-módulo",
      "name": "Nome do módulo",
      "url": "/página-de-recursos"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Módulo de menu de projeto

Project menu module provides a possibility to create a new tab in the project. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Estrutura do módulo do menu do projeto:

{
  "project-menu": [
    {
      "key": "minha-chave-do-módulo",
      "name": "Nome do módulo",
      "url": "/página-de-projeto"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Custom MT (Machine Translation) Module

This module helps you connect machine translation engines that are not supported by Crowdin yet. Once you create this kind of app, you’ll be able to pre-translate your content with the connected MT or enable translation suggestions made by it to be shown in the editor for translators.

Custom MT module structure:

{
   "custom-mt": [
     {
            "key": "custom-mt",
            "name": "Custom MT",
            "url": "/translate"
      }
    ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

url

Tipo: string

Requerido: sim

Description: The relative URL to the content page of the module, that will be integrated with Crowdin.

Add modules to your Crowdin app

To use a module in your app, declare the module in your App Descriptor file under modules, including any required properties. The properties you include control the customization options for your module.

Estrutura básica do módulo:

{
  "{module_type}": [
    {
      "key": "my-module-key",
      "name": "Module Name",
      "description": "Module description"
    }
  ]
}

Properties

{module_type}

Tipo: string

Requerido: sim

Allowed values integrations

Descrição: O tipo de módulo que o aplicativo Crowdin usa.

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

description

Tipo: string

Description: A human-readable description of what the module does.
The description will be visible in the Crowdin UI.

Este artigo foi útil?