Fernando: Criação da documentação técnica e guia de manutenção do recurso de segredos

2026-09-01T20:28:26Z

Criação da documentação técnica e guia de manutenção do recurso de segredos

New page

__NOTOC__
= 🔒 Recurso de Censura & Segredos — Guia Técnico Interno =

Este artigo documenta a arquitetura, parâmetros, arquivos envolvidos e procedimentos de manutenção do '''recurso de Censura e Segredos Dinâmicos''' implementado no wiki da crônica Vampiro: A Máscara.

----

== 🩸 Visão Geral ==

O recurso permite que o '''Narrador''' ou '''criador de um artigo''' oculte trechos de texto sensível sob uma '''tarja preta sólida''' (estética de documentos censurados / dossiês da Segunda Inquisição). O texto fica invisível para todos os leitores até que:

# O criador '''libere manualmente''' (alterando para <code>liberado=sim</code>); ou
# Uma '''data de desclassificação''' programada seja atingida (<code>data=2026-10-15</code>).

Ao passar o mouse sobre a tarja, o leitor vê o tooltip temático: <code>[INFORMAÇÃO SENSÍVEL - BLOQUEADO PELA CAMARILLA]</code>.

----

== 📁 Arquivos Envolvidos no Sistema ==

{| class="wikitable" style="width:100%;"
! Arquivo !! Localização !! Função
|-
| '''Template:Segredo''' || <code>Template:Segredo</code> || Predefinição que gera a tag <code><span></code> com atributos <code>data-*</code>
|-
| '''MediaWiki:Common.js''' || <code>MediaWiki:Common.js</code> || Lógica de revelação por data/status, botões na toolbar e alternância visual [CENSURADO | LIBERADO]
|-
| '''MediaWiki:Common.css''' || <code>MediaWiki:Common.css</code> (seção 14) || Estilos visuais da tarja (censurado, revelado e bloco)
|-
| '''MediaWiki:Vector-2022.css''' || <code>MediaWiki:Vector-2022.css</code> (seção 14) || Espelho dos estilos para o skin Vector 2022
|}

----

== ⚙️ Parâmetros da Predefinição ==

Uso básico: <code><nowiki>{{Segredo|Texto confidencial|liberado=nao}}</nowiki></code>

{| class="wikitable" style="width:100%;"
! Parâmetro !! Obrigatório !! Tipo !! Valores !! Descrição
|-
| <code>1</code> (sem nome) || '''Sim''' || Texto || Qualquer texto || O conteúdo que ficará oculto sob a tarja preta.
|-
| <code>liberado</code> || Não || String || <code>nao</code> / <code>sim</code> || Controle manual de liberação. Padrão: <code>nao</code> (censurado).
|-
| <code>data</code> || Não || Data || <code>AAAA-MM-DD</code> ou <code>DD/MM/AAAA</code> || Data a partir da qual o texto será desclassificado automaticamente.
|-
| <code>tipo</code> || Não || String || <code>inline</code> / <code>bloco</code> || <code>inline</code> = tarja no meio da frase. <code>bloco</code> = caixa de dossiê completa. Padrão: <code>inline</code>.
|-
| <code>dica</code> || Não || String || Texto livre || Nome-código exibido no tooltip (ex: "Identidade do Infiltrado").
|-
| <code>nivel</code> || Não || String || Texto livre || Nível de sigilo para o carimbo no formato bloco. Padrão: <code>CONFIDENCIAL</code>.
|}

----

== 📖 Exemplos Práticos de Uso ==

=== 1. Tarja Inline com Liberação Manual ===
<pre>
O traidor foi identificado como {{Segredo|Padre Tiago|liberado=nao|dica=Identidade do Infiltrado}}.
</pre>
'''Resultado para o leitor:''' O traidor foi identificado como {{Segredo|Padre Tiago|liberado=nao|dica=Identidade do Infiltrado}}.

=== 2. Tarja Inline com Liberação por Data ===
<pre>
A localização do refúgio é {{Segredo|Cripta da Sé de Lisboa|data=2027-01-01}}.
</pre>
O texto permanecerá coberto até 01/01/2027, quando será revelado automaticamente.

=== 3. Tarja Já Liberada (Texto Visível) ===
<pre>
O líder da revolta era {{Segredo|Aiden, o Monstro das Catacumbas|liberado=sim}}.
</pre>
'''Resultado:''' O líder da revolta era {{Segredo|Aiden, o Monstro das Catacumbas|liberado=sim}}.

=== 4. Dossiê em Bloco (Relatório Completo) ===
<pre>
{{Segredo|tipo=bloco|nivel=RELATÓRIO SAD // CONFIDENCIAL|data=2027-06-01|dica=Operação Lisboa|
O destacamento interceptou três mensageiros no Parque das Nações.
Foram confiscadas três chaves criptografadas e um diário de sangue pertencente a Duarte Montenegro.
}}
</pre>

----

== 🛠️ Ferramentas no Editor ==

=== 1. Barra de Ferramentas Rápida (Editor de Código-Fonte) ===
Ao editar pelo código-fonte, uma barra temática com borda carmesim aparece logo acima do campo de digitação:
* '''⬛ Censurar Trecho''' — Envolve a seleção com <code><nowiki>{{Segredo|...|liberado=nao}}</nowiki></code>.
* '''🔓 Inserir Liberado''' — Envolve a seleção com <code><nowiki>{{Segredo|...|liberado=sim}}</nowiki></code>.
* '''📁 Dossiê Bloco''' — Insere a estrutura completa de um relatório confidencial.
* '''🗑️ Remover Censura''' — Remove a predefinição mantendo o texto interno limpo.

=== 2. Botões Interativos no Modal do VisualEditor ===
Ao editar a predefinição pelo VisualEditor:
* O campo textual de <code>liberado</code> é substituído por botões clicáveis:
* '''[ ⬛ CENSURADO ]''' (vermelho escuro)
* '''[ 🔓 LIBERADO ]''' (verde esmeralda)

=== 3. Menu Inserir do VisualEditor ===
* Opção '''🔒 Censura / Segredo (Confidencial)''' disponível no menu superior de inserção.

----

== 🔍 Arquitetura e Linhas de Código Importantes ==

=== Lógica de Revelação (MediaWiki:Common.js) ===
A função <code>initVtmSecrets()</code> avalia a revelação segundo a seguinte precedência:
# Se <code>data-liberado === "sim"</code> (ou "true"/"1") → Adiciona <code>.is-revealed</code> (texto visível).
# Se <code>data-liberado === "nao"</code> → Adiciona <code>.is-redacted</code> (tarja preta ativa).
# Se houver <code>data-reveal-date</code> → Compara com <code>new Date()</code>:
#* Se <code>agora >= data</code> → Revela automaticamente.
#* Se <code>agora < data</code> → Mantém censurado e exibe a data formatada no tooltip.
# Padrão: <code>.is-redacted</code>.

=== Estilos Visuais (MediaWiki:Common.css) ===
* <code>.vtm-segredo.is-redacted</code>: <code>background: #0a0a0e; color: transparent; user-select: none;</code>
* <code>.vtm-segredo.is-revealed</code>: <code>background: rgba(45,12,18,.4); color: #f5f0e6; font-family: 'Special Elite';</code>
* <code>.vtm-segredo[data-tipo="bloco"]</code>: <code>display: block; border-left: 4px solid;</code>

----

== 🔧 Guia para Edições e Manutenções Futuras ==

=== Como alterar o texto do tooltip da Camarilla? ===
Edite <code>MediaWiki:Common.js</code> e altere os textos dentro das variáveis <code>tip</code> nas linhas ~19 e ~24:
<pre>
tip = '[INFORMAÇÃO SENSÍVEL - BLOQUEADO PELA CAMARILLA' + (dica ? ' // ' + dica : '') + ']';
</pre>

=== Como mudar a cor da tarja? ===
Edite a seção '''14. TARJA DE CENSURA''' em <code>MediaWiki:Common.css</code> e <code>MediaWiki:Vector-2022.css</code>:
* Altere <code>background: #0a0a0e</code> na regra <code>.vtm-segredo.is-redacted</code>.

=== Como adicionar novos campos ao Segredo? ===
# Adicione o atributo no <code>Template:Segredo</code>: <code>data-novo-parametro="{{{novo|}}}"</code>.
# Leia o atributo em <code>MediaWiki:Common.js</code> dentro de <code>initVtmSecrets()</code>: <code>el.getAttribute('data-novo-parametro')</code>.
# Atualize a seção <code><templatedata></code> na documentação do template.

[[Categoria:Documentação]]
[[Categoria:Ajuda]]

Ajuda:Recurso de Censura e Segredos - Revision history

Fernando: Criação da documentação técnica e guia de manutenção do recurso de segredos