Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
sep:internal:report [2009/09/30 19:27]
mohammad
sep:internal:report [2009/09/30 19:51]
mohammad A general update from Make to SCONS, and RCS with Wikipage
Line 1: Line 1:
 ====== SEP Report Guidelines ====== ====== SEP Report Guidelines ======
 +
  
 This page attempts to synthesize the current SEP report building  This page attempts to synthesize the current SEP report building 
Line 70: Line 71:
   * **D minus 8 days (Wed):** Now also is the time to build the preliminary table of contents, which will be needed to assign reviewers to papers. The quickest way to do it is to send to the printer a second copy of the 2-page papers built for Biondo, take the stack and write the names of the corresponding report directories on top of each front page, arrange them on a large table according to categories, edit the Makefile in the Adm directory accordingly, then type "make toc.tex" to edit the table of contents. "scons toc.pdf" or "scons paper.pdf" will likely not work because, unlike toc.tex, they need the papers to build, and if people are still working on some papers, they may not build. Use "makeTOCreadable.sh" (found in the Adm directories of SEP-128 and subsequent reports) to generate a readable TOC.   * **D minus 8 days (Wed):** Now also is the time to build the preliminary table of contents, which will be needed to assign reviewers to papers. The quickest way to do it is to send to the printer a second copy of the 2-page papers built for Biondo, take the stack and write the names of the corresponding report directories on top of each front page, arrange them on a large table according to categories, edit the Makefile in the Adm directory accordingly, then type "make toc.tex" to edit the table of contents. "scons toc.pdf" or "scons paper.pdf" will likely not work because, unlike toc.tex, they need the papers to build, and if people are still working on some papers, they may not build. Use "makeTOCreadable.sh" (found in the Adm directories of SEP-128 and subsequent reports) to generate a readable TOC.
  
-  * **D minus 6 days (Fri):** Update sign-up wiki page:  +  * **D minus 6 days (Fri):** Update sign-up [[sep:internal:proofread1 | signup wiki page]]:  
-setenv rep_num 134 \\  setenv rep_adm /net/koko/wrk1/sep$rep_num/Adm\\  pushd /net/sepwww/sepwww/pub/internal/report\\  $rep_adm/makeTOCreadable.sh $rep_adm/toc.tex rev$rep_num.html -r\\  mkdir RCS\\  popd\\ "+If you prefer the RCS system, you can update by  
 +<code> 
 +setenv rep_num 134 \\  setenv rep_adm /net/koko/wrk1/sep$rep_num/Adm\\  pushd /net/sepwww/sepwww/pub/internal/report\\  $rep_adm/makeTOCreadable.sh $rep_adm/toc.tex rev$rep_num.html -r\\  mkdir RCS\\  popd\\ 
 +</code>
  
-Fill in by hand 1st reviewer for inexperienced writers and eliminate 3rd reviewer slot for everyone else.Estimate the number of papers people should sign up for in the first round and let people know that they can start signing up. 
  
   * **D minus 3 days (Mon):**Check that a paper.pdf exists in each directory and that all reviewer slots on the sign-up sheet are filled. Let people know that they can start reviewing and remind them the instructions on the webpage.   * **D minus 3 days (Mon):**Check that a paper.pdf exists in each directory and that all reviewer slots on the sign-up sheet are filled. Let people know that they can start reviewing and remind them the instructions on the webpage.
Line 79: Line 82:
   * **D minus 2 days (Tue):** "mkdir /net/koko/wrk1/sep134/Filler". Remind people to prepare submissions for the title page contest and filler pages.   * **D minus 2 days (Tue):** "mkdir /net/koko/wrk1/sep134/Filler". Remind people to prepare submissions for the title page contest and filler pages.
  
-  * **D-day (Thu):** Start building the report. First make a backup (Use "cd /wrk1; tar -cvzf sep134.tgz sep134" to preserve file dates – breaking them can result in make rebuilds waiting to happen).+  * **D-day (Thu):** Start building the report. First make a backup (Use ''cd /wrk1; tar -cvzf sep139.tgz sep139'' to preserve file dates – breaking them can result in make rebuilds waiting to happen).
  
-Place a title page figure (dummy or real), by setting for example "RESULTSNR = title.ps" and "RESDIR = ../Filler" in "Adm/Makefileand by copying "title.ps" in "Filler".+Place a title page figure (dummy or real), by copying the figure file in "Filler" and changing the ''SConstruct'' as 
 +<code> 
 +"RESULTSNR = cover.ps"  
 +"RESDIR = ../Filler"  
 +</code> 
 +Type "sconsin the "sep139" directory, then dive in the "sconsrules to see where the process crashed.
  
-Type "make paper.ps" in the "Adm" directory, then dive in the "make" rules to see where the process crashed. +If ER/CR figures start rebuilding, you may have to use drastic measures such as temporarily replacing paper report makefiles with dummy makefiles containing only  
- +<code> 
-If ER/CR figures start rebuilding, you may have to use drastic measures such as temporarily replacing paper report makefiles with dummy makefiles containing only "include SEP.top", "RESDIR=Fig/", "RESULTSER=[names of results]"same for CR and NR"include SEP.bottom".+include SEP.top 
 +RESDIR=Fig/ 
 +RESULTSER=[names of results] 
 +"same for CR and NR" 
 +include SEP.bottom 
 +</code>
  
-LaTeX problems can appear on papers written outside of the SEP computer system, for example using "\input file.tex" instead of "\sepinput{file}", if it says it does not find a file ending in ".tex", this may be the cause.+LaTeX problems can appear on papers written outside of the SEP computer system, for example using ''\input file.tex" instead of "\sepinput{file}'', if it says it does not find a file ending in ''.tex'', this may be the cause.
  
-It is preferred that the report is built with "LATOPTS = option=report style=amsmath" in "Adm/Makefile", but sometimes the "amsmath" option breaks old LaTeX keywords in papers wrote without "amsmath". The only solution is then replacing the commands, i.e. "\matrix{}" with "\begin{matrix} \end{matrix}".+It is preferred that the report is built with "LATOPTS = option=report style=amsmath", but sometimes the "amsmath" option breaks old LaTeX keywords in papers wrote without "amsmath". The only solution is then replacing the commands, i.e. "\matrix{}" with "\begin{matrix} \end{matrix}".
  
 When all is done, look at the page number that the last paper ends with, add 1 to it and insert it in the "\setcounter" line in "pub.tex". When all is done, look at the page number that the last paper ends with, add 1 to it and insert it in the "\setcounter" line in "pub.tex".
  
-Have John & Bob look over the table of contents and adjust it.+Have Biondo & Bob look over the table of contents and adjust it.
  
-Use Adobe Acrobat Reader to search for question marks in "paper.pdf". These will give away unresolved figure and bibliographical references.+Use Adobe Acrobat Reader to search for question marks in "book.pdf". These will give away unresolved figure and bibliographical references.
  
 Sometimes the last pages (phone numbers and sponsor lists) appear double-spaced, apparently for no reason. This happens because someone, usually a person who wrote the paper from outside the SEP computer environment, used "\renewcommand\arraystretch{2.00}", usually for double spacing a table. The solution is putting the command immediately between the "\begin{tabular}" (or taking it out altogether) Sometimes the last pages (phone numbers and sponsor lists) appear double-spaced, apparently for no reason. This happens because someone, usually a person who wrote the paper from outside the SEP computer environment, used "\renewcommand\arraystretch{2.00}", usually for double spacing a table. The solution is putting the command immediately between the "\begin{tabular}" (or taking it out altogether)
  
-Include a campus map (found in "sep120/Filler") on the last blank page in the sponsor lists, phone lists, etc+Include a campus map (found in ''Filler'') on the last blank page in the sponsor lists, phone lists, etc
  
-When all is done, convert the ".ps" version of the report to "pdf" for printing using software for which it can be specified that no compression should be applied to images. Usually this means Adobe Distiller on a Mac or a PC. John and Bob are familiar with this operation. 
  
 The printers will return a printed hardcopy for proofreading 1-2 business days after the pdf is uploaded to their site. Only after this is checked it can be safely stated that the report is ready. The printers will return a printed hardcopy for proofreading 1-2 business days after the pdf is uploaded to their site. Only after this is checked it can be safely stated that the report is ready.
Line 108: Line 120:
   * **Putting the report online:** As soon as the single-file version is ready, place links to it from the main page and (if in spring) from Sponsor Meeting page. Make a "tar.gz" backup of the entire report directory.   * **Putting the report online:** As soon as the single-file version is ready, place links to it from the main page and (if in spring) from Sponsor Meeting page. Make a "tar.gz" backup of the entire report directory.
  
-Update the "HTMLDIR" variable in "Adm/Makefile" +Update the "HTMLDIR" variable in "Sconstruct"Take the filler pictures out of the papers completely – the link in "Fig", the "RESULTSNR" entry in the paper’s "Makefile" and the entry at the end of "paper.tex".
- +
-Take the filler pictures out of the papers completely – the link in "Fig", the "RESULTSNR" entry in the paper’s "Makefile" and the entry at the end of "paper.tex".+
  
 Open "$SEPINC/Doc.rules.book" and execute the "www1" target. Do it piece by piece (first the ".ps.gz" targets, then the ".pdf" ones, then the "html" ones), as it is highly probable to fail somewhere anyway. Inspect especially the html output, this is prone to silent failure. Missing equation gifs can appear if the "make" command is executed from another machine then "koko". Missing figures are very frequently caused by ".eps" figures and they are solved by making a link from "filename.eps" to "filename.ps" in the "Fig" directory. Another cause of missing figures is caused by figures that want to rebuild for the html although they were fine for pdf and ps. "Sterilizing" the Makefile by copying the true one to something else and leaving only the include sepinc , RESDIR and RESULTS*R variables solves this problem. Open "$SEPINC/Doc.rules.book" and execute the "www1" target. Do it piece by piece (first the ".ps.gz" targets, then the ".pdf" ones, then the "html" ones), as it is highly probable to fail somewhere anyway. Inspect especially the html output, this is prone to silent failure. Missing equation gifs can appear if the "make" command is executed from another machine then "koko". Missing figures are very frequently caused by ".eps" figures and they are solved by making a link from "filename.eps" to "filename.ps" in the "Fig" directory. Another cause of missing figures is caused by figures that want to rebuild for the html although they were fine for pdf and ps. "Sterilizing" the Makefile by copying the true one to something else and leaving only the include sepinc , RESDIR and RESULTS*R variables solves this problem.
sep/internal/report.txt · Last modified: 2015/05/27 02:06 (external edit)
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0