CAMCAO Infrared Camera Demonstraao do template c

OVER WHELMINGLY LARGE TELESCOPE Multi Conjugate Adaptive Optics Demonstrator CAMCAO Infrared Camera
Demonstrao do template ca
Doc. No.: OWL-PLA-FCL-60000-XXXX Issue: 1.0 Date: 06.07.2004

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

CHANGE RECORD
Issue Date Section / Paragraph aected Reason / Initiation Documents / Remarks

Author(s) Jorge Lima

06.07.2004 All

First issue

Approval

A. Amorim

Release Author(s) Approval Release Author(s) Approval Release Author(s) Approval Release Author(s) Approval Release

Jorge Lima

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Contents
1 Applicable and Reference Documents 1.1 Applicable Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Reference Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Acronyms 3 Scope 4 Introduction 5 Seces e ans co 5.1 E agora uma subseco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ca 6 Referncias e
A 7 Pontuao em L TEX ca

4 4 4 5 6 6 6 6 7 7 8 8 8 10 12

8 Comandos espec cos da classe camcaofdr.cls 8.1 S mbolos para unidades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.2 Figuras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.2.1 Figuras lado a lado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Transcrio do cdigo fonte ca o

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

1
1.1
No.

Applicable and Reference Documents

Applicable Documents
Document title Reference OWL-TRE-FCL-60000-0101 Issue 1.0 Date 14.05.2003

AD1 Mechanics Preliminary Design Report AD2 Cryogenics Preliminary Design Report AD3 Cabling Preliminary Design Report

OWL-TRE-FCL-60000-0102

1.0

14.05.2003

OWL-TRE-FCL-60000-0103

1.0

14.05.2003

1.2
No.

Reference Documents
Document title Reference OWL-TRE-FCL-60000-0101 Issue 2.0 Date 21.07.2003

RD1 Mechanics Preliminary Design Report RD2 Cryogenics Preliminary Design Report RD3 Cabling Preliminary Design Report

OWL-TRE-FCL-60000-0102

1.0

14.05.2003

OWL-TRE-FCL-60000-0103

1.0

14.05.2003

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Acronyms

ESO European Southern Observatory FCUL Faculdade de Cincias da Universidade de Lisboa e FoV Field of View INETI Instituto Nacional de Engenharia e Tecnologia Industrial LIP Laboratrio de Instrumentao e F o ca sica Experimental de Part culas PID Proportional, Integral and Dierential

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Scope

Este documento uma demonstrao da utilizao do template para a documentao do projecto e ca ca ca CAMCAO. Para compreender plenamente a utilizao do template deve comparar-se o cdigo deste docuca o mento com o resultado nal. Essa a melhor maneira de assimilar rapidamente a forma de usar as e vrias construes. a co Por exemplo, no quer dar uma olhadela ao cdigo fonte para ver como se escreveu a palavra a o CAMCAO acima, ou template?.

Introduction

Os documentos repartem-se, naturalmente, em seces, subseces, subsubseces, pargrafos destaco co co a cados. no confundir com os pargrafos normais . Para cada uma destas divises do documento a a o existe um comando espec co que realiza varias tarefas complexas. A mais evidente a formatao e ca automtica do t a tulo da diviso. Por detras da cena, contudo, realiza muitas outras tarefas: increa menta os contadores de seco ou pargrafo que sero posteriormente utilizados na construo da ca a a ca tabela de contedos e nas referncias cruzadas. u e

Seces e ans co

Acabamos de abrir uma seco. ca

5.1

E agora uma subseco ca

Para nalizar com as seces deve-se acrescentar que se se pretender fazer uma referencia posterior co a uma determinada seco tem que se especicar o argumento o label no argumento opcional do ca comando \section{...}. Por exemplo, denindo a seco: ca \section[secAfins]{Sec~es e afins} co Pode-se fazer referncia ` mesma com o comando 5). Com os comandos \subsection{...}, e a \subsubsection{...} e assim por diante, passa-se exactamente da mesma forma. O que anal um pargrafo destacado? E isto mesmo que est a ver. E qual a diferena e a a c para um pargrafo normal? Para alm do t a e tulo car a negrito? Por exemplo, podemos fazer uma referncia automtica a este pargrafo usando o comando \ref{par:xpto}, em que xpto foi e a a o label especicado quando se deniu o pargrafo. a Temos ainda os pargrafos normais, de que feita a maior parte do texto de um documento. a e A A Para criar um pargrafo em L TEX Veja no cdigo fonte como se escreveu L TEX. E, j agora, a o a como se fazem travesses. deixa-se uma linha em branco. Por exemplo: o Aqui temos um pargrafo. a

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

E aqui temos outro. Mas este texto no constitui um pargrafo ` parte (veja o cdigo para a a a o perceber do que estou a falar).

Referncias e

Frequentemente necessrio fazer referncias a partes do documento. Podendo ser a guras, tabelas, e a e seces ou mesmo a outros documentos. A forma como essas referncias so feitas, nomeadamente co e a as referncias a outros documentos convencionada. e e Na norma adoptada para os documentos do CAMCAO as referncia a documentos externos e e sempre remetida para as listas de documentos de referncia e documentos aplicveis no in e a cio do documento. Assim, estas referncias externas funcionam como uma referncia interna. e e A X e do template denido no cheiro camcaofdr.cls, as referncias Do ponto de vista do L TE e so suportadas pelo conjunto de comandos descrito a seguir. a \ref{RD:mechanicsPDR} Produz a referncia ao documento RD1. e \ref{AP:cablingPDR} Enquanto este produz a referncia ao documento AD3. e \ref{fig:image1} E uma referncia ` gura 1 que se encontra na pgina 9. e a a \ref{sec:intro} Referencia a seco 4 da pgina 6. ca a \ref{par:destacado} Referencia ao pargrafo da subseco 5.1 (porque o pargrafo no tem nua ca a a merao), na pgina 6. ca a

A Pontuao em LTEX ca

A Vejamos agora como se utilizam os vrios sinais de pontuao em L TEX. Para tal vamos usar uma a ca nova construo: uma lista enumerao. ca ca

Os vrios sinais -, , e tm signicados diferentes. a e Usa-se - como hifen (tal como em usa-se). Usa-se para representar gamas de valores, como em varia entre 28. O simbolo usa-se como sinal de pontuao (travesso) ca a Para representar o sinal de subtraco tem que se entrar em modo matemtico: 2 ca a log x

H ainda outros aspectos importantes relativos a pontuao. Por exemplo, nunca use o caracter a ca para representar aspas. Veja como se fez no documento. A J para deixar espaos inquebrveis (para prevenir que o L TEX quebre a linha por esse espao) a c a c faz-se como se mostra na seguinte frase:

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

O vencedor do prmio Nobel da economia no malfadado ano de 2003 foi o Prof. Dr. J. Jones e pelo seu trabalho notvel de sobreviver em portugal durante 6 meses. a E agora usando espaos normais: c O vencedor do prmio Nobel da economia no malfadado ano de 2003 foi o Prof. Dr. J. e Jones pelo seu trabalho notvel de sobreviver em portugal durante 6 meses. a J para forar uma linha a quebrar-se a c por determinado sitio faz-se assim.

Comandos espec cos da classe camcaofdr.cls

Nesta seco vamos tentar dar uma viso geral sobre os comandos disponibilizados pela classe ca a camcaofdr.cls. Os comandos esto categorizados. Nas subseces seguintes so tratadas cada a co a uma das categorias.

8.1

S mbolos para unidades

Colocar uma unidade a seguir a um valor, como em 2.0 mm, parece uma coisa muito simples!? Parece, mas no . a e Com efeito h algumas subtilezas relacionadas com as unidades: a Em primeiro lugar o espao que separa os s c mbolos das unidades dos respectivos valores e diferente do espao proporcional do texto normal. c Ainda que o argumento acima parea um preciosismo, o facto que se tratarmos o espao c e c que separa o valor do s mbolo das unidades como um espao normal corremos o risco de ter o c valor numa linha e o s mbolo de unidade na outra. Alm do que j foi dito, alguns s e a mbolos de unidades no esto dispon a a veis nos conjuntos de caracteres ASCII. \nm \um \mm \cm nanometros micrometros milimetros centimetros

8.2

Figuras

Para inserir guras foram providenciados comandos que asseguram que a gura inserida no doce umento de forma a respeitar o estilo adoptado para este. Continua a ser poss vel inserir guras A recorrendo aos comandos de L TEX. Contudo, essa prtica desencorajada, pois redunda necessaria e amente na proliferao de estilos e estticas inconsistentes entre os vrios documentos. Sobretudo, ca e a pode resultar na proliferao de erros que so dif ca a ceis de detectar. 8

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Figure 1: Imagem escalada para ocupar 6.5 cm de altura

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Para inserir uma gura com uma altura determinada faa o seguinte (veja o cdigo do documento c o na seco 9): ca Para inserir uma a toda a largura do texto, faa: c \insertfigureFW{image2}{Imagem escalada para ter a largura do texto} ou para inserir uma imagem ocupando apenas uma percentagem da largura do texto: \insertfigureFW[0.5]{image2}{Imagem escalada para ter a largura do texto} Vejamos um exemplo na gura 2

Figure 2: Imagem escalada para ter a largura do texto As guras devem encontrar-se no directorio ./figures.

8.2.1

Figuras lado a lado

Estas guras partilham a mesma legenda mas so referenciadas por \ref{fig:xpto} em que xpto a o nome da imagem associada. Essa referncia substituida por #(a) ou #(b). e e e Assim, mais tarde podem fazer-se as seguintes referncias ` gura. Por exemplo: veja a gura e a 3(a) (que se encontra na pgina 11, do lado esquerdo) e tambm a gura 3(b). a e

10

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

(a)

(b)

Figure 3: Exemplo de duas guras colocadas lado a lado. A gura (a) encontra-se sempre do lado esquerdo e a gura (b) do lado direito.

11

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Transcrio do cdigo fonte ca o

Nesta seco encontra uma transcrio intergral do cdigo deste documento. E muito interessante ca ca o vericar como isso foi conseguido. Para este efeito to especial foi necessario carregar o pacote a moreverb. Tal feito colocando o comando \usepackage{moreverb} no cheiro mycommands.tex. e %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % Projecto CAMCAO % % % % Documenta~o para o FDR ca % % % % Documento: demo.tex % % Descri~o: documento de demonstra~o da utiliza~o do template ca ca ca % % % % Autor: Jorge Lima % % Data: 17/11/2003 % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% % Sec~es obrigatrias co o % \isection{Scope} Este documento uma demonstra~o da utiliza~o do \emph{template} para a e ca ca documenta~o do projecto \textbf{CAMCAO}. ca Para compreender plenamente a utiliza~o do \emph{template} deve comparar-se o ca cdigo deste documento com o resultado final. Essa a melhor maneira de o e assimilar rapidamente a forma de usar as vrias constru~es. a co Por exemplo, n~o quer dar uma olhadela ao cdigo fonte para ver como se a o escreveu a palavra \textbf{CAMCAO} acima, ou \emph{template}?.

\isection[intro]{Introduction} Os documentos repartem-se, naturalmente, em sec~es, subsec~es, co co subsubsec~es, pargrafos destacados. --- n~o confundir com os pargrafos co a a a normais --- . Para cada uma destas divis~es do documento existe um comando o 12

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

especfico que realiza varias tarefas complexas. A mais evidente a e formata~o automtica do ttulo da divis~o. Por detras da cena, contudo, ca a a realiza muitas outras tarefas: incrementa os contadores de sec~o ou ca pargrafo que ser~o posteriormente utilizados na constru~o da tabela de a a ca contedos e nas refer^ncias cruzadas. u e

\isection[secAfins]{Sec~es e afins} co Acabamos de abrir uma sec~o. ca \isubsection[eAgora]{E agora uma subsec~o} ca Para finalizar com as sec~es deve-se acrescentar que se se pretender fazer co uma referencia posterior a uma determinada sec~o tem que se especificar o ca argumento o \emph{label} no argumento opcional do comando \verb#\section{...}#. Por exemplo, definindo a sec~o: ca % \begin{verbatim} \section[secAfins]{Sec~es e afins} co \end{verbatim} % Pode-se fazer refer^ncia ` mesma com o comando \ref{sec:secAfins}). e a Com os comandos \verb#\subsection{...}#, \verb#\subsubsection{...}# e assim por diante, passa-se exactamente da mesma forma. \iparagraph[destacado]{O que afinal um pargrafo destacado?} e a isto mesmo que est a ver. --- E qual a diferena para um pargrafo normal? E a c a Para alm do ttulo ficar a \textbf{negrito}? --- Por exemplo, podemos fazer e uma refer^ncia automtica a este pargrafo usando o comando e a a \verb#\ref{par:xpto}#, em que \verb#xpto# foi o \emph{label} especificado quando se definiu o pargrafo. a Temos ainda os pargrafos normais, de que feita a maior parte do texto de um a e documento. Para criar um pargrafo em \LaTeX\ --- Veja no cdigo fonte como se a o escreveu \LaTeX. E, j agora, como se fazem travess~es. --- deixa-se uma linha a o em branco. Por exemplo: Aqui temos um pargrafo. a E aqui temos outro. 13

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Mas este texto n~o constitui um pargrafo ` parte (veja o cdigo para perceber a a a o do que estou a falar). \isection[refs]{Refer^ncias} e Frequentemente necessrio fazer refer^ncias a partes do documento. Podendo e a e ser a figuras, tabelas, sec~es ou mesmo a outros documentos. A forma como co essas refer^ncias s~o feitas, nomeadamente as refer^ncias a outros documentos e a e convencionada. e Na norma adoptada para os documentos do CAMCAO as refer^ncia a documentos e externos sempre remetida para as listas de documentos de refer^ncia e e e documentos aplicveis no incio do documento. Assim, estas refer^ncias a e externas funcionam como uma refer^ncia interna. e Do ponto de vista do \LaTeX\ e do \emph{template} definido no ficheiro \texttt{camcaofdr.cls}, as refer^ncias s~o suportadas pelo conjunto de e a comandos descrito a seguir. \begin{description} \item[{\tt $\backslash$ref\{RD:mechanicsPDR\}}] Produz a refer^ncia ao documento \ref{RD:mechanicsPDR}. e \item[{\tt $\backslash$ref\{AP:cablingPDR\}}] Enquanto este produz a refer^ncia ao documento \ref{AP:cablingPDR}. e \item[{\tt $\backslash$ref\{fig:image1\}}] uma refer^ncia ` figura \ref{fig:image1} que se encontra na E e a pgina \pageref{fig:image1}. a \item[{\tt $\backslash$ref\{sec:intro\}}] Referencia a sec~o \ref{sec:intro} da pgina \pageref{sec:intro}. ca a \item[{\tt $\backslash$ref\{par:destacado\}}] Referencia ao pargrafo da subsec~o \ref{par:destacado} (porque o a ca pargrafo n~o tem numera~o), na pgina a a ca a \pageref{par:destacado}. \end{description}

\isection[pntLatex]{Pontua~o em \LaTeX} ca 14

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

Vejamos agora como se utilizam os vrios sinais de pontua~o em \LaTeX. a ca Para tal vamos usar uma nova constru~o: uma lista enumera~o. ca ca \begin{itemize} \item Os vrios sinais -, --, --- e $-$ t^m significados a e diferentes. \item Usa-se - como hifen (tal como em usa-se). \item Usa-se -- para representar gamas de valores, como em varia entre 2--8. \item O simbolo --- usa-se como sinal de pontua~o (travess~o) ca a \item Para representar o sinal de subtrac~o tem que se entrar em modo ca matemtico: $2 - \sqrt{\log x}$ a \end{itemize}

H ainda outros aspectos importantes relativos a pontua~o. Por exemplo, nunca a ca use o caracter ~\texttt{\"}~ para representar aspas. Veja como se fez no documento. J para deixar espaos inquebrveis (para prevenir que o \LaTeX\ quebre a linha a c a por esse espao) faz-se como se mostra na seguinte frase: c \begin{quote} O vencedor do prmio Nobel da economia no malfadado ano de 2003 foi o e Prof.~Dr.~J.~Jones pelo seu trabalho notvel de sobreviver em portugal durante a 6 meses. \end{quote} E agora usando espaos normais: c \begin{quote} O vencedor do prmio Nobel da economia no malfadado ano de 2003 foi o e Prof. Dr. J. Jones pelo seu trabalho notvel de sobreviver em portugal durante a 6 meses. \end{quote}

15

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

J para forar uma linha a quebrar-se\\ por determinado a c sitio faz-se assim.

\isection{Comandos especficos da classe {\bf\tt camcaofdr.cls}} Nesta sec~o vamos tentar dar uma vis~o geral sobre os comandos ca a disponibilizados pela classe {\bf\tt camcaofdr.cls}. Os comandos est~o a categorizados. Nas subsec~es seguintes s~o tratadas cada uma das categorias. co a \isubsection{Smbolos para unidades} Colocar uma unidade a seguir a um valor, como em 2.0\mm, parece uma coisa muito simples!? Parece, mas n~o . a e Com efeito h algumas subtilezas relacionadas com as unidades: a \begin{itemize} \item Em primeiro lugar o espao que separa os smbolos das unidades dos c respectivos valores diferente do espao proporcional do texto normal. e c \item Ainda que o argumento acima parea um preciosismo, o facto que se c e tratarmos o espao que separa o valor do smbolo das unidades como um espao c c normal corremos o risco de ter o valor numa linha e o smbolo de unidade na outra. \item Alm do que j foi dito, alguns smbolos de unidades n~o est~o e a a a disponveis nos conjuntos de caracteres ASCII. \end{itemize} \begin{center} \begin{tabular*}{6.5cm}{ll} \verb#\nm# & nanometros \\ \verb#\um# & micrometros \\ \verb#\mm# & milimetros \\ \verb#\cm# & centimetros \\ \end{tabular*} \end{center}

16

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

\isubsection{Figuras} Para inserir figuras foram providenciados comandos que asseguram que a figura inserida no documento de forma a respeitar o estilo adoptado para este. e Continua a ser possvel inserir figuras recorrendo aos comandos de \LaTeX. Contudo, essa prtica desencorajada, pois redunda necessariamente na a e prolifera~o de estilos e estticas inconsistentes entre os vrios documentos. ca e a Sobretudo, pode resultar na prolifera~o de erros que s~o difceis de ca a detectar. Para inserir uma figura com uma altura determinada faa o seguinte (veja o c cdigo do documento na sec~o \ref{sec:code}): o ca \insertfigure[6.5cm]{image1}{Imagem escalada para ocupar 6.5\cm\ de altura} Para inserir uma a toda a largura do texto, faa: c \begin{verbatim} \insertfigureFW{image2}{Imagem escalada para ter a largura do texto} \end{verbatim} ou para inserir uma imagem ocupando apenas uma percentagem da largura do texto: \begin{verbatim} \insertfigureFW[0.5]{image2}{Imagem escalada para ter a largura do texto} \end{verbatim} Vejamos um exemplo na figura \ref{fig:image2} \insertfigureFW{image2}{Imagem escalada para ter a largura do texto} As figuras devem encontrar-se no directorio \texttt{./figures}. \isubsubsection{Figuras lado a lado} Estas figuras partilham a mesma legenda mas s~o referenciadas por a \verb=\ref{fig:xpto}= em que \verb=xpto= o nome da imagem associada. Essa e refer^ncia substituida por \#(a) ou \#(b). e e

\inserttwinfigure[6cm]{twin_a}{twin_b}{Exemplo de duas figuras colocadas lado a 17

CAMCAO Infrared Camera Demonstraao do template c

Ref: OWL-PLAFCL-60000-XXXX Issue: 1.0 Date: 06.07.2004 Author: J. Lima

lado. A figura (a) encontra-se sempre do lado esquerdo e a figura (b) do lado direito.} Assim, mais tarde podem fazer-se as seguintes refer^ncias ` e a figura. Por exemplo: veja a figura \ref{fig:twin_a} (que se encontra na pgina a \pageref{fig:twin_a}, do lado esquerdo) e tambm a figura \ref{fig:twin_b}. e

\isection[code]{Transcri~o do cdigo fonte} ca o Nesta sec~o encontra uma transcri~o intergral do cdigo deste ca ca o documento. muito interessante verificar como isso foi conseguido. E Para este efeito t~o especial foi necessario carregar o pacote a \texttt{moreverb}. Tal feito colocando o comando e \verb#\usepackage{moreverb}# no ficheiro \texttt{mycommands.tex}. %\verbatimtabinput{body.tex} \verbatiminput{body.tex}

18