Módulos

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

Módulos suportados

  • Módulo de integrações – fornece a possibilidade de inserir uma nova página de integração no Crowdin Enterprise.
  • O módulo de painéis do editor – oferece a possibilidade de criar guias adicionais no Editor.
  • O módulo de painéis do editor – oferece a possibilidade de criar guias adicionais no Editor.
  • O módulo de recursos – oferece a possibilidade de criar um painel adicional nos recursos da organização.
  • Módulo de menu de organização – oferece a possibilidade de criar uma nova seção no painel esquerdo da página inicial da área de trabalho.
  • O módulo de menu do projeto – oferece a possibilidade de criar uma nova seção no painel esquerdo da página inicial do projeto.

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

Visão geral do módulo

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 Enterprise. Você pode encontrar no Recursos > Integrações e API. 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

Description: O URL relativo ao logotipo da integração, que será exibido na UI do Crowdin Enterprise.
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. Enterprise.

Módulo de painéis de Crowdsource

O módulo de painéis Crowdsource oferece a possibilidade de criar guias adicionais na página pública de crowdsourcing do projeto. Para trabalhar com este módulo, certifique-se de que seu projeto atenda aos seguintes requisitos:

  • O fluxo de trabalho do projeto contém a etapa de Crowdsourcing.
  • O projeto está publicado na página de configurações do Crowdsourcing.

Este módulo está disponível para todos os usuários autorizados.

Estrutura do módulo do painel Crowdsource:

{
  "crowdsource-panels": [
    {
      "key": "minha-chave-do-módulo",
      "name": "Nome do módulo",
      "url": "/crowdsource-page"
    }
  ]
}

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. Enterprise.

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. Enterprise.

Módulo de recursos

O módulo de recursos oferece a possibilidade de criar um painel adicional nos recursos da organização. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

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. Enterprise.

Módulo de menu da organização

Módulo de menu de organização oferece a possibilidade de criar uma nova seção no painel esquerdo da página inicial da área de trabalho. Este módulo está disponível apenas para administradores da organização.

Estrutura do módulo do menu de organização:

{
  "organization-menu": [
    {
      "key": "minha-cave-do-módulo",
      "name": "Nome do módulo",
      "url": "/página-da-organização",
      "icon": "/images/icon.png"
    }
  ]
}

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. Enterprise.

icon

Tipo: string

Requerido: sim

Descrição: O URL relativo ao ícone da nova seção, que será exibido na UI do Crowdin Enterprise.
A resolução recomendada é de 24x24 pixels.

Módulo de menu de projeto

O módulo de menu do projeto oferece a possibilidade de criar uma nova seção no painel esquerdo da página inicial do projeto. 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. Enterprise.

Adicione módulos ao seu aplicativo para Crowdin

Para usar um módulo no seu aplicativo, declare o módulo no seu arquivo do descritor de aplicativos nos módulos, incluindo quaisquer propriedades necessárias. As propriedades que você inclui controlarão as opções de personalização para seu módulo.

Estrutura básica do módulo:

{
  "{module_type}": [
    {
      "key": "minha-chave-de-módulo",
      "name": "Nome do módulo"
    }
  ]
}

Propriedades:

{module_type}

Tipo: string

Requerido: sim

Valores permitidos: integrations, crowdsource-panels, editor-panels, resources

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.

Este artigo foi útil?