Artigos científicos, relatórios, teses, slides com Pandoc Markdown

Transcrição

1 Artigos científicos, relatórios, teses, slides com Pandoc Markdown Date : 9 de Agosto de 2017 Há duas opções típicas para se escrever artigos, teses ou relatórios académicos técnicos: a primeira é utilizar um editor WYSIWYG (acrónimo de "what you see is what you get"), tal como o Microsoft Word, OpenOffice, etc. Uma segunda opção passa por recorrer ao LaTeX que consiste numa linguagem de marcação (i.e. o conteúdo é escrito em texto simples e pode ser anotado com comandos que descrevem como certos elementos devem ser exibidos). Mas há uma outra opção que tem vantagens sobre as restantes: utilizar o Pandoc Markdown. Desvantagens de WYSIWYG e de LaTeX Apesar de opções válidas, um editor WYSIWYG ou LaTeX têm algumas desvantagens. Por um Pplware 1 / 6

2 lado, editores comuns de WYSIWYG, tal como o Word, desapontam na separação do conteúdo da formatação. Ou seja, eles impõem ao escritor o seu próprio conceito de como um documento deve ser formatado. O editor de fórmulas matemáticas e lógicas é bastante difícil de usar, bem como a introdução automática de referências bibliográficas. Algumas tarefas demoram imenso tempo, tal como introduzir um determinado símbolo lógico ou matemático específico ou até para introduzir índices, figuras ou tabelas onde exatamente queremos. Há problemas de compatibilidade: por exemplo, daqui a vinte e cinco anos pode não se ser capaz de abrir um dado ficheiro do Word que estamos agora a escrever, e mesmo agora por vezes é complicado abrir ficheiros escritos no Word há vinte cinco anos atrás. A incompatibilidade também se manifesta entre as várias plataformas: um ficheiro que é escrito no Word pode perder determinadas formatações quando é aberto no OpenOffice e vice-versa (e se tentarmos abrir o ficheiro em algum editor simples, como no Nano ou Vim, será simplesmente ilegível). Por fim, utilizar WYSIWYG pode conduzir a preocupação constante com a formatação e, por sua vez, a uma desconcentração no processo da escrita. Por outro lado, o uso do LaTeX não tem os problemas que sublinhámos com o Word ou com outros editores WYSIWYG. Contudo, o LaTeX possui igualmente desvantagens, como a dificuldade em construir tabelas e a quantidade de erros inúteis que por vezes surgem quando se compila um determinado texto. Pplware 2 / 6

3 Talvez uma das principais barreiras para o uso do LaTex se prenda com a quantidade de comandos que se precisa de dominar, e isso requer bastante tempo, para se escrever um artigo ou uma tese bem formatada. Ao contrário do Word, precisa-se de saber que comandos são usados para que funcionalidade de marcação. Ou seja, a sintaxe do LaTeX pode parecer complexa, não a tornando particularmente legível. Por exemplo, para se criar uma documento com secção, uma subsecção, uma nota de rodapé, e uma lista de itens com alguns elementos a negrito ou a itálico temos de escrever o seguinte: \documentclass{article} \usepackage[utf8]{inputenc} \title{exemplo de Artigo} \author{domingos Faria} \date{\today} \begin{document} \maketitle \section{nome da secção} Este é o texto da secção\footnote{isto é uma nota de rodapé.}. \subsection{nome da subsecção} A seguinte é uma lista nesta subsecção. \begin{enumerate} \item O primeiro item \textbf{negrito} \begin{enumerate} \item sub-item \item sub-item \end{enumerate} \item O segundo item em \textit{itálico} \item O terceiro item etc \ldots \end{enumerate} \end{document} Vantagem do Pandoc Markdown Com o Pandoc Markdown temos uma alternativa que poderá ter vantagens em relação ao Word ou a outros editores WYSIWYG e ao LaTeX. Pplware 3 / 6

4 O Pandoc Markdown, criado pelo filósofo John MacFarlane, é uma versão estendida e revista da sintaxe simples e intuitiva de Markdown (por exemplo, com essa versão estendida podemse criar notas de rodapé, citações, referências e índices automáticos, entre muitos outros recursos úteis para a academia na produção de artigos, teses, relatórios mais técnicos). Nessa extensão consegue-se ter ao mesmo tempo as vantagens do LaTeX mas com uma sintaxe minimalista e fácil de aprender. Assim, temos uma linguagem de marcação de texto leve, intuitiva e simples de ler. Por exemplo, para se criar um artigo com uma secção, uma subsecção, uma nota de rodapé, e uma lista de itens com alguns elementos a negrito ou a itálico pode-se escrever o seguinte: --- documentclass: article title: Exemplo de Artigo author: Domingos Faria date: \today... # Nome da secção Este é o texto da secção^[isto é uma nota de rodapé.]. Pplware 4 / 6

5 ## Nome da subsecção A seguinte é uma lista nesta subsecção. * O primeiro item **negrito** - sub-item - sub-item * O segundo item em *itálico* * o terceiro item etc... Tal como se pode ver, é bastante mais fácil de se ler e muito mais fácil de escrever do que o LaTeX. Como vantagens destacamos, então, a sua sintaxe simples (para ver a sintaxe completa clique aqui). Ora, essa formatação simples economiza tempo e acelera o fluxo de trabalho de escrita (por exemplo, é muito mais simples construir uma tabela em Pandoc Markdown do que em LaTeX, mas podemos introduzir - tal como em LaTeX -, facilmente, fórmulas matemáticas ou lógicas. Como ilustração disso, se quisermos escrever em símbolos o princípio do terceiro excluído digitamos $P \lor \lnot P$). Além disso, os documentos escritos em Pandoc Markdown são multiplataforma, ou seja, qualquer editor de texto os consegue abrir - no meu caso costumo usar o gratuito Visual Studio Code dado que tem extensões úteis para o Pandoc Markdown. Consegue-se ainda exportar o texto com uma formatação profissional para HTML, PDF, Docx, TeX, entre muitos outros formatos. Para se gerarem esses vários formatos é preciso instalar o software Pandoc. Uma vez instalado podemos usar esse software para converter um ficheiro Markdown (que tipicamente tem a extensão ".md") em qualquer outro tipo de ficheiro, como PDF, HTML, Docx, etc. Por exemplo para se gerar um ficheiro PDF a partir de um texto com sintaxe Markdown que estamos a escrever basta abrir a linha de comandos ou o terminal e escrever o seguinte: pandoc documento.md -o documento.pdf O resultado será exatamente igual ao de um ficheiro profissional criado em LaTeX, mas com uma sintaxe muito mais intuitiva e fácil de usar e sem cair nas desvantagens dos editores WYSIWYG. Pode-se igualmente converter para Docx ou HTML ao alterar-se a extensão final do documento (ou seja, em vez de se escrever "documento.pdf" escreva-se "documento.html"). Com o mesmo documento em Markdown podemos também criar slides profissionais de apresentação com Beamer sem que para isso se tenha de recorrer ao PowerPoint, ao Keynote, etc. Para isso digita-se o seguinte na linha de comandos ou terminal: Pplware 5 / 6

6 Powered by TCPDF ( pandoc -t beamer documento.md -o documento.pdf Para mais recursos vale a pena consultar o manual de utilização do Pandoc aqui. Pplware 6 / 6