Labyrinx

Integração

Integrar ajuda no Labyrinx

Guia técnico para vincular campos, botões e componentes aos tópicos desta wiki. A integração na aplicação não foi realizada.

Contrato de links estáveis

Guia

O arquivo wiki-map.json é o registro central: relaciona docId, título, caminho, âncora, status e localização na interface. Os IDs não dependem do título visível. Os caminhos são relativos à raiz da wiki.

Os componentes reais do código do Labyrinx não foram inspecionados. Por isso, componentKeys permanece vazio; use os docIds fornecidos como data-help-id ou equivalente, sem afirmar que são nomes existentes no código.

Hospedar os arquivos

Guia
  1. Extraia o ZIP. A pasta dist contém os arquivos públicos. Para ler localmente, abra dist/index.html.
  2. Para hospedar, copie o conteúdo de dist para a pasta desejada, por exemplo /wiki/. Não é necessário compilar nem instalar dependências.
  3. Mantenha os nomes dos arquivos HTML e a pasta assets. Todos os recursos de leitura e busca são locais; não há fonte, biblioteca ou serviço externo obrigatório.
  4. Configure no Labyrinx a base pública da wiki. A biblioteca de links aceita uma base como /wiki/ ou uma URL completa.
  5. Teste um link direto, um campo com âncora e uma abertura em nova aba. Não é necessário login para ler os arquivos estáticos.

Resolver um ID na aplicação

Guia

O arquivo assets/help-links.js expõe LabyrinxWiki e inclui o mapa, sem depender de fetch. Carregue-o na aplicação, configure a base e gere o href pelo ID.

<script src="/wiki/assets/help-links.js"></script>
<script>
  LabyrinxWiki.configure({ baseUrl: '/wiki/' });
  const href = LabyrinxWiki.urlFor('editor.puzzle.accepted-answers');
</script>

Em React ou outro framework, importe o JSON ou adapte o resolver à configuração da aplicação. Não espalhe caminhos HTML fixos pelos componentes. A API também oferece getTopic(docId) e hasTopic(docId).

Para escolher o idioma, use configure({ baseUrl: "/wiki/", locale: "en" }) ou urlFor(docId, "es"). Idiomas: pt, en e es. O mesmo docId resolve para a seção equivalente.

Botão de ajuda contextual

Guia

Use um link acessível próximo do campo. O texto deve explicar seu destino, como “Ajuda sobre respostas aceitas”. Preserve a entrada do autor; abrir a documentação em nova aba pode evitar perda de contexto.

<a href="/wiki/help.html?doc=editor.puzzle.accepted-answers"
   target="_blank" rel="noopener"
   aria-label="Ajuda sobre respostas aceitas">?</a>

O endpoint estático help.html?doc=... resolve o ID e abre a página/âncora correspondente. Também funciona com IDs de alias do mapa. Um ID desconhecido leva à página inicial com aviso; nenhum conteúdo externo é aceito como destino.

Mapa de componentes para integração

Guia

Consulte a lista pesquisável de tópicos e IDs. Cada tópico possui um botão para copiar o link e outro para copiar o ID. O mapa contém também os campos de contexto uiLocation e componentKeys.

Quando os nomes reais dos componentes forem conhecidos, preencha componentKeys sem alterar os docIds. Um componente pode apontar para uma seção específica ou para uma referência geral. Não associe automaticamente campos com o mesmo rótulo quando seus contextos forem distintos.

Manter links ao atualizar

Guia
  • Mantenha docId e âncora quando mudar apenas o título.
  • Se mover um tópico, atualize o mapa e preserve a URL antiga com uma página ou âncora de compatibilidade.
  • Adicione aliases para IDs renomeados; não reutilize um ID com outro significado.
  • Execute o verificador após gerar as páginas: ele confere destinos, âncoras, IDs e referências internas.
  • Registre mudanças de comportamento e atualize a cobertura de testes. Não marque como executado um fluxo apenas porque o campo continua visível.

Labyrinx · Documentação de criação · Verificação: 20/10/2026