Changeset 1347 for trunk/doc

Timestamp:

04/26/07 14:27:25 (18 years ago)

Author:

mar637

Message:

move to use latex builder; doc updates for 2.2

Location:

trunk/doc

Files:

• Makefile (deleted)
• SConscript (modified) (1 diff)
• userguide.tex (modified) (4 diffs)

trunk/doc/SConscript

@@ -4 +4 @@
 Import( "env")
 myenv = env.Copy()
-# Maybe someday I can use env.DVI() to execute a re-run....
+
 if myenv["makedoc"].lower() == 'pdf':
-    dvif = myenv.File("#/userguide.dvi")
-    tmps = [ "userguide.aux", "userguide.log", "userguide.idx",  "userguide.dvi"]
-    myenv.Command(dvif,"userguide.tex",
-                ["$LATEX $SOURCE", "$LATEX $SOURCE"])
-    pdfit = myenv.PDF("#/userguide.pdf", "#/userguide.dvi")
-    myenv.Install("#/doc", pdfit)
-    for f in tmps:
-        myenv.AddPostAction(pdfit, Delete(f))
-    myenv.AddPostAction(pdfit, Move("doc/userguide.pdf", str(pdfit[0])))
+    dvif = myenv.File("userguide.tex")
+    pdf = env.PDF(dvif)
 elif myenv["makedoc"].lower() == 'html':
     if os.path.exists("/usr/bin/latex2html"):
         myenv.Command("userguide","userguide.tex",
                       "/usr/bin/latex2html -local_icons $TARGET" )
-#Return()

trunk/doc/userguide.tex

@@ -649 +649 @@
 have a trailing ``\_R'' in the source name for data from Parkes and
 Mopra, and a trailing ``e'' or ``w'' for data from Tidbinbilla.
-This functions has two \cmd{mode}s. \cmd{paired} (the deafault), which assumes matching
-adjacent pairs of source/reference scans and \cmd{time}, which finds the closest
-reference scan in time.
+This functions has two \cmd{mode}s. \cmd{paired} (the deafault), which assumes
+matching adjacent pairs of source/reference scans and \cmd{time}, which finds
+the closest reference scan in time.
 
 \begin{verbatim}
@@ -875 +875 @@
 
 Gain-elevation curves for some telescopes and frequencies are known to
-ASAP (currently only for Tidbinbilla at 20~GHz).  In these cases
-making gain-corrections is simple.  If the gain curve for your data is
-not known, the user can supply either a gain polynomial or text file
+ASAP (currently only for Tidbinbilla at 20~GHz and Parkes at K-band). 
+In these cases making gain-corrections is simple.  If the gain curve for your
+data is not known, the user can supply either a gain polynomial or text file
 tabulating gain factors at a range of elevations (see \cmd{help
 scantable.gain\_el}).
@@ -1927 +1927 @@
 limitations. The data is position switched, observing first an
 reference to the west, then the source twice and finally reference to
-the east.
+the east. Important to note, that \cmd{auto\_quotient} should be executed 
+using the \cmd{mode} `time'.
 
 \begin{verbatim}
@@ -1936 +1937 @@
 
 # Make the quotient spectra
-q = d.auto_quotient()
+q = d.auto_quotient(mode='time')
 print q