summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/confproc/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/confproc/README')
-rw-r--r--Master/texmf-dist/doc/latex/confproc/README158
1 files changed, 86 insertions, 72 deletions
diff --git a/Master/texmf-dist/doc/latex/confproc/README b/Master/texmf-dist/doc/latex/confproc/README
index 1f30b4fbd9b..126f50dcee6 100644
--- a/Master/texmf-dist/doc/latex/confproc/README
+++ b/Master/texmf-dist/doc/latex/confproc/README
@@ -1,67 +1,84 @@
The confproc package
- ($Date: 2007/10/17 00:00:01 $)
+ ($Date: 2010/07/24 00:00:01 $)
- Copyright (C) 2007 by Vincent Verfaille
- <vincent@music.mcgill.ca>
+ Copyright (C) 2010 by Vincent Verfaille
+ <[lastname].[packagename]@gmail.com>
Purpose:
- This is a LaTeX2e package providing a new document-class
- for building conference proceedings, mainly based on the
- 'hyperref' and 'pdfpages' packages.
+ Confproc is a LaTeX2e package providing a new document-class together
+ with various tools (Perl and Unix/bash scripts) for building conference
+ proceedings, or concatenating any set of PDFs with a table of contents,
+ index, bookmarks and general bibliography. The LaTeX2e class is mainly
+ based on the 'pdfpages' package for PDF papers inclusion, and the
+ 'hyperref' package for creating proper links, bookmarks and general
+ bibliography back references. It also uses many other packages for fine
+ tuning the table of contents, bibliography and index of authors.
+ Current version 0.7 is a major update with key-value option management.
+ The added value of this class is in the time saved to quickly design
+ conference proceedings or any collection of PDFs.
Files:
- confproc.dtx Docstrip archive
- --> To generate the doc, run this through LaTeX.
-
-Generated File:
- confproc.ins Batch file, run through LaTeX.
- --> Generated by running confproc.dtx through LaTeX.
- confproc.drv Driver for documentation.
- The file will be generated from confproc.ins
- To generate customized documentation, edit this
- file and run it through LaTeX.
- confproc.cls LaTeX package.
- --> Generated by running confproc.ins through LaTeX.
- confproc.cfg Configuration file.
- --> Generated by running confproc.ins through LaTeX.
- confproc.dvi Package documentation.
- --> Generated from confproc.drv.
-
- example.tex Example file demonstrating how to use this package.
- --> Generated by running confproc.ins through LaTeX.
- expapersswitch.tex Example of paper switch, to simplify paper insertion.
- --> Generated by running confproc.ins through LaTeX.
- exclasspre.tex Class and options declaration for the 1st LaTeX runs.
- --> Generated by running confproc.ins through LaTeX.
- exclasslast.tex Class and options declaration for the last LaTeX run.
- --> Generated by running confproc.ins through LaTeX.
- exbiblio.bib Bibliography for the example.
- --> Generated by running confproc.ins through LaTeX.
-
- procswitchandtoc.pl Perl script used to generate the program (ie.
- expaperswitch.tex) from the exprogram.csv file.
- --> Generated by running confproc.ins through LaTeX.
- exprogram.csv Example of comma-separated program of the conference.
- --> Generated by running confproc.ins through LaTeX.
-
- buildproc Unix script to build the example proceedings.
- --> Generated by running confproc.ins through LaTeX.
- buildpapers Unix script to re-build all the papers.
- --> Generated by running confproc.ins through LaTeX.
- buildcppdfpapers Unix script to copy all PDf papers in the right spot.
- --> Generated by running confproc.ins through LaTeX.
-
- readme.txt This file.
- --> Generated by running confproc.dtx through LaTeX.
+ - main file:
+ confproc.dtx Docstrip archive
+ To generate the doc, run this through LaTeX.
+
+ - class files:
+ confproc.ins Batch file (do: pdflatex confproc.dtx)
+ confproc.drv Driver for documentation (do: pdflatex confproc.ins)
+ Edit to generate customized doc + pdflatex confproc.drv
+ confproc.cls LaTeX package (do: pdflatex confproc.ins)
+ confproc.cfg Configuration file (do: pdflatex confproc.ins)
+ confproc.dvi Package documentation (do: pdflatex confproc.drv)
+
+ - example files (do: pdflatex confproc.ins):
+ confproc1.ist Index style
+ confproc2.ist Index style
+ example1empty.tex Simplest example file
+ example2custom.tex Customized example file
+ example3optim.tex Idem with automatic program generation
+ example4optim.tex Idem with option management
+ expapersswitch.tex Paper switch for paper insertion
+ exclasspre.tex Class options for 1st pdflatex runs on 'example4optim.tex'
+ exclasslastpb.tex Class options for last pdflatex run (paperback version)
+ exclasslastel.tex Class options for last pdflatex run (electronic version)
+ exbiblio.bib Bibliography for example*optim.tex
+ exprogram.csv Comma-separated conference program
+ newapave.bst Bibliography style from 'newapa.bst'
+ newapave.sty Bibliography style from 'newapa.sty'
+
+ - example scripts (do: pdflatex confproc.ins):
+ prepareexample.sh Unix/bash script to prepare example files and
+ folders (used it after running LaTeX on .dtx and .ins)
+
+ buildproc.sh Unix/bash script: build the example
+ buildpapers.sh Unix/bash script: re-build all the papers
+ buildcppdfpapers.sh Unix/bash script: copy papers to the right spot
+ countnbpages.sh Unix/bash script: count PDFs nb of pages
+ Requires 'pdftk' to be installed. Get it from:
+ http://www.pdftk.com or http://www.accesspdf.com/pdftk/
+ exportIndividualPDFs.sh Unix/bash scrit using pdftk to extract
+ each individual paper from the proceedings,
+ for proper page numbering and headers
+ generateswitch.pl Perl script generating 'expapersswitch.tex'
+ from 'exprogram.csv'
+ papersinfo.sh Unix/bash script to generate individual PDFs
+ with proper metadata
+ paperssplitpreamble.sh preamble of a Unix/bash script (papersplit.sh)
+ generated by exportIndividualPDFs.sh
+ removeLaTeXcmds.sh Unix/bash script to remove LaTeX accents and
+ commands for titles in PDF metadata
+
+
+Read me:
+ readme.txt This file (do: pdflatex confproc.dtx)
-Installation:
- LaTeX confproc.dtx Creates docstrip installation file
+Installation:
+ pdflatex confproc.dtx Creates docstrip installation file
confproc.ins and this file
- (La)TeX confproc.ins Creates class file confproc.cls, example
- files and scripts and documentation driver
- confproc.drv
+ pdflatex confproc.ins Creates 'confproc.cls' class file, example
+ files, scripts and documentation drive 'confproc.drv'
Docstrip options available:
package - to produce a (LaTeX2e) class file (.cls)
@@ -70,29 +87,26 @@ Installation:
possibilities of the package
Move confproc.cls into a directory searched by LaTeX.
- LaTeX confproc.dtx Creates the (LaTeX2e) documentation.
-
- optionally:
- Edit confproc.drv and customize the documentation to your wishes.
- LaTeX confproc.drv Generates customized documentation.
- Depending on your customization you will
- have to run
- makeindex confproc.idx -s gind.ist -o confproc.ind
- and/or
- makeindex confproc.glo -s gglo.ist -o confproc.gls
- LaTeX example.tex Demonstrates the possibilities of this
- package.
+ pdflatex confproc.dtx Creates the (LaTeX2e) documentation.
+
+optionally:
+ Edit confproc.drv and customize the documentation to your wishes.
+ LaTeX confproc.drv Generates customized documentation.
+ Depending on your customization you will have to run
+ makeindex confproc.idx -s gind.ist -o confproc.ind
+ and/or
+ makeindex confproc.glo -s gglo.ist -o confproc.gls
+ pdfLaTeX example*.tex Demonstrate the possibilities of this package.
+
Contact:
- E-Mail: vincent@music.mcgill.ca
- Address: Vincent Verfaille, Schulich School of Music,
- McGill University, 555 Sherbrooke street west,
- Montreal, Quebec, H3A 1E3, Canada
+ E-Mail: [lastname].[packagename]@gmail.com
+ Address: Vincent Verfaille, Montreal, QC, Canada
Legal stuff:
readme.txt, the ReadMe file for the confproc package
- Copyright (C) 2007 by Vincent Verfaille
- <vincent@music.mcgill.ca>
+ Copyright (C) 2010 by Vincent Verfaille
+ <[lastname].[packagename]@gmail.com>
This file is part of the confproc package.
-------------------------------------------