Review Authoring

This page is still in preparation.

Introduction

The PDG review authoring system consists of:

• The Reviews tool in PdgWorkspace, where you can see all PDG reviews, the list of reviews where you have any responsibility, download source files, generate PDF files of a review in different formats, and manage the status and other details of each review.
• Packages in the PDG SVN repository, where the source files for reviews in LaTeX (RPP/reviews) and TeX (LegacyRPP/reviews) are stored.
• The PDG LaTeX style and related tools and utilities.
• Utility scripts for the editor.

While both reviews in LaTeX and in the old TeX/TeXsis format are supported for now, all PDG reviews will be converted to LaTeX as soon as possible. All new reviews must be written in LaTeX.

The following documentation is for reviews in LaTeX.

Instructions for authors

Instructions for overseer

Structure of reviews in LaTeX

Notation

To avoid name clashes, each review is assigned a unique "basename", which is displayed in the review's "Technical details" tab in PdgWorkspace. In the following, "BASENAME" (written all uppercase) stands for the review's basename. For example, the Quantum Chromodynamics review has basename "qcd". Therefore, for this review "BASENAME-main.tex" refers to the file "qcd-main.tex".

Source files

PDG review source files consist of files edited by the review author as well as generated files. Do NOT edit generated files - your changes will be lost as the files are periodically regenerated.

Files edited by review authors:

• BASENAME-main.tex - this file contains the text of your review (you may include other files)
• BASENAME-booklet.tex - contents of the booklet version (if there is one)
• BASENAME-preamble.tex - for review-specific definitions or packages that need to go into the document's preamble
• BASENAME.bib - BibTeX bibliography entries (see below)

Generated files (do not edit them!):

• 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

Additional LaTeX packages and review-specific definitions

Review authorship

Figures

Tables

Labels

References and bibliography

References are handled using BibTeX (maintaining references as a series of \bibitem entries is only acceptable during the transition phase). 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.
• If INSPIRE does not have the reference you wish to cite (e.g. in the case of private communications), you may write your own BibTeX entry using an article tag of the form "RPP:BASENAME:...".

Index