Asciidoc Playground i Asciidoc Playground por Vladyr Yuri Soares de Lima Cavalcanti Asciidoc Playground ii COLLABORATORS TITLE : Asciidoc Playground ACTION NAME DATE WRITTEN BY Vladyr Yuri Soares de Lima Cavalcanti 2003-12 SIGNATURE REVISION HISTORY NUMBER DATE 1.0 2003-12 DESCRIPTION Primeira versão do meu livro. NAME V Asciidoc Playground iii Sumário 1 Playground1 1 1.1 Alterando o título do livro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 Configurando o autor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2.1 Múltiplos autores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Capítulos e Seções . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3.1 Criando seções . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3.2 Criando sub-seção . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3.3 Criando sub-sub-seção . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3.4 Capítulos e seções não podem ficar vazias . . . . . . . . . . . . . . . . . . . 2 Inserindo texto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.1 Não utilize espaço de parágrafo. . . . . . . . . . . . . . . . . . . . . . . . . 2 Como fazer Listas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.5.1 Lista não ordenada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.5.2 Lista ordenada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.5.3 Cuidados ao criar uma lista . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.5.4 Lista rotulada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Referenciando capítulos e seções . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.6.1 Explicação do número próximo à referência . . . . . . . . . . . . . . . . . . 4 1.6.2 Clicável . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.3 1.4 1.5 1.6 2 Playground2 5 2.1 Estilos de parágrafos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1.1 Aplicando os estilos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1.2 Verso — verse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.3 Citações — quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.4 Literal — literal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.5 Código fonte — listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.6 Estilos de diálogo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Asciidoc Playground 2.1.6.1 Nota . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.6.2 Dica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.6.3 Importante . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.6.4 Atenção . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.6.5 Cuidado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.7 Entendendo estilo de parágrafo . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.8 Um parágrafo pode possuir um título . . . . . . . . . . . . . . . . . . . . . 7 2.1.9 Atalho para os estilos de parágrafo diálogo . . . . . . . . . . . . . . . . . . 8 Blocos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 2.2.1 Bloco com pontos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 2.2.2 Bloco fechado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 2.2.3 Bloco para código fonte . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Caixas de diálogo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 2.3.1 Atribuindo títulos diferentes para o mesmo estilo de caixa . . . . . . . . . . 11 2.4 Índice remissivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.5 Nota de rodapé . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.6 Inserir Imagem (sem submissão) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.2 2.3 3 4 iv Playground3 14 3.1 Estilos de caracteres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.1.1 Negrito . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.1.2 Itálico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.1.3 Monospace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.1.4 Estes estilos são aplicados apenas em palavras inteiras . . . . . . . . . . . . 15 3.1.5 Sobrescrito & Subscrito . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.2 Aspas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.3 Tabelas simples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.4 Fórmulas matemáticas do Latex . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.5 Desenhando gráficos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Índice Remissivo 19 Asciidoc Playground 1 / 19 Capítulo 1 Playground1 Neste playground nós vamos aprender: • a alterar o título do livro • a configurar o autor • a inserir Capítulos e Seções • a inserir texto • a referenciar capítulos e seções • como fazer Listas 1.1 Alterando o título do livro • A primeira linha do texto determina o título do livro • A segunda linha do texto deve ser composta por uma sequência de =, com a mesma quantidade de caracteres que o título possui. Em caso de dúvidas, consulte: http://producao.virtual.ufpb.br/books/edusantana/producaocomputacao-ead-ufpb/livro/livro.chunked/ch11s01.html#titulo_livro_alterando 1.2 Configurando o autor A terceira linha do arquivo especifica o nome do autor do documento. Altere esta linha substituindo o conteúdo com o seu nome. 1.2.1 Múltiplos autores Neste curso, iremos aprender apenas como configurar um único autor. Múltiplos autores será visto no curso avançado. Asciidoc Playground 1.3 2 / 19 Capítulos e Seções Para adicionar um capítulo basta iniciar uma nova linha com 2 iguais seguidos de um espaço e o título do seu capítulo, Ex: (== Título do capítulo) Neste arquivo temos apenas um capítulo. 1.3.1 Criando seções Criar uma seção é similar à criação de capítulo, só que adicionamos mais um igual (=== Título da seção) 1.3.2 Criando sub-seção Criar uma sub-seção é similar à criação de seção, só que adicionamos mais um igual (==== Título da sub-seção) 1.3.3 Criando sub-sub-seção Criar uma sub-sub-seção é similar à criação de sub-seção, só que adicionamos mais um igual (===== Título da sub-sub-seção) OBS: Não existe sub-sub-sub-seção. 1.3.4 Capítulos e seções não podem ficar vazias Nenhuma seção ou capítulo pode ficar vazia sem nenhum texto. 1.4 Inserindo texto Os textos podem ser inseridos entre as seções e capítulos. É muito importante compreender como funcionam os parágrafos. Um parágrafo é iniciando com um texto e só termina quando encontra uma linha em branco. Enquanto não existir uma linha em branco, o texto faz parte do mesmo parágrafo. 1.4.1 Não utilize espaço de parágrafo. Não utilize espaço de parágrafo. Comece o texto no início da linha sem adicionar nenhum espaço. Caso você inicie alguma linha com espaço ela ficará desse jeito. Asciidoc Playground 1.5 Como fazer Listas 1.5.1 Lista não ordenada 3 / 19 • Um asterisco (*) seguido de espaço ( ) e texto inicia uma lista. • Adicione outro ítem da mesma forma. • Se o texto do ítem for muito grande e ocupar mais de uma linha, não tem problema nenhum. Simplesmente continue digitando o texto do ítem até ele acabar. • Adicione tantos ítens quanto forem necessários. 1.5.2 Lista ordenada 1. Uma lista ordenada numericamente é criada de forma similar 2. Só que inicia com 1 ponto (.) 3. Os ítens adicionados são numerados automaticamente a. Você também pode fazer sub-ítens b. Basta inicia-los com 2 pontos (..) 4. Você pode incluse misturar as duas listas 1.5.3 Cuidados ao criar uma lista Lembre-se que após o (*) ou (.) SEMPRE vem um espaço em branco ( ). 1.5.4 Lista rotulada O Norte Conhecido também por setentrião, setentrional ou boreal, geográfica ou astronomicamente, é uma direcção/direção fundamentada no sentido de rotação do planeta e o ponto zero dos quatro pontos cardeais O Sul Um dos quatro pontos cardeais da rosa-dos-ventos, ou meridião, ou meridional ou austral; meio-dia; para quem está no hemisfério norte, ao meio-dia solar o Sol encontra-se a Sul do observador. O Leste Leste, símbolo L ou E, um dos quatro pontos cardeais da rosa-dos-ventos, também chamado de oriente, este, nascente ou levante. O Oeste Oeste, símbolo O (ou W, do nome em inglês), para a geografia, é um dos quatro pontos cardeais da rosa-dos-ventos, que fica localizado à esquerda do observador, quando este se volta para o Norte. Asciidoc Playground 1.6 4 / 19 Referenciando capítulos e seções Para referenciar um capítulo ou seção primeiro precisamos nomeá-los. Exemplo de nomeção: [[cap_playground1]] == Playground1 [[criando_secao]] === Criando seções Os nomes atribuídos não podem conter espaços. Após nomeá-los, podermos referenciá-los da seguinte forma: <<cap_playground1>> e <<criando_secao>>. Referenciando capítulo: O Capítulo 1 [1] ensina como referenciar capítulos, entre outras coisas. Refrenciando seção: A Seção 1.3.1 [2] demonstra a criação de seção. 1.6.1 Explicação do número próximo à referência O número ao lado da referência corresponde à página onde o item referenciado se encontra. 1.6.2 Clicável Na versão digital, a referência se torna um link. Se você clicar na referência será redirecionado para o item referenciado. Asciidoc Playground Capítulo 2 Playground2 Neste playground nós vamos aprender: • Estilos de parágrafos • Caixas de diálogo • Índice remissivo • Nota de rodapé • Inserir Imagem (sem submissão) 2.1 Estilos de parágrafos E STILOS PARA PARÁGRAFO • verse • quote • literal • listing • NOTE • TIP • WARNING • IMPORTANT • CAUTION 2.1.1 Aplicando os estilos [estilo] Texto do parágrafo. 5 / 19 Asciidoc Playground 2.1.2 6 / 19 Verso — verse Tudo é amor. Até o ódio, o qual julgas ser a antítese do amor, nada mais é senão o próprio amor que adoeceu gravemente. — Francisco Cândido Xavier 2.1.3 Citações — quote A leitura após certa idade distrai excessivamente o espírito humano das suas reflexões criadoras. Todo o homem que lê demais e usa o cérebro de menos adquire a preguiça de pensar. — Albert Einstein 2.1.4 Literal — literal O seu Tatá tá? Não, o seu Tatá não tá, Mas a mulher do seu Tatá tá. E quando a mulher do seu Tatá tá, É a mesma coisa que o seu Tatá tá,tá? 2.1.5 Código fonte — listing Tinha Tinha Tinha Tinha tanta tanta tanta tanta 2.1.6 Estilos de diálogo tia tantã. anta antiga. anta que era tia. tia que era anta. [TIP] ou [NOTE] ou [IMPORTANT] ou [WARNING] ou [CAUTION] Texto do parágrafo. 2.1.6.1 Nota Nota O caju do Juca E a jaca do cajá. O jacá da Juju E o caju do Cacá. Asciidoc Playground 2.1.6.2 7 / 19 Dica Dica Debaixo da cama tem uma jarra. Dentro da jarra tem uma aranha. Tanto a aranha arranha a jarra, Como a jarra arranha a aranha. 2.1.6.3 Importante Importante Palma, palminha, Palminha de Guiné Pra quando papai vié, Mamãe dá a papinha, Vovó bate cipó, Na bundinha do nenê. 2.1.6.4 Atenção Atenção Se o papa papasse pão. Se o papa papasse papa. Se o papa papasse tudo, Seria um papa papão. 2.1.6.5 Cuidado Cuidado Bão, babalão, Senhor Capitão, Espada na cinta, Ginete na mão. Em terra de mouro Morreu seu irmão, Cozido e assado No seu caldeirão 2.1.7 Entendendo estilo de parágrafo No playground anterior você aprendeu que um parágrafo inicia com texto e termina quando encontrar uma linha em branco. Nota Quando você aplica o estilo no parágrafo, ele irá terminar quando encontrar uma linha em branco. Se você quiser que dois parágrafos possuam o mesmo estilo, deverá utilizar estilo de bloco que veremos mais adiante (Seção 2.2 [9]). 2.1.8 Um parágrafo pode possuir um título .Título do seu parágrafo [estilo] Texto do seu parágrafo aqui. Asciidoc Playground 8 / 19 Exemplo onde “O beijo flor” é o título: O BEIJO FLOR - ESTILO VERSE Uma vez teve um incêndio na floresta. Os animais fugiam sem parar. E o leão, na confusão, franziu a testa. Quando viu o beija-flor ficando lá. Indo ao rio e pegando em seu biquinho. Um pouquinho, d´água pra jogar. Num incêndio, bem maior que um passarinho. O leão se interessou em perguntar: Por que é que você está fazendo isso? Se esse fogo é muito grande pra você! Faço isso, porque essa é a minha parte! Ingredientes para fazer um bolo na caneca - literal 1 4 3 2 4 4 1 ovo pequeno colheres (sopa) de leite colheres (sopa) de óleo colheres (sopa) rasas de chocolate em pó colheres (sopa) rasas de farinha de trigo colheres (sopa) rasas de açúcar colher (café) rasa de fermento em pó Modo de Preparo - listing Na caneca onde irá consumir, coloque o ovo e bata bem com um garfo Coloque o óleo, o açúcar, o leite e o chocolate e bata mais Coloque a farinha e o fermento e misture delicadamente até encorpar Leve ao forno microondas por 3 minutos em potência alta 2.1.9 Atalho para os estilos de parágrafo diálogo Os exemplos a seguir precisam ser separados com uma linha em branco para funcionarem: NOTE: Este é um atalho para o diálogo Nota. TIP: Este é um atalho para o diálogo Dica. IMPORTANT: Este é um atalho para o diálogo Importante. WARNING: Este é um atalho para o diálogo Atenção. CAUTION: Este é um atalho para o diálogo Cuidado. Nota Este é um atalho para o diálogo Nota. Asciidoc Playground 9 / 19 Dica Este é um atalho para o diálogo Dica. Importante Este é um atalho para o diálogo Importante. Atenção Este é um atalho para o diálogo Atenção. Cuidado Este é um atalho para o diálogo Cuidado. 2.2 Blocos Blocos podem ser considerados como um agrupador de parágrafos. 2.2.1 Bloco com pontos Caixa com pontos equivalem ao estilo literal Caixa com 4 pontos automaticamente vira estilo literal Estes dois parágrafos dentro do bloco foram afetados. Aplicando estilo listing à caixa com pontos Caixa com 4 pontos aplicando listing como estilo. Estes dois parágrafos dentro do bloco foram afetados. 2.2.2 Bloco fechado **** Texto qualquer aqui. Bloco fechado. **** Texto qualquer aqui. Bloco fechado. Asciidoc Playground 2.2.3 10 / 19 Bloco para código fonte Geralmente utilizado para inserir código fonte. Possui uma cor de fundo. Este código que você está vendo aqui: ---#include <stdio.h> int main() { printf("Hello World!\n"); exit(0); } ---Irá virar: #include <stdio.h> int main() { printf("Hello World!\n"); exit(0); } Ela ainda pode possuir um destaque de cores quando especificado a linguagem de programação do código: #include <stdio.h> int main() { printf("Hello World!\n"); exit(0); } Código HTML <html> <body> <h1>Título em html</h1> <p class="classe">Texto qualquer aqui</p> </body> </html> 2.3 Caixas de diálogo Nota Esta caixa contém mais de um parágrafo. Percebam que o estilo aplicado ao bloco foi o NOTE. A caixa pode conter vários parágrafos. Asciidoc Playground 11 / 19 Dica Caixa semelhante à anterior. Percebam que o estilo aplicado ao bloco foi o TIP. A caixa pode conter vários parágrafos. Importante Caixa semelhante à anterior. Percebam que o estilo aplicado ao bloco foi o IMPORTANT. Atenção Caixa semelhante à anterior. Percebam que o estilo aplicado ao bloco foi o WARNING. Cuidado Caixa semelhante à anterior. Percebam que o estilo aplicado ao bloco foi o CAUTION. 2.3.1 Atribuindo títulos diferentes para o mesmo estilo de caixa Você pode criar títulos de caixas padrões. Saiba mais! Quer saber mais sobre fotossíntese? Consulte http://www.smartkids.com.br/especiais/fotossintese.html. Curiosidade. . . A maneira mais fácil de diferenciar um animal carnívoro de um herbívoro é olhando nos seus olhos. Os carnívoros (cachorros, leões) possuem os olhos na parte da frente da cabeça, o que facilita a localização do alimento. Já os herbívoros (aves, coelhos) possuem os olhos do lado da cabeça para perceber a aproximação de um possível predador. 2.4 Índice remissivo Para adicionar um índice remissivo basta: (((Termo1))) Importante Adicione o termo como escrito acima, numa linha, separada por duas linhas em branco para gerar uma entrada no índice remissivo. Consulte o índice remissivo na última página. Asciidoc Playground 2.5 12 / 19 Nota de rodapé Inserir nota de rodapé é muito simples: Evafootnote:[A mulher de Adão] não teve mãe. Eva1 não teve mãe. Exemplo de outra nota de rodapé O termo fotossíntesefootnote:[outra nota aqui.] significa síntese que usa luz. O termo fotossíntese2 significa síntese que usa luz. 2.6 Inserir Imagem (sem submissão) Nesta seção vamos aprender como inserir e referenciar uma imagem no texto. A Figura 2.1 [12] foi adicionada da seguinte forma: [[fig_charlie]] .Charlie Chaplin no filme X image::images/charlie-chaplin.jpg[scaledwidth="60%"] Figura 2.1: Charlie Chaplin no filme X Nota O valor de scaledwidth equivale ao espaço total ocupado pela imagem. Se for alterado para 100% ocupará toda a largura da página. 1A mulher de Adão nota aqui. 2 Outra Asciidoc Playground 13 / 19 Importante Infelizmente a submissão de imagens requer instalação de um ambiente de produção, que não é visto no nosso curso introdutório. Veremos aqui somente como inserir uma imagem no texto — como a imagem foi submetida ao repositório não será visto. Asciidoc Playground 14 / 19 Capítulo 3 Playground3 Neste playground nós vamos aprender: • Estilos de caracteres • Aspas • Tabelas simples • Desenhando gráficos • Fórmulas matemáticas do Latex 3.1 Estilos de caracteres Até agora aprendemos como aplicar estilos de parágrafo. Agora vamos aprender como aplicar estilos de caracteres dentro do parágrafo. 3.1.1 Negrito O negrito é aplicado nas palavras que estão entre dois (*). Ex: Aplicar *negrito* é fácil. Aplicar negrito é fácil. 3.1.2 Itálico O itálico é aplicado nas palavras que estão entre duas aspas simples (’). A aspa simples é inserida no teclado brasileiro teclando apóstrofo seguido de espaço. Ex: Aplicar ’itálico’ é fácil. Aplicar itálico é fácil. Asciidoc Playground 3.1.3 15 / 19 Monospace A fonte monospace possui todos os caracteres com o mesmo tamanho. Este estilo é aplicando entre duas crases (`). As variáveis ‘aluno‘ e ‘professor‘ não foram inicializadas. As variáveis aluno e professor não foram inicializadas. 3.1.4 Estes estilos são aplicados apenas em palavras inteiras Não funciona A*sso*biar é escrito com ‘ss‘. A*sso*biar é escrito com ss. Funciona *Assobiar* é escrito com ‘ss‘. Assobiar é escrito com ss. 3.1.5 Sobrescrito & Subscrito Texto^em cima^ é possível. Texto~em baixo~ é possível. Textoem cima é possível. Textoem baixo é possível. 3.2 Aspas Não funciona As palavras ficam "pegadas" quado "usamos" aspas. As palavras ficam "pegadas"quado "usamos"aspas. Funciona Elas não ficam ‘‘pegadas’’ quado ‘usamos’ crase e aspas simples. Elas não ficam “pegadas” quado ‘usamos’ crase e aspas simples. ←- Asciidoc Playground 3.3 16 / 19 Tabelas simples Fazendo uma tabela .Adedonha |==== | Letra | Nome | Animal | Cidade | A | Ana | Arara | Aracaju | C | Carolina | Cavalo | Curitiba |==== Tabela 3.1: Adedonha Letra A C Nome Ana Carolina Animal Arara Cavalo Cidade Aracaju Curitiba Fazendo uma tabela com cabeçalho .Adedonha com cabeçalho em destaque [options="header"] |==== | Letra | Nome | Animal | Cidade | A | Ana | Arara | Aracaju | C | Carolina | Cavalo | Curitiba |==== Tabela 3.2: Adedonha com cabeçalho em destaque Letra A C Nome Ana Carolina Animal Arara Cavalo Cidade Aracaju Curitiba Dica Vários exemplos de tabelas podem ser visto em: https://raw.github.com/edusantana/producao-computacao-ead-ufpb/master/estrutura-inicial/livro/capitulos/asciidocexemplos.asc Asciidoc Playground 3.4 17 / 19 Fórmulas matemáticas do Latex Importante Estas fórmulas em Latex só irão funcionar no livro em PDF. Nota Você pode consultar um livro de Cálculo escrito neste processo: http://producao.virtual.ufpb.br/books/edusantana/calculo-diferencial-e-integral-livro/livro/livro.pdf C = α + βY γ + ε E QUATION 3.1: Uma equação qualquer. Colocar equação no meio do texto, C = α + βY γ + ε, também é possível. Mas o mais legal é referencia-la (ver Equação 3.1 [17]). Dica Ver https://asciidoc.googlecode.com/hg/doc/latexmath.txt http://www.methods.co.nz/asciidoc/latexmath.pdf 3.5 e comparar com Desenhando gráficos Importante Embora você provavelmente não irá criar gráficos, o importante é compreender que é possível fazê-lo. Exemplo de como criar uma gráfico com graphviz. ["graphviz", "grafo.png", width="30%"] .Exemplo de grafo. ---graph G { n0 -- n1 -- n2 -- n3 -- n0; n1 -- n3; n0 -- n2; } ---- Asciidoc Playground 18 / 19 Figura 3.1: Exemplo de grafo. Nota No site http://www.graphviz.org/Gallery.php encontramos uma galeria de gráficos que podem ser baixados e customizados. Asciidoc Playground Capítulo 4 Índice Remissivo _ Índice remissivo, 11 I Imagem, 12 N Nota de rodapé, 12 19 / 19