Shortcodes disponíveis · Do Básico ao Avançado em Leitura e Anotações

Shortcodes

Shortcodes são macros de template que permitem inserir elementos dinâmicos nas páginas deste site. São úteis para citações, referências bibliográficas e figuras com legendas padronizadas.

Todos os shortcodes abaixo estão disponíveis em qualquer arquivo .md dentro do diretório content/.

`cite(id="...")`

Insere uma referência inline ao autor ou estudo correspondente, formatada de acordo com o estilo acadêmico.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	sim	Identificador da referência em `data/references.yaml`

Exemplo


<sup class="citation" data-ref-id="roediger2006"><a href="#ref-roediger2006" id="cite-roediger2006">[roediger2006]</a></sup>

Saída

Roediger e Karpicke ^{[roediger2006]} demonstraram que a prática de recuperação supera a releitura em testes de retenção.

Notas para contribuidores

Os IDs válidos correspondem às entradas em data/references.yaml. Não invente IDs.
Para citações com dois autores, use "X e Y" na forma verbal: "Roediger e Karpicke".
Para três ou mais autores, use "X et al.": "Dunlosky et al. ^{[dunlosky2013]} ".
Em caso de dúvida sobre qual ID usar, consulte referências bibliográficas.

`bib()`

Insere uma lista completa de todas as referências bibliográficas cadastradas em data/references.yaml, formatadas em estilo APA simplificado.

Parâmetros

Nenhum.

Exemplo

<section class="relacionados">
  <h2>Artigos relacionados</h2>
  <ul>
    <li><a href="https://pages.singularjourney.org/devjonatas/guia-livros-anotacoes/recursos/glossario/">Glossário de termos e métodos</a> — glossario dos termos e metodos citados no guia, de aprendizagem baseada em evidencia…</li>
    <li><a href="https://pages.singularjourney.org/devjonatas/guia-livros-anotacoes/recursos/faq/">Perguntas frequentes</a> — respostas curtas às dúvidas mais comuns sobre leitura, anotação, ferramentas e o que…</li>
    <li><a href="https://pages.singularjourney.org/devjonatas/guia-livros-anotacoes/recursos/referencias-bibliograficas/">Referências bibliográficas</a> — todas as fontes usadas no guia, em ordem alfabetica: pesquisa cognitiva, estudos…</li>
    <li><a href="https://pages.singularjourney.org/devjonatas/guia-livros-anotacoes/enciclopedia/conceitos/curva-do-esquecimento/">A curva do esquecimento</a> — O que Ebbinghaus mediu em 1885, o que a curva realmente prevê, e os quatro…</li>
  </ul>
</section>


{{ bib() }}

Saída

A saída é uma lista formatada de todas as referências, renderizada pelo tema como uma seção de bibliografia ao final da página.

Notas para contribuidores

Use {{ bib() }} uma única vez, ao final de cada página que contenha referências.
Não é necessário incluir todas as referências da base — apenas as que foram efetivamente citadas com {{ cite(...) }} na página.
A ordem de exibição é alfabética por sobrenome do primeiro autor.

`figure(src="..." alt="..." caption="...")`

Insere uma figura com legenda, alt text e caption padronizados.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`src`	string	sim	Caminho para a imagem (relativo a `static/`)
`alt`	string	sim	Texto alternativo para acessibilidade
`caption`	string	sim	Legenda explicativa da figura

Exemplo


<figure>
  <img src="images&#x2F;metodo-cornell.jpg" alt="Diagrama do método Cornell com as três áreas da página" loading="lazy">
  <figcaption>Figura 1: Método Cornell — divisão da página em pistas, notas e resumo</figcaption></figure>

Saída

A saída é um elemento <figure> HTML com <img> e <figcaption> adequadamente formatados pelo tema.

Notas para contribuidores

Sempre inclua alt descritivo para acessibilidade (leitores de tela).
O caption aparece abaixo da imagem e deve complementar, não repetir, o texto circundante.
Imagens devem ser armazenadas em static/images/ ou subdiretórios equivalentes.
Caminhos devem ser relativos ao diretório static/, sem o prefixo static/.

Boas práticas

Use cite() para qualquer afirmação que se baseie em uma fonte específica.
Inclua bib() apenas em páginas que usam pelo menos uma citação.
Sempre verifique o ID antes de usar — referências com ID inexistente não serão renderizadas.
Para adicionar novas referências ao sistema, edite data/references.yaml seguindo o formato existente (cada entrada com id, type, author, year, title, e demais campos relevantes).

Referências

Dunlosky, J.; Rawson, K. A.; Marsh, E. J.; Nathan, M. J.; Willingham, D. T. (2013). Improving Students' Learning With Effective Learning Techniques: Promising Directions From Cognitive and Educational Psychology., Psychological Science in the Public Interest 14(1), pp. 4-58 DOI: 10.1177/1529100612453266
Roediger, H. L. III; Karpicke, J. D. (2006). Test-Enhanced Learning: Taking Memory Tests Improves Long-Term Retention., Psychological Science 17(3), pp. 249-255 DOI: 10.1111/j.1467-9280.2006.01693.x