Difference: ReviewsInLatexTutorial (1 vs. 15)

Revision 152019-05-22 - ElisabettaPianori

Line: 1 to 1
 

Reviews in Latex: how to



Line: 9 to 9
 
  • 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)
Changed:
<
<
  • Under the Sources file tab, you can see the instructions on how to check out your review in Latex. If you can, please run the svn command in a command line prompt. Otherwise, download the tar file from the pdgworskpace interface and extract the archive.
  • cd latex_tutorial (or click on the extracted directory)
  • you need to compile the latex code. Type the following lines in a command line prompt:
    • pdflatex latex_tutorial
    • bibtex latex_tutorial.1
    • pdflatex latex_tutorial
    • pdflatex latex_tutorial
  • or
    • make
  • it's a good idea, once in a while, to run svn update . It will make sure that you are working with the latest version of the pdg Latex templates
>
>
  • 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 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.
Added:
>
>
  • 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
Line: 108 to 103
  --
Warning
Can't INCLUDE TWiki.UserReports repeatedly, topic is already included.
Added:
>
>
 
META FILEATTACHMENT attachment="intro.tar" attr="" comment="" date="1540479340" name="intro.tar" path="intro.tar" size="174080" user="ElisabettaPianori" version="2"
Added:
>
>
META FILEATTACHMENT attachment="instructions.pdf" attr="" comment="" date="1558552942" name="instructions.pdf" path="instructions.pdf" size="349570" user="ElisabettaPianori" version="1"

Revision 142019-05-22 - ElisabettaPianori

Line: 1 to 1
 

Reviews in Latex: how to



Line: 90 to 90
 
    • 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
Added:
>
>
  • 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.

Revision 132019-02-14 - Beringer

Line: 1 to 1
 

Reviews in Latex: how to



Line: 13 to 13
 
  • cd latex_tutorial (or click on the extracted directory)
  • you need to compile the latex code. Type the following lines in a command line prompt:
    • pdflatex latex_tutorial
Changed:
<
<
    • bibtex latex_tutorial
>
>
    • bibtex latex_tutorial.1
 
    • pdflatex latex_tutorial
    • pdflatex latex_tutorial
  • or

Revision 122019-01-29 - ElisabettaPianori

Line: 1 to 1
 

Reviews in Latex: how to



Line: 89 to 89
 
    • add a reference to it in BASENAME-main.tex using the following command: \cite{Tanabashi:2018oca}
Changed:
<
<
  • In case the reference does not appear in INSPIRE, use the standard convention for the label: BASENAME:ref:_meaningful_name
>
>
  • In case the reference does not appear in INSPIRE, use the standard convention for the label: BASENAME:_meaningful_name
 

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.

Revision 112019-01-18 - ElisabettaPianori

Line: 1 to 1
 

Reviews in Latex: how to



Line: 25 to 25
 
  • 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.
Changed:
<
<
  • There are certain files that you should not modify. If you do, your changes will be overwritten daily.
>
>
  • 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
Line: 71 to 71
 
    • 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.
Changed:
<
<
>
>
  • For example, to add the following reference: https://inspirehep.net/record/1688995:
    • add the following code in the BASENAME.bib file:
          @article{Tanabashi:2018oca,
            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:ref:_meaningful_name
 

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
Changed:
<
<
  • Now you can go into 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.
>
>
  • 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

Revision 102019-01-18 - ElisabettaPianori

Line: 1 to 1
Changed:
<
<

Tutorial: reviews in Latex

>
>

Reviews in Latex: how to

 

Changed:
<
<

Before the tutorial

>
>

Check out and compile your review

 
Changed:
<
<

Setting up Latex before the tutorial

  • Make sure to have install on your laptop a recent version of Latex.
  • download from here a test version of a review intro.tar
  • extract the files in the archive (if using a command line prompt, use tar -xvf intro.tar).
  • cd intro
  • compile it with the following commands:
    • pdflatex intro
    • bibtex intro
    • pdflatex intro
    • pdflatex intro
  • or alternative, if you have make installed, type the following command:
    • make

  • if neither of the set of commands work, check if you have available the following LaTeX packages required for PDG reviews in LaTeX (check error messages in the log file):
    • xifthen
    • color
    • float
    • amsmath
    • graphicx
    • xspace
    • titling
    • fancyhdr
    • titlesec
    • geometry
    • import
    • lineno
    • showlabels
    • bibunit

  • if you have these packages installed, and updated, and still it does not compile, write an email to support@pdg.lbl.gov

At the tutorial

  • We will use a dedicated database for the review: TutorialPdgWorkspace.
  • Once you open this webpage, you should see database: tutorial on the top left of the page, right under the PDGworkspace logo
  • More details about the workflow fore reviews and tip on naming conventions can be found here: https://pdgdoc.lbl.gov/Pdg/ReviewTool

Check out and compile LaTex Tutorial review

>
>
 
  • Select Reviews from the top row, and then select my reviews from the drop-down menu under Review Filters
Changed:
<
<
  • In your list of reviews, you should see one titled "LaTeX Tutorial". Click on the title, and it will take you to the overview tab for this review.
  • Under the sources file tab, you can see the instructions on how to check out your review. If you can, please run the svn command in a command line prompt. Otherwise, download the tar file from the pdgworskpace interface and extract the archive.
>
>
  • 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. If you can, please run the svn command in a command line prompt. Otherwise, download the tar file from the pdgworskpace interface and extract the archive.
 
  • cd latex_tutorial (or click on the extracted directory)
  • you need to compile the latex code. Type the following lines in a command line prompt:
    • pdflatex latex_tutorial
Line: 57 to 18
 
    • pdflatex latex_tutorial
  • or
    • make
Changed:
<
<
  • Now you should have a pdf file available titled pdf_latex.pdf. Open and inspect it.
>
>
  • it's a good idea, once in a while, to run svn update . It will make sure that you are working with the latest version of the pdg Latex templates
 
Changed:
<
<

Edit the test LaTex Tutorial review

>
>

Edit the review

 
Changed:
<
<
  • Now let's edit the main body of the review.
  • Open with your favorite text editor the file latex_tutorial-main.tex
>
>
  • 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.
Added:
>
>
  • 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.
  • There are certain files that you should not modify. If you do, your changes will be overwritten 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
 
Changed:
<
<

Add a section

>
>

Sections titles

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

Add a figure

>
>

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}
Line: 81 to 49
  \ref{label}
  • For example: see Fig. \ref{latex-tutorial:fig:ideogram}
Changed:
<
<
  • good practice for the label is to use: basename:fig:_some meaningful name_
<--   * use \pdgfigure or \pdgwidefigure for a single-column or double-column wide figure in the book, respectively-->
>
>
  • good practice for the label is to use: basename:fig:some-meaningful-name_
 
Changed:
<
<

Add a table

>
>

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:
Line: 98 to 65
 
  • 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}
Deleted:
<
<
<--   * use \pdgtable or \pdgwidetable environments for single-column or double-column wide tables in the book format, -->
 
Changed:
<
<

Add a reference

>
>

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{".
Line: 108 to 74
 
Changed:
<
<

Start migrating one of your own review from teXsis to Latex -- Advanced, optional part

Download one of your reviews in teXsis

  • open the tutorial pdg workspace using this link: TutorialPdgWorkspace
  • under Review Filters, choose "my reviews" from the drop-down menu
  • click on the name of your reviews that you want to migrate from texSis to Latex
  • under the source file tab, you can find the command to check out the teXsis version of your review
  • make sure that you have these files saved somewhere safe, you will need them later

Download the empty Latex version for the same review

  • ask Kirill in person, or send an email to support AT pdg.lbl.gov, to change your review in the tutorial database from teXsis to Latex
  • open again the tutorial pdg workspace using this link: TutorialPdgWorkspace
  • Under Review Filters, choose "my reviews" from the drop-down menu
  • Click again on the same review, and check that now the database point to the Latex version. To do that, once you click on the name of one of your review, you can check under the Technical Details tab if the format field correspond to LaTeX. If not, ask for help.
  • go back in the Overview tab
  • click on draft link under Generate latest version (PDF), the current version of the review will appear. It should contain only the title and the authors.
  • download the Latex version of your review, following the instructions under the source file tab. Make sure to check out this code in a different folder wrt of the code in teXsis

Start updating the review in Latex

  • open the Tutorial pdgworkspace TutorialPdgWorkspace, navigate to the review you're about to modify, and then update its status under the Overview tab.
    • click on update
    • click on start editing draft
  • Now you can start copying the text from your review in teXsis to the main body of the review in Latex.
    • Suggestions:
      • copy a small amount of text at the time, and then test if it compiles
      • if there are equations, you'd have to change to syntax. Equation in latex are added using the equation environment. A working example is:
                  \begin{equation}\label{BASENAME:eq:myname}
                   N_{exp} = \sigma_{exp} \times \int L(t) dt.
                   \end{equation}
                  
  • Once you've migrate the all review (or part of it for testing), you can check the updated source code into svn. Make sure you run the following command from the directory where the Latex version of the review was downloaded.
>
>

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
Changed:
<
<
  • Now you can go into the tutorial pdg workspace TutorialPdgWorkspace, 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.
>
>
  • Now you can go into 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 update
    • click on pass to editor

Revision 92019-01-18 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 91 to 91
 
    \begin{pdgtable}
   {|c|c|c|} {This is an example table}{latex-tutorial:tab:mytable}{}
Changed:
<
<
My Table & 1.5 & $ 1.3\%$\
>
>
\pdgtableheader{Colum1 & Column2 & Column3} row1 & 1 & 2\ row2 & 1 & 2\
  \end{pdgtable}
  • If you want to add a reference to the table in the text, you can use the following command:

Revision 82018-10-25 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 133 to 133
 
      • copy a small amount of text at the time, and then test if it compiles
      • if there are equations, you'd have to change to syntax. Equation in latex are added using the equation environment. A working example is:

Changed:
<
<
==\begin{equation}\label{BASENAME:eq:myname}
N_{exp} = \sigma_{exp} \times \int L(t) dt.
\end{equation}==
>
>
\begin{equation}\label{BASENAME:eq:myname} N_{exp} = \sigma_{exp} \times \int L(t) dt. \end{equation}
 
  • Once you've migrate the all review (or part of it for testing), you can check the updated source code into svn. Make sure you run the following command from the directory where the Latex version of the review was downloaded.
    • svn status : it will list the files that you modified

Revision 72018-10-25 - Jdanderson

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 20 to 20
 
    • make

  • if neither of the set of commands work, check if you have available the following LaTeX packages required for PDG reviews in LaTeX (check error messages in the log file):
Changed:
<
<
    • ifthen
>
>
    • xifthen
 
    • color
    • float
    • amsmath

Revision 62018-10-25 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 72 to 72
 

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:
Changed:
<
<
\pdgfigure{option to determine the position }{ the name of the file, found in the figures directory }{other options}{ your caption }{ label }
>
>
\pdgfigure{ the name of the file, found in the figures directory }{ your caption }{ label }{option to determine the position }{other options}
 
  • For example:
Changed:
<
<
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}{width=0.4\textwidth}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}{width=0.4\textwidth}{h!}
>
>
    • \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:
    \ref{label}
  • For example:
Changed:
<
<
see Fig. \ref{latex_tutorial:figure:ideogram}
  • good practice for the label is to use: basename:figure:_some meaningful name_
>
>
see Fig. \ref{latex-tutorial:fig:ideogram}
  • good practice for the label is to use: basename:fig:_some meaningful name_
 
<--   * use \pdgfigure or \pdgwidefigure for a single-column or double-column wide figure in the book, respectively-->

Add a table

  • To add a table, we use the following environment :
Changed:
<
<
\pdgtable{}{ label }{ your caption }{ dimension of the table }
>
>
\pdgtable{ dimension of the table }{ your caption }{ label }{options}
 
  • for example, to add a table with three columns, with the text centered:
        \begin{pdgtable}
Changed:
<
<
{h}{intro:table:mytable}{This is an example table}{|c|c|c|}
>
>
{|c|c|c|} {This is an example table}{latex-tutorial:tab:mytable}{}
  My Table & 1.5 & $ 1.3\%$\ \end{pdgtable}
  • If you want to add a reference to the table in the text, you can use the following command:
Changed:
<
<
see Fig. \ref{intro:table:mytable}
>
>
see Table \ref{latex-tutorial:tab:mytable}
 
<--   * use \pdgtable or \pdgwidetable environments for single-column or double-column wide tables in the book format, -->

Add a reference

Line: 138 to 138
  \end{equation}==
  • Once you've migrate the all review (or part of it for testing), you can check the updated source code into svn. Make sure you run the following command from the directory where the Latex version of the review was downloaded.
Changed:
<
<
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
>
>
    • 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 the tutorial pdg workspace TutorialPdgWorkspace, 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
Line: 147 to 147
  --
Warning
Can't INCLUDE TWiki.UserReports repeatedly, topic is already included.
Changed:
<
<
META FILEATTACHMENT attachment="intro.tar" attr="" comment="" date="1540405018" name="intro.tar" path="intro.tar" size="256000" user="ElisabettaPianori" version="1"
>
>
META FILEATTACHMENT attachment="intro.tar" attr="" comment="" date="1540479340" name="intro.tar" path="intro.tar" size="174080" user="ElisabettaPianori" version="2"

Revision 52018-10-24 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 7 to 7
 

Setting up Latex before the tutorial

Changed:
<
<
>
>
  • Make sure to have install on your laptop a recent version of Latex.
  • download from here a test version of a review intro.tar
  • extract the files in the archive (if using a command line prompt, use tar -xvf intro.tar).
 
  • cd intro
  • compile it with the following commands:
    • pdflatex intro
Line: 19 to 19
 
  • or alternative, if you have make installed, type the following command:
    • make
Changed:
<
<
  • if neither of the set of commands work, check if you have available the following LaTeX packages required for PDG reviews in LaTeX:
>
>
  • if neither of the set of commands work, check if you have available the following LaTeX packages required for PDG reviews in LaTeX (check error messages in the log file):
 
    • ifthen
    • color
    • float
Line: 35 to 35
 
    • showlabels
    • bibunit
Changed:
<
<
  • if you have these packages installed, and updated, and still it does not compile, write an email to some address
>
>
  • if you have these packages installed, and updated, and still it does not compile, write an email to support@pdg.lbl.gov
 

At the tutorial

Changed:
<
<
We will use a dedicated database for the review: TutorialPdgWorkspace.
Once you open this webpage, you should see database: tutorial on the top left of the page, right under the PDGworkspace logo
>
>
  • We will use a dedicated database for the review: TutorialPdgWorkspace.
  • Once you open this webpage, you should see database: tutorial on the top left of the page, right under the PDGworkspace logo
  • More details about the workflow fore reviews and tip on naming conventions can be found here: https://pdgdoc.lbl.gov/Pdg/ReviewTool
 

Check out and compile LaTex Tutorial review

Line: 64 to 65
 
  • Open with your favorite text editor the file latex_tutorial-main.tex
  • After the command with the revision date (\revised{August 2018}), you can add some text.
Added:
>
>

Add a section

  • 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:
Changed:
<
<
\pdgfigure{}{ the name of the file, found in the figures directory }{}{ your caption }{ label }
>
>
\pdgfigure{option to determine the position }{ the name of the file, found in the figures directory }{other options}{ your caption }{ label }
 
  • For example:
Changed:
<
<
\pdgfigure{}{intro96.pdf}{}{A typical ideogram}{intro:fig:ideogram}
>
>
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}{width=0.4\textwidth}
    • \pdgfigure{intro96.pdf}{A typical ideogram}{latex_tutorial:figure:ideogram}{width=0.4\textwidth}{h!}
 
  • If you want to add a reference to the figure in the text, you can use the following command:
    \ref{label}
  • For example:
Changed:
<
<
see Fig. \ref{intro:fig:ideogram}
>
>
see Fig. \ref{latex_tutorial:figure:ideogram}
 
  • good practice for the label is to use: basename:figure:_some meaningful name_
Changed:
<
<
  • use \pdgfigure or \pdgwidefigure for a single-column or double-column wide figure in the book, respectively
>
>
<--   * use \pdgfigure or \pdgwidefigure for a single-column or double-column wide figure in the book, respectively-->
 

Add a table

Changed:
<
<
  • To add a table, use the following command in the text:
>
>
  • To add a table, we use the following environment :
  \pdgtable{}{ label }{ your caption }{ dimension of the table }
Changed:
<
<
  • for example, to add a table with three columns, with the text centered:
    \begin{pdgtable}
        {h}{intro:table:mytable}{This is an example table}{|c|c|c|}
        My Table & 1.5 & $ 1.3\%$\\
        \end{pdgtable}
>
>
  • for example, to add a table with three columns, with the text centered:
        \begin{pdgtable}
        {h}{intro:table:mytable}{This is an example table}{|c|c|c|}
        My Table & 1.5 & $ 1.3\%$\\
        \end{pdgtable}
        
 
  • If you want to add a reference to the table in the text, you can use the following command:
    see Fig. \ref{intro:table:mytable}
Changed:
<
<
  • use \pdgtable or \pdgwidetable environments for single-column or double-column wide tables in the book format,
>
>
<--   * use \pdgtable or \pdgwidetable environments for single-column or double-column wide tables in the book format, -->
 

Add a reference

  • References are handled using BibTeX. To add a reference to your review:
Line: 97 to 106
 
Changed:
<
<

Start modifying your own review

>
>

Start migrating one of your own review from teXsis to Latex -- Advanced, optional part

Download one of your reviews in teXsis

  • open the tutorial pdg workspace using this link: TutorialPdgWorkspace
  • under Review Filters, choose "my reviews" from the drop-down menu
  • click on the name of your reviews that you want to migrate from texSis to Latex
  • under the source file tab, you can find the command to check out the teXsis version of your review
  • make sure that you have these files saved somewhere safe, you will need them later
 
Changed:
<
<

Download your review that has already been migrated to Latex

>
>

Download the empty Latex version for the same review

  • ask Kirill in person, or send an email to support AT pdg.lbl.gov, to change your review in the tutorial database from teXsis to Latex
 
  • open again the tutorial pdg workspace using this link: TutorialPdgWorkspace
  • Under Review Filters, choose "my reviews" from the drop-down menu
Changed:
<
<
  • Identify one of your reviews that has already been migrated to Latex. To do that, once you click on the name of one of your review, you can check under the Technical Details tab if the format field correspond to LaTeX. If instead format field corresponds to TeXsis, your review has not been migrated to Latex yet, so please find another one.
>
>
  • Click again on the same review, and check that now the database point to the Latex version. To do that, once you click on the name of one of your review, you can check under the Technical Details tab if the format field correspond to LaTeX. If not, ask for help.
 
  • go back in the Overview tab
Changed:
<
<
  • click on draft link under Generate latest version (PDF), the current version of the review will appear.
  • download the Latex version of your review, following the instructions under the source file tab.
    • Note: the svn command should contains /RPP/

Download the same review in texSis

  • on a different window of your browser, open the standard version of the pdg workspace PdgWorkspace,
  • Under Review Filters, choose "my reviews" from the drop-down menu by Show
  • click on the name of the same review you choose earlier from the tutorial pdg workspace
  • under the source file tab, you can find the command to download the old version in teXsis of your review
  • download it in a different location wrt to the Latex based review.
    • Note: the svn command should contains LegacyRPP
>
>
  • click on draft link under Generate latest version (PDF), the current version of the review will appear. It should contain only the title and the authors.
  • download the Latex version of your review, following the instructions under the source file tab. Make sure to check out this code in a different folder wrt of the code in teXsis
 

Start updating the review in Latex

  • open the Tutorial pdgworkspace TutorialPdgWorkspace, navigate to the review you're about to modify, and then update its status under the Overview tab.
    • click on update
    • click on start editing draft
Changed:
<
<
  • Now you can start copying the text from your review in texSis to the main body of the review in Latex.
>
>
  • Now you can start copying the text from your review in teXsis to the main body of the review in Latex.
 
    • Suggestions:
Changed:
<
<
      • copy a small amount of text at the time
>
>
      • copy a small amount of text at the time, and then test if it compiles
 
      • if there are equations, you'd have to change to syntax. Equation in latex are added using the equation environment. A working example is:
Added:
>
>
  ==\begin{equation}\label{BASENAME:eq:myname}
N_{exp} = \sigma_{exp} \times \int L(t) dt.
\end{equation}==
Changed:
<
<
  • Once you've moved some code, you can check into svn the updated Latex version of the code. Make sure you run the following command from the directory where the Latex version of the review was downloaded. svn commit -m "Brief summary of your changes"=
>
>
  • Once you've migrate the all review (or part of it for testing), you can check the updated source code into svn. Make sure you run the following command from the directory where the Latex version of the review was downloaded. 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 the tutorial pdg workspace TutorialPdgWorkspace, 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
Line: 136 to 147
  --
Warning
Can't INCLUDE TWiki.UserReports repeatedly, topic is already included.
Changed:
<
<
<--

Comments


No such template def TMPL:DEF{PROMPT:above} -->

META FILEATTACHMENT attachment="intro.tgz" attr="" comment="" date="1540328546" name="intro.tgz" path="intro.tgz" size="158208" user="ElisabettaPianori" version="2"
>
>
META FILEATTACHMENT attachment="intro.tar" attr="" comment="" date="1540405018" name="intro.tar" path="intro.tar" size="256000" user="ElisabettaPianori" version="1"

Revision 42018-10-23 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 7 to 7
 

Setting up Latex before the tutorial

Changed:
<
<
  • Download a recent version of Latex. See [https://www.tug.org/texlive/quickinstall.html] for unix/Windows and [http://www.tug.org/mactex/] for Mac.
  • download from here a test version of a review
>
>
 
  • compile it with the following commands:
    • pdflatex intro
    • bibtex intro
    • pdflatex intro
    • pdflatex intro
Added:
>
>
  • or alternative, if you have make installed, type the following command:
    • make
 
Changed:
<
<
* if it fails, check if you have available the following LaTeX packages required for PDG reviews in LaTeX:
>
>
  • if neither of the set of commands work, check if you have available the following LaTeX packages required for PDG reviews in LaTeX:
 
    • ifthen
    • color
    • float
Line: 29 to 33
 
    • import
    • lineno
    • showlabels
Changed:
<
<
    • bibunit (TBC)
>
>
    • bibunit
  * if you have these packages installed, and updated, and still it does not compile, write an email to some address

At the tutorial

Changed:
<
<
We will use a dedicated database for the review: TutorialPdgWorkspace.
>
>
We will use a dedicated database for the review: TutorialPdgWorkspace.
 Once you open this webpage, you should see database: tutorial on the top left of the page, right under the PDGworkspace logo
Changed:
<
<

Check out and compile your review

>
>

Check out and compile LaTex Tutorial review

 
Changed:
<
<
  • Open PDGworkspace TutorialPdgWorkspace.
  • Select the review that you intend to work on (click on the title of the review). You'll see the overview webpage.
  • To make sure your review is already available in Latex format, check under the Technical Details tab, that the format field correspond to LaTeX. If instead format field corresponds to TeXsis, your review has not been migrated to Latex yet. You need to choose a different review to work on.
  • Under the sources file tab, you can see the command line to check out your review. If the svn command contains LegacyRPP, your review has not been migrated to Latex yet. Otherwise the svn command will contain only the RPP string.

Edit your review

>
>
  • Open PDGworkspace TutorialPdgWorkspace.
  • Select Reviews from the top row, and then select my reviews from the drop-down menu under Review Filters
  • In your list of reviews, you should see one titled "LaTeX Tutorial". Click on the title, and it will take you to the overview tab for this review.
  • Under the sources file tab, you can see the instructions on how to check out your review. If you can, please run the svn command in a command line prompt. Otherwise, download the tar file from the pdgworskpace interface and extract the archive.
  • cd latex_tutorial (or click on the extracted directory)
  • you need to compile the latex code. Type the following lines in a command line prompt:
    • pdflatex latex_tutorial
    • bibtex latex_tutorial
    • pdflatex latex_tutorial
    • pdflatex latex_tutorial
  • or
    • make
  • Now you should have a pdf file available titled pdf_latex.pdf. Open and inspect it.

Edit the test LaTex Tutorial review

  • Now let's edit the main body of the review.
  • Open with your favorite text editor the file latex_tutorial-main.tex
  • After the command with the revision date (\revised{August 2018}), you can add some text.
 

Add a figure

Added:
>
>
  • 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 }
  • For example:
    \pdgfigure{}{intro96.pdf}{}{A typical ideogram}{intro:fig:ideogram}
  • If you want to add a reference to the figure in the text, you can use the following command:
    \ref{label}
  • For example: see Fig. \ref{intro:fig:ideogram}
  • good practice for the label is to use: basename:figure:_some meaningful name_
  • use \pdgfigure or \pdgwidefigure for a single-column or double-column wide figure in the book, respectively
 

Add a table

Added:
>
>
  • To add a table, use the following command in the text:
    \pdgtable{}{ label }{ your caption }{ dimension of the table }
  • for example, to add a table with three columns, with the text centered:
    \begin{pdgtable}
        {h}{intro:table:mytable}{This is an example table}{|c|c|c|}
        My Table & 1.5 & $ 1.3\%$\\
        \end{pdgtable}
  • If you want to add a reference to the table in the text, you can use the following command:
    see Fig. \ref{intro:table:mytable}
  • use \pdgtable or \pdgwidetable environments for single-column or double-column wide tables in the book format,
 

Add a reference

Changed:
<
<

Commit to svn

Generate the pdf file for the book from the pdgworspace webpage

>
>
  • 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, add the following reference: https://inspirehep.net/record/1691634 in latex_tutorial.bib, and then add a reference in latex_tutorial-main.tex, using the command:
    \cite{}

Start modifying your own review

Download your review that has already been migrated to Latex

  • open again the tutorial pdg workspace using this link: TutorialPdgWorkspace
  • Under Review Filters, choose "my reviews" from the drop-down menu
  • Identify one of your reviews that has already been migrated to Latex. To do that, once you click on the name of one of your review, you can check under the Technical Details tab if the format field correspond to LaTeX. If instead format field corresponds to TeXsis, your review has not been migrated to Latex yet, so please find another one.
  • go back in the Overview tab
  • click on draft link under Generate latest version (PDF), the current version of the review will appear.
  • download the Latex version of your review, following the instructions under the source file tab.
    • Note: the svn command should contains /RPP/

Download the same review in texSis

  • on a different window of your browser, open the standard version of the pdg workspace PdgWorkspace,
  • Under Review Filters, choose "my reviews" from the drop-down menu by Show
  • click on the name of the same review you choose earlier from the tutorial pdg workspace
  • under the source file tab, you can find the command to download the old version in teXsis of your review
  • download it in a different location wrt to the Latex based review.
    • Note: the svn command should contains LegacyRPP

Start updating the review in Latex

  • open the Tutorial pdgworkspace TutorialPdgWorkspace, navigate to the review you're about to modify, and then update its status under the Overview tab.
    • click on update
    • click on start editing draft
  • Now you can start copying the text from your review in texSis to the main body of the review in Latex.
    • Suggestions:
      • copy a small amount of text at the time
      • if there are equations, you'd have to change to syntax. Equation in latex are added using the equation environment. A working example is: \begin{equation}\label{BASENAME:eq:myname}
                  N_{exp} = \sigma_{exp} \times \int L(t) dt.
                  \end{equation}
  • Once you've moved some code, you can check into svn the updated Latex version of the code. Make sure you run the following command from the directory where the Latex version of the review was downloaded. svn commit -m "Brief summary of your changes"=
  • Now you can go into the tutorial pdg workspace TutorialPdgWorkspace, 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
  --
Warning
Can't INCLUDE TWiki.UserReports repeatedly, topic is already included.
Added:
>
>

META FILEATTACHMENT attachment="intro.tgz" attr="" comment="" date="1540328546" name="intro.tgz" path="intro.tgz" size="158208" user="ElisabettaPianori" version="2"

Revision 32018-10-23 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 7 to 7
 

Setting up Latex before the tutorial

Changed:
<
<
  • Download a recent version of Latex. See
  • check out this test version of a review from the PDG svn repository with the following command: is this technically possible, to provide one command for everyone to check out one review? Or should I put it somewhere where it's accessible?
>
>
  • Download a recent version of Latex. See [https://www.tug.org/texlive/quickinstall.html] for unix/Windows and [http://www.tug.org/mactex/] for Mac.
  • download from here a test version of a review
 
  • compile it with the following commands:
Changed:
<
<
    • pdflatex xxx
    • bibtex xxx
    • pdflatex xxx
    • pdflatex xxx
>
>
    • pdflatex intro
    • bibtex intro
    • pdflatex intro
    • pdflatex intro

* if it fails, check if you have available the following LaTeX packages required for PDG reviews in LaTeX:

    • ifthen
    • color
    • float
    • amsmath
    • graphicx
    • xspace
    • titling
    • fancyhdr
    • titlesec
    • geometry
    • import
    • lineno
    • showlabels
    • bibunit (TBC)
 
Changed:
<
<
* if it fails, write an email to some address
>
>
* if you have these packages installed, and updated, and still it does not compile, write an email to some address
 

At the tutorial

Revision 22018-10-17 - ElisabettaPianori

Line: 1 to 1
 

Tutorial: reviews in Latex



Line: 10 to 10
 
  • Download a recent version of Latex. See
  • check out this test version of a review from the PDG svn repository with the following command: is this technically possible, to provide one command for everyone to check out one review? Or should I put it somewhere where it's accessible?
  • compile it with the following commands:
Changed:
<
<
    • pdflatex accel
    • bibtex accel
    • pdflatex accel
    • pdflatex accel
>
>
    • pdflatex xxx
    • bibtex xxx
    • pdflatex xxx
    • pdflatex xxx
  * if it fails, write an email to some address
Line: 26 to 26
 
  • Open PDGworkspace TutorialPdgWorkspace.
  • Select the review that you intend to work on (click on the title of the review). You'll see the overview webpage.
Changed:
<
<
  • To make sure your review is already available in Latex format, check under the Technical Details tab, that the format correspond to LaTeX. If instead format corresponds to TeXsis, your review has not been migrated to Latex yet. You need to choose a different review to work on.
>
>
  • To make sure your review is already available in Latex format, check under the Technical Details tab, that the format field correspond to LaTeX. If instead format field corresponds to TeXsis, your review has not been migrated to Latex yet. You need to choose a different review to work on.
 
  • Under the sources file tab, you can see the command line to check out your review. If the svn command contains LegacyRPP, your review has not been migrated to Latex yet. Otherwise the svn command will contain only the RPP string.

Edit your review

Revision 12018-10-15 - ElisabettaPianori

Line: 1 to 1
Added:
>
>

Tutorial: reviews in Latex



Before the tutorial

Setting up Latex before the tutorial

  • Download a recent version of Latex. See
  • check out this test version of a review from the PDG svn repository with the following command: is this technically possible, to provide one command for everyone to check out one review? Or should I put it somewhere where it's accessible?
  • compile it with the following commands:
    • pdflatex accel
    • bibtex accel
    • pdflatex accel
    • pdflatex accel

* if it fails, write an email to some address

At the tutorial

We will use a dedicated database for the review: TutorialPdgWorkspace.
Once you open this webpage, you should see database: tutorial on the top left of the page, right under the PDGworkspace logo

Check out and compile your review

  • Open PDGworkspace TutorialPdgWorkspace.
  • Select the review that you intend to work on (click on the title of the review). You'll see the overview webpage.
  • To make sure your review is already available in Latex format, check under the Technical Details tab, that the format correspond to LaTeX. If instead format corresponds to TeXsis, your review has not been migrated to Latex yet. You need to choose a different review to work on.
  • Under the sources file tab, you can see the command line to check out your review. If the svn command contains LegacyRPP, your review has not been migrated to Latex yet. Otherwise the svn command will contain only the RPP string.

Edit your review

Add a figure

Add a table

Add a reference

Commit to svn

Generate the pdf file for the book from the pdgworspace webpage

--

Warning
Can't INCLUDE TWiki.UserReports repeatedly, topic is already included.

Comments


No such template def TMPL:DEF{PROMPT:above}

 
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