Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 803

News	FAQ
Search	Home

Adding Notes and Memos

Contributed by Wim Brouw, ATNF
It took me a while to insert a Note in the system and considering the difficulty others have had, I make the following points:

1. Select a note number (I just take the next number available, but maybe there is somebody to ask?) - say nnn (e.g. 225)
2. Create (check in) directory code/doc/notes/nnn.dir (If it's there then others will know the number is taken.)
3. Put the body of your latex Note (without embracing document information like documentstyle, title, \begin{document} etc) in nnn.dir (e.g. ai -l mynote.latex)
4. Create, (in code/doc/notes itself) a file called nnn.latex containing the document information, and which includes mynote.latex (without a directory!) Example:

   \documentclass[11pt]{article}
   \usepackage{html, epsf}
   %%-----------------------------------------------------------------------------
   
   \begin{document}
   
   \title{NOTE 224 -- AIPS++ Least Squares background}
     
   
   \author{Wim Brouw}
   
   \date{22 January 1999}
   
   \maketitle
   %%---------------------------------------------------------------------------
   \htmladdnormallink{A postscript version of this note is available 
   (124kB).}{../224.ps}
   \tableofcontents
         
   \input{lsq.latex}
   \end{document}
   

5. Add your note number to the code/doc/notes/makefile (just do like the other notes, e.g.:

   224 := -split 0
   

6. Test if all ok, by making a Postscript version: gmake nnn.ps
   And an html version:
   gmake nnn
   

7. If all is ok, then add your Note to the Notes index:

      code/doc/notes/notes.dir/nindex.tex
      E.g:
   \item[224]
   \htmladdnormallink{\textit{AIPS++ Least Squares background}}{../224/224.html}
   \linebreak  1999/01/25 Brouw
   

Note: Other notes, AIPS++ documents can include your note or parts of your note by adding the following line to the makefile

TIROOT := $(word 1, $(AIPSPATH))/code/doc
EXTRA_TEXINPUTS := $(TIROOT)/memos/111.dir:$(TIROOT)/notes/156.dir
/notes/196.dir

you then use the \input{file} to include it the other document. The HowTos (code/doc/reference/HowTos.latex) is a good example.