Ajuda:Guia de Estilo: mudanças entre as edições
Mais ações
Sem resumo de edição |
Sem resumo de edição |
||
| Linha 49: | Linha 49: | ||
=== Tipos Disponíveis === | === Tipos Disponíveis === | ||
{{Nota|info|INFO (Padrão)|Use para dicas gerais ou informações complementares | {{Nota|info|INFO (Padrão)|Use para dicas gerais ou informações complementares.}} | ||
<pre>{{Nota|info|DICA|Texto da dica...}}</pre> | <pre>{{Nota|info|DICA|Texto da dica...}}</pre> | ||
{{Nota|success|SUCESSO | {{Nota|success|SUCESSO|Use para indicar novas funcionalidades ou boas práticas.}} | ||
<pre>{{Nota|success|NOVIDADE|Versão 15.0 lançada...}}</pre> | <pre>{{Nota|success|NOVIDADE|Versão 15.0 lançada...}}</pre> | ||
{{Nota|warning|ATENÇÃO|Use para alertas que requerem cuidado do usuário | {{Nota|warning|ATENÇÃO|Use para alertas que requerem cuidado do usuário.}} | ||
<pre>{{Nota|warning|ATENÇÃO|Verifique o cadastro antes de salvar...}}</pre> | <pre>{{Nota|warning|ATENÇÃO|Verifique o cadastro antes de salvar...}}</pre> | ||
{{Nota|danger| | {{Nota|danger|CRÍTICO|Use para riscos de perda de dados ou bloqueios.}} | ||
<pre>{{Nota|danger|IMPORTANTE|Não desligue o servidor | <pre>{{Nota|danger|IMPORTANTE|Não desligue o servidor...}}</pre> | ||
---- | ---- | ||
== 3. Tabelas de Campos (Data Grid) == | == 3. Tabelas de Campos (Data Grid) == | ||
Substitua as tabelas manuais pelo componente <code>{{TabelaCampos}}</code> | Substitua as tabelas manuais pelo componente <code>{{TabelaCampos}}</code>. | ||
=== Sintaxe Básica === | === Sintaxe Básica === | ||
<pre> | <pre> | ||
{{TabelaCampos| | {{TabelaCampos| | ||
| Linha 75: | Linha 74: | ||
=== Sintaxe Segura (Anti-Bug) === | === Sintaxe Segura (Anti-Bug) === | ||
{{Nota|warning|RECOMENDADO|Se você precisar quebrar linhas ou usar listas | {{Nota|warning|RECOMENDADO|Se você precisar quebrar linhas ou usar listas dentro da tabela, use '''1=''' e '''2=''' para evitar erros.}} | ||
<pre> | <pre> | ||
| Linha 96: | Linha 95: | ||
---- | ---- | ||
== 4. Cards e Grids | == 4. Cards e Grids == | ||
=== 4.1. Cards Básicos === | === 4.1. Cards Básicos === | ||
| Linha 104: | Linha 102: | ||
<pre> | <pre> | ||
<div class="celta-grid"> | <div class="celta-grid"> | ||
{{Card|titulo=Dicas|texto=Texto do card | {{Card|titulo=Dicas|texto=Texto do card...}} | ||
</div> | </div> | ||
</pre> | </pre> | ||
=== 4.2. Menus de Navegação (CardMenu) === | === 4.2. Menus de Navegação (CardMenu) === | ||
Use <code>{{CardMenu}}</code> para criar listas de links | Use <code>{{CardMenu}}</code> para criar listas de links. Cores: `blue`, `dark`, `orange`, `green`, `red`. | ||
{{Nota|warning|IMPORTANTE|Os asteriscos (*) da lista devem estar colados na margem esquerda.}} | |||
<pre> | <pre> | ||
| Linha 126: | Linha 123: | ||
</div> | </div> | ||
</pre> | </pre> | ||
=== 4.3. Grid de 2 Colunas Fixas === | === 4.3. Grid de 2 Colunas Fixas === | ||
Para forçar '''2 colunas grandes''', adicione a classe <code>celta-grid-2</code>. | |||
<pre> | <pre> | ||
<div class="celta-grid celta-grid-2"> | <div class="celta-grid celta-grid-2"> | ||
{{Card...}} | {{Card...}} | ||
</div> | </div> | ||
| Linha 165: | Linha 148: | ||
---- | ---- | ||
== 6. Template Base (Copiar e Colar) == | == 6. Barras de Contato (Rodapé) == | ||
''Use este código para iniciar uma nova página de manual rapidamente | Adicione no final das páginas para exibir os canais de atendimento. | ||
=== Padrão (Suporte Técnico) === | |||
Use: <code>{{ContatoSuporte}}</code> | |||
{{ContatoSuporte}} | |||
=== Financeiro / Comercial === | |||
Use: <code>{{ContatoFinanceiro}}</code> | |||
{{ContatoFinanceiro}} | |||
---- | |||
== 7. Template Base (Copiar e Colar) == | |||
''Use este código para iniciar uma nova página de manual rapidamente.'' | |||
<pre> | <pre> | ||
| Linha 174: | Linha 172: | ||
}} | }} | ||
Resumo da funcionalidade. | |||
{{Nota|info|PRÉ-REQUISITO|Necessário estar na versão 15.0 ou superior.}} | {{Nota|info|PRÉ-REQUISITO|Necessário estar na versão 15.0 ou superior.}} | ||
| Linha 187: | Linha 185: | ||
{{Linha | {{Linha | ||
| tipo=check | | tipo=check | ||
| 1= Nome do | | 1= Nome do Campo | ||
| 2= Explicação | | 2= Explicação do campo. | ||
}} | }} | ||
}} | }} | ||
| Linha 198: | Linha 192: | ||
== 3. Passo a Passo == | == 3. Passo a Passo == | ||
# Clique em '''Incluir'''; | # Clique em '''Incluir'''; | ||
# Preencha os dados | # Preencha os dados; | ||
#: {{Print|Exemplo_Tela.png|Tela de cadastro}} | #: {{Print|Exemplo_Tela.png|Tela de cadastro}} | ||
# Clique em '''Gravar'''. | # Clique em '''Gravar'''. | ||
{{ | {{ContatoSuporte}} | ||
</pre> | </pre> | ||
---- | ---- | ||
== | == 8. Layouts Especiais == | ||
=== Tela Cheia (Sem Sidebar) === | |||
Para Dashboards ou Home Page: | |||
<pre> | <pre> | ||
<div class="celta-full-width"> | <div class="celta-full-width"> | ||
... | ... conteúdo ... | ||
</div> | </div> | ||
</pre> | </pre> | ||
=== Menu Lateral Estilo Sistema === | |||
Para replicar o menu branco lateral do sistema Celta: | |||
== | |||
Para | |||
<pre> | <pre> | ||
<div class="celta-sys-menu"> | <div class="celta-sys-menu"> | ||
<div class="celta-sys-header">Menu do Sistema</div> | <div class="celta-sys-header">Menu do Sistema</div> | ||
<div style="display: flex; flex-direction: column;"> | <div style="display: flex; flex-direction: column;"> | ||
[[Link|<span class="celta-sys-btn"><i class="bi bi-house"></i> Botão 1</span>]] | [[Link|<span class="celta-sys-btn"><i class="bi bi-house"></i> Botão 1</span>]] | ||
</div> | </div> | ||
</div> | </div> | ||
</pre> | </pre> | ||
Edição das 02h53min de 1 de dezembro de 2025
Guia de Estilo e Padrões de Edição
Este guia documenta os componentes visuais do Celta Wiki Framework. Utilize estes padrões para manter a consistência, agilidade e beleza da documentação.
1. Cabeçalho (Obrigatório)
Toda página deve iniciar com o componente de cabeçalho para gerar o breadcrumb (navegação) e o título padrão.
Gera a caixa azul com título. Ideal para documentações.
{{Cabecalho
| [[Módulo Pai]] › [[Sub-rotina]]
| Título da Página
}}
Gera apenas o breadcrumb. Use em páginas com design personalizado.
{{Cabecalho
| [[Módulo Pai]]
| no
}}
2. Caixas de Aviso (Notas)
Use o template
Nota
para destacar informações. Agora possuímos 4 cores semânticas.
Sintaxe
{{Nota | TIPO | TÍTULO | Seu texto aqui... }}
Tipos Disponíveis
Use para dicas gerais ou informações complementares.
{{Nota|info|DICA|Texto da dica...}}
Use para indicar novas funcionalidades ou boas práticas.
{{Nota|success|NOVIDADE|Versão 15.0 lançada...}}
Use para alertas que requerem cuidado do usuário.
{{Nota|warning|ATENÇÃO|Verifique o cadastro antes de salvar...}}
Use para riscos de perda de dados ou bloqueios.
{{Nota|danger|IMPORTANTE|Não desligue o servidor...}}
3. Tabelas de Campos (Data Grid)
Substitua as tabelas manuais pelo componente
Campo / Parâmetro
Função e Instruções
.
Sintaxe Básica
{{TabelaCampos|
{{Linha| Nome do Campo | Explicação do que deve ser preenchido. }}
}}
Sintaxe Segura (Anti-Bug)
{{TabelaCampos|
{{Linha
| 1= Nome do Campo
| 2= Explicação longa que permite:
* Listas com marcadores
* Quebras de linha
}}
}}
Resultado Visual
| Campo / Parâmetro | Função e Instruções |
|---|---|
| Data Inicial | Informe a data de início do relatório. |
| Cliente | Selecione o cliente ou deixe em branco para todos. |
4. Cards e Grids
4.1. Cards Básicos
Use
{{{titulo}}}
{{{texto}}}
para blocos simples de texto.
<div class="celta-grid">
{{Card|titulo=Dicas|texto=Texto do card...}}
</div>
4.2. Menus de Navegação (CardMenu)
Use
{{{titulo}}}
{{{conteudo}}}
para criar listas de links. Cores: `blue`, `dark`, `orange`, `green`, `red`.
Os asteriscos (*) da lista devem estar colados na margem esquerda.
<div class="celta-grid">
{{CardMenu
| cor = orange
| icone = bi-star
| titulo = Favoritos
| conteudo =
* [[Link 1]]
* [[Link 2]]
}}
</div>
4.3. Grid de 2 Colunas Fixas
Para forçar 2 colunas grandes, adicione a classe celta-grid-2.
<div class="celta-grid celta-grid-2">
{{Card...}}
</div>
5. Imagens e Badges
Prints de Tela
Padroniza o tamanho e a borda das imagens.
{{Print|Nome_Arquivo.png|Legenda da imagem}}
Badges (Etiquetas)
Use ao lado de títulos para destacar versões.
== Instalação {{Badge|novo|v15.2}} ==
Resultado: Instalação v15.2
6. Barras de Contato (Rodapé)
Adicione no final das páginas para exibir os canais de atendimento.
Padrão (Suporte Técnico)
Use:
Financeiro / Comercial
Use:
Contato
7. Template Base (Copiar e Colar)
Use este código para iniciar uma nova página de manual rapidamente.
{{Cabecalho
| [[Módulo]] › [[Funcionalidade]]
| Título do Manual
}}
Resumo da funcionalidade.
{{Nota|info|PRÉ-REQUISITO|Necessário estar na versão 15.0 ou superior.}}
== 1. Visão Geral ==
Explicação do conceito...
== 2. Configuração ==
Acesse o menu '''Cadastro > Operações'''.
{{TabelaCampos|
{{Linha
| tipo=check
| 1= Nome do Campo
| 2= Explicação do campo.
}}
}}
== 3. Passo a Passo ==
# Clique em '''Incluir''';
# Preencha os dados;
#: {{Print|Exemplo_Tela.png|Tela de cadastro}}
# Clique em '''Gravar'''.
{{ContatoSuporte}}
8. Layouts Especiais
Tela Cheia (Sem Sidebar)
Para Dashboards ou Home Page:
<div class="celta-full-width"> ... conteúdo ... </div>
Menu Lateral Estilo Sistema
Para replicar o menu branco lateral do sistema Celta:
<div class="celta-sys-menu">
<div class="celta-sys-header">Menu do Sistema</div>
<div style="display: flex; flex-direction: column;">
[[Link|<span class="celta-sys-btn"><i class="bi bi-house"></i> Botão 1</span>]]
</div>
</div>