Ativa o menu
Alternar menu de preferências
Alternar menu pessoal
Não autenticado(a)
Your IP address will be publicly visible if you make any edits.

Ajuda:Guia de Estilo: mudanças entre as edições

De Celta Sistemas Wiki
Sem resumo de edição
Sem resumo de edição
 
(32 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
{{Cabecalho
{{Cabecalho
  | [[Interno]]
  |
  | Guia Rápido de Edição (Padrão Visual)
  | Guia de Estilo e Padrões
}}
}}


Use os blocos abaixo para manter o padrão visual das documentações do Celta.
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. O Cabeçalho (Obrigatório) ==
__TOC__
Toda página DEVE começar com este código. Ele gera o título, a navegação e a data automaticamente.
 
== 1. Cabeçalho da Página ==
Use sempre na primeira linha da página.
 
=== Exemplo Padrão (Manuais e Tutoriais) ===
 
<pre><nowiki>
{{Cabecalho
| [[Tutoriais]] › [[Sub-rotina]]
| Título da Página de *Exemplo*
}}
</nowiki></pre>
 
'''Resultado:'''


<pre>
{{Cabecalho
{{Cabecalho
  | [[Módulo Pai]] › [[Sub-rotina]]
  | [[Módulo Pai]] › [[Sub-rotina]]
  | Título da Página
  | Título da Página de *Exemplo*
}}
}}
O texto de introdução/resumo vai aqui, logo abaixo do cabeçalho.
 
</pre>
=== Invisível (Dashboards e Hubs) ===
 
<pre><nowiki>
{{Cabecalho | [[Invisível (Dashboards e Hubs)]] | no}}
</nowiki></pre>
 
'''Resultado:'''
 
{{Cabecalho | [[Invisível (Dashboards e Hubs)]] | no}}
 
----
 
== 2. Caixas de Aviso (Notas) ==
Sintaxe:
<pre><nowiki>
{{Nota | tipo | TÍTULO | Texto...}}
</nowiki></pre>
 
=== Tipo: Dica / Informação ===
 
<pre><nowiki>
{{Nota|info|DICA|Texto da dica ou informação complementar.}}
</nowiki></pre>
 
'''Resultado:'''
{{Nota|info|DICA|Texto da dica ou informação complementar.}}
 
=== Tipo: Sucesso / Novidade ===
 
<pre><nowiki>
{{Nota|success|SUCESSO|Para novidades ou boas práticas.}}
</nowiki></pre>
 
'''Resultado:'''
{{Nota|success|SUCESSO|Para novidades ou boas práticas.}}
 
=== Tipo: Atenção / Alerta ===
 
<pre><nowiki>
{{Nota|warning|ATENÇÃO|Alertas que requerem cuidado.}}
</nowiki></pre>
 
'''Resultado:'''
{{Nota|warning|ATENÇÃO|Alertas que requerem cuidado.}}
 
=== Tipo: Crítico / Erro ===
 
<pre><nowiki>
{{Nota|danger|CRÍTICO|Risco de perda de dados ou bloqueios.}}
</nowiki></pre>
 
'''Resultado:'''
{{Nota|danger|CRÍTICO|Risco de perda de dados ou bloqueios.}}


----
----


== 2. Caixas de Destaque (Notas) ==
== 3. Tabela de Campos ==
Use para Dicas, Avisos ou Observações importantes.
Use para listar parâmetros. Utilize `1=` e `2=` para evitar quebras.
 
=== Exemplo de Tabela ===


'''Código:'''
<pre><nowiki>
<pre>
{{TabelaCampos|
{{Nota|TÍTULO DA DICA|
  {{Linha
Escreva o texto da observação aqui.
  | 1= Nome do Campo
  | 2= Explicação do campo.
  }}
  {{Linha
  | 1= Outro Parâmetro
  | 2= Explicação com lista:
* Item A
* Item B
  }}
}}
}}
</pre>
</nowiki></pre>
 
'''Resultado:'''


'''Visualização:'''
{{TabelaCampos|
{{Nota|TÍTULO DA DICA|Escreva o texto da observação aqui.}}
  {{Linha
  | 1= Nome do Campo
  | 2= Explicação do campo.
  }}
  {{Linha
  | 1= Outro Parâmetro
  | 2= Explicação com lista:
* Item A
* Item B
  }}
}}


----
----


== 3. Badges (Etiquetas de Versão) ==
== 4. Cards e Menus ==
Use ao lado de títulos para indicar novidades ou versão mínima.
 
=== 4.1. Cards Simples ===
 
<pre><nowiki>
<div class="celta-grid">
  {{Card | titulo=Dicas | texto=Texto do card...}}
  {{Card | titulo=Manual | texto=Texto do card...}}
</div>
</nowiki></pre>
 
'''Resultado:'''
 
<div class="celta-grid">
  {{Card | titulo=Dicas | texto=Texto do card...}}
  {{Card | titulo=Manual | texto=Texto do card...}}
</div>
 
=== 4.2. Menus de Navegação (Hubs) ===
Cores: `blue`, `dark`, `orange`, `green`, `red`.
 
<pre><nowiki>
<div class="celta-grid">
{{CardMenu
| cor = orange
| icone = bi-star
| titulo = Favoritos
| conteudo =
* [[Link 1]]
* [[Link 2]]
}}
</div>
</nowiki></pre>
 
'''Resultado:'''
 
<div class="celta-grid">
{{CardMenu
| cor = orange
| icone = bi-star
| titulo = Favoritos
| conteudo =
* [[Página principal|Link Exemplo 1]]
* [[Página principal|Link Exemplo 2]]
}}
</div>
 
=== 4.3. Listas de Links (CardLista) ===
Usado para listas limpas sem borda colorida (Ex: Acesso Rápido).
* **Atenção:** Os asteriscos (*) devem ficar colados na margem esquerda.
 
<pre><nowiki>
<div class="celta-grid">
{{CardLista
| icone = bi-lightning-fill
| cor = #f59e0b
| titulo = Acesso Rápido
| conteudo =
* [[Link 1]]
* [[Link 2]]
}}
</div>
</nowiki></pre>


'''Código:'''
'''Resultado:'''
<pre>
== Configuração {{Badge|novo|Versão 2025}} ==
</pre>


'''Visualização:'''
<div class="celta-grid">
<div style="font-size:1.5em; font-weight:bold; border-bottom:1px solid #eee; border-left:5px solid #3366cc; padding-left:15px;">
{{CardLista
Configuração {{Badge|novo|Versão 2025}}
| icone = bi-lightning-fill
| cor = #f59e0b
| titulo = Acesso Rápido
| conteudo =
* [[Página principal|Link 1]]
* [[Página principal|Link 2]]
}}
</div>
</div>


----
----


== 4. Imagens (Prints) ==
== 5. Ícones ==
Use sempre este padrão para telas do sistema. Não use o comando "File" direto.
 
O Wiki utiliza a biblioteca '''Bootstrap Icons''': [https://icons.getbootstrap.com/ Galeria Oficial].
 
* **Uso em Cards:** Passe o nome da classe no parâmetro `icone` (Ex: `icone = bi-gear`).
* **Uso no Texto:** Use a tag `<i>`:
*: ` <i class="bi bi-check-circle"></i> ` -> <i class="bi bi-check-circle"></i>
 
----
 
== 6. Imagens e Badges ==
 
=== 6.1. Prints de Tela ===
 
<pre><nowiki>
{{Print|Nome_do_Arquivo.png|Legenda da imagem}}
</nowiki></pre>
 
=== 6.2. Etiquetas de Versão ===
 
<pre><nowiki>
Funcionalidade Nova {{Badge|novo|v15.0}}
</nowiki></pre>
 
'''Resultado:'''
 
Funcionalidade Nova {{Badge|novo|v15.0}}
 
=== 6.3. Logo Oficial (SVG) ===
Exibe a logo vetorizada do sistema.
* **Uso:** `{{Logo|width=200px}}`
 
'''Resultado:'''
{{Logo|width=200px}}
 
----
 
== 7. Rodapé de Contato ==
Adicione apenas o código abaixo no final das páginas.
 
=== Suporte Técnico (Padrão) ===


'''Código:'''
<pre><nowiki>
<pre>
{{ContatoSuporte}}
{{Print|Nome_do_Arquivo.png|Legenda descrevendo a imagem}}
</nowiki></pre>
</pre>
 
'''Resultado:'''
 
{{ContatoSuporte}}
 
=== Financeiro / Comercial ===
 
<pre><nowiki>
{{ContatoFinanceiro}}
</nowiki></pre>
 
'''Resultado:'''
 
{{ContatoFinanceiro}}


----
----


== 5. Template Base (Copiar e Colar) ==
== 8. Template Base (Copiar e Colar) ==
''Copie o bloco abaixo para iniciar uma nova página rapidamente:''
Copie este bloco para iniciar uma nova página.


<pre>
<pre><nowiki>
{{Cabecalho
{{Cabecalho
  | [[Módulo]] › [[Funcionalidade]]
  | [[Módulo]] › [[Funcionalidade]]
Linha 68: Linha 270:
}}
}}


Breve resumo do que este manual ensina.
Resumo da funcionalidade.
 
{{Nota|info|PRÉ-REQUISITO|Necessário estar na versão 15.0 ou superior.}}


== 1. Visão Geral ==
== 1. Visão Geral ==
Texto explicativo...
Explicação do conceito...
 
== 2. Configuração ==
Acesse o menu '''Cadastro > Operações'''.


{{Nota|IMPORTANTE|
{{TabelaCampos|
Informação crítica que o usuário não pode esquecer.
  {{Linha
  | 1= Nome do Campo
  | 2= Explicação do campo.
  }}
}}
}}


== 2. Passo a Passo ==
== 3. Passo a Passo ==
# Acesse o menu '''Cadastro''';
# Clique em '''Incluir''';
# Clique em '''Incluir''';
#: {{Print|imagem_exemplo.jpg|Tela de inclusão}}
# Preencha os dados;
# Preencha os campos e salve.
#: {{Print|Exemplo_Tela.png|Tela de cadastro}}
# Clique em '''Gravar'''.


[[Categoria:Manual]]
{{ContatoSuporte}}
</pre>
</nowiki></pre>

Edição atual tal como às 21h26min de 1 de dezembro de 2025

Guia de Estilo e Padrões

Atualizado em: 01/12/2025

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 da Página

Use sempre na primeira linha da página.

Exemplo Padrão (Manuais e Tutoriais)

{{Cabecalho
 | [[Tutoriais]] › [[Sub-rotina]]
 | Título da Página de *Exemplo*
}}

Resultado:

Título da Página de *Exemplo*

Atualizado em: 01/12/2025

Invisível (Dashboards e Hubs)

{{Cabecalho | [[Invisível (Dashboards e Hubs)]] | no}}

Resultado:


2. Caixas de Aviso (Notas)

Sintaxe:

{{Nota | tipo | TÍTULO | Texto...}}

Tipo: Dica / Informação

{{Nota|info|DICA|Texto da dica ou informação complementar.}}

Resultado:

DICA

Texto da dica ou informação complementar.

Tipo: Sucesso / Novidade

{{Nota|success|SUCESSO|Para novidades ou boas práticas.}}

Resultado:

SUCESSO

Para novidades ou boas práticas.

Tipo: Atenção / Alerta

{{Nota|warning|ATENÇÃO|Alertas que requerem cuidado.}}

Resultado:

ATENÇÃO

Alertas que requerem cuidado.

Tipo: Crítico / Erro

{{Nota|danger|CRÍTICO|Risco de perda de dados ou bloqueios.}}

Resultado:

CRÍTICO

Risco de perda de dados ou bloqueios.


3. Tabela de Campos

Use para listar parâmetros. Utilize `1=` e `2=` para evitar quebras.

Exemplo de Tabela

{{TabelaCampos|
  {{Linha
   | 1= Nome do Campo
   | 2= Explicação do campo.
  }}
  {{Linha
   | 1= Outro Parâmetro
   | 2= Explicação com lista:
* Item A
* Item B
  }}
}}

Resultado:

Campo / Parâmetro Função e Instruções
Nome do Campo Explicação do campo.
Outro Parâmetro Explicação com lista:
  • Item A
  • Item B

4. Cards e Menus

4.1. Cards Simples

<div class="celta-grid">
  {{Card | titulo=Dicas | texto=Texto do card...}}
  {{Card | titulo=Manual | texto=Texto do card...}}
</div>

Resultado:

Dicas

Texto do card...

Manual

Texto do card...

4.2. Menus de Navegação (Hubs)

Cores: `blue`, `dark`, `orange`, `green`, `red`.

<div class="celta-grid">
{{CardMenu
 | cor = orange
 | icone = bi-star
 | titulo = Favoritos
 | conteudo = 
* [[Link 1]]
* [[Link 2]]
}}
</div>

Resultado:

Usado para listas limpas sem borda colorida (Ex: Acesso Rápido).

  • **Atenção:** Os asteriscos (*) devem ficar colados na margem esquerda.
<div class="celta-grid">
{{CardLista
 | icone = bi-lightning-fill
 | cor = #f59e0b
 | titulo = Acesso Rápido
 | conteudo =
* [[Link 1]]
* [[Link 2]]
}}
</div>

Resultado:

Acesso Rápido


5. Ícones

O Wiki utiliza a biblioteca Bootstrap Icons: Galeria Oficial.

  • **Uso em Cards:** Passe o nome da classe no parâmetro `icone` (Ex: `icone = bi-gear`).
  • **Uso no Texto:** Use a tag ``:
    ` ` ->

6. Imagens e Badges

6.1. Prints de Tela

{{Print|Nome_do_Arquivo.png|Legenda da imagem}}

6.2. Etiquetas de Versão

Funcionalidade Nova {{Badge|novo|v15.0}}

Resultado:

Funcionalidade Nova v15.0

6.3. Logo Oficial (SVG)

Exibe a logo vetorizada do sistema.

  • **Uso:** `
    `

Resultado:


7. Rodapé de Contato

Adicione apenas o código abaixo no final das páginas.

Suporte Técnico (Padrão)

{{ContatoSuporte}}

Resultado:



Financeiro / Comercial

{{ContatoFinanceiro}}

Resultado:


8. Template Base (Copiar e Colar)

Copie este bloco para iniciar uma nova página.

{{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
   | 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}}