Reviews in Latex: how to

Check out and compile your review

  • Open PDGworkspace 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:
  • 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 includes 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 instructions.pdf
  • There are certain files that you should not modify. If you do, your changes will be overwritten in svn daily.
    • 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

Sections titles

  • Use the standard latex syntax:
    \section{Title of the section}\label{basename:sec:_meaningful name_}

Add a figure

  • To add a figure, make sure to add a figure into the subdirectory figures (there is already a file in the subdirectory for your convenience)
  • the command to add a figure in your review is the following:
    \pdgfigure{ the name of the file, found in the figures directory }{ your caption }{ label }{option to determine the position }{other options}
  • For example:
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex-tutorial:fig:ideogram}{}{}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex-tutorial:fig:ideogram}{}{width=0.4\textwidth}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex-tutorial:fig:ideogram}{h!}{width=0.4\textwidth}
  • If you want to add a reference to the figure in the text, you can use the following command:
  • For example: see Fig. \ref{latex-tutorial:fig:ideogram}
  • good practice for the label is to use: basename:fig:some-meaningful-name_

Add a table

  • To add a table, we use the following environment :
    \pdgtable{ dimension of the table }{ your caption }{ label }{options}
  • for example, to add a table with three columns, with the text centered:
       {|c|c|c|} {This is an example table}{latex-tutorial:tab:mytable}{}
       \pdgtableheader{Colum1 & Column2 & Column3} 
       row1 & 1 & 2\\
       row2 & 1 & 2\\
  • If you want to add a reference to the table in the text, you can use the following command:
    see Table \ref{latex-tutorial:tab:mytable}

Add a reference

  • References are handled using BibTeX. To add a reference to your review:
    • Look up the reference in INSPIRE and download its BibTeX entry (see bottom of the "Information" tab for the article, under "Export").
    • Add the BibTeX entry to your review's .bib file. Note the article tag assigned by INSPIRE - you can see it in the first line of the BibTeX entry, after "@article{".
    • Cite the reference with "\cite", using the article tag assigned by INSPIRE.
  • For example, to add the following reference:
    • add the following code in the BASENAME.bib file:
            author         = "Tanabashi, M. and others",
            title          = "{Review of Particle Physics}",
            collaboration  = "Particle Data Group",
            journal        = "Phys. Rev.",
            volume         = "D98",
            year           = "2018",
            number         = "3",
            pages          = "030001",
            doi            = "10.1103/PhysRevD.98.030001",
            SLACcitation   = "%%CITATION = PHRVA,D98,030001;%%"
    • add a reference to it in BASENAME-main.tex using the following command: \cite{Tanabashi:2018oca}
  • In case the reference does not appear in INSPIRE, use the standard convention for the label: BASENAME:_meaningful_name
  • In case you need to add multiple references within the same set of brakets, use the following code: \cite{paper1,paper2}
  • In case you want to cluster into one reference multiple papers, use the following code: \cite{paper1,*paper2,*paper3} Note the use of the asterisk to signal trailing papers. If a paper is preceded by the asterisk, it can't be cited separately later - latex will fail and provide an error. In general, the recommendation is to cite papers individually, without using the asterisk to group them.

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 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 update
    • click on pass to editor

-- No permission to view TWiki.UserReports

Topic attachments
I Attachment History Action Size Date Who Comment
PDFpdf instructions.pdf r1 manage 341.4 K 2019-05-22 - 19:22 ElisabettaPianori  
Compressed Zip archivetar intro.tar r2 r1 manage 170.0 K 2018-10-25 - 14:55 ElisabettaPianori  
Edit | Attach | Watch | Print version | History: r15 < r14 < r13 < r12 < r11 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r15 - 2019-05-22 - ElisabettaPianori
This site is powered by the TWiki collaboration platform Powered by PerlCopyright Information: This page and all following are copyrighted by the Regents of the University of California