Differences

This shows you the differences between two versions of the page.

sep:software:softtex [2008/10/05 18:40]
jeff
sep:software:softtex [2016/08/23 21:37] (current)
gcalves
Line 18: Line 18:
Building papers with the SCons/RSF package is quite straightforward.  Before beginning, make sure that you have set the correct environmental paths.  On (t)csh shells, this requires setting the following: Building papers with the SCons/RSF package is quite straightforward.  Before beginning, make sure that you have set the correct environmental paths.  On (t)csh shells, this requires setting the following:
-setenv RSFROOT /opt/RSF/ \\ +     setenv RSFROOT /opt/RSF/ \\ 
-setenv PYTHONPATH $(PYTHONPATH):$(RSFROOT)/lib \\+     setenv PYTHONPATH $(PYTHONPATH):$(RSFROOT)/lib \\
In the directory where your paper.tex file is located, you need to make a **SConstruct** file that passes the necessary arguments to SCons.  The general structure of the SConstruct file is: In the directory where your paper.tex file is located, you need to make a **SConstruct** file that passes the necessary arguments to SCons.  The general structure of the SConstruct file is:
-#------------------\\ +     #------------------\\ 
-# SConstruct for building papers\\ +     # SConstruct for building papers\\ 
-from rsftex import *\\ +     from rsftex import *\\ 
-End(resdir='',use='',options='')\\ +     End(resdir=' ',use=' ',options=' ')\\ 
-#------------------\\+     #------------------\\
In the call to End(), the //resdir// option informs SCons where the Figure directory is located.  The //use// option passes on the names of LaTeX packages commonly included in building.  Some common ones include //amsmath, amsfonts// and //color//.  The //options// flag passes on settings about the layout of the document.  For example, when you want to prepare something in a manuscript format (i.e. double-spaced) then you can use //manuscript//.  Other options include //single-sided// and //double-sided//.  You can also change the font size with //11pt// and //12pt//.   In the call to End(), the //resdir// option informs SCons where the Figure directory is located.  The //use// option passes on the names of LaTeX packages commonly included in building.  Some common ones include //amsmath, amsfonts// and //color//.  The //options// flag passes on settings about the layout of the document.  For example, when you want to prepare something in a manuscript format (i.e. double-spaced) then you can use //manuscript//.  Other options include //single-sided// and //double-sided//.  You can also change the font size with //11pt// and //12pt//.  
 +===== Building a Report =====
 +
 +Building a report requires a slightly more involved SConstruct file; however, the process is fairly modular (not completely though!) so individuals will not have to change much in their own directory.  Again, make sure that you have set the correct environmental paths:
 +
 +     setenv RSFROOT /opt/RSF/ \\
 +     setenv PYTHONPATH $(PYTHONPATH):$(RSFROOT)/lib \\
 +
 +The main report directory (liked located at /net/koko/wrk1/sep1??) should contain each author's report(s) in subdirectories.  The default naming convention is your login name followed by a number (e.g. jeff3).  One then has to make a report SConstruct file.  As an example, the one used to generate SEP134 is:
 +
 +     #-----------------------------------------------
 +     from rsfbook import *\\
 +     report =  ( \\
 +            ('Imaging Hessian', 'yaxun1 claudio1 gayeni1'),\\
 +            ('Velocity Analysis','biondo1 claudio2 altheyab1 sjoerd2'),\\
 +            ('Imaging with non-standard coordinates and sources', 'jeff1 jeff2 jeff3 sjoerd1'),\\
 +            ('Computational Interpretation', 'adam1 bob1 bob2'),\\
 +            ('Interpolation','bill2 jon1 xukai1'),\\
 +            ('Amplitudes and anisotropy','jim1 jim2 jim3 mohammad1') )\\
 +     Papers(\\
 +       copyr='by the Board of Trustees of the Leland Stanford Junior University\\\\ \\vspace{2.0in} Copying \\
 +            permitted for all internal purposes of the Sponsors of Stanford Exploration Project',\\
 +       report='SEP-134',\\
 +       group='Stanford Exploration Project',\\
 +       line='Report Number 134, April 2008',year=2008,\\
 +       fig=('Filler','cover','width=\\textwidth'),\\
 +       resdirs={'jim3':"FIG",'biondo1':'Fig/Psfig'},\\
 +       papers=report,bios = '/usr/local/share/TEX/database')\\
 +     End(use='amsmath,amsfonts,amssymb',options='onecolumn')\\
 +     #-----------------------------------------------
\\ \\
 +Note that if individuals have different naming conventions for their figures, then these can be specified using the //resdirs// option.  \\
 +\\
 +Other report making issues:
 +
 +   * Bios - New SEPers will have to create a biography entry and have their picture (in .pdf) taken for inclusion at the end of the report.  This requires creating new entries in // /usr/local/share/TEX/database //.
 +
 +   * Running headers - Make sure that each one of the papers in the reports have the running headers.  If they do not exists, then the running header from the previous paper will continue over to the next paper.
 +
 +
 +=== Latex Hints ===
 +
 +==== LATEX NOTICE ====
 +
 +  * Use AMS Math. package.
 +
 +  * **Do not** put PDF text documents(pages>1) in ''Fig'' folder
 +
 +  * **Do not** use underscores in figure filenames, e.g., ''\plot{model_vel}'' breaks the report.
 +
 +  * Use **Header Commands**
 +  <code>
 +  \lefthead{Maysami}
 +  \righthead{short title of paper}
 +  \footer{SEP--138}
 +  </code>
 +
 +  * **Do not** use ''\email'' command.
 +
 +  * ''\def'' works fine; however, ''\newcommand'' causes  problems when is repeated for defining the same command (e.g include the same macro file in two deifferent aricles) . If you define a new commnd you must add your initials at the beginning of the command name (e.g. \providecommand BLBmycommad {#1}{\par}.) One work-around is ''\providecommand''. The ''\providecommand'' is identical to the ''\newcommand''  if a command with this name does not exist; if it does already exist, the ''\providecommand'' does nothing and the old definition remains in effect.
 +
 +  * In order to fully test each of your papers, you need to make a duplicate copy of the directory containing it (e.g. ''mohammadA'' and ''mohammadB'') into the main report directory and try to build it. For this purpose, you may make a local copy of the report directory in your own home directories and  create two copies of each of your paper directories (e.g. ''mohammadA'' and ''mohammadB''). Then try to build the report with only your own papers in it and see if it works fine or not. If not, you may consider debugging your paper to fix the problems.
 +\\
 +
===== TeX ===== ===== TeX =====
Line 52: Line 114:
LaTeX source files are processed with a plain text editor or word processor. The editor of choice is **GNU Emacs**, empowered by **AUC TeX** package. On Windows, there is a nice shareware program, **Texmaker**, found on [[http://www.xm1math.net/texmaker/]]. LaTeX source files are processed with a plain text editor or word processor. The editor of choice is **GNU Emacs**, empowered by **AUC TeX** package. On Windows, there is a nice shareware program, **Texmaker**, found on [[http://www.xm1math.net/texmaker/]].
-| [[http://research.microsoft.com/users/lamport/|Leslie Lamport]] 's Home Page   \\ [[http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html|LaTeX]] documentation \\  All about [[http://www.latex2html.org/|LaTeX2HTML]] \\ [[http://www.dina.kvl.dk/~abraham/religion/|GNU Emacs]] as a religion, [[http://www.cs.washington.edu/homes/voelker/ntemacs.html|Windows]] port  \\ [[http://sunsite.auc.dk/auctex/|AUC TeX]] package for Emacs |+| [[http://research.microsoft.com/users/lamport/|Leslie Lamport]] 's Home Page   \\ [[http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html|LaTeX]] documentation \\  All about [[http://www.latex2html.org/|LaTeX2HTML]] \\ [[http://www.dina.kvl.dk/~abraham/religion/|GNU Emacs]] as a religion, [[https://www.gnu.org/software/emacs/manual/html_mono/efaq-w32.html#Downloading|Windows]] port  \\ [[https://www.emacswiki.org/emacs/AUCTeX|AUCTex]] package for Emacs |
Recommended books on LaTeX are Recommended books on LaTeX are
Line 65: Line 127:
LaTeX2e allows users to add their own classes to the standard classes ("article", "letter", "book", "report", etc.), supplied in the base LaTeX2e distribution. **SEP2e** is a LaTeX2e class, used at SEP for writing reports, books, and theses. A brief documentation is available as a compressed postscript and HTML. LaTeX2e allows users to add their own classes to the standard classes ("article", "letter", "book", "report", etc.), supplied in the base LaTeX2e distribution. **SEP2e** is a LaTeX2e class, used at SEP for writing reports, books, and theses. A brief documentation is available as a compressed postscript and HTML.
-February 2007, Brad Artman added an example Adm directory for your Thesis directory. All chapter directories live in the Thesis directory. All the files you need in Thesis/Adm are included here: [[Thesis|Thesis/Adm]]. Check out the [[sep:software:softtex:faq#Is there a thesis macro?|thesis faq]] too. One- and two-sided printing now supported (and accepted by the University).+February 2007, Brad Artman added an example Adm directory for your Thesis directory. All chapter directories live in the Thesis directory. All the files you need in Thesis/Adm are included here: [[sep:software:softtex:thesis:Adm|Thesis/Adm]]. Check out the [[sep:software:softtex:faq#Is there a thesis macro?|thesis faq]] too. One- and two-sided printing now supported (and accepted by the University).
To help new users start writing SEP report papers, we provide an example paper in compressed postscript and HTML. To help new users start writing SEP report papers, we provide an example paper in compressed postscript and HTML.
Line 73: Line 135:
\\ \\
 +
===== Scripts ===== ===== Scripts =====
Line 82: Line 145:
\\ \\ \\ \\
{{page>share:footer&nofooter&noeditbtn}} {{page>share:footer&nofooter&noeditbtn}}
 +  * Unordered List Item
/web/html/data/attic/sep/software/softtex.1223232054.txt.gz · Last modified: 2015/05/26 22:41 (external edit)
www.chimeric.de Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0