Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 6f3f215aa7
Fetching contributors…

Cannot retrieve contributors at this time

170 lines (123 sloc) 6.535 kb
Apostilator Classic - A Latex Interface
***************************************
Apostilator é uma interface baseada em um processador XML para
LaTeX que simplifica o processo de escrita de documentos.
1. Dependencias
***************
1.1 Debian
**********
# echo 'Aptitude::Recommends-Important "false";' >> /etc/apt/apt.conf
# aptitude install perl texlive texlive-latex-recommended \
texlive-latex-extra texlive-fonts-extra
1.2 Gentoo
**********
# install: perl tetex latex-unicode
2. Instalação
*************
# cp apostilator.pl /usr/bin
3. Arquitetura
**************
O Apostilator é um processador de arquivos .axml "Apostilator-XML",
conversor para LaTeX e gerador de PDF. É formado pelo executável
"apostilator.pl" e por um diretório para cada projeto de apostila. Um
projeto inicial esta disponível em "project-example", e você deve usá-lo
como ponto de partida.
A sintaxe dos capítulos e apêndices devem seguir o padrão AXML
"Apostilator-XML". A especificação esta contida no manual que pode ser
acessado através do projeto "project-manual" do Apostilator.
Crie o diretório do seu projeto copiando o diretório
"project-example" disponibilizado, verifique que cada capítulo é formado
um arquivo .axml, e a lista de capítulos esta contida no arquivo
Chapters.lst. Para adicionar ou remover capítulos, basta criar ou
remover os arquivos .axml do diretório do projeto e removê-lo da lista
em Chapters.lst. Se seus arquivos iniarem com números você pode utilizar
a opção -l para que o apostilator gere o Chapters.lst para você.
Para gerar a sua apostila, apenas execute 'apostilator.pl' no
diretório corrente ($PWD) ou especifique através da opção "--workdir=".
A apostila será gerada em /Nome-do-projeto.pdf.
4. Padrão "apostilator-XML"
***************************
A sintaxe dos documentos do projeto esta descrita na Apostila criada
com o próprio apostilator no projeto "project-manual".
Para acessá-la, basta entrar no diretório deste projeto e compilá-la:
$ cd /path/apostilator-version/project-manual
$ apostilator.pl
5. Apostilas
************
Para iniciar um projeto chamado "Postfix" de uma nova apostila, copie
o diretório "project-example" renomeando, como o exemplo abaixo:
# cp -a /path/to/project-example /home/rei/Projetos-AXML/Postfix
Adicione os capítulos em formato AXML no diretório (ex:
"./Postfix/Capitulo01.axml" e inclua esta arquivo .axml em
"./Postfix/Chapters.lst".
Caso seus arquivos de capítulos .axml começem por números de 1 a 8
como "01_introducao.axml" ou "23_diversos.axml", e apêndices comecem por
9 como "91_GPL.axml", o comando 'apostilator.pl -l' gerará a lista
ordenada em Chapters.lst e Appendix.lst. Não use a opção '-l' caso seus
arquivos não sigam este padrão pois os arquivos Chapters.lst e
Appendix.lst serão removidos.
As imagens devem ser salvas em "./Postfix/imgs/"
6. Executando
*************
Modos de execução:
$ apostilator.pl --workdir=/home/rei/Apostila-Postfix [ OPCAO ]
$ cd /home/rei/Apostila-Postfix
$ apostilator.pl [ OPCAO ]
Configure o nome do autor e o título da Apostila (use --workdir):
$ apostilator.pl --skip-pdf --set-tile="Postfix para tráfego intenso"
$ apostilator.pl --skip-pdf --set-author="Reinaldo Gil Lima de Carvalho"
Para compilar somente os capítulos (sem atualizar sumário e bibliografia):
$ apostilator.pl --preview
7. Exemplos
***********
8.1 Limpando arquivos temporários
*********************************
$ apostilator.pl --workdir=/home/rei/apostilator-openldap --clean
8.2 Efetuando backup
********************
$ apostilator.pl --workdir=/home/rei/apostilator-bs7799 --backup
8.3 Atualizar rapidamente (sem atualizar indíces e bibliografia)
****************************************************************
$ apostilator.pl --workdir=/home/rei/Apostila-Postfix --preview
8.4 Usando o --workdir ou dentro do projeto
*******************************************
$ apostilator.pl --workdir=/home/rei/Apostila-Postfix
$ cd /home/rei/Apostila-Postfix
$ apostilator.pl
8.5 Compilar prjeto, sem iniciar visualizador de PDF
****************************************************
$ apostilator.pl --workdir=/home/rei/Apostila-Postfix --no-open-pdf
$ apostilator.pl --no-open-pdf
8. Para desenvolvedores
***********************
A estrutura de cada projeto é formada por:
/ -- diretório repositório de arquivos .axml
/imgs/ -- diretório com imagens utilizadas nos aXMLs
/Chapters.lst -- Lista de arquivos .axml
/Appendix.lst -- Lista de arquivos .axml
/Bibliography.bib -- Bibliografias em formato BibTex
/.tex/ -- diretório para conversões de formatos
/.tex/base.tex -- estrutura básica em LaTeX do documento
/.tex/titlepage.tex -- página de capa utilizada pelo base.tex
/.tex/titlepage.png -- imagem utilizada na capa
/.tex/babelbib.sty -- definições de bibliografia
/.tex/portuguese.bdf -- definições de estrutura do LaTeX
9. Autor
********
Copyright (C) 2007-2012 Reinaldo de Carvalho <reinaldoc@gmail.com>
Copyright (C) 2005-2006 Luiz C. B. Mostaço Guidolin <lcguid@gmail.com>
10. Licença
***********
O Apostilator é um software livre; você pode redistribuí-lo e/ou
modificá-lo dentro dos termos da GNU LGPL versão 3 como publicada pela
Fundação do Software Livre (FSF).
Este programa é distribuído na esperança que possa ser útil, mas SEM
NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer
MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/LGPL
em português para maiores detalhes.
Você deve ter recebido uma cópia da GNU LGPL versão 3, sob o título
"LICENCA.txt", junto com esse programa. Se não, acesse
http://www.gnu.org/licenses ou escreva para a Fundação do Software Livre
(FSF) Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA.
Fim do README
*************
Jump to Line
Something went wrong with that request. Please try again.