Documentaci´on de alta calidad con L A T E X Mauro Silvosa Rivera ([email protected]) Emilio J. Padr´ on Gonz´ ale z (em[email protected]) Grupo de Usuarios y Programadores de Linux (GPUL) 30 de marzo de 2011 IX Xornad as sobre Soft wa re Libre (GPUL) Documentaci´ on de alta calidad con L A T E X 30 de marzo de 2011 1 / 51
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
5/10/2018 Latex en Alta Calidad Documentos - slidepdf.com
Independencia entre el contenido, su estructura y su presentacion
Documentos con estructura semantica explıcita
Independencia del editor y formatos abiertos no binarios
Buena integracion con los sistemas de control de versiones
Robustez y fiabilidad
El menor coste posible
Importante...
Documentar procesos y publicar resultados aportan riqueza a las empresasy/o grupos de investigacion. Necesitamos, por tanto, una infraestructurade documentacion de alta calidad que nos permita gestionar toda ladocumentacion que generemos desde el primer dıa.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 5 / 51
1 Sistemas de documentacion por markup LATEX SGML / XML ...
2 Sistemas de documentacion WYSIWYG
Microsoft Office OpenOffice.org / Sun Microsystems StarOffice Adobe Acrobat Writer ...
Interesante...La industria aeronautica genera documentacion basada en SGML/XML porquediferentes organismos de aviacion solicitan la misma documentacion condiferentes estilos, formatos o soportes. Documentos importantes, incluso, tienenque ser legibles en cualquier editor de texto plano.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 6 / 51
Informacion sobre la naturaleza y formato del documento Paquetes a utilizar Comandos definidos por el usuario
2 Documento = Estructura + Contenido
En definitiva...
El “contenido” del documento es lo que realmente queremos escribir y enlo que centraremos la mayor parte de nuestro esfuerzo. El resto del trabajo
consistira en definir a medida que redactamos el “contenido” la estructuradel documento usando para ello los diferentes comandos, ordenes yentornos que nos proporciona LATEX.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 8 / 51
Ten years ago a crack commando unit was sent to prison by a military court
for a crime they didn’t commit. These men promptly escaped from a maximum
security stockade to the Los Angeles underground. Today, still wanted by the
government, they survive as soldiers of fortune. If you have a problem and no
one else can help, and if you can find them, maybe you can hire the A-team.
This is my boss, Jonathan Hart, a self-made millionaire, he’s quite a guy.
This is Mrs H., she’s gorgeous, she’s one lady who knows how to take care of
herself. By the way, my name is Max. I take care of both of them, which ain’t
easy, ’cause when they met it was MURDER!
I never spend much time in school but I taught ladies plenty. It’s true I hire
my body out for pay, hey hey. I’ve gotten burned over Cheryl Tiegs, blown up forRaquel Welch. But when I end up in the hay it’s only hay, hey hey. I might jump
an open drawbridge, or Tarzan from a vine. ’Cause I’m the unknown stuntman
that makes Eastwood look so fine.
Knight Rider, a shadowy flight into the dangerous world of a man who does
not exist. Michael Knight, a young loner on a crusade to champion the cause of
the innocent, the helpless in a world of criminals who operate above the law.
1
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 9 / 51
En LATEX una figura es un elemento flotante que permite incluir un grafico
o cualquier otra cosa y anadir cierta informacion sobre el mismo:etiqueta de referencia
informacion de posicionamiento
una leyenda o pie de figura
Lista de figuras
LATEX lleva la cuenta del numero de figuras del documento, de forma quepuede crear automaticamente la relacion o listado de figuras deldocumento (\listoffigures).
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 18 / 51
TEX permite realizar referencias a diferentes elementos deldocumento. Podemos referencias ecuaciones, tablas, figuras,secciones, paginas, capıtulos, etc. Ademas, tambien podemos hacerreferencias bibliograficas aprovechando las capacidades de bibtex.
Las secciones del documento y los entornos mas comunes permiten
ser referenciados. Para ello hay que asignarles una etiqueta empleandoel comando \labelnombre_de_la_referencia.
Para referenciar una parte del documento (seccion o entorno) usamosel comando \refnombre_de_la_referencia o bien el comando
\pagerefnombre_de_la_referencia.Las referencias bibliograficas se realizan con el comando\citenombre_referencia_bibtex.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 29 / 51
\begindocument\chapter[Tıtulo 1 en TOC]Tıtulo 1 en documento\labelch:capitulo_uno
\section[Seccion 1.1 en TOC]Seccion 1.1 en documentoLa bibliografıa especializada~\citerockets recomienda que paralanzar un cohete de modelismo es imprescindible realizar una cuenta
atras que comience al menos en cinco (ver seccion \refsec:launch,pagina \pagerefsec:launch)
\chapter[Tıtulo 2 en TOC]Tıtulo 2 en documento
\section[Seccion 2.1 en TOC]Seccion 2.1 en documento\labelsec:launch
% incluir referencias bibliograficas bibtex
\bibliographybibliografia\bibliographystyleplain
\enddocument
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 30 / 51
Hemos preparado un esqueleto de PFC en LATEX que nos permitira:
Ponernos a trabajar sin tener que perder tiempo configurando el preambulodel documento para ajustarse a las directrices de la Universidad de A Coruna.
Incluir la tabla de contenidos de forma automatica.
Incluir tablas y figuras y generar listas de tablas y listas de figuras de formaautomatica.
Incluir automaticamente la bibliografıa utilizada usando bibtex.
Realizar referencias cruzadas entre las diferentes partes y elementos deldocumento. Realizar referencias bibliograficas.
Rotar tablas que por su anchura no quepan si no se colocan en vertical.Disponer de plantillas para los documentos adicionales que hay que incluircomo parte de los tramites a realizar en la entrega del proyecto, ası comopara la portada, dedicatoria y agradecimientos.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 33 / 51
La clase article es muy versatil, ası que hemos preparado un esqueletoque bien podrıa servir para: un artıculo cientıfico o de divulgacion la documentacion de una practica
pasar los apuntes de una asignaturaDe forma predeterminada, la plantilla no introduce el tıtulo deltrabajo en una hoja propia, y no crea tabla de contenidos.
La plantilla que se presenta no utiliza bibTeX, sino el entorno
thebibliography , con las referencias directamente en el.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 35 / 51
Sirve para presentarse como candidato a una oferta de empleo en una
empresa o laboratorio.
Para esta charla hemos preparado un esqueleto en LATEX utilizando laclase article y los entornos de LATEX habituales.
Caracterısticas destacadas:
Inclusion de foto (sı, parece ser que es util y que ayuda al personal deRRHH a no perderse entre tantos CV’s)
Inclusion de un cajetın para el PFC (muchas veces, ese trabajo y latitulacion es la unica carta de presentacion de la que se dispone).
URL: http://www.ctan.org/tex-archive/macros/latex/contrib/cvAunque no lo hemos usado en el esqueleto, LATEX dispone de un paquetellamado CV para este fin.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 36 / 51
CartasLATEX es ideal para escribir cartas formales . Como siempre, siguiendosu filosofıa, nos centramos en el contenido de lo que queremos
expresar. La clase letter se encargara de que el aspecto final seaimpecable.
El gpulero anonimoFacultade de Informatica
Campus de Elvina s/n15071 A Coruna
16 de abril de 2008
Sr/Sra Nipsum OdioMaestranza s/nA Coruna
Estimado Sr/Sra Nipsum,
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Cras quis felis euarcu posuere ornare. Class aptent taciti sociosqu ad litora torquent per co-nubia nostra, per inceptos himenaeos. Vestibulum et nisi. Integer eu arcu necmetus viverra viverra. Maecenas massa nibh, elementum sit amet, ultricesid, elementum in, enim. Quisque eros ipsum, fermentum vestibulum, dignis-sim at, mollis nec, nunc. Curabitur varius venenatis libero. Proin enim. Crasporta ultricies libero. Morbi elit nibh, scelerisque et, dapibus id, lobortis et,mi. Nam rutrum enim et ante. Cum sociis natoque penatibus et magnis disparturient montes, nascetur ridiculus mus.
Maecenas non nisl. Nam augue. Donec ornare, augue vel rhoncus dictum,velit arcu vulputate neque, id mollis purus odio eget est. Nullam commodoadipiscing nunc. Pellentesque a enim viverra sapien mollis aliquam. Proin
ullamcorper tempor tellus. Fusce eleifend diam id turpis. Duis ut mauris.Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam volutpat,nisl et condimentum venenatis, nulla elit condimentum ligula, eu elementumpede erat in elit.
Atentamente,
Gpulero anonimo
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 37 / 51
Al igual que para el PFC, tambien hemos preparado una plantilla parauna tesis doctoral (PhD).
La plantilla tiene numerosos puntos en comun con la del PFC, aunqueen este caso no se ajusta a una normativa tan rıgida. Al igual que laanterior, nos permite: Ponernos a trabajar disponiendo de una estructura adecuada. Incluir, de forma automatica, tabla de contenidos y listas de tablas y
figuras. Incluir automaticamente la bibliografıa utilizada usando bibtex. Realizar referencias cruzadas entre las diferentes partes y elementos del
documento. Realizar referencias bibliograficas. Disponer de plantillas para las diversas partes de las que suele constar
un documento de este estilo: dedicatoria, hoja de firmas. Se incorpora tambien un fichero adicional phdb5.tex para escalar el a4
resultante a tamano b5, mas elegante. Ademas de la portada tradicional, se genera tambien una portada mas
elegante pensada para el formato b5.
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 38 / 51
Para crear una presentacion con LATEX Beamer solo tenemos que:1 Utilizar como clase del documento la clase beamer 2 Seleccionar un tema para nuestra presentacion
si no seleccionamos un tema hay uno predeterminado3 Opcionalmente podemos configurar determinados aspectos de nuestra
presentacion, y algunos temas admiten parametros de configuracion
\documentclassbeamer
\usetheme[secheader]Boadilla
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 41 / 51
Podemos organizar la presentacion como cualquier otro documento,
con secciones, subsecciones, etc.El elemento basico de una presentacion es la diapositiva otransparencia (slide , que dirıan los anglosajones): entorno frame en LATEX Beamer
Tıtulo (opcional) Subtıtulo (opcional)
Contenido
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 42 / 51
Podemos organizar la presentacion como cualquier otro documento,
con secciones, subsecciones, etc.El elemento basico de una presentacion es la diapositiva otransparencia (slide , que dirıan los anglosajones): entorno frame en LATEX Beamer
\beginframe
\frametitleTıtulo (op)
\framesubtitleSubtıtulo (op)
CONTENIDO
Por ej.: \textbf¡HOLA MUNDO!
\endframe
Tıtulo (op)Subtıtulo (op )
CONTENIDO
Por ej: ¡HOLA MUNDO!
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 42 / 51
\ b e g i n f r a m e\ f r a m e t i t l e E je mp lo de d i a p o s i t i v a con \LaTeX\ Beamer
Lo mas u t i l s e r a h ac er un us o i n t e n s i v o de l a s d i s t i n t a s l i s t a s :
\ b e g i n i t e m i z e \ i t e m L a s \ s t r u c t u r e \ i t i t e m i ze , p or e j em p lo
\ b e g i n i t e m i z e \ i t e m s e r a n s i n du da muy u s ad a s\ i t e m e n v a r i o s n i v e l e s , a de ma s\ i t e m a unq ue s i n p a s a r s e\en d i t e m i z e
\ i t e m L a s \ s t r u c t u r e \ i t e n u m e r a te t a m b ie n s o n f r e c u e n t e s\ b e g i n e n u m e r a t e \ i t e m s u u so e s e x ac t am e nt e e l mismo\ i t e m como c a b r ı a e s p e r a r\ i t e m q ue e n c u a l q u i e r d oc um en to \LaTeX\en d e n u m e r a t e
\en d i t e m i z e
\ b e g i n b l o c k Con e s t e b lo qu e r e s a l t o c o sa sP od em os m e t e r t a m b i e n l i s t a s y o t r o c o d i g o \LaTeX\ d e n tr o d e l b l oq u e .E l e n to r no \ s t r u c t u r e \ i t d e s c r i p t i o n , p or e j em p lo :\ b e g i n d e s c r i p t i o n \ i t e m [ e s to ] d e s c r i p c i o n de e st o\ i t e m [ e so ] d e s c r i p c i o n de e s o\ i t e m [ a q u e l l o ] d e s c r i p c i o n de a q u e l l o\en d d e s c r i p t i o n
\en d b l o c k
\en d f r a m e
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 45 / 51
\ b e g i n f r a m e C i r c u i t o s l o g i c o s y s ı m b o l o s F un ci on es b i n a r i a s con una s o l a e n tr a da \ b e g i n i t e m i z e \ i t e m F u n c io n e s u n a r i a s : $2ˆ2ˆ 1=4$ p o s i b i l i d a d e s :
\ b e g i n i t e m i z e
\ i t e m F u n c io n c e ro \ i t e m F u n c io n i d e n t i d ad\ i t e m F u n c ion NOT \ i t e m F u n c io n u n id a d\en d i t e m i z e
\en d i t e m i z e
\ b e g i n t a b l e \ b e g i n t a b u l a r c@\ h s p a c e 0.7cm c c c c \ t o pr u l e & $ f 0 $ & $ f 1 $ & $ f 2 $ & $ f 3$\\X & $ 0 $ & $ X $ & $\ o v e r l i n e X$ & $ 1 $\\\ m i d r u l e
0 & 0 & 0 & 1 & 1\\1 & 0 & 1 & 0 & 1\\\ b o t t o m r u l e\en d t a b u l a r \ c a p t i o n F un ci on es de una v a r i a b l e
\en d t a b l e
\ b e g i n c o l u m n s\column 0.47\ t e x t w i d t h \ b e g i n b l o c k Ma te m at ic as
v a r . \ i t a c t i v a = v a l . l o g . ’ $1 $ ’\\v a r . \ i t no a c t i v a = v a l . l o g . ’ $ 0 $ ’\en d b l o c k \column 0.5\ t e x t w i d t h \ b e g i n b l o c k F ı s i c a me n t e : 2 n i v e l e s de t e n s i o n
v a l o r \ i t a l t o ’ H’ ( h i gh , $\ s im eq 5˜ vo l $ , $V c c $)\\v a l o r \ i t b a j o ’ L ’ ( low , $\ s im eq 0˜ v o l $ , $GND$)
\en d b l o c k \en d c o l u m n s
\en d f r a m e
Circuitos logicos y sımbolosFunciones binarias con una sola entrada
Funciones unarias: 221= 4 posibilidades:
Funcion cero Funcion identidad Funcion NOT Funcion unidad
f 0 f 1 f 2 f 3X 0 X X 1
0 0 0 1 11 0 1 0 1
Cuadro: Funciones de una variable
Matematicas
var. activa = val. log. ’1’var. no activa = val. log. ’0’
Fısicamente: 2 niveles de tension
valor alto ’H’ (high, 5 vol , V cc )valor bajo ’L’ (low, 0 v ol , G N D )
() 17 de abril de 2009 1 / 1
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 46 / 51
Los diferentes temas de beamer permiten generar una primeradiapositiva con tıtulo, autores y demas:
1 En el preambulo del documento disponemos de una serie de comandospara anadir informacion sobre la presentacion:
\ t i t l e Documentaci on d e a l t a c a l i d a d con \LaTeX
\ a u t h o r [ I X X or na da s s o b r e S o f t wa r e L i b r e ]\mboxMauro S i l v o s a R i v e r a( m a u r o @ m e l e e i s l a n d . n e t ) \an d \mbox E m i l i o J . P ad ro n G o n z a l e z ( e m i l i o j @ u d c . e s ) \ i n s t i t u t e [ GPUL ] G ru po d e U s u a r i o s y P r o gr a m ad o r es d e L i n u x ( GPUL)\ d a t e \ t o d a y
2 Los distintos temas tambien hacen uso de esa informacion enencabezados y pies de pagina
3
Para generar la pagina de tıtulo:\ frame \ t i t l e p a g e
IX Xornadas sobre Software Libre (GPUL) Documentacion de alta calidad con LATEX 30 de marzo de 2011 47 / 51