lchamon/poliTeX

语言: TeX

git: https://github.com/lchamon/poliTeX

Laão圣保罗大学理工学院手稿(POLI / EPUSP)
LaTeX class for manuscripts of the Polytechnic School of the University of São Paulo (POLI / EPUSP)
README.md (中文)

POLITEX

美国职业技术学院理工学院手稿的LaTeX课程。

polyTeX类(读作“POLITEK”)基于教授改编的ABNT专着类。 Paulo Barreto符合POLI-USP标准(链接)。但是,它在课程的实施和功能方面发生了相当大的变化。一些主要的区别是:

  • 删除不直接支持POLI-USP标准的功能(不同的标题,标题格式,摘要类型......);
  • 清除代码并添加注释以便于维护:新类的大小是前一类的一半;
  • 使用标准的LaTeX软件包(如fancyhdr和geometry)删除格式“hacks”;
  • 前文本部分实施的变化;
  • 新功能:作品的题词,章节中的题词,支持部分的使用(\部分);
  • 支持CBT和多位作者;
  • 国际化:支持用英语撰写的文件;
  • 根据POLI 2013(链接)。

使用

template.tex文件是一个polyTeX类文档,其中包含所有讨论的功能。打开它,写下你的CBT,论文或论文。以下是该类的主要选项和功能以供参考。

课程选择

  • pnumromarab:使用前文本部分中的罗马算法和文本部分中的阿拉伯数字对页面进行编号。页面计数在文本部分的开头重新开始。如果未设置此选项,则在ABNT / POLI模式之后对所有阿拉伯算法页面进行编号,从假封面开始计数。
  • abnttoc:包括“p。”根据ABNT / POLI的要求,在摘要中的页面编号前面。这是唯一的选择,如果忽略,则不遵循ABNT(因为这个“p。”在目录中是荒谬的)。
  • normalnum:强制数字和表格在整个文本中连续编号。 ABNT / POLI标准要求每章重新开始编号,如果不使用此选项,则会发生这种情况。
  • draftprint:此打印选项可减少内部边距(删除绑定的出血),这可以在打印版本时进行查看以节省纸张。
  • twosideprint:调整双面打印的边距和分页。
  • capsec:此选项强制节标题的大小写,也就是说,无论您如何键入代码,节标题都将以大写形式显示。
  • simplex:使用单个间距而不是1.5(POLI标准要求)生成文档。
  • spacoduplo:使用双倍间距而不是1.5(POLI标准要求)生成文档。
  • 时代:尝试使用Times作为文本正文的字体,而不是默认的LaTeX字体Computer Modern Roman。需要额外的包(mathptmx)。
  • noindentfirst:默认是所有段落都是缩进的。如果需要,可以启用此选项,强制不缩进章节/节的第一段。

序言

要使用polyTeX类,您需要在序言中设置文档的参数:

标题

\titulo{Título}

作者

\autor{Nome Sobrenome}

注意:您可以通过换行符分隔作者来定义多个作者(例如,对于TCC)。使用超过5位作者可能会使封面有点紧张。

\autor{Nome Sobrenome\\%
       Nome Sobrenome\\%
       Nome Sobrenome}

顾问/共同定位者

\orientador{Nome do orientador}
\coorientador{Nome do coorientador (opcional)}

注意:这些字段不应设置为免费的教学论文/纪念馆。

文件类型

  • TCC
\tcc{Eletricista com ênfase em Sistemas Eletrônicos}
  • 硕士论文
\dissertacao{Engenharia Elétrica}
  • 博士论文
\teseDOC{Engenharia Elétrica}
  • 自由教学论文
\teseLD
  • 免费教学纪念
\memorialLD

部门和集中区

\departamento{Nome do departamento}
\areaConcentracao{Área de concentração}

本地

\local{São Paulo}

\data{2014}

生成前文本元素

根据ABNT / POLI标准,前文本元素应按以下顺序出现:

  1. 假面板
  2. 封面
  3. 奉献(可选)
  4. 致谢(可选)
  5. 碑文(可选)
  6. 白话总结
  7. 外语摘要
  8. 列表(表格,图形,符号)(可选)
  9. 目录

注:判决期限(在封面和封面之间)是从银行获得的,必须从图书馆部门索取目录表(封面背面)(http: /www.poli.usp.br/en/bibliotecas/servicos/catalogacao-na-publicacao.html)。

注意:文档的语言是使用babel包定义的。节标题自动翻译。要用葡萄牙语写文本,请在序言\ usepackage [brazil] {babel}中使用。对于英语,请使用\ usepackage [english] {babel}。

注意:切换语言时,请务必在编译之前清除或删除LaTeX创建的所有辅助文件。这是babel包的一个问题。但不要担心:如果你忘了,巴贝尔很烦人,会提醒你一个错误。考虑自己警告!

盖和盖板

\capa
\falsafolhaderosto
\folhaderosto

奉献(可选)

\dedicatoria{Dedicatória}

致谢(可选)

\begin{agradecimentos}

Lorem ipsum...

\end{agradecimentos}

碑文(可选)

\epigrafe{%
    \emph{``Epígrafe''}
    \begin{flushright}
        -{}- Autor
    \end{flushright}
}

白话总结

\begin{resumo}
Resumo...
%
\\[3\baselineskip]
%
\textbf{Palavras-Chave} -- Palavra, Palavra, Palavra, Palavra, Palavra.
\end{resumo}

外语摘要

\begin{abstract}
Abstract...
%
\\[3\baselineskip]
%
\textbf{Keywords} -- Word, Word, Word, Word, Word.
\end{abstract}

列表(可选)

\listadefiguras
\listadetabelas

注意:您还可以使用pretextualsection环境包含自定义列表(例如,符号列表或首字母缩略词)。这些列表由用户定义(即使使用某些LaTeX包生成内容,也必须手动输入):

\begin{pretextualsection}{Lista de símbolos}

Lista de símbolos...

\end{pretextualsection}

目录

\sumario

辅助功能

长报价(超过3行)

\begin{citacaoLonga}
    Uma longa citação literal
\end{citacaoLonga}

章节标题

\capepigrafe[0.5\textwidth]{``Frase espirituosa de um autor famoso''}{Autor famoso}

行情和参考ABNT:ABNTeX 2

POLI标准要求引用和引用采用ABNT格式。要使用BibTeX执行此操作,请安装CTAN提供的ABNTeX 2软件包(http://www.ctan.org/tex-archive/macros/latex/contrib/abntex2)。然后包括在序言\ usepackage [num] {abntex2cite}(用于数值模型中的引用)或\ usepackage [alf] {abntex2cite}(用于作者日期模板中的引用)。在您的引用之前,声明样式\ bibliographystyle {abntex2-num}或\ bibliographystyle {abntex2-alf}。如果您更喜欢使用其他参考样式(例如,对于IEEE),请忽略abntex2cite包并在\ bibliography之前声明样式。

提示

  • 使用BibTeX!
  • 将文档的每一章写在一个单独的.tex文件中。使用\ include {chapter.tex}命令将章节包含在主文档中。
  • 使用不间断的空间〜,即LaTeX不会改变线条的空间。在括号,引号,数字和任何其他看起来很奇怪的项目之前使用。
  • 了解不同的数学环境并使用最适合您的数学环境(方程式,子方程式,对齐,对齐,收集,收集,多线)。不要操纵手中方程的间距和缩进。

问题

GitHub存储库应提交问题和建议:

HTTPS://GitHub.com/罗刹魔女/polite X

作者

Chamon [luizchamon] [gmail]

本文使用googletrans自动翻译,仅供参考, 原文来自github.com

en_README.md

poliTeX

Classe do LaTeX para manuscritos da Escola Politécnica da USP.

A classe poliTeX (leia-se "POLITEK") é baseada na classe para monografias ABNT adaptada pelo Prof. Paulo Barreto para os padrões da POLI-USP (link). Porém, ela apresenta consideráveis mudanças na implementação e funcionalidades da classe. Algumas das principais diferenças são:

  • Remoção de funções que não suportavam diretamente o padrão da POLI-USP (diferentes cabeçalhos, formatações de títulos, tipos de sumários...);
  • Limpeza do código e adição de comentários para facilitar a manutenção: a nova classe tem metade do tamanho da anterior;
  • Remoção de "hacks" de formatação usando de pacotes padrões do LaTeX como fancyhdr e geometry;
  • Mudanças na implementação das partes pré-textuais;
  • Novas funcionalidades: epígrafe do trabalho, epígrafes nos capítulos, suporte para o uso de partes (\part);
  • Suporte para trabalhos de TCC e múltiplos autores;
  • Internacionalização: suporte para documentos redigidos em inglês;
  • De acordo com a norma POLI 2013 (link).

Uso

O arquivo template.tex é um documento da classe poliTeX com todas as funcionalidades comentadas. Basta abri-lo e escrever seu TCC, dissertação ou tese. A seguir, estão as principais opções e funções da classe para referência.

Opções da classe

  • pnumromarab: Numera as páginas usando algorismos romanos na parte pré-textual e algarismo arábicos na parte textual. A contagem de páginas reinicia no início da parte textual. Se esta opção não for definida, o padrão da ABNT/POLI é seguido, numerando todas as páginas com algorismo arábicos, iniciando a contagem na falsa folha de rosto.

  • abnttoc: Inclui "p." na frente da numeração das páginas no sumário conforme exigido pela ABNT/POLI. Esta é a única opção que, se ignorada, não segue a ABNT (porque esse "p." no sumário é ridículo).

  • normalnum: Força figuras e tabelas a serem numeradas continuamente por todo o texto. O padrão ABNT/POLI exige que a numeração reinicie a cada capítulo, que é o que ocorre se esta opção não for usada.

  • draftprint: Esta opção de impressão reduz a margem interna (remove a sangria para encadernação), o que pode economizar folhas na hora de imprimir versões para revisão.

  • twosideprint: Ajusta as margens e paginação para impressão frente-e-verso.

  • capsec: Esta opção força a capitalização dos títulos das seções, isto é, independente de como você escrever no código, os títulos das seções serão apresentados em letras maiúsculas.

  • espacosimples: Gera o documento usando espaçamento simples ao invés de 1.5 (exigido pelo padrão POLI).

  • espacoduplo: Gera o documento usando espaçamento duplo ao invés de 1.5 (exigido pelo padrão POLI).

  • times: Tenta usar Times como fonte para o corpo do texto ao invés de Computer Modern Roman, a fonte padrão do LaTeX. Requer pacotes adicionais (mathptmx).

  • noindentfirst: O padrão é que todos os parágrafos sejam indentados. Se desejar, pode ativar esta opção que força o primeiro parágrafo de capítulos/seções a não serem indentados.

O preâmbulo

Para usar a classe poliTeX você precisa definir os parâmetros do seu documento no preâmbulo:

Título

\titulo{Título}

Autor(es)

\autor{Nome Sobrenome}

Nota: você pode definir múltiplos autores (por exemplo, para TCCs) separando os autores por quebras de linhas. Usar mais de 5 autores pode deixar a capa um pouco apertada.

\autor{Nome Sobrenome\\%
       Nome Sobrenome\\%
       Nome Sobrenome}

Orientador / Coorientador

\orientador{Nome do orientador}
\coorientador{Nome do coorientador (opcional)}

Nota: Esses campos não devem ser definidos para teses/memoriais de livre docência.

Tipo de documento

  • TCC
\tcc{Eletricista com ênfase em Sistemas Eletrônicos}
  • Dissertação de mestrado
\dissertacao{Engenharia Elétrica}
  • Tese de doutorado
\teseDOC{Engenharia Elétrica}
  • Tese de livre docência
\teseLD
  • Memorial para livre docência
\memorialLD

Departamento e área de concentração

\departamento{Nome do departamento}
\areaConcentracao{Área de concentração}

Local

\local{São Paulo}

Ano

\data{2014}

Geração de elementos pré-textuais

De acordo com a norma ABNT/POLI, os elementos pré-textuais devem aparecer na seguinte ordem:

  1. Capa
  2. Falsa folha de rosto
  3. Folha de rosto
  4. Dedicatória (opcional)
  5. Agradecimentos (opcional)
  6. Epígrafe (opcional)
  7. Resumo em língua vernácula
  8. Resumo em língua estrangeira
  9. Listas (tabelas, figuras, símbolos) (opcional)
  10. Sumário

Nota: O termo de julgamento (que fica entre a falsa folha de rosto e a folha de rosto) é obtido da banca e a ficha catalográfica (que fica no verso da folha de rosto) deve ser solicitada ao setor de bibliotecas (http://www.poli.usp.br/en/bibliotecas/servicos/catalogacao-na-publicacao.html).

Nota: A língua do documento é definida pelo uso do pacote babel. Os títulos das seções são traduzidos automaticamente. Para escrever o texto em português, use no preâmbulo \usepackage[brazil]{babel}. Para inglês, use \usepackage[english]{babel}.

Atenção: Ao trocar de língua, sempre faça um make clean ou apague todos os arquivos auxiliares criados pelo LaTeX antes de compilar. Esse é um problema do pacote babel. Mas não se preocupe: se você esquecer, o babel é chato e vai lembrar você com um erro. Considere-se avisado!

Capa e folhas de rosto

\capa
\falsafolhaderosto
\folhaderosto

Dedicatória (opcional)

\dedicatoria{Dedicatória}

Agradecimentos (opcional)

\begin{agradecimentos}

Lorem ipsum...

\end{agradecimentos}

Epígrafe (opcional)

\epigrafe{%
    \emph{``Epígrafe''}
    \begin{flushright}
        -{}- Autor
    \end{flushright}
}

Resumo em língua vernácula

\begin{resumo}
Resumo...
%
\\[3\baselineskip]
%
\textbf{Palavras-Chave} -- Palavra, Palavra, Palavra, Palavra, Palavra.
\end{resumo}

Resumo em língua estrangeira

\begin{abstract}
Abstract...
%
\\[3\baselineskip]
%
\textbf{Keywords} -- Word, Word, Word, Word, Word.
\end{abstract}

Listas (opcional)

\listadefiguras
\listadetabelas

Nota: Você também pode incluir listas personalizadas (e.g., lista de símbolos ou siglas) usando o ambiente pretextualsection. Estas listas são definidas pelo usuário (você deve inseri-las manualmente, mesmo que o conteúdo seja gerado usando algum pacote do LaTeX):

\begin{pretextualsection}{Lista de símbolos}

Lista de símbolos...

\end{pretextualsection}

Sumário

\sumario

Funções auxiliares

Citações longas (mais de 3 linhas)

\begin{citacaoLonga}
    Uma longa citação literal
\end{citacaoLonga}

Epígrafe para capítulos

\capepigrafe[0.5\textwidth]{``Frase espirituosa de um autor famoso''}{Autor famoso}

Citações e referências ABNT: ABNTeX 2

O padrão da POLI exige que citações e referências estejam no formato ABNT. Para fazer isto usando BibTeX, instale o pacote ABNTeX 2 disponível pelo CTAN (http://www.ctan.org/tex-archive/macros/latex/contrib/abntex2). Em seguida, inclua no preâmbulo \usepackage[num]{abntex2cite} (para citações no modelo numérico) ou \usepackage[alf]{abntex2cite} (para citações no modelo autor-data). Logo antes das suas referências, declare o estilo \bibliographystyle{abntex2-num} ou \bibliographystyle{abntex2-alf}. Se preferir usar outro estilo de referência (do IEEE, por exemplo), ignore o pacote abntex2cite e declare o estilo antes do \bibliography.

Dicas

  • Use BibTeX!
  • Escreva cada capítulo do seu documento em um arquivo .tex separado. Use o comando \include{capitulo.tex} para incluir os capítulos no seu documento principal.
  • Use espaços inquebráveis ~, ou seja, espaços nos quais o LaTeX não muda de linha. Use antes de parênteses, citações, números e qualquer outro ítem que ficaria estranho começando uma linha.
  • Saiba sobre os diferentes ambientes de matemática e use aquele que for mais adequado para o seu caso (equation, subequations, align, aligned, gather, gathered, cases, multline). Não manipule o espaçamento e indentação de equações na mão.

Issues

Problema e sugestões devem ser enviadas pelo repositório GitHub:

https://github.com/lchamon/poliTeX

Author

Chamon [luizchamon] [gmail]