Computers in Cardiology

Writing a CinC Paper Using LaTeX

George Moody <george@mit.edu>
12 September 2006

This directory contains the CinC Author's Kit for preparing manuscripts in PDF format using LaTeX. The following files are included:
READMEplain text version of this page
balance.styLaTeX macro for equalizing column length
cinc.clsCinC style file
cinc.bstCinC bibliography style file
template.texgeneric template for a manuscript (LaTeX source)
template.pdfformatted version of template.tex
refs.bibsample BibTeX bibliography file
Makefilerules for generating template.pdf using a make utility
pdftex.cfgneeded if using an old (pre-2002) version of pdflatex (see the note at the end of this file)
example1, example2directories containing two complete sample papers, including figures and bibliography files
makebstdirectory containing files needed to generate cinc.bst

The entire kit may be downloaded as latex.tar.gz or latex.zip.

This kit can be used with any reasonably modern (September, 1994 or later) version of LaTeX, a dialect of Donald Knuth's TeX software for typesetting. Visit http://www.tug.org/, the TeX Users Group, for links to both free and commercial versions of TeX for UNIX (including Linux and Mac OS X), MS-DOS, MS-Windows, OS/2, VMS, and other operating systems. The popular tetex package is included in most Linux distributions and contains all of the components you will need aside from those provided here.

INSTALLATION

Download and install TeX (including LaTeX, BibTeX, and the PSNFSS2e package) first if you have not already done so. (PSNFSS2e is a standard component of all modern versions of TeX/LaTeX that permits use of PostScript fonts, such as the Times Roman that is the standard font for Computers in Cardiology proceedings. cinc.cls requires the times.sty file included in PSNFSS2e.)

To install the files provided in this directory, do one of the following:

If your installation of LaTeX doesn't include balance.sty, copy balance.sty from this directory into the same location where you copied cinc.cls.

FORMATTING THE EXAMPLES (OPTIONAL)

The use of these files is best illustrated by the included sample manuscripts (example1/example1.tex and example2/example2.tex), which are accompanied by sets of PDF (.pdf), PostScript (.ps), and encapsulated PostScript (.eps) figures in example*/figures/, and by BibTeX bibliography (.bib) files in example*/bib/, all of which are referenced in the papers. To format the sample manuscripts:

  1. Install cinc.cls and cinc.bst by copying them from this directory into the example directories, or into the standard locations.
  2. If you have pdflatex, enter the example1 directory and do the following:
    	pdflatex example1   [creates example1.aux, needed by bibtex]
    	bibtex example1	    [creates example1.bbl, needed by pdflatex]
    	pdflatex example1   [merges references]
    	pdflatex example1   [produces final PDF with correct citation numbers]
    

    (The multiple runs of pdflatex are needed to prepare data for bibtex and then to resolve the cross-references.)

    These steps produce example1.pdf (and several temporary files that can be removed).

  3. If you don't have pdflatex, enter the example1 directory and do the following:
    	latex example1	    [creates example1.aux, needed by bibtex]
    	bibtex example1	    [creates example1.bbl, needed by latex]
    	latex example1	    [merges references]
    	latex example1      [produces DVI file with correct citation numbers]
    	dvips -Ppdf -t letter -o example1.ps example1
    

    These steps produce example1.ps (and several temporary files).

The Makefile included in each directory can be used by a make utility to automate these steps.

A similar procedure can be used to format example2.tex, which illustrates other features of the CinC style files.

WRITING YOUR MANUSCRIPT

Go to CinC's template customizer, at http://www.cinc.org/MakeTemplateForm.htm, to make a custom template for your manuscript. Although this author's kit includes a generic template (template.tex), we recommend that you use the LaTeX template generator provided on the CinC web site (www.cinc.org) to make a custom template for your paper. The template generator helps you to fill in the title, author, and affiliation information that appears at the top of the first page of your paper in the correct format, and it helps us to gather that information so that it can be included in the table of contents of the proceedings without transcription errors.

The instructions below assume that you have saved your template as a file named paper.tex, into which you can type your paper.

Please use the example files provided as models for your own manuscripts. All references should be entered in BibTeX (.bib) database files (see the samples in the example*/bib directories). In order to conform to the layout instructions, please check your final version against the example layout provided. Please double-check that you have followed these rules:

  1. The title of the paper should not end with a "."
  2. List the authors of the paper in the form:
    	AB Johnson, CB Anderson
    
    Do not use "." after initials, and do not use the word "and" before the name of the last author.
  3. List the authors' institutions within the \author statement. Use superscripted numerals to identify the affiliations of each author if necessary. Use \\ and \mbox{}\\ to create a blank line between the authors' names and their institutions. For example:
         \author{HA~Kestler$^{1,2}$, F Schwenker$^1$, G Hafner$^1$, V~Hombach$^2$, 
          G~Palm$^1$, M~H{\"o}her$^2$ \\
          \mbox{}\\
          $^1$Neural Information Processing, University of Ulm, Germany \\
          $^2$Medicine II -- Cardiology, University Hospital Ulm, Germany}
    
  4. Inside table environments, place the \caption at the beginning to insure that the table legend appears above the table.
  5. To create two equal-length columns on the last page, first identify what portion of your manuscript would be included in the first column on the last page, then insert the command
    	\balance
    
    anywhere within this portion of text, and reformat. (This works because cinc.cls now includes the standard balance.sty package. Thanks to Erik Bojorges for this suggestion.)

If you use the custom template generator at http://www.cinc.org/MakeTemplateForm.htm your manuscript will satisfy requirements 1, 2, and 3 automatically.

FORMATTING YOUR MANUSCRIPT

You must submit your manuscript in PDF format (other formats, such as LaTeX source, DVI, and PostScript, cannot be accepted). There are three acceptable ways to generate a PDF from LaTeX sources. The instructions below assume that you have composed your paper in a file called paper.tex:

Method A: If you have pdflatex (included in most recent TeX distributions), this method is simplest. If you have PostScript figures, you will need to convert them to PDF before using this method (or else use method B below).

  1. Run these commands:
    	pdflatex paper
    	bibtex paper
    	pdflatex paper
    	pdflatex paper
    
  2. If there were any errors or warnings, make any necessary corrections and repeat step 1. If you have a PDF viewer (such as Acrobat or a recent copy of GhostScript), use it to view paper.pdf, and correct any formatting errors.

Method B: If you have ps2pdf (distributed with GhostScript), you might prefer this method, especially if converting your PostScript figures to PDF would be time-consuming. Note that "\" at the end of a line indicates that the command continues on the next line.

  1. Run these commands:
    	latex paper
    	bibtex paper
    	latex paper
    	latex paper
    
  2. You will now have a .dvi file named paper.dvi. Rename it so that its name begins with CinC-200 (for example, it can be CinC-2006.dvi, as shown below). Do not skip this step! If you ignore this requirement, the manuscript collector will reject your PDF and you will need to begin again.
  3. Run these commands:
    	dvips -Ppdf -t letter -o CinC-2006.ps CinC-2006.dvi
    	ps2pdf -dPDFSETTINGS=/printer -dCompatibilityLevel=1.3 \
    	 -dMaxSubsetPct=100 -dSubsetFonts=true -dEmbedAllFonts=true \
    	 -sPAPERSIZE=letter CinC-2006.ps
    
    VERY IMPORTANT: Use "letter" in the dvips and ps2pdf commands even if your normal paper size is A4, since the Proceedings are printed on US letter-sized pages.
  4. If there were any errors or warnings, make any necessary corrections and repeat step 1. Use Acrobat or GhostScript to view CinC-2006.pdf, and correct any formatting errors.

Method C: If you don't have pdflatex or ps2pdf, you will have to use this method.

  1. Run these commands:
    	latex paper
    	bibtex paper
    	latex paper
    	latex paper
    	dvips -Ppdf -t letter -o paper.ps paper.dvi
    
    VERY IMPORTANT: Use "-t letter" in the dvips command even if your normal paper size is A4, since the Proceedings are printed on US letter-sized pages.
  2. If there were any errors or warnings, make any necessary corrections and repeat step 1.
  3. Convert your PostScript file, paper.ps, to PDF using the CinC PDF conversion service.

SUBMITTING YOUR MANUSCRIPT

You must submit your PDF manuscript electronically (paper copies are no longer necessary or accepted). Go to http://cinc.mit.edu/ for instructions on submitting your manuscript using your web browser.

The Editor will be available during the poster session to answer questions and give advice. It would be helpful if you bring a single printed copy of your paper with you, which the Editor may mark and will give back to you.

PRINTING YOUR MANUSCRIPT

Most PDF viewing software can also be used to print PDF files. If you use Adobe Reader, choose Page Scaling: None (or uncheck "Shrink oversized pages to paper size" and "Expand small pages to paper size") in Reader's Print dialog; this ensures that your paper will be printed at the same scale as will be used in the published Proceedings. Copies printed on A4 paper will not be centered on the page, but they should be readable.

You may use color in figures, but print your manuscript on a black-and-white printer and be sure that your figures are still legible. The proceedings are published in printed form (black-and-white only) as well as on CD-ROMs and on-line (in color). It's important that readers of the printed proceedings be able to see your figures as you intended.

OLD VERSIONS OF pdflatex

If you use a version of pdflatex older than 1.10 (released in 2002), you may need to copy pdftex.cfg from this directory into the directory that contains your manuscript before formatting it with pdflatex. Versions 1.10 and later can get the information contained in pdtex.cfg from \pdf... declarations in cinc.cls, and versions 1.20a and later completely ignore pdftex.cfg. The settings in question define the paper size (8.5 x 11 inches, the size used to print the proceedings) and the location of the coordinate system origin on the page. If your pdflatex needs pdftex.cfg and can't find it, your paper size and margins may be incorrect. If you are in doubt, open your PDF file with GhostScript or Adobe Reader and check the paper size, which should be 8.5 x 11 inches (216 x 279 mm), not 210 x 297 mm as for A4 paper.

ACKNOWLEDGEMENTS

The cinc.cls file was originally adapted by Hans Kestler from Peter Nuchter's IEEEtran2e.cls, which in turn was adapted from IEEEtran.sty by Gerry Murray and Silvano Balemi. Bob Throne, Alan Murray, Andrew Sims, George Moody, and Erik Bojorges contributed feedback, bug fixes, and further improvements. The cinc.bst file was created by Hans Kestler and George Moody using Patrick Daly's makebst generator. George Moody wrote the generic template and a C program for customizing it based on input from Bill Sanders's template generator for MS Word; Bill translated the customizer into VB and incorporated it into the template generator.

Your comments, suggestions, questions, and bug reports are welcome; please send them to George Moody (george@mit.edu).