ReviewsInLatexTutorial < Pdg

---+ Reviews in Latex: How To

%TOC%<br /><br />
---+ Check out and compile your review

   * Open PDGworkspace [[https://pdgprod.lbl.gov/pdgprod/PdgWorkspace/Reviews.action][PdgWorkspace]].
   * Select *Reviews* from the top row, and then select *my reviews* from the drop-down menu under *Review Filters*
   * Click on the title of the review you want to work on, it will take you to the overview tab for this review.
   * Under the *Technical details* tab, check that the field *Format* is filled with *Latex*. In case it is still filled with *TeXsis*, your review has not been migrated to Latex yet. In this case, ask Piotr to switch your review to LaTeX (make sure to download a copy of the old source files before switching to LaTeX, you won't be able to access it anymore once the review has been switched to Latex in the PdgWorkspace)
   * Under the *Sources file* tab, you can see the instructions on how to check out your review in Latex. You can run the svn command in a command line prompt, or download the tar file from the pdgworskpace interface and extract the archive.
   * In case you are not running latex from a command line, you can find some hints on installing it and running it from a gui at this link: https://pdgdoc.lbl.gov/Pdg/LaTeXHints
   * In case you're working on a command line prompt, the list of commands to be used can be found in pdgworkspace under the *Source File* tab.
   * When working with svn and a command line prompt, it's recommended to run ==svn update== often. This will ensure that you are working with the latest version of the pdg Latex templates

---+ Edit the review

   * To edit the main body of the review, open with your favorite text editor the file *BASENAME-main.tex* where BASENAME is the string associated to your review under the *Technical details* tab in the PdgWorkspace.
   * After the command with the revision date (\revised{August 2018}), you can add some text.
   * The initial LaTeX template will include instructions on how to write a PDG review in LaTeX (*examples.tex*). Once you don't need these instructions anymore, you can simply comment out the corresponding include line in your *BASENAME-main.tex* LaTeX file.
   * An instrucions.pdf file is also stored in the directory: it contains recommendation and instructions on how to use the pdf template. It's also attached to this page [[%ATTACHURL%/instructions.pdf][instructions.pdf]]
   * These instructions includes details and specific examples on how to
      * align equations
      * add wide equations
      * add figures using the PDG macros
      * add tables using the PDG macros
      * add labels and referencing
      * add index entries
      * add bibliography entries
   * %RED%PLEASE NOTE: There are certain files that you should not modify. If you do, your changes will be overwritten in svn daily.%ENDCOLOR%
      * Makefile - Makefile to generate different formats
      * pdg.cls - PDG review sytle file
      * pdg.bst - BibTeX style file
      * pdgdefs.tex - PDG standard symbols and macros
      * BASENAME.tex - driver file for this review in standalone mode
      * examples.tex
---++ Save your changes
   * Once you're done with your changes, you can check the updated source code into svn (or send it to the overseer or the editor). If you work with svn, make sure you run the following command from the directory where the Latex version of the review was downloaded.
      * ==svn update== : it will make sure that you are working with the latest version of the pdg Latex templates
      * ==svn status== : it will list the files that you modified
      * ==svn commit -m "Brief summary of your changes"== : it will copy the changes in the svn repository
   * Now you can go into [[https://pdgprod.lbl.gov/pdgprod/PdgWorkspace/][PdgWorkspace]], select your review, and then under the *Overview* tab click on draft link under *Generate latest version (PDF)*: you should see the updated version of the review.
   * If you're happy of your change and they are final, update the status of the review under the *Overview* tab.
      * click on %BLUE%update%ENDCOLOR%
      * click on %BLUE%pass to editor%ENDCOLOR%

-- %USERSIG{ElisabettaPianori - 2018-10-15}%
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
pdf	instructions.pdf	r3 r2 r1	manage	457.0 K	2023-12-11 - 23:16	Beringer	Instructions for typesetting PDG reviews in LaTeX
tar	intro.tar	r2 r1	manage	170.0 K	2018-10-25 - 14:55	ElisabettaPianori
This topic: Pdg > ReviewsInLatexTutorial
Topic revision: r17 - 2023-12-11 - Beringer