Como criar elementos - abntex/limarka GitHub Wiki
O limarka utiliza o Markdown do pandoc, com a extensão raw_tex, para possibilitar inclusão de código latex no texto.
# Título do Capítulo
## Título da seção
### Título da subseção
#### Título da subsubseção
##### Título da seção quináriaSegue exemplo de capítulos e seções reais:
# Introdução
## Motivação
## Objetivos
### Objetivo geral
### Objetivos específicos
# Fundamentação teóricaNormas da ABNT: Cada capítulo deve iniciar numa página impar (feito automaticamente pelo abnTeX, que adiciona páginas em branco se necessário).
Os parágrafos terminam quando encontram uma linha em branco.
Mesmo que eu digite um texto
quebrado em várias linhas,
mesmo assim,
ele será apresentado como um único parágrafo.
Aqui é o inicia um novo parágrafo.
Formatação: *palavras em itálico*, **palavras em negrito**.
Normas da ABNT: O negrito não é obrigatório. Se desejar pode utilizar apenas itálico para destacar as palavras.
Texto -- exemplo de travessão.
Os comentários ou notas invisíveis são conteúdos que não irão aparecer no texto. Você pode utilizá-los para adicionar lembretes, informações adicionais, trechos dos textos citados, etc. Veja a sintaxe através do seguinte exemplo:
<!-- Lembrar de adicionar
uma imagem aqui -->- Objetivo 1;
- Objetivo 2;
- Objetivo 3.Ou também:
* Objetivo 1;
* Objetivo 2;
* Objetivo 3.1. Primeiro item da lista;
2. Segundo item da lista;
3. Terceiro item da lista.a. Primeiro item da lista;
b. Segundo item da lista;
c. Terceiro item da lista.Ou também:
a) Primeiro item da lista;
b) Segundo item da lista;
c) Terceiro item da lista.O limarka através do subprojeto pandoc_abnt implementa diversas correções automáticas, consulte a documentação desse subprojeto para entendê-las.
Exemplo de nota de rodapé:
Adoro várias frutas: banana, caju e morango.[^morango]
[^morango]: Morango não é fruta.
O código latex pode ser inserido ao longo do texto:
\begin{array}{c|c}
1 & 2 \\
\hline
3 & 4
\end{array}
Inclusive dentro do parágrafo, como podemos ver: \sqrt{81}.
As normas da ABNT exigem que as Figuras e Tabelas obrigatoriamente possuam legenda, fonte e sejam referenciadas o mais próximo possível.
IMPORTANTE: Infelizmente a sintaxe do Markdown não é expressiva suficientemente para atender essas exigências para as Imagens e Tabelas. A solução temporária era incluir e referenciar as imagens e tabelas através de códigos em Latex. No entanto, com a criação do filtro pandoc_abnt agora é possível utilizar uma sintaxe mais simples para imagens.
As seções seguintes apresentam como inserir Imagens e Tabelas com o abnTeX2 para produzir documentos em conformidade com a ABNT.
As Figuras deverão ser salvas no diretório imagens e incluídas, referenciadas e descritas com código Latex.
Segundo as normas da ABNT todas as figuras devem obrigatoriamente:
- Conter uma legenda que a descreva
- Conter sua fonte
- Ser referenciada no texto o mais próximo possível (para referenciar é necessário criar um rótulo)
Nessa sintaxe é necessário que Fonte: seja digitado no próximo parágrafo após a imagem. O largura é opcional, equivale ao tamanho da figura em relação a largura da página. O \autoref deve ser utilizado no texto para referenciar a imagem através de seu rótulo.
{#rotulo largura=100%}
Fonte: Autor.
Referenciando no texto:
Ver \autoref{rotulo}.
Ou
Ver Figura \ref{rotulo}.Exemplo:
{#passarinho largura=30%}
Fonte: Autor.
Ver \autoref{passarinho}.
OBS: Essa sintaxe funciona a partir da versão v0.7.0 do limarka, com pandoc_abnt v0.1.2 ou superior.
Nas versões do limarka anteriores a v0.7.0 as figuras eram inseridas com código latex, as seções a seguir descrevem funcionalidades para auxiliar a inserção de figuras com código latex.
Utilize o subcomando fig para selecionar uma imagem, incluí-la e referenciá-la.
$ limarka fig imagens/passaro.jpg
<!--
Para referenciar essa figura no texto utilize: Figura \ref{fig:passaro}
-->
\begin{figure}[htbp]
\caption{\label{fig:passaro}Legenda da figura.}
\begin{center}
\includegraphics[width=1.0\textwidth]{imagens/passaro.jpg}
\end{center}
\legend{Fonte: Autor.}
\end{figure}O código gerado pode ser copiado e colado diretamente no arquivo de texto Markdown. O trecho entre <!-- --> é um comentário que PODE ser mantido no texto, ele informa como referenciar a figura no texto. Edite a legenda e a fonte. Veja um exemplo no texto:
Na Figura \ref{fig:passaro} é apresentado o bonito-do-campo (*Chlorophonia cyanea*) uma ave passeriforme
brasileira da família dos emberizídeos. Os machos de tais aves têm as cabeças, gargantas e peitos verdes,
alto dorso e uropígio azuis, ventre amarelo dourado, enquanto as fêmeas diferem apenas pela ausência de
azul no uropígio .
<!--
Para referenciar essa figura no texto utilize: Figura \ref{fig:passaro}
-->
\begin{figure}[htbp]
\caption{\label{fig:passaro}Ave com as cores da bandeira do Brasil.}
\begin{center}
\includegraphics[width=1.0\textwidth]{imagens/passaro.jpg}
\end{center}
\legend{Fonte: Autor.}
\end{figure}
(...)Se o nome do arquivo não for especificado é solicitado ao usuário escolher qual arquivo (dentro do diretório imagens) será utilizado. Suponha um diretório imagens com o seguinte conteúdo:
imagens/
|-- computador.jpg
|-- mouse.jpg
|-- passaro.jpg
`-- telefone.jpg
$ limarka fig
Ao invocar o comando sem o nome do arquivo o limarka solicita ao usuário escolher o arquivo:
$ limarka fig
1 imagens/computador.jpg
2 imagens/mouse.jpg
3 imagens/passaro.jpg
4 imagens/telefone.jpg
Escolha um arquivo para a Figura: 3
Em seguida o código Latex é gerado da mesma forma anterior.
Se invocado com o parâmetro -i, todos os parâmetros serão solicitados ao usuário:
$ limarka fig -i
1 imagens/ficha-catalografica.odt
2 imagens/ficha-catalografica.pdf
3 imagens/folha-de-aprovacao-escaneada.pdf
4 imagens/passaro.jpg
Escolha um arquivo para a Figura: 4
Insira o texto da legenda [Legenda da figura.]): Pássaro com as cores da bandeira do Brasil.
Insira o texto da fonte [Autor.]):
Rótulo para referenciar a figura [fig:passaro]. fig:
Forneça as dimensões separadas por espaço [100]:
<!--
Para referenciar essa figura no texto utilize: Figura \ref{fig:passaro}
-->
\begin{figure}[htbp]
\caption{\label{fig:passaro}Legenda da figura.}
\begin{center}
\includegraphics[width=1.0\textwidth]{imagens/passaro.jpg}
\end{center}
\legend{Fonte: Autor.}
\end{figure}
Recomendações para as figuras: Remova acentos e caracteres especiais dos nomes dos arquivos de imagens.
Consulte:
- Ajuda do subcomado
fig(limarka help fig) - Manual do abntex, seção 6.4 Rótulos e legendas (
texdoc abntex) - figtab.pdf
Exemplo de utilização de sintaxe de tabela:
: Perfil dos voluntários do experimento \label{tabperfil}
|Vol.|Formação acadêmica |Experiência c/ Latex| Expeiência c/ Markdown|
|:-:|:----------------------------:|:------------------:|:--------------------:|
|1 |Ciência da Computação |ShareLatex | Readme/Github|
|2 |Engenharia da Computação |Viu prof. utilizando|-|
|3 |Engenheiro elétrico (mestrando)|Utiliza para tudo |-|
Fonte: Autor.
Referenciando a tabela: \autoref{tabperfil}
As tabelas deverão ser incluídas e referenciadas com código Latex.
Invoque o comando limarka tab para criar um código inicial para uma tabela.
\begin{table}[htb]
\ABNTEXfontereduzida
\caption{Legenda da tabela.}
\label{tab:71532}
\begin{tabular}{p{2.6cm}|p{6.0cm}|p{2.25cm}|p{3.40cm}}
%\hline
\textbf{Nível de Investigação} & \textbf{Insumos} & \textbf{Sistemas de Investigação} & \textbf{Produtos} \\
\hline
Meta-nível & Filosofia\index{filosofia} da Ciência & Epistemologia &
Paradigma \\
\hline
Nível do objeto & Paradigmas do metanível e evidências do nível inferior &
Ciência & Teorias e modelos \\
\hline
Nível inferior & Modelos e métodos do nível do objeto e problemas do nível inferior & Prática & Solução de problemas \\
% \hline
\end{tabular}
\legend{Fonte: Autor.}
\end{table}
\begin{table}[htb]
\IBGEtab{%
\caption{Legenda da tabela.}%
\label{tab:71532}
}{%
\begin{tabular}{ccc}
\toprule
Nome & Nascimento & Documento \\
\midrule \midrule
Maria da Silva & 11/11/1111 & 111.111.111-11 \\
\midrule
João Souza & 11/11/2111 & 211.111.111-11 \\
\midrule
Laura Vicuña & 05/04/1891 & 3111.111.111-11 \\
\bottomrule
\end{tabular}%
}{%
\fonte{Autor.}%
}
\end{table}
Consulte:
- Manual do abntex, seção 6.5 Tabelas em conformidade com padrões do IBGE (
texdoc abntex) - Comando tab
- wiki/LaTeX/Tables
- Normas de apresentação tabular / IBGE (utilizado pela ABNT)
- figtab.pdf
Devido a demanda de elaboração de cronogramas em projetos/qualificação o limarka apresenta os seguintes códigos que podem ser utilizados para iniciar a elaboração de um cronograma.
O seguinte código gera o cronograma acima:
\begin{table}[htbp]
\centering
\caption{Cronograma de atividades}
\label{tab:cronograma}
\begin{tabular}{|c|c|c|c|c|c|}
\hline
Fase & Março & Abril & Maio & Junho & Julho \\
\hline
1 & \textbullet & & & & \\
2 & & \textbullet & & & \\
3 & & & \textbullet & & \\
4 & & & & \textbullet & \\
5 & & & & & \textbullet \\
\hline
\end{tabular}
\legend{Fonte: Autor.}
\end{table}
Sintaxe de quadro:
Quadro nome-do-quadro: Título do quadro
QUALQUER TABELA AQUI
Fonte: Texto da fonte.
Para referenciar o quadro: \autoref{nome-do-quadro}
Exemplo de quadro:
Quadro perfil: Perfil dos voluntários do experimento
|Vol.|Formação acadêmica |Experiência c/ Latex| Expeiência c/ Markdown|
|:-:|:----------------------------:|:------------------:|:--------------------:|
| 1 |Ciência da Computação |ShareLatex | Readme/Github|
| 2 |Engenharia da Computação |Viu prof. utilizando|-|
| 3 |Engenheiro elétrico (mestrando)|Utiliza para tudo |-|
Fonte: Autor.
Para referenciar esse quadro: \autoref{perfil}
Para adicionar linhas horizotais, inicie a primeira coluna com \hline a partir da segunda linha:
Quadro perfil2: Perfil dos voluntários do experimento
|Vol.|Formação acadêmica |Experiência c/ Latex| Expeiência c/ Markdown|
|:-:|:----------------------------:|:------------------:|:--------------------:|
| 1 |Ciência da Computação |ShareLatex | Readme/Github|
|\hline 2 |Engenharia da Computação |Viu prof. utilizando|-|
|\hline 3 |Engenheiro elétrico (mestrando)|Utiliza para tudo |-|
Fonte: Autor.
Quadro cronograma: Cronograma de atividades
| Fase | Março | Abril | Maio | Junho |
|:----:| :----:|:-----:|:----:|:-----:|
| 1 | X | X | | |
Fonte: Autor.
Para referenciar esse quadro no texto: \autoref{cronograma}
O seguinte código gera o cronograma acima:
\begin{table}[htbp]
\centering
\caption{Cronograma de atividades}
\label{tab:cronograma}
\begin{tabular}{|l|c|c|c|c|c|}
\hline
Atividade & Março & Abril & Maio & Junho & Julho \\
\hline
XXXXXXXXXXXXXXXX & \textbullet & & & & \\
XXXXXXXXXXXXXXXX & & \textbullet & & & \\
XXXXXXXX & & & \textbullet & & \\
XXXXXXXX & & & & \textbullet & \\
XXXXXXXX & & & & & \textbullet \\
\hline
\end{tabular}
\legend{Fonte: Autor.}
\end{table}
As referências são utilizadas com código Latex.
Consulte:
- Rerefências
- Manual do abntex2cite (
texdoc abntex2cite)
As citações diretas sempre devem contem a página ou seção do documento:
> Para realizar uma citação direta (que deve ter no mínimo três linhas),
basta iniciar a linha com o símbolo '>'. Este parágrafo seria apresentado
com o espaçamento à esquerda \cite[p. 7]{chave_da_referencia}.
As referências são realizadas através de rótulos, similar as Figuras e Tabelas. Os nomes dos rótulos são elaborados com prefixos para lembrar que tipo de rótulo estamos nos referindo. Então fig:passaro é um rótulo para uma figura (prefixo fig:). Os prefixos para capítulos e seção costumam ser cap e sec, mas são apenas sugestões.
Outro aspecto relevante é a sintaxe para DEFINIR rótulos em capítulos e seções. Basta adicionar {#cap:nome-do-rotulo} ou {#sec:nome-do-rotulo} após seus títulos.
# Referenciando capítulos ou seções no limarka {#cap:rotulos}
(...)
## Exemplo de seção com rótulo {#sec:exemplo-de-rotulo}
Para saber como incluir rótulo em seções consulte:
- A **seção** \ref{sec:exemplo-de-rotulo} ou
- ou \autoref{sec:exemplo-de-rotulo} ou ainda
- \autoref{sec:exemplo-de-rotulo} - \nameref{sec:exemplo-de-rotulo}
Os rótulos de capítulos são similares, consulte o Capítulo \ref{cap:rotulos}Os comandos \ref, \autoref, e \nameref são instruções Latex. Para saber mais opções consulte documentações específicas: Labels_and_Cross-referencing e hyperref.
Para criar um capítulo não numerado utilize {-} após o título do capítulo:
# Introdução {-}
Texto da introdução, capítulo não numerado.
# Primeiro capítulo
Texto do primeiro capítulo aqui.
Os anexos e apêndices são digitados nos arquivos anexos.md e apendices.md respectivamente. A sintaxe de edição é semelhante ao do arquivo trabalho-academico.md. A diferença é que nesses arquivos os capítulos tornam-se Anexos ou Apêndices.
Para utilização desses elementos é necessário habilitar sua utilização no arquivo configuracao.pdf.
Um comando bastante útil nas seções de Anexos e Apêndices é o includepdf (do pacote pdfpages, que inclui um documento PDF. Sua documentação pode ser acessada digitando texdoc pdfpages. Veja exemplos de utilização:
Insere a primeira página do documento:
\includepdf{imagens/questionario_BRA_2006_Untrans_Portuguese.pdf}
Insere todas as páginas do documento:
\includepdf[pages=-]{imagens/questionario_BRA_2006_Untrans_Portuguese.pdf}
Insere todas as páginas do documento em ordem reversa:
\includepdf[pages=last-1]{imagens/questionario_BRA_2006_Untrans_Portuguese.pdf}
Insere todas as páginas do documento, e adiciona cabeçalho com paginação:
\includepdf[pages=-,pagecommand={\thispagestyle{abntheadings}}]{imagens/questionario_BRA_2006_Untrans_Portuguese.pdf}
