thesis-template Documentation

thesis-template Documentation
Release 0.1
Abdel Rojas
July 27, 2016
Contenido
1
Requerimientos
1.1 Offline - En tu Localhost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 Online - En una nube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
1
1
2
Instalación - Localhost
2.1 Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3
3
3
3
Instalación - Versión Online
3.1 Sharelatex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.2 Writelatex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5
5
5
4
Template
4.1 Estructura de Archivos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7
5
Archivos de configutación
5.1 El z-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9
9
6
Archivos main.tex
6.1 El main.tex principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.2 main.tex generales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
11
11
7
Acondicionando la Portada
7.1 Crear un diseño de la portada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
13
8
Directorio Samples
15
9
Indices and tables
17
i
ii
CHAPTER 1
Requerimientos
1.1 Offline - En tu Localhost
1.1.1 LaTeX
• pdflatex
• Tkiz
1.1.2 Repositorios + Opcional
• Github: para que la redacción de la memoria posea control de versiones.
1.2 Online - En una nube
• Sharelatex
• Writelatex
1
thesis-template Documentation, Release 0.1
2
Chapter 1. Requerimientos
CHAPTER 2
Instalación - Localhost
2.1 Linux
Instalar la herramienta git para tener un sistema de control de versiones
$ sudo apt-get install git
Instalar LaTeX y paquetes extras necesarios para la compilación, esto tardará unos momentos debido al tamaño de los
paquetes.
$ sudo apt-get install texlive-base texlive-latex-base texlive-lang-spanish
$ sudo apt-get install texlive-latex-extra texlive-fonts-extra texlive-extra-utils
Si se desea hacer una instalación completa de la suite se puede ejecutar la siguiente instalación:
$ sudo apt-get install texlive-full
IMPORTANTE: se debe considerar un espacio de al menos 2 GB para la instalación completa.
2.2 Windows
Bajar Texmaker de...
3
thesis-template Documentation, Release 0.1
4
Chapter 2. Instalación - Localhost
CHAPTER 3
Instalación - Versión Online
También es posible realizar una importación a sitios en nube usando otras alternativas gratuitas.
3.1 Sharelatex
sharelatex
Pros:
• Primer pro
Contras:
• Primera contra
3.2 Writelatex
writelatex
Pros:
• Primer pro
Contras:
• Primera contra
5
thesis-template Documentation, Release 0.1
6
Chapter 3. Instalación - Versión Online
CHAPTER 4
Template
4.1 Estructura de Archivos
• 00-init
– 01-dedicatoria.tex
– 02-agradecimientos.tex
– 03-resumen.tex
– glosario.tex
– main.tex
• 01-intro
– 01-intro.tex
– 02-objetivos.tex
– 03-estructura-documento.tex
– main.tex
• 02-estado-del-arte
– 01-seccion.tex
– 02-seccion.tex
– main.tex
• 03-propuesta
– 01-seccion.tex
– 02-seccion.tex
– main
• anexos
– 01-anexo.tex
– 02-anexo.tex
– main.tex
• bib
7
thesis-template Documentation, Release 0.1
– bibliografia.bib
• docs
• img
– design
• samples
– bibliografia.tex
– codigos.tex
– imagenes.tex
– tablas.tex
• z-config
– data.tex
– macros.tex
– packages.tex
– structure.tex
• main.tex
8
Chapter 4. Template
CHAPTER 5
Archivos de configutación
5.1 El z-config
Dentro de este directorio se encuentran 4 archivos que serán descritos para su comprensión y correcto uso del template.
5.1.1 data.tex
Se encuentran los campos de texto reemplazables y usados por el archivo macros.tex. Los comandos se definen de la
siguiente forma:
\newcommand{\nombrecomando}{texto que representa el comando}
De esta forma se aislan los datos de las estructuras que se creen en el archivo macros.tex.
5.1.2 macros.tex
Almacena la configuración de las macros creadas independiente de los datos que albergue en sus estructuras, por
ejemplo la macro de portada contiene la construcción completa de la porta junto a su diseño, pero la información
reemplazable se encuentra en el archivo data.text. Por tanto, este archivo es rara vez modificable.
5.1.3 packages.tex
Todos los paquetes necesarios para el desarrollo del documento se incorporan en este archivo, son ordenados por su
utilidad para ser identificados fácilmente y hacer más comprensible el documento en general.
5.1.4 structure.tex
Es el archivo encargado de configurar el diseño y estructura general del documento. En este archivo se encuentran los
estilos de listing, mintex, configuración de la tabla de contenido, ubicación de los archivos de imágenes, entre otros.
9
thesis-template Documentation, Release 0.1
10
Chapter 5. Archivos de configutación
CHAPTER 6
Archivos main.tex
En prácticamente todo el template, se encuentran a disposición unos archivos llamados main.tex. Son los archivos
maestros que organizan la secuencia de compilación del documento, es decir, determinan que archivo es considerado
para la compilación y en qué orden serán tratados para obtener el resultado final del pdf.
6.1 El main.tex principal
Es el archivo que se encuentra afuera de toda la jeraquía de carpetas y se encuentra al mismo nivel que el Makefile.
Corresponde al core del proyecto e incorpora los archivos del z-config y los main.tex de cada directorio.
6.2 main.tex generales
Se encuentran al interior de cada directorio correspondiente a un capítulo. Estos archivos definen el título del capitulo,
incorporación de los textos modulares a compilar y su orden en el pdf.
Este archivo debe ser creado en cada directorio de capítulo para facilitar la modularización del proyecto.
11
thesis-template Documentation, Release 0.1
12
Chapter 6. Archivos main.tex
CHAPTER 7
Acondicionando la Portada
La portada de memoria se encuentra diseñada con el formato estándar de acuerdo a los requisitos impuestos por la
Universidad Técnica Federico Santa María.
Para cambiar la información expuesta en el template, se deben reemplazar los campos que se encuentran en el archivo
data.tex del z-config por los deseados.
Los comentarios del documento podrán guiarte en las modificaciones.
7.1 Crear un diseño de la portada
El diseño completo de la portada se encuentra definido por el comando portada en el archivo macros.tex, y a su vez,
recoge los datos de data.tex para rellenar los campos.
Es posible crear nuevas instancias de portadas creando un nuevo comando que incorpore los datos pero con distintos
diseños. Para hacer esto, basta con crear en el archivo macros.tex un nuevo bloque que defina el comando nuevo, como
por ejemplo lo siguiente:
\newcommand{\portadanueva}
{
\begin{titlepage}
% Código que incorpore el diseño usando macros con los datos
% ubicados en data.tex
\end{titlepage}
}
Luego para que el template reconozca y use la nueva portada, debe ser reemplazado el comando portada ubicado en
el archivo main.tex principal del proyecto por el nuevo comando que define la portada creada.
13
thesis-template Documentation, Release 0.1
14
Chapter 7. Acondicionando la Portada
CHAPTER 8
Directorio Samples
Para facilitar la redacción del documento memoria, se ha incorporado un directorio que es ingnorado en la compilación,
ya que posee ejemplos de códigos útiles en la redacción misma.
Los archivos se encuentran divididos según sea el tipo de código a incorporar.
IMPORTANTE: Esta carpeta puede ir actualizandose en el repositorio oficial del template, debido a que se puedan ir
agregando nuevos bloques de códigos útiles.
15
thesis-template Documentation, Release 0.1
16
Chapter 8. Directorio Samples
CHAPTER 9
Indices and tables
• genindex
• modindex
• search
17