OKF — Open Knowledge Format

Última revisão: 2026-09-04

OKF (Open Knowledge Format) é uma convenção aberta para coleções de conhecimento em Markdown: arquivos Markdown puros com um cabeçalho de frontmatter pequeno e uniforme. Esta página explica o que é o OKF, o que o Plainva faz automaticamente por ele — e por que você não precisa usar nada disso.

O que é o OKF?

A ideia: todo documento no vault diz por si mesmo o que ele é. Um cabeçalho mínimo no frontmatter já basta:

---
type: Note
---
# Minha nota

Vai escrever arquivos com uma ferramenta ou script? O contrato exato de campos — valores permitidos, como cada tipo de propriedade é serializado e as regras de nomes reservados — está na Referência do Formato de Arquivo.

De onde vem o OKF: o OKF é uma especificação aberta do Google Cloud (GoogleCloudPlatform/knowledge-catalog, licença Apache-2.0). O Plainva segue o OKF 0.2 (publicado em 25 de julho de 2026). Novos na 0.2 são cinco campos opcionais com os quais uma nota diz de onde veio, se alguém a revisou e se ela ainda vale — generated, verified, sources, stale_after e status. O que o Plainva mostra e escreve deles está descrito abaixo, em “Proveniência, revisão e ciclo de vida”.

Por que o Plainva usa o OKF?

O Markdown puro é maravilhosamente portátil — mas, sozinho, não tem nenhuma estrutura confiável. O OKF acrescenta exatamente a estrutura que falta, e tudo continua sendo Markdown comum com frontmatter padrão:

O que o Plainva faz automaticamente

Arquivos novos recebem o cabeçalho OKF automaticamente: toda nota criada no Plainva recebe type no frontmatter — desde o OKF 0.2, o marcador de versão okf_version mora uma vez no index.md raiz, não mais em cada nota. Você configura os valores por vault: Configurações → Vault → Conteúdo e estrutura → OKF (Open Knowledge Format)type para novas notas (padrão Note) e type para notas diárias (padrão Daily Note). Se um modelo traz seu próprio type, o modelo prevalece.

Arquivos existentes nunca são alterados sem que você peça. O Plainva só adiciona campos OKF ao criar novos arquivos ou quando você inicia explicitamente a conversão.

Campos de sistema protegidos: no painel de Propriedades, type e — onde notas mais antigas ainda o carregam — okf_version são marcados como campos de sistema do OKF (“Campo de sistema do OKF – gerenciado pelo Plainva”): o valor de type é selecionável em uma lista suspensa de tipos conhecidos, okf_version é somente exibição; renomear, trocar o tipo e excluir ficam travados para que a convenção não se quebre por acidente.

O explicador: O que é OKF? nas configurações te dá a versão resumida em três frases, além de um link para esta página. Ele não abre mais sozinho; se um vault contém arquivos que não seguem o formato OKF, o Plainva avisa isso uma vez em uma pequena mensagem com um botão que leva direto à conversão.

Proveniência, revisão e ciclo de vida (OKF 0.2)

Desde o OKF 0.2, uma nota pode dizer de onde veio, quem a revisou e se ela ainda vale. O Plainva transforma isso em três coisas:

O que o Plainva mostra.

O que o Plainva escreve.

Atualizando a versão do bundle. A versão da convenção mora uma vez no index.md raiz. Um vault que ainda declara "0.1" continua funcionando sem alterações — em Configurações → Vault → Conteúdo e estrutura → Versão do bundle (no celular: Configurações → Vault → Manutenção → Versão do bundle) você a atualiza para 0.2 com Atualizar…. O diálogo mostra de antemão o que muda: a linha no index.md raiz e, como uma caixa de seleção (ativada por padrão), a remoção do campo legado okf_version das notas que ainda o carregam. Todo arquivo é copiado como backup antes de ser alterado; Limpar… faz apenas a segunda parte. A tabela de campos e as regras de escrita em detalhe estão na Referência do Formato de Arquivo.

index.md: o sumário por pasta

Um index.md é o sumário de uma pasta: uma lista das notas e subpastas que ela contém, com descrições e links relativos.

Convertendo um vault existente (opt-in)

Se arquivos no vault não seguem o formato OKF (campo type ausente, ou nomes reservados usados como notas comuns), o Plainva oferece a conversão — uma vez ao abrir o vault, e permanentemente em Configurações → Vault → Conteúdo e estrutura (o item só aparece enquanto houver algo a fazer).

O assistente Converter para o formato OKF trabalha em etapas claras:

  1. Verificação — mostra quantos arquivos são afetados (pastas de modelos e de sistema são excluídas; arquivos com frontmatter ilegível são ignorados, nunca “consertados”).
  2. Decisões — um type padrão para arquivos sem um; valores de type existentes podem ser mantidos (recomendado — já são tipos OKF válidos) ou renomeados para outro campo.
  3. Pré-visualização (sem alterações) — uma simulação mostra antecipadamente o que mudaria.
  4. Converter — cada arquivo é copiado para .plainva/backups/ antes de ser alterado; um relatório resume o que mudou, o que foi ignorado e a pasta de backup. Depois você pode opcionalmente continuar para o gerenciador de index.md.

Uma dica do assistente: as alterações passam pela sincronização normalmente — em vaults com git, faça commit antes.

No telefone

O mesmo caminho existe no celular: Configurações → Vault → Manutenção → Converter para o formato OKF. As etapas são as mesmas — varredura, decisões, prévia, conversão — e a prévia nomeia as notas afetadas antes de qualquer coisa ser escrita.

Duas coisas se somam, porque um telefone pode tirar um app da memória a qualquer momento:

Reverter restaura os arquivos a partir da pasta de backup — no desktop também, pelo relatório ao final da execução. A pasta de backup permanece depois; ela é a única cópia do estado anterior à conversão.

Preciso usar o OKF?

Não. O OKF é um padrão suave:

Veja também