diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/confproc')
| -rw-r--r-- | Master/texmf-dist/source/latex/confproc/confproc.dtx | 6455 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/confproc/confproc.ins | 200 |
2 files changed, 6655 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/confproc/confproc.dtx b/Master/texmf-dist/source/latex/confproc/confproc.dtx new file mode 100644 index 00000000000..7121bc4baa3 --- /dev/null +++ b/Master/texmf-dist/source/latex/confproc/confproc.dtx @@ -0,0 +1,6455 @@ +%^^A ================================================================= +%^^A Some basic integrity-test stuff +%^^A ================================================================= +% \changes{0.1c}{2007/07/31}{Removing checksum} +% \changes{0.3}{2007/09/24}{Putting checksum back} +% \CheckSum{766} +% +% \iffalse +%<*ID> +% \CharacterTable +% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +% Digits \0\1\2\3\4\5\6\7\8\9 +% Exclamation \! Double quote \" Hash (number) \# +% Dollar \$ Percent \% Ampersand \& +% Acute accent \' Left paren \( Right paren \) +% Asterisk \* Plus \+ Comma \, +% Minus \- Point \. Solidus \/ +% Colon \: Semicolon \; Less than \< +% Equals \= Greater than \> Question mark \? +% Commercial at \@ Left bracket \[ Backslash \\ +% Right bracket \] Circumflex \^ Underscore \_ +% Grave accent \` Left brace \{ Vertical bar \| +% Right brace \} Tilde \~} +%^^A ================================================================= +%^^A Here is a `conference proceedings' package developed for DAFx-06. +%^^A For a short installation guide, see below +%^^A ================================================================= +%%% @LaTeX-package-file{ +%%% author = "Vincent Verfaille", +%%% version = "v0.3", +%%% date = "$Date: 2007/09/28 00:00:01 $", +%%% \changes{0.1d}{2007/07/31}{Renaming 'procconf' into 'confproc'} +%%% filename = "confproc.dtx, +%%% address = "Vincent Verfaille +%%% Sound Processing and Control Lab. +%%% Input Device and Music Interaction Lab. +%%% Schulich School of Music +%%% McGill University +%%% 555, Sherbrooke street west +%%% Montreal, Quebec, H3A 1E3 +%%% Canada", +%%% URL = "http://www.music.mcgill.ca/musictech/spcl/vincent_verfaille", +%%% email = "vincent@music.mcgill.ca", +%%% codetable = "ISO/ASCII", +%%% keywords = "McGill University, conference proceedings, DAFx-06, +%%% documentclass", +%%% dependencies = "\LaTeXe", +%%% supported = "yes", +%%% abstract = "This is a LaTeX2e package for conference proceedings. It derives form LaTeX scripts written for the DAFx-06 conference proceedings, mainly based on the \package{pdfpages} package for including the proceedings papers and the \package{hyperref} package for creating proper table of contents, bookmarks and general bibliography back references. It also uses many other packages for fine tuning of table of contents, bibliography and index of authors. The added value of this class is in the time it saves for you to quickly design your proceedings.", +%%% docstring = "When making the DAFx-06 proceedings, I +%%% designed a set of LaTeX macros to simplify the work. +%%% As those secret scripts became relatively popular, I +%%% updated them, under the form of the provided package.", +%%% copyright = "confproc.dtx, the documented macro-file for +%%% the confproc package +%%% Copyright (C) 2007 by Vincent Verfaille +%%% <vincent@music.mcgill.ca> +%%% +%%% This program may be distributed and/or +%%% modified under the conditions of the LaTeX +%%% Project Public License, either version 1.2 +%%% of this license or (at your option) any +%%% later version. +%%% +%%% The latest version of this license is in +%%% http://www.latex-project.org/lppl.txt +%%% and version 1.2 or later is part of all +%%% distributions of LaTeX version 1999/12/01 or +%%% later. +%%% +%%% This program consists of the confproc.dtx file." +%%% } +%</ID> +% +%<*install> +%^^A ================================================================= +%^^A Purpose of this package +%^^A ================================================================= +% This is a LaTeX2e package providing a new document-class for conference +% proceedings. It derives form LaTeX scripts written for the DAFx-06 conference proceedings. +% +%^^A ================================================================= +%^^A Installation of this package +%^^A ================================================================= +% Installation: +% LaTeX this file: creates docstrip installation file +% confproc.ins, readme.txt AND the (LaTeX2e) +% documentation +% (La)TeX confproc.ins: creates class file confproc.cls, example +% file example.tex and documentation +% driver confproc.drv +% +% Docstrip options available: +% package - to produce a (LaTeX2e) class file (.cls) +% driver - to produce a driver file to print the documentation +% example - to produce example files, which demonstrate the +% possibilities of this package +%</install> +% +% \fi +% \iffalse +% \changes{0.1a}{2007/07/27}{Readme: updated!} +%<*readme> +%^^A ================================================================= +%^^A Here is the readme.txt file +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +\begin{filecontents*}{readme.txt} + The confproc package + + ($Date: 2007/09/28 00:00:01 $) + + Copyright (C) 2007 by Vincent Verfaille + <vincent@music.mcgill.ca> + +Purpose: + This is a LaTeX2e package providing a new document-class + for conference proceedings. It derives form LaTeX scripts + written for the DAFx-06 conference proceedings. + +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. + +Installation: + + LaTeX 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 + + Docstrip options available: + package - to produce a (LaTeX2e) class file (.cls) + driver - to produce a driver file to print the documentation + example - to produce an example file, which demonstrates the + 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. + +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 + +Legal stuff: + readme.txt, the ReadMe file for the confproc package + Copyright (C) 2007 by Vincent Verfaille + <vincent@music.mcgill.ca> + + This file is part of the confproc package. + ------------------------------------------- + + There is no warranty for the confproc package. I provide the + program `as is', without warranty of any kind, either expressed or + implied, including, but not limited to, the implied warranties of + merchantability and fitness for a particular purpose. The entire + risk as to the quality and performance of the program is with you. + Should the program prove defective, you assume the cost of all + necessary servicing, repair, or correction. + + This program may be distributed and/or modified under the + conditions of the LaTeX Project Public License, either version 1.2 + of this license or (at your option) any later version. + + The latest version of this license is in + http://www.latex-project.org/lppl.txt + and version 1.2 or later is part of all distributions of LaTeX + version 1999/12/01 or later. + + This is a generated file. It may not be distributed without the + original source file confproc.dtx. + + This program consists of the confproc.dtx file. + + Files generated by means of unpacking this program using the + docstrip program may be distributed at the distributor's + discretion. However if they are distributed then a copy of + this program must be distributed together with them. +\end{filecontents*} +%</readme> +% +% \changes{0.1d}{2007/08/01}{Adding the confproc.ist creation.} +%<*indexstyle> +%^^A ================================================================= +%^^A Here is the creation of the index style file confproc.ist +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +\begin{filecontents*}{confproc.ist} +%% +%% This is file `confproc.ist', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% confproc.dtx (with options: `doc') +%% +%% This is `confproc.ist', an index formatting example, for the confproc package. +%% Copyright (C) 2007 by Vincent Verfaille +%% <vincent@music.mcgill.ca> +%% +%% This file is part of the confproc package. +%% ------------------------------------------- +%% +%% It may be distributed and/or modified under the conditions of the +%% LaTeX Project Public License, either version 1.2 of this license or +%% (at your option) any later version. +%% +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.2 or later is part of all distributions of LaTeX version +%% 1999/12/01 or later. +%% +%% This file may not be distributed without the original source file +%% `confproc.dtx'. +%% +%% The list of all files belonging to the confproc package is given in +%% the file `readme.txt'. +%% +%% For more details, LaTeX the source `confproc.dtx'. +%% + +%%--add a letter between 2 lists +heading_prefix "{\\bfseries\\hfil " +heading_suffix "\\hfil}\\nopagebreak\n" +headings_flag 1 + +%%-- Add lines with points between name and page numbers +delim_0 "\\dotfill" +delim_1 "\\dotfill" +delim_2 "\\dotfill" +\end{filecontents*} +%</indexstyle> +% +% +% \changes{0.1d}{2007/08/01}{Adding the \package{threecolindex.sty} creation} +% \changes{0.2a}{2007/08/12}{Removing the \package{threecolindex.sty} file: corresponding cmds moved into the class!} +% +% \changes{0.1d}{2007/08/01}{Installer: adding newapave.bst.} +%<*newapavebst> +\begin{filecontents*}{newapave.bst} +%$$$ newapave.bst $$$ +% BibTeX `newapave' style file for BibTeX version 0.99c, LaTeX version 2e +% Place it in a file called newapave.bst in the BibTeX search path. +%(Placing it in the same directory as the LaTeX document should also work.) +% Support for named citations is provided by named.sty +% +% This version was modified by V. Verfaille, from the already modified master file made by +% Oren Patashnik, and the 'named' BibTeX style of Peter F. Patel-Schneider. +% +% Copyright (C) 2006, all rights reserved. +% Copying of this file is authorized only if either +% (1) you make absolutely no changes to your copy, including name, or +% (2) if you do make changes, you name it something other than 'newapave.bst'. +% There are undoubtably bugs in this style. If you make bug fixes, +% improvements, etc. please let me know. My e-mail address is: +% vincent@music.mcgill.ca +% +% This style was made from 'plain.bst', 'named.bst', and 'apalike.bst', +% with lots of tweaking to make it look like APA style, along with tips +% from Young Ryu and Brian Reiser's modifications of 'apalike.bst'. +% Then, it was modified a bit for the DAFx-06 proceedings, for use +% with the general bibliography. +% +% Citation format: (author-last-name, year) +% (author-last-name and author-last-name, year) +% (author-last-name {\em et al.}, year) +% (author-last-name) +% (author-last-name and author-last-name) +% (author-last-name {\em et al.}) +% (year) +% +% Reference list ordering: alphabetical by author or whatever passes +% for author in the absence of one. +% +% This BibTeX style has support for abbreviated author lists and for +% year-only citations. This is done by having the citations +% actually look like +% +% \citeauthoryear{full-author-info}{abbrev-author-info}{year} +% +% The LaTeX style has to have the following (or similar) +% +% \let\@internalcite\cite +% \def\fullcite{\def\citeauthoryear##1##2##3{##1, ##3}\@internalcite} +% \def\fullciteA{\def\citeauthoryear##1##2##3{##1}\@internalcite} +% \def\shortcite{\def\citeauthoryear##1##2##3{##2, ##3}\@internalcite} +% \def\shortciteA{\def\citeauthoryear##1##2##3{##2}\@internalcite} +% \def\citeyear{\def\citeauthoryear##1##2##3{##3}\@internalcite} +% + +ENTRY + { address + author + booktitle + chapter + edition + editor + howpublished + institution + journal + key +% month + note + number + organization + pages + publisher + school + series + title + type + volume + year + } + {} + { label extra.label sort.label } + +INTEGERS { output.state before.all mid.sentence after.sentence after.block } + +FUNCTION {init.state.consts} +{ #0 'before.all := + #1 'mid.sentence := + #2 'after.sentence := + #3 'after.block := +} + +STRINGS { s t u } + +FUNCTION {output.nonnull} +{ 's := + output.state mid.sentence = + { ", " * write$ } + { output.state after.block = + { add.period$ write$ + newline$ + "\newblock " write$ + } + { output.state before.all = + 'write$ + { add.period$ " " * write$ } + if$ + } + if$ + mid.sentence 'output.state := + } + if$ + s +} + +FUNCTION {special.output.nonnull} +{ 's := + output.state mid.sentence = + { " " * write$ } + { output.state after.block = + { ": " write$ + newline$ + "\newblock " write$ + } + { output.state before.all = + 'write$ + { ": " * write$ + } + if$ + } + if$ + mid.sentence 'output.state := + } + if$ + s +} + +FUNCTION {output.nonnull.colon} +{ 's := + output.state mid.sentence = + { ": " * write$ } + { output.state after.block = + { add.period$ write$ + newline$ + "\newblock " write$ + } + { output.state before.all = + 'write$ + { add.period$ " " * write$ } + if$ + } + if$ + mid.sentence 'output.state := + } + if$ + s +} + +FUNCTION {output.nonnull.space} +{ 's := + output.state mid.sentence = + { "\ " * write$ } + { output.state after.block = + { add.period$ write$ + newline$ + "\newblock " write$ + } + { output.state before.all = + 'write$ + { add.period$ " " * write$ } + if$ + } + if$ + mid.sentence 'output.state := + } + if$ + s +} + +FUNCTION {special.output} +{ duplicate$ empty$ + 'pop$ + 'special.output.nonnull + if$ +} + +FUNCTION {output} +{ duplicate$ empty$ + 'pop$ + 'output.nonnull + if$ +} + +FUNCTION {output.check} +{ 't := + duplicate$ empty$ + { pop$ "empty " t * " in " * cite$ * warning$ } + 'output.nonnull + if$ +} + +FUNCTION {output.check.colon} +{ 't := + duplicate$ empty$ + { pop$ "empty " t * " in " * cite$ * warning$ } + 'output.nonnull.colon + if$ +} + +FUNCTION {output.check.space} +{ 't := + duplicate$ empty$ + { pop$ "empty " t * " in " * cite$ * warning$ } + 'output.nonnull.space + if$ +} + +FUNCTION {output.year.check} +{ year empty$ + { "empty year in " cite$ * warning$ + } + { write$ + ", " year * "." * "~\hfill " * % shorter and simpler without label (2002a, 2002b useless) +%% ", " year * extra.label * "." * " \Pointinghand{} " * % shorter + mid.sentence 'output.state := +% mid.sentence 'output.state := * "}" + } + if$ +} + +FUNCTION {output.bibitem} +{ newline$ + + "\bibitem[" write$ + label write$ + "]{" write$ + + cite$ write$ + "}" write$ + newline$ + "" + before.all 'output.state := +} + +FUNCTION {fin.entry} +{% add.period$ + write$ + newline$ +} + +FUNCTION {new.block} +{ output.state before.all = + 'skip$ + { after.block 'output.state := } + if$ +} + +FUNCTION {new.sentence} +{ output.state after.block = + 'skip$ + { output.state before.all = + 'skip$ + { after.sentence 'output.state := } + if$ + } + if$ +} + +FUNCTION {not} +{ { #0 } + { #1 } + if$ +} + +FUNCTION {and} +{ 'skip$ + { pop$ #0 } + if$ +} + +FUNCTION {or} +{ { pop$ #1 } + 'skip$ + if$ +} + +FUNCTION {new.block.checka} +{ empty$ + 'skip$ + 'new.block + if$ +} + +FUNCTION {new.block.checkb} +{ empty$ + swap$ empty$ + and + 'skip$ + 'new.block + if$ +} + +FUNCTION {new.sentence.checka} +{ empty$ + 'skip$ + 'new.sentence + if$ +} + +FUNCTION {new.sentence.checkb} +{ empty$ + swap$ empty$ + and + 'skip$ + 'new.sentence + if$ +} + +FUNCTION {field.or.null} +{ duplicate$ empty$ + { pop$ "" } + 'skip$ + if$ +} + +FUNCTION {underline} +{ duplicate$ empty$ + { pop$ "" } + { "\underline{" swap$ * "}" * } + if$ +} + +FUNCTION {emphasize} +{ duplicate$ empty$ + { pop$ "" } + { "{\em " swap$ * "}" * } + if$ +} + +FUNCTION {emphasize.space} +{ duplicate$ empty$ + { pop$ "" } + { "{\em " swap$ * "\/}" * } + if$ +} + +INTEGERS { nameptr namesleft numnames } + +FUNCTION {format.names} +{ 's := + #1 'nameptr := % nameptr = 1; + s num.names$ 'numnames := % numnames = num.name$(s); + numnames 'namesleft := + { namesleft #0 > } + + { s nameptr "{vv~}{ll}{, jj}{, f.}" format.name$ 't := + + nameptr #1 > + { namesleft #1 > + { ", " * t * } + { numnames #2 > + { "," * } + 'skip$ + if$ + t "others" = + { " et~al." * } +% { ", \& " * t * } +% { " \& " * t * } + { " and " * t * } + if$ + } + if$ + } + 't + if$ + nameptr #1 + 'nameptr := % nameptr += 1; + namesleft #1 - 'namesleft := % namesleft =- 1; + } + while$ +} + +FUNCTION {format.names.fml} +{ 's := + #1 'nameptr := % nameptr = 1; + s num.names$ 'numnames := % numnames = num.name$(s); + numnames 'namesleft := + { namesleft #0 > } + + { s nameptr "{f.~}{vv~}{ll}{, jj}" format.name$ 't := + + nameptr #1 > + { namesleft #1 > + { ", " * t * } + { numnames #2 > + { "," * } + 'skip$ + if$ + t "others" = + { " et~al." * } +% { " and " * t * } + { " \& " * t * } + if$ + } + if$ + } + 't + if$ + nameptr #1 + 'nameptr := % nameptr += 1; + namesleft #1 - 'namesleft := % namesleft =- 1; + } + while$ +} + +FUNCTION {format.authors} +{ author empty$ + { "" } + { author format.names } + if$ +} + +FUNCTION {format.key} +{ empty$ + { key field.or.null } + { "" } + if$ +} + +FUNCTION {format.editors.fml} +{ editor empty$ + { "" } + { editor format.names.fml + editor num.names$ #1 > + { " (Eds.)" * } + { " (Ed.)" * } + if$ + } + if$ +} + +FUNCTION {format.editors} +{ editor empty$ + { "" } + { editor format.names + editor num.names$ #1 > + { " (Eds.)" * } + { " (Ed.)" * } + if$ + } + if$ +} + +FUNCTION {format.editors.dot} +{ editor empty$ + { "" } + { editor format.names + editor num.names$ #1 > + { " (Eds.)." * } + { " (Ed.)." * } + if$ + } + if$ +} + +FUNCTION {format.title} +{ title empty$ + { "" } + { title "t" change.case$ } + if$ +} + +% Note that the APA style requires case changes +% in article titles. The following does not +% change cases. If you perfer it, uncomment the +% following and comment out the above. + +%FUNCTION {format.title} +%{ title empty$ +% { "" } +% { title } +% if$ +%} + +FUNCTION {n.dashify} +{ 't := + "" + { t empty$ not } + { t #1 #1 substring$ "-" = + { t #1 #2 substring$ "--" = not + { "--" * + t #2 global.max$ substring$ 't := + } + { { t #1 #1 substring$ "-" = } + { "-" * + t #2 global.max$ substring$ 't := + } + while$ + } + if$ + } + { t #1 #1 substring$ * + t #2 global.max$ substring$ 't := + } + if$ + } + while$ +} + +FUNCTION {format.btitle} +{ edition empty$ + { title emphasize } + { title empty$ + { title emphasize } + { "{\em " title * "\/} (" * edition * " ed.)" * "." * } + if$ + } + if$ +} + +FUNCTION {format.emphasize.booktitle} +{ edition empty$ + { booktitle emphasize } + { booktitle empty$ + { booktitle emphasize } + { "{\em " booktitle * "\/} (" * edition * " ed.)" * "." * } + if$ + } + if$ +} + +FUNCTION {tie.or.space.connect} +{ duplicate$ text.length$ #3 < + { "~" } + { " " } + if$ + swap$ * * +} + +FUNCTION {either.or.check} +{ empty$ + 'pop$ + { "can't use both " swap$ * " fields in " * cite$ * warning$ } + if$ +} + +FUNCTION {format.bvolume} +{ volume empty$ + { "" } + { "volume" volume tie.or.space.connect + series empty$ + 'skip$ + { " of " * series emphasize * } + if$ + "volume and number" number either.or.check + } + if$ +} + +FUNCTION {format.number.series} +{ volume empty$ + { number empty$ + { series field.or.null } + { output.state mid.sentence = + { "number" } + { "Number" } + if$ + number tie.or.space.connect + series empty$ + { "there's a number but no series in " cite$ * warning$ } + { " in " * series * } + if$ + } + if$ + } + { "" } + if$ +} + +FUNCTION {format.edition} +{ edition empty$ + { "" } + { output.state mid.sentence = + { edition "l" change.case$ " edition" * } + { edition "t" change.case$ " edition" * } + if$ + } + if$ +} + +INTEGERS { multiresult } + +FUNCTION {multi.page.check} +{ 't := + #0 'multiresult := + { multiresult not + t empty$ not + and + } + { t #1 #1 substring$ + duplicate$ "-" = + swap$ duplicate$ "," = + swap$ "+" = + or or + { #1 'multiresult := } + { t #2 global.max$ substring$ 't := } + if$ + } + while$ + multiresult +} + +FUNCTION {format.pages} +{ pages empty$ + { "" } + { pages multi.page.check + { "pp.\" pages n.dashify tie.or.space.connect } % removed parenthesis + { "pp.\" pages tie.or.space.connect } % removed parenthesis + if$ + "" * + } + if$ +} + +% By Young (and Spencer) +FUNCTION {format.vol.num.pages} +{ number empty$ + { volume empty$ + 'skip$ + { "" volume * "" *} % removed \em + if$ + } + { volume % removed \em + number empty$ + {"there's a number but no volume in " cite$ * warning$ } + { "(" number * ")" * * } + if$ + } + if$ + pages empty$ + 'skip$ + { duplicate$ empty$ + { pop$ format.pages } + { ", pp. " * pages n.dashify * } + if$ + } + if$ +} + +FUNCTION {format.chapter.pages} +{ chapter empty$ + 'format.pages + { type empty$ + { "chapter" } + { type "l" change.case$ } + if$ + chapter tie.or.space.connect + pages empty$ + 'skip$ + { ", " * format.pages * } +% { ", pp. " * format.pages * } + if$ + } + if$ +} + +FUNCTION {format.chapter.pages.incoll} +{ chapter empty$ + 'format.pages + { type empty$ + { "chapter" } + { type "l" change.case$ } + if$ + chapter tie.or.space.connect + pages empty$ + 'skip$ + { " pp. " * format.pages * } + if$ + } + if$ +} + +FUNCTION {format.in.ed.booktitle} +{ booktitle empty$ + { "" } + { editor empty$ + { "In " format.emphasize.booktitle * } + { "In " format.editors * ", " * format.emphasize.booktitle * } + if$ + } + if$ +} + +FUNCTION {format.in.ed.booktitle.incoll} +{ booktitle empty$ + { "" } + { editor empty$ + { "In " format.emphasize.booktitle * } + { "In " format.editors.fml * ", " * format.emphasize.booktitle * } + if$ + } + if$ +} + +FUNCTION {format.thesis.type} +{ type empty$ + 'skip$ + { pop$ + type "t" change.case$ + } + if$ +} + +FUNCTION {format.tr.number} +{ type empty$ + { "Technical Report" } + 'type + if$ + number empty$ + { "t" change.case$ } + { number tie.or.space.connect } + if$ +} + +FUNCTION {format.article.crossref} +{ "In" + "\cite{" * crossref * "}" * +} + +FUNCTION {format.crossref.editor} +{ editor #1 "{vv~}{ll}" format.name$ + editor num.names$ duplicate$ + #2 > + { pop$ " et~al." * } + { #2 < + 'skip$ + { editor #2 "{ff }{vv }{ll}{ jj}" format.name$ "others" = + { " et~al." * } + { " and " * editor #2 "{vv~}{ll}" format.name$ * } + if$ + } + if$ + } + if$ +} + +FUNCTION {format.book.crossref} +{ volume empty$ + { "empty volume in " cite$ * "'s crossref of " * crossref * warning$ + "In " + } + { "Volume" volume tie.or.space.connect + " of " * + } + if$ + editor empty$ + editor field.or.null author field.or.null = + or + { key empty$ + { series empty$ + { "need editor, key, or series for " cite$ * " to crossref " * + crossref * warning$ + "" * + } + { "{\em " * series * "\/}" * } + if$ + } + { key * } + if$ + } + { format.crossref.editor * } + if$ + " \cite{" * crossref * "}" * +} + +FUNCTION {format.incoll.inproc.crossref} +{ "In" + " \cite{" * crossref * "}" * +} + +FUNCTION {article} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + crossref missing$ + { journal emphasize "journal" output.check + format.vol.num.pages output + } + { format.article.crossref output.nonnull + format.pages output + } + if$ + new.block + note output + output.year.check% moved + fin.entry +} + +FUNCTION {book} +{ output.bibitem + author empty$ + { format.editors.dot + "author and editor" output.check } + { format.authors + output.nonnull + crossref missing$ + { "author and editor" editor either.or.check } + 'skip$ + if$ + } + if$ + new.block + format.btitle + "title" output.check + crossref missing$ + { format.bvolume output + new.block + format.number.series output + new.sentence + address output + publisher "publisher" output.check.colon + } + { new.block + format.book.crossref output.nonnull + } + if$ +% format.edition output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {booklet} +{ output.bibitem + format.authors output + author format.key output + new.block + format.title + "title" output.check + new.block + howpublished output + address output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {inbook} +{ output.bibitem + author empty$ + { format.editors.dot + "author and editor" output.check + } + { format.authors output.nonnull + crossref missing$ + { "author and editor" editor either.or.check } + 'skip$ + if$ + } + if$ + new.block + format.btitle + "title" output.check + crossref missing$ + { format.bvolume output + format.chapter.pages + "chapter and pages" output.check + new.block + format.number.series output + new.sentence + address output + publisher + "publisher" output.check.colon + } + { format.chapter.pages "chapter and pages" output.check + new.block + format.book.crossref output.nonnull + } + if$ +% format.edition output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {incollection} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + crossref missing$ + { format.in.ed.booktitle.incoll + "booktitle" output.check.colon + format.bvolume output + format.number.series output + format.chapter.pages special.output + new.sentence + address output + publisher "publisher" output.check.colon + } + { format.incoll.inproc.crossref + output.nonnull + format.chapter.pages output + } + if$ + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {inproceedings} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + crossref missing$ + { format.in.ed.booktitle + "booktitle" output.check + format.bvolume output + format.number.series output + address output +% new.sentence %removed, to avoid having a ".", but having a "," instead + organization output + publisher output + format.pages output + } + { format.incoll.inproc.crossref output.nonnull + format.pages output + } + if$ + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {conference} { inproceedings } + +FUNCTION {manual} +{ output.bibitem + format.authors output + author format.key output + new.block + format.btitle + "title" output.check + organization address new.block.checkb +% Reversed the order of "address" and "organization", added the ":". + address output + organization "organization" output.check.colon +% address output +% ":" output +% organization output +% format.edition output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {mastersthesis} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + "Master's thesis" format.thesis.type output.nonnull + school "school" output.check + address output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {misc} +{ output.bibitem + format.authors output + author format.key output + title howpublished new.block.checkb + format.title output + new.block + howpublished output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {phdthesis} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.btitle + "title" output.check + new.block + "PhD thesis" format.thesis.type output.nonnull + school "school" output.check + address output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {proceedings} +{ output.bibitem + editor empty$ + { organization output } + { format.editors.dot output.nonnull } + if$ + author format.key output + new.block + format.btitle + "title" output.check + format.bvolume output + format.number.series output + address output + new.sentence + organization output + publisher output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {techreport} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + format.tr.number output.nonnull + institution + "institution" output.check + address output + new.block + note output + output.year.check % moved + fin.entry +} + +FUNCTION {unpublished} +{ output.bibitem + format.authors + "author" output.check + author format.key output + new.block + format.title + "title" output.check + new.block + note "note" output.check + output.year.check % moved + fin.entry +} + +FUNCTION {default.type} { misc } + +MACRO {jan} {"January"} + +MACRO {feb} {"February"} + +MACRO {mar} {"March"} + +MACRO {apr} {"April"} + +MACRO {may} {"May"} + +MACRO {jun} {"June"} + +MACRO {jul} {"July"} + +MACRO {aug} {"August"} + +MACRO {sep} {"September"} + +MACRO {oct} {"October"} + +MACRO {nov} {"November"} + +MACRO {dec} {"December"} + +MACRO {acmcs} {"ACM Computing Surveys"} + +MACRO {acta} {"Acta Informatica"} + +MACRO {ai} {"Artificial Intelligence"} + +MACRO {cacm} {"Communications of the ACM"} + +MACRO {ibmjrd} {"IBM Journal of Research and Development"} + +MACRO {ibmsj} {"IBM Systems Journal"} + +MACRO {ieeese} {"IEEE Transactions on Software Engineering"} + +MACRO {ieeetc} {"IEEE Transactions on Computers"} + +MACRO {ieeetcad} + {"IEEE Transactions on Computer-Aided Design of Integrated Circuits"} + +MACRO {ipl} {"Information Processing Letters"} + +MACRO {jacm} {"Journal of the ACM"} + +MACRO {jcss} {"Journal of Computer and System Sciences"} + +MACRO {scp} {"Science of Computer Programming"} + +MACRO {sicomp} {"SIAM Journal on Computing"} + +MACRO {tocs} {"ACM Transactions on Computer Systems"} + +MACRO {tods} {"ACM Transactions on Database Systems"} + +MACRO {tog} {"ACM Transactions on Graphics"} + +MACRO {toms} {"ACM Transactions on Mathematical Software"} + +MACRO {toois} {"ACM Transactions on Office Information Systems"} + +MACRO {toplas} {"ACM Transactions on Programming Languages and Systems"} + +MACRO {tcs} {"Theoretical Computer Science"} + +READ + +FUNCTION {sortify} +{ purify$ + "l" change.case$ +} + +INTEGERS { len } + +FUNCTION {chop.word} +{ 's := + 'len := + s #1 len substring$ = + { s len #1 + global.max$ substring$ } + 's + if$ +} + +INTEGERS { fullptr numfull fullsleft } + +STRINGS { u1 u2 } + +FUNCTION {my.full.label} +{ +% Initialize 'u1','u2','s'. + "" 'u1 := + "" 'u2 := + 's := + +% Initialize 'fullptr','numfull','fullsleft'. + #1 'fullptr := + s num.names$ 'numfull := + numfull 'fullsleft := + +% enter the while loop which generates the first-citation information. +% while we have names left, +% format the next name +% if this is the next-to-last name, tack the ampersand on the end +% else if this isn't the last name, tack the comma on the end. +% concatenate the next name onto the first-citation string. +% update the counters. + + { fullsleft #0 > } + { s fullptr "{vv~}{ll}" format.name$ 'u1 := + fullsleft #2 = + { u1 " \& " * 'u1 := } + { fullsleft #2 > + { u1 ", " * 'u1 := } + 'skip$ + if$ + } + if$ + u2 u1 * 'u2 := + fullptr #1 + 'fullptr := + fullsleft #1 - 'fullsleft := + } + while$ + +% push 'u2' onto the stack -- our first-citation information. + u2 +} + +FUNCTION {format.lab.names} +{ 's := + s #1 "{vv~}{ll}" format.name$ + s num.names$ duplicate$ + #2 > + { pop$ " et~al." * } + { #2 < + 'skip$ + { s #2 "{ff }{vv }{ll}{ jj}" format.name$ "others" = + { "et~al. " * } +% { " and " * s #2 "{vv~}{ll}" format.name$ * } + { " \& " * s #2 "{vv~}{ll}" format.name$ * } + if$ + } + if$ + } + if$ +} + +FUNCTION {author.key.label} +{ author empty$ + { key empty$ + { cite$ #1 #3 substring$ } + 'key + if$ + } + { author format.lab.names } + if$ +} + +FUNCTION {editor.key.label} +{ editor empty$ + { key empty$ + { cite$ #1 #3 substring$ } + 'key + if$ + } + { editor format.lab.names } + if$ +} + +FUNCTION {author.editor.key.label} +{ author empty$ + { editor empty$ + { key empty$ + { cite$ #1 #3 substring$ } + 'key + if$ + } + { editor format.lab.names } + if$ + } + { author format.lab.names } + if$ +} + +FUNCTION {calc.label} +{ type$ "book" = + type$ "inbook" = + or + 'author.editor.key.label + { type$ "proceedings" = + 'editor.key.label + 'author.key.label + if$ + } + if$ + duplicate$ + + author my.full.label % generate the first-citation information. + + "\protect\citeauthoryear{" swap$ * "}{" * swap$ * "}{" * + year field.or.null purify$ #-1 #4 substring$ * + 'label := + year field.or.null purify$ #-1 #4 substring$ * + sortify 'sort.label := +} + +FUNCTION {sort.format.names} +{ 's := + #1 'nameptr := + "" + s num.names$ 'numnames := + numnames 'namesleft := + { namesleft #0 > } + { nameptr #1 > + { " " * } + 'skip$ + if$ + s nameptr "{vv{ } }{ll{ }}{ f{ }}{ jj{ }}" format.name$ 't := + nameptr numnames = t "others" = and + { "et al" * } + { t sortify * } + if$ + nameptr #1 + 'nameptr := + namesleft #1 - 'namesleft := + } + while$ +} + +FUNCTION {sort.format.title} +{ 't := + "A " #2 + "An " #3 + "The " #4 t chop.word + chop.word + chop.word + sortify + #1 global.max$ substring$ +} + +FUNCTION {author.sort} +{ author empty$ + { key empty$ + { "to sort, need author or key in " cite$ * warning$ + "" + } + { key sortify } + if$ + } + { author sort.format.names } + if$ +} + +FUNCTION {editor.sort} +{ editor empty$ + { key empty$ + { "to sort, need editor or key in " cite$ * warning$ + "" + } + { key sortify } + if$ + } + { editor sort.format.names } + if$ +} + +FUNCTION {author.editor.sort} +{ author empty$ + { editor empty$ + { key empty$ + { "to sort, need author, editor, or key in " cite$ * warning$ + "" + } + { key sortify } + if$ + } + { editor sort.format.names } + if$ + } + { author sort.format.names } + if$ +} + +FUNCTION {presort} +{ calc.label + label sortify + " " + * + type$ "book" = + type$ "inbook" = + or + 'author.editor.sort + { type$ "proceedings" = + 'editor.sort + 'author.sort + if$ + } + if$ + #1 entry.max$ substring$ % added for newapa + 'sort.label := % added for newapa + sort.label % added for newapa + * + " " + * + title field.or.null + sort.format.title + * + #1 entry.max$ substring$ + 'sort.key$ := +} + +ITERATE {presort} + +SORT % by label, sort.label, title --- for final label calculation + +STRINGS { last.label next.extra } + +INTEGERS { last.extra.num } + +FUNCTION {initialize.extra.label.stuff} +{ #0 int.to.chr$ 'last.label := + "" 'next.extra := + #0 'last.extra.num := +} + +FUNCTION {forward.pass} +{ last.label label = + { last.extra.num #1 + 'last.extra.num := + last.extra.num int.to.chr$ 'extra.label := + } + { "a" chr.to.int$ 'last.extra.num := + "" 'extra.label := + label 'last.label := + } + if$ +} + +FUNCTION {reverse.pass} +{ next.extra "b" = + { "a" 'extra.label := } + 'skip$ + if$ + label extra.label * "}" * 'label := + extra.label 'next.extra := +} + +EXECUTE {initialize.extra.label.stuff} + +ITERATE {forward.pass} + +REVERSE {reverse.pass} + +FUNCTION {bib.sort.order} +{ sort.label + " " + * + year field.or.null sortify + * + " " + * + title field.or.null + sort.format.title + * + #1 entry.max$ substring$ + 'sort.key$ := +} + +ITERATE {bib.sort.order} + +SORT % by sort.label, year, title --- giving final bib. order. + +FUNCTION {begin.bib} + +{ preamble$ empty$ + 'skip$ + { preamble$ write$ newline$ } + if$ + "\begin{thebibliography}{}" write$ newline$ +} + + +EXECUTE {begin.bib} + +EXECUTE {init.state.consts} + +ITERATE {call.type$} + +FUNCTION {end.bib} +{ newline$ + "\end{thebibliography}" write$ newline$ +} + +EXECUTE {end.bib} +\end{filecontents*} +%</newapavebst> +% +% \changes{0.1d}{2007/08/01}{Installer: adding newapave.sty.} +%<*newapavesty> +%^^A ================================================================= +%^^A Here is the creation of the bibliography style file newapave.sty +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +\begin{filecontents*}{newapave.sty} +%$$$ newapave.sty $$$ --- July 31, 2006 (Version 2.1) +% - Version 2.1. +% +% This file implements citations for the ``newapave'' bibliography style. +% +% Stephen N. Spencer +% modified the ``apalike'' LaTeX style +% Young U. Ryu +% further modified +% Vincent Verfaille +% modified as 'newapave' for DAFx-06: right-flushed back-references! +% +% SEE THE FOLLOWING COMMENTS. THEY CONSISTS OF 4 SECTIONS +% 1 - newapave.bst and \bibitem entry +% 2 - citation formats +% 3 - changing citation functions (if you want) +% 4 - enforcing APA style section heading (if you want) +% +%%%%% +% [1] newapave.bst and \bibitem entry +% +% The ``newapave.bst'' BibTeX bibliography style creates citations with labels: +% \citeauthoryear{author-info}{abbrev. author-info}{year} +% +%%%%% +% [2] Citation Formats +% +% The citations are enclosed within parentheses. ``(,)'' +% as default. But one may change them. +% Short author lists use the ``et al.'' construct. +% These labels are processed by the following LaTeX commands: +% +% \cite[optional notes]{Key(s)} +% -> (Authors1, Year1; Authors2, Year2; ..., optional notes) +% \citeA[optional notes]{key} +% -> Authors (Year, optional notes) +% Note: ONE AND ONLY ONE KEY. +% \citeA[pp.~3--5]{Apt88,Lloyd87} does not make sense at all. +% In this case, the outcome will look aweful. +% \citeB{keys} +% -> Authors1 (Year1), Authors2 (Year2), ... +% Note: \citeB[Notes]{keys} are given, notes will be ingored, +% because it does not make sense at all. +% \citeauthor[optional notes]{key} +% -> Authors1, Authors2, ..., optional notes +% +% The difference between `\shortciteXXX' and `\citeXXX': +% is that `\shortciteXXX' gives `First author et al.' +% if no. authors >= 3. +% +% \shortcite[optional notes]{Key(s)} +% -> (Short Authors1, Year1; Short Authors2, Year2; ..., optional notes) +% \shortciteA[optional notes]{key} +% -> Short Authors (Year, optional notes) +% Note: ONE AND ONLY ONE KEY. +% \shortciteA[pp.~3--5]{Apt88,Lloyd87} does not make sense at all. +% In this case, the outcome will look aweful. +% \shortciteB{keys} +% -> Authors1 (Year1), Authors2 (Year2), ... +% Note: \citeB[Notes]{keys} are given, notes will be ingored, +% because it does not make sense at all. +% \shortciteauthor[optional notes]{key} +% -> Short Authors1, Short Authors2, ..., optional notes +% +% \citeyear[optional notes]{key} +% -> (Year, optional notes) +% +%%%%% +% [3] Changing Citation Punctuations +% +% However, you may change citation punctuations. +% \citepunct{open paren}% +% {between authors}% +% {between author year}% +% {between citations}% +% {before notes}% +% {closing paren} +% +% For example, +% \citepunct{[}{and}{ }{, }{: }{]} +% - use square brackets +% `and' between authors +% space between author and year +% comma between citations +% comma before notes +% e.g. [Apt and van Emden 1986, Lloyd 1985: Notes] +% +% The default is: +% \citepunct{(}{\&}{, }{; }{, }{)} +% +% Notice spaces around punctuations in \citepunct!!! +% +%%%%% +% [4] Enforcing APA Style Section Heading +% +% \newapasectioning redefines section headings as described +% by the APA Publication Manual +% \section - level 1 (toc entry, paageheading) +% \subsection - level 2 (toc entry) +% \subsection - level 3 (toc entry) +% \paragraph - level 4 +% \subparagraph - level 3 +% +% if place * after \section, \subsection, \subsubsection +% section headings are not listed in the table of contents +% +\def\citestarts{(} +\def\betweenauthors{\&} +\def\betweenauthoryear{, } +\def\betweencites{; } +\def\beforenote{, } +\def\citeends{)} +% +\def\citepunct#1#2#3#4#5#6{% + \def\citestarts{#1} + \def\betweenauthors{#2} + \def\betweenauthoryear{#3} + \def\betweencites{#4} + \def\beforenote{#5} + \def\citeends{#6} } +% +\let\@internalcite\cite +% +% +\def\cite{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + \citestarts##1\if@tempswa \beforenote##2\fi\citeends}% + \def\citeauthoryear##1##2##3{##1\betweenauthoryear##3}\@internalcite} +\def\citeA{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + ##1\if@tempswa \beforenote##2\fi\citeends}% + \def\citeauthoryear##1##2##3{##1 \citestarts##3}\@citedata} +\def\citeB{\def\@citeseppen{-1000}% + \def\@cite##1##2{##1}% + \def\citeauthoryear##1##2##3{##1 \citestarts##3\citeends}\@citedata} +\def\citeauthor{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + ##1\if@tempswa \beforenote##2\fi}% + \def\citeauthoryear##1##2##3{##1}\@citedata} +% +% +\def\shortcite{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + \citestarts##1\if@tempswa \beforenote##2\fi\citeends}% + \def\citeauthoryear##1##2##3{##2\betweenauthoryear##3}\@internalcite} +\def\shortciteA{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + ##1\if@tempswa \beforenote##2\fi\citeends}% + \def\citeauthoryear##1##2##3{##2 \citestarts##3}\@citedata} +\def\shortciteB{\def\@citeseppen{-1000}% + \def\@cite##1##2{##1}% + \def\citeauthoryear##1##2##3{##2 \citestarts##3\citeends}\@citedata} +\def\shortciteauthor{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + ##1\if@tempswa \beforenote##2\fi}% + \def\citeauthoryear##1##2##3{##2}\@citedata} +% +\def\citeyear{\def\@citeseppen{-1000}% + \def\@cite##1##2{% + \citestarts##1\if@tempswa \beforenote##2\fi\citeends}% + \def\citeauthoryear##1##2##3{##3}\@citedata} +% +\def\@citedata{\@ifnextchar[{\@tempswatrue\@citedatax}{\@tempswafalse\@citedatax[]}} +% +\def\@citedatax[#1]#2{% +\if@filesw\immediate\write\@auxout{\string\citation{#2}}\fi + \def\@citea{}\@cite{\@for\@citeb:=#2\do + {\@citea\def\@citea{\betweencites}\@ifundefined + {b@\@citeb}{{\bf ?}\@warning + {Citation `\@citeb' on page \thepage \space undefined}} +{\csname b@\@citeb\endcsname}}}{#1}} +% +\def\@citex[#1]#2{% +\if@filesw\immediate\write\@auxout{\string\citation{#2}}\fi + \def\@citea{}\@cite{\@for\@citeb:=#2\do + {\@citea\def\@citea{\betweencites}\@ifundefined + {b@\@citeb}{{\bf ?}\@warning + {Citation `\@citeb' on page \thepage \space undefined}}% +{\csname b@\@citeb\endcsname}}}{#1}} +% +% (from apalike.sty) +% No labels in the bibliography. +% Set length of hanging indentation for bibliography entries. +\def\@biblabel#1{} +\newlength{\bibhang} +%\setlength{\bibhang}{1em} % ORIGINAL +\setlength{\bibhang}{0.5em} % DAFx-06 +% +\def\thebibliography#1{% + \section*{\bibname} + \addcontentsline{toc}{part}{\bibname} + \list + {\relax}{\setlength{\labelsep}{0em} + \setlength{\itemindent}{-\bibhang} + \setlength{\leftmargin}{\bibhang}} +% \def\newblock{\hskip .11em plus .33em minus .07em} % ORIGINAL + \def\newblock{\hskip 0em plus 0.0em minus .07em} % DAFx-06 + \sloppy\clubpenalty4000\widowpenalty4000 + \sfcode`\.=1000\relax} +% +% +% +%%% Sectioning + +\def\newapasectioning{ + \newlength{\sectionheadwidth} + \setlength{\sectionheadwidth}{\textwidth} + \addtolength{\sectionheadwidth}{-8em} + \let\@internalsection\section + \let\@internalsubsection\subsection + \let\@internalsubsubsection\subsubsection + \let\@internalparagraph\paragraph + \let\@internalsubparagraph\subparagraph + % Level 1 + \def\section{\@ifnextchar *{\a@sections}{\a@section}} + \def\a@sections##1##2{% + \@internalsection*{% + \centering\parbox{% + \sectionheadwidth}{% + \centering\normalsize\bf\uppercase{##2}}\@mkboth{##2}{##2}}} + \def\a@section##1{% + \addcontentsline{toc}{section}{##1} + \@internalsection*{% + \centering\parbox{% + \sectionheadwidth}{% + \centering\normalsize\bf\uppercase{##1}}\@mkboth{##1}{##1}}} + % Level 2 + \def\subsection{\@ifnextchar *{\a@subsections}{\a@subsection}} + \def\a@subsections##1##2{% + \@internalsubsection*{% + \centering\parbox{\sectionheadwidth}{\centering\normalsize\bf##2}}} + \def\a@subsection##1{% + \addcontentsline{toc}{subsection}{##1} + \@internalsubsection*{% + \centering\parbox{\sectionheadwidth}{\centering\normalsize\bf##1}}} + % Level 3 + \def\subsubsection{\@ifnextchar *{\a@subsubsections}{\a@subsubsection}} + \def\a@subsubsections##1##2{% + \@internalsubsubsection*{% + \centering\parbox{% + \sectionheadwidth}{\centering\normalsize\underbar{##2}}}} + \def\a@subsubsection##1{% + \addcontentsline{toc}{subsubsection}{##1} + \@internalsubsubsection*{% + \centering\parbox{% + \sectionheadwidth}{\centering\normalsize\underbar{##1}}}} + % Level 4 + \def\a@paragraph##1{% + \@internalsubsubsection*{\normalsize\underbar{##1}}} + % Level 5 + \def\a@subparagraph##1{% + \@internalsubparagraph*{\normalsize\underbar{##1}.}} + % table of contents + \def\tableofcontents{% + \section*{Contents}\@starttoc{toc}} + % list of figures + \def\listoffigures{% + \section*{List of Figures}\@starttoc{lof}} + % list of tables + \def\listoftables{% + \section*{List of Tables}\@starttoc{lot}} + % Change : to . in Figure/Table Caption + \long\def\@makecaption##1##2{ + \vskip 10pt + \setbox\@tempboxa\hbox{##1. ##2} + \ifdim \wd\@tempboxa >\hsize ##1. ##2\par \else \hbox + to\hsize{\hfil\box\@tempboxa\hfil} + \fi} +} +\end{filecontents*} +%</newapavesty> +% +% \changes{0.1b}{2007/07/27}{Class package finished. Switching to docstrip.} +% \changes{0.1d}{2007/08/01}{Adding creation of all Unix scripts and example files (using '\nopreamble' and '\nopostamble'.} +%<*installer> +%^^A ================================================================= +%^^A Here is the docstrip installation file +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +\begin{filecontents}{confproc.ins} +%% confproc.ins, the batch file for the confproc package +%% Copyright (C) 2007 by Vincent Verfaille +%% <vincent@music.mcgill.ca> +%% +%% This file is part of the confproc package. +%% ------------------------------------------- +%% +%% It may be distributed and/or modified under the conditions of the +%% LaTeX Project Public License, either version 1.2 of this license or +%% (at your option) any later version. +%% +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.2 or later is part of all distributions of LaTeX +%% version 1999/12/01 or later. +%% +%% In particular, NO PERMISSION is granted to modify the contents of +%% this file since it contains the legal notices that are placed in +%% the files it generates. +%% +%% This file may not be distributed without the original source file +%% confproc.dtx. +%% +%% The list of all files belonging to the confproc package is given +%% in the file `readme.txt'. +%% +%% This file will generate fast loadable files and documentation +%% driver files from the .dtx files in this package when run through +%% LaTeX or TeX. +%% +%% ------------------- start of docstrip commands ------------------- +\def\batchfile{confproc.ins} +\input docstrip.tex +% +\ifToplevel{\ifx\askonceonly\undefined% +\Msg{******************}% +\Msg{*}% +\Msg{* This installation requires docstrip}% +\Msg{* version 2.4e or later.}% +\Msg{*}% +\Msg{* An older version of docstrip has been input}% +\Msg{*}% +\Msg{******************}% +\errhelp{Move or rename old docstrip.tex.}% +\errmessage{Old docstrip in input path}% +\batchmode% +\csname @@end\endcsname% +\fi% +}% +% +%% Define standard text: +% +\def\nline{^^J\MetaPrefix\space}% +\def\stdtext{% +Copyright (C) 2007 by Vincent Verfaille + <vincent@music.mcgill.ca>\nline\nline% +This file is part of the confproc package.\nline% +-------------------------------------------\nline\nline% +It may be distributed and/or modified under the conditions of the\nline% +LaTeX Project Public License, either version 1.2 of this license or\nline% +(at your option) any later version.\nline\nline% +The latest version of this license is in\nline% +\space\space http://www.latex-project.org/lppl.txt\nline% +and version 1.2 or later is part of all distributions of LaTeX version\nline% +1999/12/01 or later.\nline\nline% +This file may not be distributed without the original source file\nline% +`\inFileName'.\nline\nline% +The list of all files belonging to the confproc package is given in\nline% +the file `readme.txt'.} +% +%% Declare preambles (and use \stdtext): +% +\declarepreamble\driver + +This is `\outFileName', the documentation driver for the confproc package. +\stdtext + +This is the driver file to produce the LaTeX documentation +from the original source file `\inFileName'. + +Make changes to it as needed. (Never edit the file `\inFileName'!) + +\endpreamble% +% +\declarepreamble\package + +This is `\outFileName', a LaTeX2e package to build conference proceedings. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\declarepreamble\example + +This is `\outFileName', an example file for the confproc package. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\declarepreamble\config + +This is `\outFileName', a configuration file for the confproc package. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\keepsilent% +% +%% Greeting: +% +\askforoverwritetrue% +\askonceonly% +% +\ifToplevel{% + \Msg{}% + \Msg{**********************}% + \Msg{* Hello to the installation of the `confproc' package. *}% + \Msg{**********************}% + \Msg{}% + \Msg{*********}% + \Msg{* Generating files... *}% + \Msg{*********}% +}% +% +%% File generation: +% +\generate{% + \usepreamble\example\file{example.tex}{\from{confproc.dtx}{example}}% + \usepreamble\example\file{expapersswitch.tex}{\from{confproc.dtx}{expapersswitch}}% + \usepreamble\example\file{expages.tex}{\from{confproc.dtx}{expages}}% + \usepreamble\example\file{exclasspre.tex}{\from{confproc.dtx}{exclasspre}}% + \usepreamble\example\file{exclasslast.tex}{\from{confproc.dtx}{exclasslast}}% + \usepreamble\example\file{exbiblio.bib}{\from{confproc.dtx}{exbiblio}}% + \nopreamble\nopostamble\file{procswitchandtoc.pl}{\from{confproc.dtx}{procswitchandtoc}}% + \nopreamble\nopostamble\file{exprogram.csv}{\from{confproc.dtx}{exprogram}}% + \nopreamble\nopostamble\file{buildpapers}{\from{confproc.dtx}{buildpapers}}% + \nopreamble\nopostamble\file{buildproc}{\from{confproc.dtx}{buildproc}}% + \nopreamble\nopostamble\file{buildcppdfpapers}{\from{confproc.dtx}{buildcppdfpapers}}% + \usepreamble\driver\file{confproc.drv}{\from{confproc.dtx}{driver}}% + \usepreamble\config\file{confproc.cfg}{\from{confproc.dtx}{config}}% +% \usedir{tex/latex/misc}% + \usepreamble\package\file{confproc.cls}{\from{confproc.dtx}{package}% + \nopreamble\nopostamble\file{buildcls}{\from{confproc.dtx}{buildcls}}% + \nopreamble\nopostamble\file{cleancls}{\from{confproc.dtx}{cleancls}}% + }% +}% +% +%% Report: +% +\ifToplevel{% + \Msg{}% + \Msg{********************}% + \Msg{*}% +\makeatletter\@ifundefined{basedir}{% + \Msg{* To finish the installation you have to move the following}% + \Msg{* file into a directory searched by LaTeX:}% +}{% + \Msg{* The following file has been automatically created in a} + \Msg{* directory searched by LaTeX:} +}\makeatother% + \Msg{*}% + \Msg{* \space\space confproc.cls}% + \Msg{*}% +\makeatletter\@ifundefined{basedir}{% + \Msg{* Using a TDS compatible TeX distribution, this would be e.g.}% + \Msg{* tex/latex/misc of your main or your local or your private}% + \Msg{* texmf path. If you don't know these paths, have a look}% + \Msg{* at your `texmf.cnf' or try:}% + \Msg{* \space\space kpsexpand \string\$TEXMFMAIN}% + \Msg{* \space\space kpsexpand \string\$TEXMFLOCAL}% + \Msg{* \space\space kpsexpand \string\$HOMETEXMF}% + \Msg{* You may also use another folder at your TEXINPUTS path.}% +}{}\makeatother% + \Msg{* To produce the documentation and a example, run the}% + \Msg{* following files through LaTeX:}% + \Msg{*}% + \Msg{* \space\space confproc.drv (three times)}% + \Msg{* \space\space example.tex}% + \Msg{*}% + \Msg{* For the legal stuff please have a look at:}% + \Msg{*}% + \Msg{* \space\space readme.txt}% + \Msg{*}% + \Msg{*}% + \Msg{* Happy TeXing!}% + \Msg{*}% + \Msg{********************}% + \Msg{}% +}% +% +\endbatchfile +\end{filecontents} +%</installer> +% +% \changes{0.1c}{2007/07/30}{Head: new} +%^^A ================================================================= +%^^A Here is the header that is written to driver-, example- and +%^^A class-file +%^^A ================================================================= +% +% The docdate info. It specifies the date of the documentation, which +% may differ from the filedate. (Its ok if docdate is younger. If it +% is older, then I forgot documenting. In that case: kick me... ;-) +%<*dtx|driver> +\def\docdate{2007/09/28} +%</dtx|driver> +% +% The required LaTeX version: +%<*dtx|driver|package|example> +\NeedsTeXFormat{LaTeX2e}[1994/12/01]% +%</dtx|driver|package|example> +% +% Identification of the docstrip file: +%<*dtx> +\ProvidesFile +%===================================================================== + {confproc.dtx} +%===================================================================== +%</dtx> +% +% Identification of the driver file: +%<driver>\ProvidesFile{confproc.drv} +% +% Identification of the example file: +%<example>\ProvidesFile{example.tex} +% +% Identification of the configuration file: +%<config>\ProvidesFile{confproc.cfg} +% +% Identification of the package file: +%<package>\ProvidesClass{confproc} +% +% Provide command to identify example file: +%<example>\def\DescribesFile#1 [#2 #3 #4 (#5)] +%<example> {\def\filedate{#2}\def\fileversion{#3}} +% +% Identification of the example file: +%<example>\DescribesFile{confproc.cls} +% +% The next three lines: +% 1.: Identification of the included .dtx-file. +% 2.: The date and version for docstrip, driver, example, config, +% package and dtx file. +% 3.: A short description and author for the included .dtx-file. +% \fi +% \ProvidesFile{confproc} +% [2007/09/28 v0.3: Documentation for confproc (VV)] +% \iffalse +% +% A short description and author for driver, example, config +% and package file: +%<package> [2007/09/28 v0.3: Conference Proceedings class (VV)] +%<example> [2007/09/28 v0.3: Example for confproc (VV)] +%<config> [2007/09/28 v0.3: Configuration for confproc (VV)] +%<driver> [2007/09/28 v0.3: Driver for confproc (VV)] +% +% A short description and author for the docstrip file: +%<*dtx> + [2007/09/28 v0.3: Documented source for confproc (VV)] +%</dtx> +% +%^^A ================================================================= +%^^A Here is the driver for customized documentation +%^^A ================================================================= +%<*driver> + % + % We do not specify any options by default and its recommended not to + % change this. If you want to use a4paper the proper way is to add + % a line + % \PassOptionsToClass{a4paper}{article} + % to your `ltxdoc.cfg'. +\documentclass{ltxdoc} + +%\changes{0.1f}{2007/08/03}{Doc style: adding hyperref package} + % Only use fontenc if it is present + \IfFileExists{fontenc.sty}{% + \usepackage[T1]{fontenc}}{} +\usepackage{amssymb} +\RequirePackage[pdftex,colorlinks=true,linkcolor=red,citecolor=red,pagecolor=red,urlcolor=blue,bookmarksopen=true,bookmarksopenlevel=1,raiselinks,hyperindex,backref,pagebackref,plainpages=false,pdfpagelabels,breaklinks,linktocpage,pdfstartview=XYZ]{hyperref} + +\usepackage{supertabular} +%\usepackage{tweaklist} +%\renewcommand{\enumhook}{\setlength{\topsep}{0pt}% +% \setlength{\itemsep}{0pt}} + + % By default this file will build the `user' documentation. It + % covers the basic information you need as an user and provides + % (if you want to) a compact index with the most important + % commands. To get the `programmer' documentation (with code + % listing, extended command index and change history), comment out + % the next line +% \OnlyDescription + + % To produce the compact command index: + % run makeindex -s confproc.ist confproc + + % If you commented out \OnlyDescription, you are able to control the + % index and change history with the following commands: + + % To produce the extended command index: add the following line + % one run, then run makeindex -s gind.ist confproc + % and re-process, with or without this line (much faster without) + % + % This will only have an effect if you commented out + % \OnlyDescription above! + \EnableCrossrefs + + % Next you can control the index numbering by the two commands + % \PageIndex and \CodelineIndex (I prefer the latter one..). If + % you don't want any index, comment out both commands. + % + % Description index entries refer to page numbers, code listing + % index entries refer to code lines + \CodelineIndex + % Make all index entries (description and code listing) refer to + % page numbers (if you add the following line you should comment + % out the \CodelineIndex) +% \PageIndex + + % Produce a 2 column index (if ever) + \setcounter{IndexColumns}{2} + + % To produce a change history: add the following line for one run, + % then run makeindex -s gglo.ist -o confproc.gls confproc.glo + % and re-process, with or without this line (faster without) + \RecordChanges + +\begin{document} + \DocInput{confproc.dtx} +\end{document} +%</driver> +% \fi +% +%^^A ================================================================= +%^^A We continue with the `normal' .dtx-file +%^^A ================================================================= +% \changes{0.1c}{2007/07/30}{Docu: new} +% +% \changes{0.2d}{2007/08/18}{Index: removing from index all commands not related to the 'confproc' package} +%^^A ================================================================= +%^^A Even with enabled crossrefs do not index all macros. +%^^A ================================================================= +% \DoNotIndex{\@empty} +% \DoNotIndex{\@ifundefined} +% \DoNotIndex{\@maketitle} +% \DoNotIndex{\@ne} +% \DoNotIndex{\@plus} +% \DoNotIndex{\@tempboxa, \@tempcnta, \@tempdima} +% \DoNotIndex{\\, \", \{, \}, \&, \ , \', \`, \^, \:, \~} +% \DoNotIndex{\@authorlistbyfirstname} +% \DoNotIndex{\@authorlistbysurname} +% \DoNotIndex{\@authors} +% \DoNotIndex{\@idxitem} +% \DoNotIndex{\@mparswitchfalse} +% \DoNotIndex{\@mparswitchtrue} +% \DoNotIndex{\@twosidefalse } +% \DoNotIndex{\@twosidetrue} +% \DoNotIndex{\@ptsize} +% \DoNotIndex{\@restonecolfalse} +% \DoNotIndex{\@restonecoltrue} +% \DoNotIndex{\@twosidefalse} +% \DoNotIndex{\@twosidetrue} +% \DoNotIndex{\addcontentsline} +% \DoNotIndex{\addtocontents} +% \DoNotIndex{\addtolength, \AtEndDocument, \advance} +% \DoNotIndex{\afterassignment} +% \DoNotIndex{\begin, \begingroup, \bf, \bfseries, \box} +% \DoNotIndex{\baselineskip} +% \DoNotIndex{\bigskip} +% \DoNotIndex{\caption, \centerline, \ClassError, \ClassWarning, \ClassWarningNoLine} +% \DoNotIndex{\ClassInfo, \CurrentOption, \cdot, \count, \centering, \cleardoublepage, \clearpage, \CodelineIndex} +% \DoNotIndex{\conf@FinalVersion, \conf@BibMerge, \conf@BibBackRef} +% \DoNotIndex{\conf@procWithColors, \conf@procWithoutColors} +% \DoNotIndex{\conf@PrintNoLayout, \conf@PrintAllLayouts} +% \DoNotIndex{\conf@NoFancyHeaders, \conf@FancyHeadersOnPapers, \conf@FancyHeadersExceptPapers} +% \DoNotIndex{\conf@TwoColumnIndex, \conf@ThreeColumnIndex} +% \DoNotIndex{\conf@TwoColumnBib, \conf@OneColumnBib} +% \DoNotIndex{\conf@TwoColumnTOC, \conf@OneColumnTOC} +% \DoNotIndex{\conf@TocNumberingLeft, \conf@TocNumberingRight} +% \DoNotIndex{\conf@TestPageNumbering, \conf@WithCleardoublepage, \conf@WithClearsinglepage} +% \DoNotIndex{\conf@procWithDebug} +% \DoNotIndex{\conf@IncludePDFs, \conf@DoNotIncludePDFs} +% \DoNotIndex{\DeclareRobustCommand, \def, \DeclareOption, \dimen, \divide, \documentclass} +% \DoNotIndex{\em, \else, \end, \ExecuteOptions, \endgroup, \expandafter} +% \DoNotIndex{\fontfamily, \fontseries, \fontsize, \footnoterule, \footnotesize, \frontmatter} +% \DoNotIndex{\fboxrule, \fboxsep \framebox, \fi, \filedate, \fileversion} +% \DoNotIndex{\gdef, \global, \GenericWarning} +% \DoNotIndex{\href, \hfill, \hfil, \hskip, \hspace, \hbox, \hss, \hb@xt@, \headheight, \headsep, \hoffset, \hspace} +% \DoNotIndex{\i, \it, \item, \IfFileExists, \InputIfFileExists, \ifx, \if} +% \DoNotIndex{\kern} +% \DoNotIndex{\label, \LARGE, \Large, \large, \let, \lineskip, \LoadClass} +% \DoNotIndex{\line, \linethickness} +% \DoNotIndex{\mainmatter, \mbox, \MessageBreak, \makebox} +% \DoNotIndex{\multiput, \m@ne} +% \DoNotIndex{\n, \newcommand, \newlength, \null, \noexpand, \newbox, \newif, \next@tpage, \noindent} +% \DoNotIndex{\o, \oddsidemargin} +% \DoNotIndex{\par, \PackageError, \PackageWarningNoLine, \put, \PageIndex} +% \DoNotIndex{\PassOptionsToClass, \ProcessOptions, \providecommand, \protect, \parbox, \p@} +% \DoNotIndex{\r, \relax, \renewcommand, \rule, \RequirePackage, \RecordChanges} +% \DoNotIndex{\selectfont, \setcounter, \setlength, \small, \setbox, \space, \stop, \scriptsize} +% \DoNotIndex{\today, \texttt, \typeout, \thinlines, \the, \textwidth, \thispagestyle, \topmargin, \topskip} +% \DoNotIndex{\u, \usepackage, \undefined, \underline, \unitlength, \unkern} +% \DoNotIndex{\vfil, \vskip, \vbox, \vss, \vspace, \vfill} +% \DoNotIndex{\voffset} +% \DoNotIndex{\wd} +% \DoNotIndex{\x, \xbf} +% \DoNotIndex{\z@} +% +%^^A ================================================================= +%^^A Some definitions to enhance the logical mark-up of this +%^^A documentation +%^^A ================================================================= +% ^^A for environments (`\cmd' for commands is already defined in +% ^^A \package{ltxdoc.cls}) +% \DeclareRobustCommand*{\env}[1]{\texttt{#1}} +% ^^A for packages, styles, classes +% \DeclareRobustCommand*{\package}[1]{\texttt{#1}} +% ^^A for eMails, urls +% \DeclareRobustCommand*{\url}[1]{|#1|} +% ^^A for files, paths and command-lines +% \DeclareRobustCommand*{\file}[1]{\texttt{#1}} +% ^^A for persons +% \DeclareRobustCommand*{\person}[1]{\textsf{#1}} +% ^^A for counters +% \DeclareRobustCommand*{\Lcount}[1]{\textsl{\small#1}} +% ^^A for length registers +% \DeclareRobustCommand*{\Llength}[1]{\cmd{#1}} +% ^^A for package options +% \DeclareRobustCommand*{\Lopt}[1]{\textsf{#1}} +% \DeclareRobustCommand*{\smiley}{|:-)|} +% \DeclareRobustCommand*{\winkey}{|;-)|} +% \DeclareRobustCommand*{\koma}{\textsf{K\kern.05em O\kern.05em% +% M\kern.05em A\kern.1em-\kern.1em Script}} +% \DeclareRobustCommand*{\tds}{TDS} +% \DeclareRobustCommand*{\ctan}{\textsc{ctan}} +% \DeclareRobustCommand*{\mail}[2]{\person{#1} +% \url{\textless #2\textgreater}} +% \DeclareRobustCommand*{\ie}{{\em i.e.}} +% \DeclareRobustCommand*{\eg}{{\em e.g.}} +% +%^^A ================================================================= +%^^A If there is a multicol.sty present, we'll print the table of +%^^A contents with 2 columns +%^^A ================================================================= +% \newif\ifmulticols +% \IfFileExists{multicol.sty}{\multicolstrue}{\multicolsfalse} +% +%^^A ================================================================= +%^^A After this the commands \filedate and \fileversion are defined +%^^A ================================================================= +% \GetFileInfo{confproc} +% +%^^A ================================================================= +%^^A Title definition +%^^A ================================================================= +% \title{The \package{\filename}~package\thanks{This file version number is \fileversion~ last revision on \filedate; doc is dated \docdate.}} +% \author{Vincent +% \changes{0.1g}{2007/08/07}{Typo in my email} +% Verfaille\thanks{\url{vincent@music.mcgill.ca}}} +% \date{Printed on \today} +% \maketitle +% +% \changes{0.1c}{2007/07/30}{Document created} +%^^A ================================================================= +%^^A A small abstract +%^^A ================================================================= +% \begin{abstract} +% The \package{\filename} package is a new \LaTeXe\ document-class for conference proceedings. It derives form LaTeX scripts written for the DAFx-06 conference proceedings, mainly based on the \package{pdfpages} package for including the proceedings papers and the \package{hyperref} package for creating proper table of contents, bookmarks and general bibliography back-references. It also uses many other packages for fine tuning of table of contents, bibliography and index of authors. The added value of this class resides in its time-saving aspects when designing conference proceedings. See \file{readme.txt} for a short overview and additional (legal) information, and \file{example.tex} and corresponding files and scripts for an example of use. +% \end{abstract} +% +% {\parskip 0pt ^^A We have to reset \parskip (bug in \LaTeX, +% ^^A see doc.dtx) +% \setcounter{tocdepth}{2} +% \tableofcontents +% } +% +% \changes{0.1c}{2007/07/30}{Introduction: new} +% \changes{0.2e}{2007/09/01}{Introduction: reorganized} +% \changes{0.2e}{2007/09/01}{Introduction: history shortened} +% \changes{0.3}{2007/09/28}{Docu: typo and spell checks} +%^^A ================================================================= +%^^A Short description of what is done by the package +%^^A Miscellaneous comments +%^^A ================================================================= +% \section{Introduction} +% \label{sec:intro} +% +%^^A ================================================================= +% \subsection{Short history} +% +%^^A ================================================================= +%^^A \subsubsection{The origins} +% +% When editing the proceedings of the 9th International Conference on Digital Audio Effects\footnote{DAFx-06: \href{http://www.dafx.ca/dafx06_proceedings.html}{\sf http://www.dafx.ca/dafx06\_proceedings.html}} (DAFx-06, Montr\'eal, Qc, Canada), I developed a set of \LaTeX{} commands in order to produce the best quality proceedings we could achieve thanks to \LaTeX{}. The solution developed was partially documented on the DAFx-06 website \cite{Verfaille:2006:howto:web} and in a technical report \cite{Verfaille:2006:howto:confproc}. +% +% Later on, I created a shorter example version on which other proceedings editors could build up their proceedings. It was used for the 5th International Linux Audio Conference\footnote{LAC2007: \href{http://www.kgw.tu-berlin.de/~lac2007/proceedings.shtml}{\sf http://www.kgw.tu-berlin.de/$\sim$lac2007/proceedings.shtml}} (March 2007, Berlin, Germany; edited by \person{Marije Baalman}); for the 13th International Conference on Auditory Display\footnote{ICAD-07: \href{http://www.music.mcgill.ca/icad2007/proceedings.php}{\sf http://www.music.mcgill.ca/icad2007/proceedings.php}} (June 2007, Montreal, Qc, Canada; edited by \person{Gary Scavone}); for the Journal on Multimodal User Interfaces\footnote{JMUI: \href{http://www.jmui.org/index.php/JMUI/issue/view/1/showToc}{\sf http://www.jmui.org/index.php/JMUI/issue/view/1/showToc}} (Vol. 1(1), 2007; edited by \person{Christian Frisson}); and for the 10th International Conference on Digital Audio Effects\footnote{DAFx-07: \href{http://dafx.labri.fr/}{\sf http://dafx.labri.fr/}} (September 2007, Bordeaux, France; edited by \person{Sylvain Marchand}). +% +%^^A ================================================================= +%^^A \subsubsection{A class? A package!} +% +% To better share this example with other users of the \LaTeXe\ community, I converted this set of \LaTeXe\ commands into a document class using the information provided in \cite{LaTeX:class:writers}, and then into a package producing all necessary files (the class, the documentation, the example, the scripts, etc.) using {\sf Docstrip} \cite{mittelbach:1999:docstrip} together with the documentation by \person{Scott Pakin} \cite{Pakin:2004:howto:package}. +% +%^^A ================================================================= +%^^A \subsubsection{Bases} +% +% The provided \package{confproc} class is based on several great packages, among which \package{pdfpages} \cite{Matthias:2004:pdfpages} by \person{Andreas Matthias} (the most useful package for proceedings making) together with \package{hyperref} \cite{hyperref} by \person{Sebastian Rahtz} and \person{Heiko Oberdiek} (to manage with all PDF and hyperlinks issues). So, you may consider it as a time saving package to faster produce your conference proceedings. +% +% +% \changes{0.2e}{2007/09/01}{Finish to re-test and document the pros/cons of other packages} +%^^A ================================================================= +%^^A The rivalry ;-) +%^^A ================================================================= +% \subsection{Other packages or softwares} +% \label{subsec:other} +% +% I tried several alternative solutions, before deciding to create my own package. There are so many talented people out there developing great \LaTeX\ packages that I would have preferred to use anybody else's solution! Unfortunately, I have not been able to make any of them work in the way I needed. ^^A I would not say that they are no other `alive' other packages doing the same, since there are! +% +%^^A ================================================================= +% \subsubsection{Using Acrobat} +% +% Eventhough it is nothing related to a \LaTeX{} package, nor a free application, the Acrobat Professional software \cite{Adobe:2007:Acrobat} is a solution to create proceedings with proper internal links for a set of PDF papers with internal links. Some useful explanations will help to understand al that has to be done \cite{Brazil:2002}. Indeed, you have to do all the links for the table of contents, the index of authors and the general bibliography by hand. This sounds like hours of work! Would you really plan to do that, and potentially having to re-do it all when discovering any small error, as it happens during both the editing and the printing processes? Any \LaTeX{} solution would provide automatization of proceedings building. +% +% +%^^A ================================================================= +% \subsubsection{The \package{combine} package} +% +% The one I would have loved to be able to use is the \package{combine} package by \person{Peter Wilson} \cite{Wilson:2004:combine}, as it was especially designed for the purpose of combining articles into proceedings. It would have been perfect if it did not have incompatibilities with our \package{dafx06.sty} proceedings template (or conference style), since many commands are added in the header file. I encountered problems with the \package{hyperref} package as well as some minor problems with \package{fancyhdr.sty}: eventually, no paper was inserted in the proceedings, and the \LaTeX\ run would always fail (stopped without any notice during the first paper inclusion). Very frustrating, as it was too late for changing our conference proceedings style to make them compatible with \package{combine}. I contacted \person{Peter Wilson}, to which I am indebt for all the precious advices he gave me, among which was the use of a concurrent solution, \ie{} the \package{pdfpages} package! ^^A Many of his comments were motivations for finding my own way in the world of proceedings. +% +%^^A ================================================================= +% \subsubsection{The \package{pdfpages} package} +% +% As no magic solution do exist (yet?), the \package{pdfpages} package by \person{Andreas Matthias} \cite{Matthias:2004:pdfpages} is a very easy way to combine several PDF documents into a single document. Unfortunately, where \package{combine} seemed to be able to preserve internal references of each paper, \package{pdfpages} does not provide such feature, as papers are included as a set of single PDF pages. As I am not a specialist of the PDF format and so on, I can imagine that it is extremely complex to achieve such a feature. Anyway, it means that if your original PDF documents had internal links, hyper-references, links to URL, etc, they will simply be all broken. +% +% With this in mind, we used this package as a basis (so it then is not a concurrent), especially for the following feature: clicking on a page in the proceedings will open the corresponding paper (with its proper internal links). Simple! +% +%^^A ================================================================= +% \subsubsection{The \package{mini.sty} package} +% +% The \package{mini.sty} package \cite{mini:eConf} does a very good job for concatenating abstracts in a single proceedings document. However, it is not suited (to my knowledge) for conference proceedings, where each paper has to be compiled with the conference style and has its very own title, authors, etc. (that cannot be inserted as (sub)sections). +% +%^^A ================================================================= +% \subsubsection{The AMS \package{editor} package} +% +% The \package{editor} package from the AMS \cite{AMS:editor} provides information and documents to produce both the front end and the back end of proceedings, which is of great help to understand all that has to be done (particularly the table of contents and the re-numbering of all papers). However, as they explicitely say it, there is no mechanism to assemble the files together. +% +% +% \changes{0.2a}{2007/08/12}{Docu: added the description from the report} +%^^A ================================================================= +%^^A Description +%^^A ================================================================= +% \subsection{Description of the solution provided} +% +% Using all the knowledge I could find around (and in the previously cited documentations about how to do a good PDF document for the proceedings), together with many tricks I found, this \LaTeX{} class provides the following features: +% \begin{enumerate} +% \item automatically generates the whole proceedings, after changing any of its paper information (thanks to \LaTeX!); +% \item concatenates papers by inserting several individual documents into one document (with \package{pdfpages}); +% \item provides `clickable' links (hyper-references) from the table of contents, the index of authors and the full bibliography to access to the corresponding page(s) (with \package{hyperref}); +% \item provides access to individual papers: a click on any paper's page opens the corresponding PDF paper (that still has its internal links); this feature comes with \package{pdfpages}. +% \item left-numbers the table of contents (using \package{titlesec}); +% \item displays the index of authors with two or three columns (hack derived from \package{twocolindex}, and using \package{multicolumn}); +% \item organizes the bookmarks by proceedings' sections: the preamble, the table of contents, the days/sessions, the full bibliography, and the index of authors. Also, authors' names appear under their relative paper title. +% \item organizes the table of contents: only the index of authors appearing in the table of contents (using \package{tocbibind}); +% \item provides full bibliography, or at least help and informations for you to build one, with right-flushed back-reference page numbers. +% \item enables fast \LaTeX\ run, using the \Lopt{draft} option of \package{pdfpages}. Useful when repetitively correcting errors, changing the layout (index, bookmarks, table of contents), merging bibliographies, etc. +% \item orders the packages. As \package{hyperref} redefines most of LaTeX internal commands, a lot of care has to be taken when ordering the insertion of packages, otherwise some of the features can disappear. +% \item gives information about the merging process involved to generate a general bibliography, as well as about production issues. +% \end{enumerate} +% +% +% \changes{0.2e}{2007/09/01}{Pros and cons reorganized} +%^^A ================================================================= +%^^A Pros and cons +%^^A ================================================================= +% \subsection{The pros and cons} +% \label{subsec:prosandcons} +% +% There are numerous advantages with the \package{\filename} class, as it: +% \begin{itemize} +% \item provides an all-in-one package (with various useful scripts); +% \item saves time: you can directly re-use the tricks I found; +% \item provides several commands and options to customize your document; +% \item correctly inserts the \package{hyperref} package as the last one, so that it can properly redefine all internal macros as it does. +% \end{itemize} +% There are also disadvantages, among which: +% \begin{itemize} +% \item the order of package insertion is fixed, and you may not change it. Otherwise, by adding packages after the class insertion, you may break the \LaTeX{} commands redefined by \package{hyperref}. This package has to be inserted last, but will not be anymore after you add packages in your document. This is the main limitation I can think of, and would appreciate any feedback, comments, tricks, that would help to resolve this issue. +% \item not everything is transparent to the user (or look into the class code); +% \item customization is limited to the class designer's defined commands; +% \item creates DAFx-like proceedings: if you liked it, great; otherwise, well, you will need to work more to change what you do not like; +% \item the \package{\filename} package is young: its functionalities were only used 4 times (in its previous form of \LaTeX{} commands). I however used it to recompile the DAFx-06 proceedings, in order to check compability, and it was able to re-generate the exactly same document! +% \end{itemize} +% +% +%^^A ================================================================= +%^^A Left empty and commented out until version 1.0 is reached +%^^A ================================================================= +% ^^A \subsection{What's new} +% ^^A \label{subsec:new} +% +% \changes{0.1c}{2007/07/30}{Todo: created} +%^^A ================================================================= +%^^A What have to be done? +%^^A ================================================================= +% \subsection{To do / bugs} +% \label{subsec:todo} +% +% At this time this package offers all the features the original scripts did, and even more. So, as far as I am concerned, it is `complete' as is. You may however consider debugging/adding the following functionalities for you own use: +% \begin{itemize} +%^^A \item replace all \verb+\def+ by \verb+\newcommand+ +% \item fix the flush-right problem for back-references in the bibliography; +% \item have the pdf link pointing to the top of the page of the index/bibliography, and not to a particular position in the text; +% \item provide a mechanism to set the argument of \verb+\pdfbookmark[0]{Program}{contents}+, that customizes the table of contents bookmark entry (does not work yet); +% \item use the \package{keyval} package to properly manage options like \verb+<option>=<value>+; +% \item provide a way to allow for package inclusion in the proceedings that are placed {\bf before} the \package{hyperref} package. I tried including the \package{hyperref} package using the \cmd{\AtBeginDocument} command, but was not successful yet. +% ^^A Try again with \cmd{\PassOptionToPackage[]{}} for packages that are already loaded.... +% ^^A \item debug \cmd{\clearsinglepage} and \cmd{\cleardoublepage} +% \item handle programs with parallel sessions (table of contents); +% \item fix bugs, misspellings, etc. +% \end{itemize} +% +%^^A ================================================================= +%^^A I'm sorry, but there are known bugs +%^^A ================================================================= +%^^A \subsection{Known Bugs} +%^^A \label{subsec:bugs} +% +%^^A At this time, there is only one know bug: +%^^A \begin{itemize} +%^^A \item +%^^A \end{itemize} +%^^A If you have a solution to fix a bug or if you find a new one I'd +%^^A be glad to hear\footnote{mail to +% ^^A \mail{Vincent Verfaille}{vincent@music.mcgill.ca}} from you! +% +% \changes{0.1d}{2007/07/31}{Thanks: to be changed} +%^^A ================================================================= +%^^A Thanks +%^^A ================================================================= +% \subsection{Thanks} +% \label{subsec:thanks} +% +% Thanks go to \person{Philippe Depalle} for offering me to be the DAFx-06 proceedings editor, to \person{Julien Boissinot} for saying ``Why don't you make a class?'', and to \person{Gary Scavone}, \person{Sylvain Marchand}, \person{Marije Baalman}, \person{Christian Kl\"under} and \person{Christian Frisson} for being the guinea-pigs of the previously existing scripts. +% +% +% \changes{0.1c}{2007/07/30}{Installation: new} +% \changes{0.2e}{2007/09/01}{Installation: updated section, with subsubsections and Unix script for lazy people} +%^^A ================================================================= +%^^A Installation guide +%^^A ================================================================= +% \section{Installation} +% \label{subsec:install} +% +%^^A ================================================================= +% \subsection{Steps summary} +% +% After checking that you have all required packages (see sec. \ref{subsec:need}), do the following: +% \begin{enumerate} +% \item generate the documentation: `\file{latex \filename.dtx}'; +% \item generate the \file{\filename.cls} file: `\file{latex \filename.ins}'; +% \item finish the documentation: `\file{latex \filename.dtx}' (two times); +% \item optionally: move \file{\filename.cls}, \file{\filename.pdf} and \file{example.tex} and all the other example-related generated files; +% \end{enumerate} +% this is explained with more details in sec. \ref{sec:install:steps}. +% +% \changes{0.1c}{2007/07/30}{Docu: changing installation steps} +% \changes{0.2e}{2007/09/01}{Layouts: moved to the example} +% \changes{0.2e}{2007/09/01}{Required packages documented} +%^^A ================================================================= +%^^A What is required? +%^^A What is recommended? +%^^A What is supported? +%^^A ================================================================= +% \subsection{What do you need} +% \label{subsec:need} +% +% There are some packages that are required with the use of \package{\filename}, while others are simply recommended: +% \begin{enumerate} +% \item Packages, that are essentially required by \package{\filename}: +% \begin{enumerate} +% \item \LaTeXe\ (at least the 1994/12/01~release)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/base}{macros/latex/base}\\ +% \package{\filename} is a \LaTeXe\ document-class. +%^^A \item \color{red}\package{graphicx} +%^^A (at least 1996/08/05 v1.0a) \\ +%^^A \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/required/graphics/graphicx.dtx}{macros/latex/required/graphics/graphicx.dtx} \\ +%^^A The logos are included by using the \cmd{\includegraphics}~command provided by \package{graphicx}. \color{black} +% \item \package{pdfpages} +% (at least 2006/08/12 v0.4a)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.dtx}{macros/latex/contrib/pdfpages/pdfpages.dtx}\\ +% For including the articles of the proceedings as PDF documents. +% \item \package{hyperref} +% (at least 2007/02/07 v6.75r)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.dtx}{macros/latex/contrib/hyperref/hyperref.dtx}\\ +% For creating hyper-references in the PDF file. +% \item \package{hypcap} +% (at least 2006/02/20 v1.5)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.dtx}{macros/latex/contrib/oberdiek/hypcap.dtx}\\ +% To provide proper hyperref anchors to table and figure captions. +% \item \package{color} +% (at least 2005/11/14 v1.0j)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/required/graphics/color.dtx}{macros/latex/required/graphics/color.dtx}\\ +% This package is used at least by \package{hyperref} to provide color links. +% \item \package{fancyhdr} +% (at least 2005/03/22 v3.2)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/fancyhdr.sty}{macros/latex/contrib/fancyhdr/fancyhdr.sty}\\ +% Used to change the headers and footers for all pages of the proceedings, so that they can match the paper template style, if any. +% \item \package{index} +% (at least 2004/01/20 v4.2beta)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/index/index.dtx}{macros/latex/contrib/index/index.dtx}\\ +% Used to produce the index of authors. +% \item \package{tocbibind} +% (at least 2003/03/13 v1.5g)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/tocbibind/tocbibind.dtx}{macros/latex/contrib/tocbibind/tocbibind.dtx}\\ +% For changing the \cmd{\indexname} command and disabling automatic insertion of index in the table of contents. +% \item \package{titletoc} +% (at least 2005/01/22 v1.5)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/titlesec/titletoc.sty}{macros/latex/contrib/titlesec/titletoc.sty}\\ +% For changing the table of contents layout. +% \item \package{multitoc} +% (at least 1999/06/08 v2.01)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/ms/multitoc.dtx}{macros/latex/contrib/ms/multitoc.dtx}\\ +% Used to provide a two column table of contents. +% \item \package{multicol} +% (at least 2006/05/18 v1.6g)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/required/tools/multicol.dtx}{macros/latex/required/tools/multicol.dtx}\\ +% Used to provide multi-column index of authors. +% \item \package{newapa} +% (at least 1991/06/13 v2.0)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/biblio/bibtex/contrib/newapa/}{biblio/bibtex/contrib/newapa/}\\ +% For the general bibliography style (note that it is slightly modified after insertion). +% \item \package{newapave} +% (at least 2006/07/31 v2.1)\\ +% Included in the \package{\filename} package.\\ +% For the general bibliography style, if you like the one developed for DAFx-06 (year at the end, before back-references that are right-flushed). +% \item \package{sectsty} +% (at least 2002/02/25 v2.0.2)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/sectsty/sectsty.dtx}{macros/latex/contrib/sectsty/sectsty.dtx}\\ +% Used for its \cmd{\chapterfont} command to give the same headers/footers to the table of contents. +% \end{enumerate} +% +% \item Non-exhaustive list of packages that are being successfully used with \package{\filename} in the provided example: +% \begin{enumerate} +% \item \package{setspace} +% (at least 2000/12/01 6.7)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/setspace/setspace.sty}{macros/latex/contrib/setspace/setspace.sty}\\ +% For changing the line spacing of welcome letters. +% \item \package{inputenc} +% (at least 2006/05/05 v1.1b)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/base/inputenc.dtx}{macros/latex/base/inputenc.dtx}\\ +% For changing the input encoding, for instance to run \LaTeX{} on a document with accents (for the authors' names and the paper titles). +% \item \package{fontenc} +% (at least 2005/09/27 v1.99g)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/unpacked/fontenc.sty}{macros/latex/unpacked/fontenc.sty}\\ +% For changing the font encoding. +% \item \package{times} +% (at least 2005/04/12)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/fonts/psfonts/corelpak/times/psnfss/times.sty}{fonts/psfonts/corelpak/times/psnfss/times.sty}\\ +% For changing the default \LaTeX{} font to `Times', as it displays better in PDF files. +%^^A \item \package{amsmath} +%^^A (at least 2000/07/18 v2.13)\\ +%^^A \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/required/amslatex/math/amsmath.dtx}{macros/latex/required/amslatex/math/amsmath.dtx}\\ +%^^A For AMS math, as you may have some math displayed even in the preamble or postamble of the proceedings. +%^^A \item \package{amssymb} +%^^A (at least 2002/01/22 v2.2d)\\ +%^^A \ctan: \href{http://www.ctan.org/tex-archive/fonts/amsfonts/doc/latex/amssymb.dtx}{fonts/amsfonts/doc/latex/amssymb.dtx}\\ +%^^A For AMS symbols (same reason). +% \item \package{layout} +% (at least 2000/09/25 v1.2c)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/required/tools/layout.dtx}{macros/latex/required/tools/layout.dtx}\\ +% For fine tuning you document header and footer so that they match those of the the paper templates. +% \item \package{layouts} +% (at least 2004/10/25 v2.6c)\\ +% \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/layouts/layouts.dtx}{macros/latex/contrib/layouts/layouts.dtx}\\ +% For checking the fine tuning of the table of contents layout, in which case the \package{layouts} package is for you. However, if the table of contents layout is printed too early, it will not properly display its layout... +% \end{enumerate} +% +% ^^A \item Packages, that are supported by +% ^^A \package{\filename}: +% ^^A \begin{enumerate} +% ^^A \item +% ^^A \end{enumerate} +% \end{enumerate} +% +% Under normal circumstances you don't have to install so many of these packages (except \package{\filename} of course: its installation process is described in the next section), since most of them should be part of your \LaTeX{} distribution. If this is not the case you'll find the most recent versions at \ctan\footnote{Comprehensive \TeX{} Archive Network: \href{http://www.ctan.org/}{\sf http://www.ctan.org/}}. +% +% +%^^A ================================================================= +% \subsection{Installation steps}\label{sec:install:steps} +% +% The provided \package{\filename.dtx} file is an `one-file-contains-it-all': it contains the \file{.cls} class file, its \file{.pdf} documentation, %a customizable driver for the documentation, +% the \file{.ins} batch file, a complete example, and a `read me'. +% To install the package: +% \begin{enumerate} +% \item run \file{\filename.dtx} through \LaTeX. This will generate the batch file (\file{\filename.ins}) and a \file{readme.txt}. Additionally the documentation (\file{\filename.pdf}) is generated (to get the cross-references right, you have to rerun this twice, however). +% \item run the newly generated \file{\filename.ins} through \LaTeX{} to do the actual installation. This will generate the \file{\filename.cls}~class file, the example file (\file{example.tex}) as well as other example-related files (\file{exsessions.tex}, \file{expapersswitch.tex}, \file{exbiblio.bib} and \file{exprogram.csv}) and scripts (Perl: \file{procswitchandtoc.pl}; Unix: \file{buildcls}, \file{cleancls}, , \file{buildproc}, \file{buildpapers} and \file{buildcppdfpapers}), the documentation driver (\file{\filename.drv}) and a sample configuration file (\file{\filename.cfg}). +%^^A Normally, if you set \cmd{\BaseDirectory}\footnote{see the documentation of the \file{docstrip}~program: \cite{mittelbach:1999:docstrip}} in your \file{docstrip.cfg}, the document-class \file{\filename.cls} is immediately moved to an appropriate location (e.g.\ `\file{\$(TEXMF)/tex/latex/misc/}' with a \tds\footnote{\TeX\ Directory Structure, see \cite{twgtds:1999:tds}} compliant \LaTeX\ installation). Otherwise you have to move it yourself into a directory searched by \LaTeX.\\ +%^^A Normally (with a \tds\ installation) all configuration +%^^A (\file{.cfg}) files are collected in +%^^A `\file{\$(TEXMF)/tex/latex/config/}'. Since there may be already +%^^A an older `\file{\filename.cfg}' that perhaps mustn't be +%^^A overwritten, you have to move (and merge) the file yourself. +% +% \item to finish the installation it is recommended to move the documentation (\file{\filename.pdf}) and the example-related files to where you collect the documentations (with a \tds\ compliant \LaTeX\ installation this would be `\file{\$(TEXMF)/doc/tex/latex/\filename}' for example). +% +% \item for a demonstration of the possibilities of \package{\filename} see the \file{example.tex} file and run it through \LaTeX . For a more complete demonstration, use the \file{buildproc} Unix script (see sec. \ref{sec:scripts:buildproc}), that will make for you all the necessary steps to provide the final version of the example proceedings. +% \end{enumerate} +% +% The `\file{latex \filename.dtx}'-run above will---by +% default---generate the `user' documentation. If you need the +% full documentation (with complete listing of the documented +% source code and/or command index and the change history) you may +% edit \file{\filename.drv} to meet your needs (never edit +% \file{\filename.dtx} itself!). For more information on the +% enhanced documentation see \file{\filename.drv} or +% \file{readme.txt}. +% +% \changes{0.2f}{2007/09/05}{Scripts: Unix `buildcls' script added} +% \changes{0.2g}{2007/09/07}{Scripts: Unix `buildcls' script shorten} +% \changes{0.2g}{2007/09/07}{Scripts: Unix `buildcls' script with chmod on the Perl script, + example of use of the script} +% \changes{0.2h}{2007/09/12}{Scripts: Unix `buildcls' script moves example files in `example/'} +% \changes{0.2i}{2007/09/24}{Scripts: Unix `buildcls' script moves the index style `confproc.ist' in `example/'} +%^^A ================================================================= +% \subsection{Unix script to make the class} +% +% You may consider using this Unix script (after setting the path to \LaTeXe\ binaries) in order to generate the class and the documentation, and to prepare the example-related files. It uses \file{bash}: +% \begin{macrocode} +%<*buildcls> +#!/bin/sh +% \end{macrocode} +% First, you may set the path to \LaTeXe\ binaries: +% \begin{macrocode} +#-- set path to LaTeX binaries +LaPath="/usr/texbin/" #- TexLive 2007 +#LaPath="/usr/local/teTeX/bin/i386-apple-darwin-current/" #- teTeX +% \end{macrocode} +% and then, only if necessary, change the names to the \LaTeX{} compilers: +% \begin{macrocode} +#-- set names of LaTeX and related compilers +Latex=$LaPath"pdflatex" +Index=$LaPath"makeindex" +% \end{macrocode} +% as well as the document and example target names: +% \begin{macrocode} +Target="confproc" #- set document's name +extarget="example" #- se tthe example folder name +% \end{macrocode} +% We can start building the documentation and the \file{.ins} file: +% \begin{macrocode} +#-- build doc, class and example files +$Latex $Target.dtx #- build doc. and .ins file +$Latex $Target.ins #- build class and example files +% \end{macrocode} +% We then create the example folder: +% \begin{macrocode} +#-- prepare scripts for building example +mkdir $extarget #- create the folder +% \end{macrocode} +% and move the example-related files and scripts: +% \begin{macrocode} +mv ex*.* $extarget/ #move all example files into it +mv buildproc.tex $extarget/buildproc # move scripts into it +mv buildcppdfpapers.tex $extarget/buildcppdfpapers +mv buildpapers.tex $extarget/buildpapers +mv procswitchandtoc.pl $extarget/ +% \end{macrocode} +% We also copy the class, the index style, the bibliography style, and the example related folders: +% \begin{macrocode} +cp -r pictures $extarget/ #- copy pictures into it +cp -r papers $extarget/ #- copy papers into it +cp confproc.cls $extarget/ #- copy the class into it +cp confproc.ist $extarget/ #- copy the index style into it +cp newapave.* $extarget/ #- copy the newapave bib style files +% \end{macrocode} +% We then change the permission of the example-related scripts: +% \begin{macrocode} +cd $extarget +chmod +x buildproc +chmod +x procswitchandtoc.pl +% \end{macrocode} +% and move the \file{expages.tex} generated file to the right place: +% \begin{macrocode} +mv expages.tex papers/ +cd .. +% \end{macrocode} +% Once it is done, we can finish the documentation. this full sequence is only necessary if you generate the implementation, index and changes history: +% \begin{macrocode} +#-- finish to build the documentation +$Latex $Target.dtx #- re-run doc for toc update +$Latex $Target.dtx #- re-run doc for proper back-references +$Index -s gind.ist $Target #- with \CodelineIndex of \PageIndex +$Index -s gglo.ist -o $Target.gls $Target.glo #- with \RecordChanges +$Latex $Target.dtx #- insert index & list of changes, re-number +$Latex $Target.dtx #- last run with proper page numbers +% \end{macrocode} +% Since there are 2 scripts, one to install (this one) and one to clean up all the mess (mainly used by me during building tests), we also prepare the latter: +% \begin{macrocode} +#-- prepare scripts for cleaning package +mv cleancls.tex cleancls +chmod +x cleancls +% \end{macrocode} +% By uncommenting the last line, you will also build the example! +% \begin{macrocode} +#-- build example +cd $extarget +#./buildproc +%</buildcls> +% \end{macrocode} +% This script is generated by the first \LaTeX\ run on \package{confproc.dtx}. You then have to change its permission in the \verb+bash+ shell to make it executable:\begin{verbatim} +%chmod +x buildcls +%\end{verbatim} +% Then, you can run it from the \verb+bash+ shell:\begin{verbatim} +%./buildcls +%\end{verbatim} +% +% +% \changes{0.2f}{2007/09/05}{Scripts: Unix `cleancls' script added} +% \changes{0.2g}{2007/09/07}{Scripts: Unix `cleancls' script shorten} +%^^A ================================================================= +% \subsection{Unix script to clean up the class' folder} +% +% Here is another Unix script for cleaning up the folder where the class was generated: +% \begin{macrocode} +%<*cleancls> +#!/bin/sh +mkdir backup #--- move the files to be kept +mv confproc.dtx backup/ +mv buildcls backup/ +cp cleancls backup/ +mv pd1enc.def backup/ +rm *.* #--- clean up! +mv backup/confproc.dtx . #--- move the backed up files +mv backup/buildcls . +mv backup/cleancls . +mv backup/pd1enc.def . +rm -r backup #--- remove the temporary backup folder +%</cleancls> +% \end{macrocode} +% You may want to use it to re-generate the whole package from the \file{.dtx} file. +% Note that this script too is generated by the first \LaTeX\ run on the \package{confproc.dtx} file. +% +% +% +%^^A ================================================================= +%^^A How to use confproc +%^^A ================================================================= +% \section{Using the \package{\filename} package} +% \label{sec:usage} +% +%^^A ================================================================= +%^^A Loading +%^^A ================================================================= +% \subsection{Loading} +% \label{subsec:load} +% +% The class is loaded with:\begin{verbatim} +%\documentclass{confproc} +%\end{verbatim} +% You can modify the behavior of \package{\filename} with options +% (all available options are described below in subsection +% \ref{subsec:options}):\begin{verbatim} +%\documentclass[<options>]{confproc} +%\end{verbatim} +% +% +% \changes{0.1c}{2007/07/30}{Options: new} +% \changes{0.2f}{2007/09/05}{Options: adding DescribeMacro for all} +% \changes{0.2g}{2007/09/07}{Cmds: adding DescribeMacro for all} +% \changes{0.2g}{2007/09/07}{Options: re-organizing section} +%^^A ================================================================= +%^^A Available Options +%^^A ================================================================= +% \subsection{Options} +% \label{subsec:options} +% +% There are two types of options: some are specific to the \package{\filename} class (sometimes also passed to other packages), others are simply passed to the \package{book} class, the \package{hyperref} or \package{pdfpages} packages. +% \changes{0.2b}{2007/08/16}{Options: adding default} +% \changes{0.2e}{2007/09/01}{Options: finished the alphabetical list of all options} +% \changes{0.3}{2007/09/26}{Options: moved the alphabetical list of all options} +% A summary of all options is given in Tab.~\ref{tab:options:all:1} and \ref{tab:options:all:2}. +%^^A \color{red} {\sc find a way to get a 2-pages table, \eg{} using the \package{longtable.sty}} file \color{black} +% +% +% \changes{0.2b}{2007/08/16}{Options: description added for \package{\filename} options} +%^^A ================================================================= +% \subsubsection{Options specific to \package{\filename}}\label{sec:options:confproc} +% +% \subsubsection*{Compilation step} +% +% The option \DescribeMacro{compil}\Lopt{compil} with one of its 3 possible values is the most important option to set, as it changes the page numbering and the speed of the \LaTeX\ run, once the other options dealing with the layout suit you. Depending if you are working on the conference program definition, on merging the bibliographic items, or on producing the final document, you will use one of the three following options: +% \begin{itemize} +% \item \DescribeMacro{compil=bibmerge}\Lopt{compil=bibmerge}: this first option is to be used if you are generating a general bibliography for the proceedings. It will then only insert the first and last page of each paper, plus a page with all citations from the current paper (thus creating back-references from the bibliography, as for the \Lopt{compil=bibbackref} option, except that page numbers are not the final ones). This means that page numbering of PDF papers is incorrect, but the \LaTeX\ run is faster. +% \item \DescribeMacro{compil=bibbackref}\Lopt{compil=bibbackref}: this option is for all but last \LaTeX{} runs, once you finished the bibliography merging process. It generates proper back-references from the bibliography by replacing the last page of the paper by an inclusion of citations to the paper it cites. It also generates proper page numbering for the table of contents and the index of authors. This requires several \LaTeX{} runs, as you can see in the corresponding Unix script in sec.~\ref{sec:scripts:buildproc}. You will then need a final compilation with the \Lopt{compil=last} option. If you need to check page numbering of the articles, then use the \Lopt{final} option too, to force inserting the PDF instead of a blank page, together with the \Lopt{movepagenumber} option if your articles have page numbers. +% \item \DescribeMacro{compil=last}\Lopt{compil=last}: this is for the last \LaTeX{} run. It means that you previously defined you r program (paper ordering), generated the general bibliography (and merged common items), re-compiled all papers if necessary (in order to re-number them all, and have them using the new bibliography), and compiled the document enough times with the \Lopt{compil=bibbackref} option, so as to have proper page numbering and back-references in the table of contents, the index of authors and the general bibliography (see sec.~\ref{sec:confproc:compil} and \ref{sec:confproc:compil:script}). +% \end{itemize} +% +% As the \LaTeX\ run may be long when only making a small change, you may want to speed up the process by using the \Lopt{draft} \DescribeMacro{draft} option from the \package{pdfpages} package (see sec. \ref{sec:options:pdfpages}). This is useful for instance when making layout changes, editing the welcome letters, or working on generating proper page numbering. This will replace each PDF page by an almost blank page. The other possible option is \DescribeMacro{final} \Lopt{final}. Note that it is configured by default depending on the \Lopt{compil} option you used, but can be modified anyway. +% +% Also, the \DescribeMacro{verbose}\Lopt{verbose} or \DescribeMacro{debug}\Lopt{debug} option adds some debug comments in the \LaTeX{} console, both from \package{\filename} and \package{hyperref} packages, that might help to track problems if any. It can be used at any compilation step, of course! +% +% +% \subsubsection*{Proceedings type} +% +% Depending wether the proceedings are to be printed or distributed as a PDF electronic document, you may prefer to have color links or not\footnote{Remember that color is expensive to be printed, and when printed in a grey scale, it may reduce the readibility of the linking text.}. All the hyperlink features work properly by default, so the only option you have to set is: +% \begin{itemize} +% \item \DescribeMacro{printed}\Lopt{printed} for a version with black links (identical to the \Lopt{colorlinks=false} option of the \package{pdfpages} package, see sec. \ref{sec:options:pdfpages}); +% \item \DescribeMacro{electronic}\Lopt{electronic} for a version with user-defined colors for links (identical to the default \Lopt{colorlinks=true} option of the \package{pdfpages} package, see sec.~\ref{sec:options:pdfpages}). +% \end{itemize} +% +% \subsubsection*{Proceedings layout} +% +% \changes{0.2e}{2007/09/01}{Layouts: moved to the example} +% The next options deal with the layout customization for the table of contents, the index of authors and the general bibliography: +% \begin{itemize} +% \item \DescribeMacro{onecoltoc}\Lopt{onecoltoc}: prints the table of contents with one column (default); +% \item \DescribeMacro{twocoltoc}\Lopt{twocoltoc}: prints the table of contents with two columns; +% \item \DescribeMacro{tocnumleft}\Lopt{tocnumleft}: prints page numbers on the left of table of contents (default), as chosen for DAFx-06 as it seems to provides faster click access to the papers. +% \item \DescribeMacro{tocnumright}\Lopt{tocnumright}: prints page numbers on the right of table of contents; +% \item \DescribeMacro{onecolbib}\Lopt{onecolbib}: prints the general bibliography with 1 column; +% \item \DescribeMacro{twocolbib}\Lopt{twocolbib}: prints the general bibliography with 2 columns (default); +% \item \DescribeMacro{threecolindex}\Lopt{threecolindex}: prints the index of authors with 3 columns (default); +% \item \DescribeMacro{twocolindex}\Lopt{twocolindex}: prints the index of authors with 2 columns. +% \end{itemize} +% +% \subsubsection*{Headers}\label{sec:headers} +% +% The next four settings for the \Lopt{headers} option should be used as exclusive settings, as they define to which pages a header and footer should be added: +% \begin{itemize} +% \item \DescribeMacro{headers=no}\Lopt{headers=no} (default): no headers added to any pages; +% \item \DescribeMacro{headers=pdfonly}\Lopt{headers=pdfonly}: headers only added to PDF-included files; +% \item \DescribeMacro{headers=exceptpdf}\Lopt{headers=exceptpdf}: headers added to all pages except PDF-included files; +% \item \DescribeMacro{headers=allpages}\Lopt{headers=allpages}: headers for all pages. +% \end{itemize} +% For instance, if your paper templates do not have any template (simplest solution as you do not have to renumber all papers nor to tweak the $x$ and $y$ shift for PDF insertion), you may use the \Lopt{headers=allpages}. Conversely, if your paper template have a header and footer defined, you may use the \Lopt{headers=exceptpdf}. In the case you want proceedings without header/footer (you may want to add them in Acrobat with other fancy fonts and layout), use the \Lopt{headers=no} option. Finally, if (for a strange reason I did not figure out yet) you want to insert header/footer on the PDF inserted papers only, use the \Lopt{headers=pdfonly}. +% +% In the case you are using paper templates with page numbers, you may want to check that the page numbering of the papers is ok. You can do so using the \DescribeMacro{movepagenumbers}\Lopt{movepagenumbers} option, that moves the footer by a few millimeters down, combined with the \Lopt{headers=allpages} or \Lopt{headers=pdfonly}. You will see two footers appearing: the one from the paper, and below the one from the proceedings. +% +% Depending wether your document is \Lopt{oneside} or \Lopt{twoside}, you may want to force it to always clear single or double page. Do this using the following options: +% \begin{itemize} +% \item \DescribeMacro{cleardoublepage} \Lopt{cleardoublepage} (default); +% \item \DescribeMacro{clearsinglepage} \Lopt{clearsinglepage}. +% \end{itemize} +% You may want to force it to always: +% \begin{itemize} +% \item clear double page after each paper in 1-side mode using \DescribeMacro{cleardoublepage} \Lopt{cleardoublepage} (used with \Lopt{oneside}); +% \item not clear double page after each paper in 2-side mode using \DescribeMacro{clearsinglepage} \Lopt{clearsinglepage} (used with \Lopt{twoside}). +% \end{itemize} +% +% \changes{0.2b}{2007/08/16}{Options: added descriptions for \package{book} options} +%^^A ================================================================= +% \subsubsection{Options from the \package{book} package}\label{sec:options:book} +% +% The following options are passed to the \package{book} class: +% \begin{itemize} +% \item \DescribeMacro{a4paper}\Lopt{a4paper}: for the European A4 paper (also passed to \package{hyperref}); +% \item \DescribeMacro{letterpaper}\Lopt{letterpaper}: for the North American letter paper (also passed to \package{hyperref}); +% \item \DescribeMacro{10pt,11pt,12pt}\Lopt{10pt}, \Lopt{11pt} and \Lopt{12pt} for the font size; +% \item \DescribeMacro{twoside}\Lopt{twoside} for two-sided documents (chapters only start on odd \& right pages). Note that by default, this option will add a blank page to all inserted papers with an odd number of pages, so that they all start on a right page. This does not save paper, but provides proceedings that are much easier to navigate. +% \item \DescribeMacro{oneside}\Lopt{oneside} for one-sided documents (chapters may start on any page). +% \end{itemize} +% +% +% \begin{table}[htbp] +% \centering +% \begin{tabular}{lcp{1.8cm}p{6cm}}\hline +% Option & Default & Package(s) & Values/Function\\ \hline +% \Lopt{10pt} & $\surd$ & \package{book}, \package{confproc} & 10 pt is normal font size\\ +% \Lopt{11pt} & --- & \package{book}, \package{confproc} & 11 pt is normal font size\\ +% \Lopt{12pt} & --- & \package{book}, \package{confproc} & 12 pt is normal font size\\ +% \Lopt{backref} & $\surd$ & \package{hyperref} & add reference page number and link for each bibliographic item in the general bibliography \\ +% \Lopt{breaklinks} & $\surd$ & \package{hyperref} & allows links to break over lines by making links over multiple lines into PDF links to the same target (great for table of contents and bibliography in two columns)\\ +% \Lopt{citecolor=colorforcite} & green & \package{hyperref} & use the user-defined \Lopt{colorforcite} color for links to bibliography items cited \\ +% \Lopt{colorlinks=false} & --- & \package{hyperref} & links without colors. Equivalent to \Lopt{printed}\\ +% \Lopt{colorlinks} & --- & \package{hyperref} & links with colors. Equivalent to \Lopt{colorlinks=true} and \Lopt{electronic}\\ +% \Lopt{colorlinks=true} & $\surd$ & \package{hyperref} & links with colors. Equivalent to \Lopt{colorlinks} and \Lopt{electronic}\\ +% \Lopt{compil} & \Lopt{bibbackref} & \package{confproc} & \Lopt{last}: for the final compilation\\ +% & & & \Lopt{bibmerge}: faster compilation for working on the general bibliography \\ +% & & & \Lopt{bibbackref}: preparing back-references for the final compilation \\ +% \Lopt{debug} & --- & \package{hyperref}, \package{\filename} & adds debug info when running \LaTeX{}. Same as \Lopt{verbose} \\ +% \Lopt{draft} & --- & \package{pdfpages} & does not include PDF papers \\ +% \Lopt{electronic} & $\surd$ & \package{confproc} & links with colors. Identical to \Lopt{colorlinks=true} from \package{pdfpages} \\ +% \Lopt{final} & $\surd$ & \package{pdfpages} & includes all PDF papers (slow) \\ +% \Lopt{headers} & no & \package{confproc} & \Lopt{no}: no headers added to any pages\\ +% & --- & & \Lopt{pdfonly}: headers only added to papers included as PDFs\\ +% & --- & & \Lopt{exceptpdf}: headers added to all pages except to papers included as PDFs (default)\\ +% & --- & & \Lopt{headers=allpages}: headers for all pages, PDFs included\\ +% \Lopt{hyperindex} & $\surd$ & \package{hyperref} & text of index entries are hyperlinks, to link authors form the index to their various papers\\ \hline +% \end{tabular} +% \caption{{\it Alphabetical list of all options 1/2}} +% \label{tab:options:all:1} +% \end{table} +% +% \begin{table}[htbp] +% \centering +% \begin{tabular}{lcp{1.8cm}p{6cm}}\hline +% Option & Default & Package(s) & Values/Function\\ \hline +% \Lopt{linkcolor=colorforlink} & red & \package{hyperref} & use the user-defined \Lopt{colorforlink} color for links, such as from the index of authors, table of contents and general bibliography back-references\\ +% \Lopt{linktocpage} & $\surd$ & \package{hyperref} & link provided by page number instead of text\\ +% \Lopt{movepagenumbers} & --- & \package{confproc} & move page numbers down by a few millimeters \\ +% \Lopt{onecoltoc} & $\surd$ & \package{confproc} & one column table of contents \\ +% \Lopt{oneside} & --- & \package{book}, \package{confproc} & for one-sided documents (new chapters start on odd \& right pages) \\ +% \Lopt{pdfpagelabels} & $\surd$ & \package{hyperref} & set PDF page labels: compulsory for creating any link to page!\\ +% \Lopt{pdfstartview=XYZ} & $\surd$ & \package{hyperref} & open the PDF file in Acrobat with zoom=100\% instead of full screen\\ +% \Lopt{pdftex} & $\surd$ & \package{hyperref} & set up \package{hyperref} for use with the pdftex program \\ +% \Lopt{plainpages=false} & $\surd$ & \package{hyperref} & forces page anchors to be named by the arabic form of the page number, rather than the formatted form\\ +% \Lopt{printed} & --- & \package{confproc} & links without color. Identical to \Lopt{colorlinks=false} from \package{pdfpages} \\ +% \Lopt{raiselinks} & $\surd$ & \package{hyperref} & forces \cmd{\special} commands to reflect the real height of the link (which could contain a graphic)\\ +% \Lopt{tocnumleft} & $\surd$ & \package{confproc} & left page numbering table of contents \\ +% \Lopt{tocnumright} & --- & \package{confproc} & right page numbering table of contents \\ +% \Lopt{threecolindex} & --- & \package{confproc} & three columns index of authors \\ +% \Lopt{twocolindex} & --- & \package{confproc} & two columns index of authors \\ +% \Lopt{twocoltoc} & --- & \package{confproc} & two columns table of contents \\ +% \Lopt{urlcolor=colorforurl} & cyan & \package{hyperref} & use the user-defined \Lopt{colorforurl} color for URL (general bibliography, publishing information)\\ +% \Lopt{verbose} & --- & \package{hyperref}, \package{\filename} & adds debug info when running \LaTeX{}. Same as \Lopt{debug} \\ +% \Lopt{a4paper} & --- & \package{hyperref}, \package{confproc} & European A4 paper\\ +% \Lopt{letterpaper} & $\surd$ & \package{hyperref}, \package{confproc} & North American letter paper\\ +% \Lopt{twoside} & $\surd$ & \package{book}, \package{confproc} & two-sided documents (new chapters do not start on odd \& right pages)\\ \hline +% \end{tabular} +% \caption{{\it Alphabetical list of all options 2/2}} +% \label{tab:options:all:2} +% \end{table} +% +% +% +% \changes{0.2b}{2007/08/16}{Options: added descriptions for \package{hyperref} options} +%^^A ================================================================= +% \subsubsection{Options from the \package{hyperref} package}\label{sec:options:hyperref} +% +% As the \package{\filename} package is based on the \package{hyperref} package for all PDF and links aspects, there are many options you can change: +% \begin{itemize} +% \item \DescribeMacro{colorlinks=true}\DescribeMacro{colorlinks}\Lopt{colorlinks=true} or \Lopt{colorlinks} provides color links in the table of contents, index of authors and general bibliography to the corresponding pages in the proceedings. This option has the same effect as the \Lopt{electronic} option from the \package{\filename} package. +% \item \DescribeMacro{colorlinks=false}\Lopt{colorlinks=false} provides links without color, which is particularly helpful for printed proceedings (where using color increases the cost of printing, or reduces the quality if printed in black and white). This option has the same effect as the \Lopt{printed} option from the \package{\filename} package. +% \item \DescribeMacro{citecolor=colorforcite}\Lopt{citecolor=colorforcite} uses the color \Lopt{colorforcite} (to be defined by the used) for links to bibliography items cited; +% \item \DescribeMacro{linkcolor=colorforlink}\Lopt{linkcolor=colorforlink} uses the color \Lopt{colorforlink} for links, such as from the index of authors, table of contents and general bibliography back-references; +% \item \DescribeMacro{urlcolor=colorforurl}\Lopt{urlcolor=colorforurl} uses the color \Lopt{colorforurl} for URL, mainly in the general bibliography but also in the publishing information, for example; +% \item \DescribeMacro{verbose,debug}\Lopt{verbose} and \Lopt{debug} prints more information from the \package{hyperref} package; +% \item \DescribeMacro{a4paper,letterpaper}\Lopt{a4paper} or \Lopt{letterpaper} are options passed to \package{hyperref}; +% \item \DescribeMacro{bookmarksopen} \Lopt{bookmarksopen=true}/\Lopt{false}: opens/closes the bookmark in the PDF file; +% \item \DescribeMacro{bookmarksopenlevel} \Lopt{bookmarksopenlevel=1}/\Lopt{0}/\Lopt{2}: the bookmark is open at level 1 (resp. 0, 2). +% \end{itemize} +% +% There are also several options that are given by default to the \package{hyperref} package, and that you should not change except you exactly know what you are doing and why. Indeed, they change specific properties of hyperlinks (such as back-references) that you may which to preserve for you electronic version of the proceedings (please refer to the \package{hyperref} documentation \cite{hyperref} for more complete, accurate and up-to-date descriptions): +% \begin{itemize} +% \item \DescribeMacro{pdftex}\Lopt{pdftex}: to set up \package{hyperref} for use with the pdftex program. +% \item \DescribeMacro{raiselinks}\Lopt{raiselinks}: in the hypertex driver, the height of links is normally calculated by the driver as simply the base line of contained text; this options forces \cmd{\special} commands to reflect the real height of the link (which could contain a graphic). +% \item \DescribeMacro{hyperindex}\Lopt{hyperindex}: makes the text of index entries into hyperlinks. It is used for the index of authors, to link back to their various papers. +% \item \DescribeMacro{backref}\Lopt{backref}: allows for back-references in the general bibliography. +% \item \DescribeMacro{pagebackref}\Lopt{pagebackref}: adds `backlink' text to the end of each item in the bibliography, as a list of page numbers (this can only work properly if there is a blank line after each \cmd{\bibitem}). +% \item \DescribeMacro{plainpages=false}\Lopt{plainpages=false}: forces page anchors to be named by the arabic form of the page number, rather than the formatted form. This is useful as the proceedings is using the \package{book} class, and therefore has a front matter (publishing information, welcome letters, table of contents, etc) before the papers. +% \item \DescribeMacro{pdfpagelabels}\Lopt{pdfpagelabels}: sets PDF page labels, to be able to link to them. +% \item \DescribeMacro{breaklinks}\Lopt{breaklinks}: allows links to break over lines by making links over multiple lines into PDF links to the same target. This is particularly useful for 2-columns table of contents with the option \Lopt{linktocpage=false} (not the default); and for long URLs in the general bibliography. +% \item \DescribeMacro{linktocpage}\Lopt{linktocpage}: makes page number (instead of text) to be the link to table of contents (as well as list of figures and list of tables, but they are not often used for proceedings). +% \item \DescribeMacro{pdfstartview=XYZ}\Lopt{pdfstartview=XYZ}: opens the PDF in Acrobat with zoom=100\% instead of full screen; especially useful if working with a big screen (\eg{} 30 inches). +% \end{itemize} +% {\bf Important remark}: unknown options used with the \package{\filename} package are passed to the \package{hyperref} package. That way, you can change any of the options existing in the \package{hyperref} documentation; a good thing for fine tuning your document, but at your own risks if you do not read the corresponding documentation. ^^A I hope that all the options already defined in the \package{\filename} package will be sufficient so that you do not have to use other ones. +% +% +%^^A ================================================================= +% \subsubsection{Options from the \package{pdfpages} package}\label{sec:options:pdfpages} +% +% The \package{\filename} package is also based on the \package{pdfpages} package for paper inclusion. There are then two options you may use, that are passed to the \package{pdfpages} package: +% \begin{itemize} +% \item \DescribeMacro{final}\Lopt{final}: inserts the PDF pages, resulting in a slow \LaTeX{} run. When working on the layout and on the bibliography merging process, you may want to see all included papers. +% \item \DescribeMacro{draft}\Lopt{draft}: does not insert the PDF pages, resulting in a fast \LaTeX{} run. % When working on generating the table of contents and index of authors, you may not need to see PDF documents, but rather those metadata. +% +% \end{itemize} +% This pair of option \Lopt{final/draft} is {\bf not} exclusive. Therefore, if using the two, it always is \Lopt{final} that will `win'. For instance, using:\begin{verbatim} +%\documentclass[final,draft]{confproc} +%\end{verbatim} +% you would expect the last option to be the one used by the package. In fact, it will rather use:\begin{verbatim} +%\documentclass[final]{pdfpages} +%\end{verbatim} +% and the papers will all be included, with slower \LaTeX{} compilation. So, if you wish to use the \Lopt{draft} option, be sure not to leave any\Lopt{final} anywhere else! +% +% \changes{0.2b}{2007/08/16}{Options: adding default} +% \changes{0.2e}{2007/09/01}{Layouts: removed layout} +%^^A ================================================================= +% \subsubsection{Options by default}\label{sec:options:default} +% +% By default, the set of options used (if not defined by the user) is: \\ +% \Lopt{letterpaper}, \Lopt{10pt}, \Lopt{twoside}, \Lopt{twosidepapers}, \Lopt{compil=bibbackref}, \Lopt{tocnumleft}, \Lopt{threecolindex}, \Lopt{onecoltoc}, \Lopt{colorlinks=true}, \Lopt{linkcolor=red}, \Lopt{citecolor=blue}, \Lopt{pagecolor=red}, \Lopt{urlcolor=blue}, \Lopt{bookmarksopen=true}, \Lopt{bookmarksopenlevel=1}, \Lopt{headers=no}. +% +% +% +% +% +% \changes{0.1c}{2007/07/30}{Commands: created} +% \changes{0.2g}{2007/09/07}{Cmds: re-organizing/merging sections about customization} +%^^A ================================================================= +%^^A Description of the provided commands +%^^A ================================================================= +% \subsection{Commands and customization} +% \label{subsec:commands}\label{sec:custom} +% +% Here is a non-exhaustive list of what you may customize in the proceedings: +% \begin{itemize} +% \item the proceedings PDF metadata (see sec. \ref{sec:custom:metadata}); +% \item the titles for special section (see sec. \ref{sec:custom:special:section:titles}); +% \item the front page (see sec. \ref{sec:custom:front:page}); +% \item the document layout (see sec. \ref{sec:custom:layout:doc}); +% \item the document header/footer (see sec. \ref{sec:custom:header:footer}); +% \item the publishing information; +% \item the welcome letter(s); +% \item the title/author style in the table of contents and bookmarks (see sec. \ref{sec:custom:title:author}); +% \item the color for links (see sec. \ref{sec:custom:colors}); +% \item and of course how many columns for the table of contents (1 or 2), bibliography (1 or 2) and index of authors (2 or 3) using options (see sec. \ref{sec:options:confproc}). +% \end{itemize} +% All this is implemented in the provided example; it is now re-documented just in case you would start a document from scratch. +% +%^^A ================================================================= +% \subsubsection{PDF metadata}\label{sec:custom:metadata} +% +% The PDF metadata are information you will get in the operating system about the electronic version of you proceedings. There are at least three metadata you should consider setting, which are given together with their default values: +% \begin{itemize} +% \item PDF title (default: `Proceedings title').\\ +% Use the \DescribeMacro{\procpdftitle}\cmd{\procpdftitle} command to change it:\begin{verbatim} +%\renewcommand{\procpdftitle}{DAFx-06 Proceedings} +%\end{verbatim} +% \item PDF author (default: `Proceedings author/editor').\\ +% Use the \DescribeMacro{\procpdfauthor}\cmd{\procpdfauthor} command to change it:\begin{verbatim} +%\renewcommand{\procpdfauthor}{Vincent Verfaille, McGill University} +%\end{verbatim} +% \item PDF description/subject (default: `Proceedings description').\\ +% Use the \DescribeMacro{\procpdfsubject}\cmd{\procpdfsubject} command to change it:\begin{verbatim} +%\renewcommand{\procpdfsubject}{Proc. of the 9th Int. Conf. on% +% Digital Audio Effects - Montreal, Quebec, Canada} +%\end{verbatim} +% \end{itemize} +% Those commands are used in the \DescribeMacro{\hypersetup}\cmd{\hypersetup} command; you may also redefine all the setup items by redefining \cmd{\hypersetup} in your own document's preamble. +% +%^^A ================================================================= +% \subsubsection{Special section titles}\label{sec:custom:special:section:titles} +% +% The titles of the following special sections can be redefined too: +% \begin{itemize} +% \item table of contents (default: `Conference Program').\\ +% Use the \DescribeMacro{\contentsname}\cmd{\contentsname} command to change it:\begin{verbatim} +%\renewcommand{\contentsname}{\vspace*{-0.8cm}\Large % +% \bfseries Conference Program} +%\end{verbatim} +% The use of a negative vertical space is a dirty trick to shift up the whole of table of contents. +% \item general bibliography (default: `Full Bibliography').\\ +% Use the \DescribeMacro{\procbibname}\cmd{\procbibname} command to change it:\begin{verbatim} +%\renewcommand{\procbibname}{\large \bfseries General Bibliography} +%\end{verbatim} +% \item index of authors (default: Index of Authors').\\ +% Use the \DescribeMacro{\procindexname}\cmd{\procindexname} command to change it:\begin{verbatim} +%\renewcommand{\procindexname}{\large \bfseries List of Authors} +%\end{verbatim} +% \end{itemize} +% +% +%^^A ================================================================= +% \subsubsection{Front page}\label{sec:custom:front:page} +% +% If you wish to design the front page in the same \LaTeX\ document as the proceedings, you may use the usual \cmd{\maketitle} command as follows:\begin{verbatim} +%\author{Bob, Department of blah blah blah} +%\title{Proceedings of the blah blah blah} +%\date{\today} +%\maketitle +%\end{verbatim} +% You may also use the commands \cmd{\procpdfauthor} \cmd{\procpdftitle} if their value is the same as for the PDF metadata: +%\begin{verbatim} +%\author{\procpdfauthor} +%\title{\procpdftitle} +%\end{verbatim} +% It is then your turn to do fine tuning of all the parameters of this page so that it looks as you wish (potentialy with logos, images, etc). +% +% In the DAFx-06 proceedings, we chose instead to insert the front page as a PDF document. Indeed, we found it easier to design our very own cover (using Xe\TeX), and you could consider using other tools that \LaTeX. For that reason, we used the following command instead:\begin{verbatim} +%\includepdf[noautoscale,pages=1,link]{\PICTPATH ex_1stpage.pdf} +%\end{verbatim} +% Note that this PDF file is not generated by the package, but it is provided in the \file{.zip} archive of the package. +% +% +%^^A ================================================================= +% \subsubsection{Document layout}\label{sec:custom:layout:doc} +% +%^^A ================================================================= +% \paragraph{Letter format} +% We used the following for tuning page attributes:\begin{verbatim} +%\oddsidemargin -4.95truemm +%\evensidemargin -4.95truemm +%\topmargin 0truept +%\headheight 12truept +%\footskip 0truept +%\textheight 229truemm +%\textwidth 175truemm +%\voffset -28truept +%\headsep 20truept +%\end{verbatim} +% so that the proceedings layout can perfectly match the one of individual papers. This means that you have to check for those values in your template. Then, you may set the left/right and up/down shifts of the inserted PDFs files using:\begin{verbatim} +%\setlength{\LaTeXxShift}{0pt} +%\setlength{\LaTeXyShift}{-28pt} +%\setlength{\WordxShift}{10pt} +%\setlength{\WordyShift}{-40pt} +%\end{verbatim} +% The values may differ depending if the papers were generated using a \LaTeX\ template and a Word template, in the case your templates are not perfectly identical (which is often the case). The default values provided by the class are those used for the DAFx-06 proceedings, and were tested for both letter and A4 format. +% +%^^A ================================================================= +% \paragraph{A4 format} +% +% We used the following for fine tuning page attributes:\begin{verbatim} +%\oddsidemargin -4.95truemm +%\evensidemargin -10.95truemm +%\topmargin 0truept +%\headheight 12truept +%\footskip 0truept +%\textheight 229truemm +%\textwidth 175truemm +%\voffset -28truept +%\headsep 20truept +%\end{verbatim} +% Then, set the left/right and up/down shifts of the inserted PDFs files using:\begin{verbatim} +%\setlength{\LaTeXxShift}{8.45pt} +%\setlength{\LaTeXyShift}{-3pt} +%\setlength{\WordxShift}{10pt} +%\setlength{\WordyShift}{-40pt} +%\end{verbatim} +% +%^^A ================================================================= +% \subsubsection{Header and footer}\label{sec:custom:header:footer} +% +% As the paper templates often have a header and footer, you may want to use the same headers/footers for the proceedings (using the \Lopt{headers} option, see sec.~\ref{sec:headers}). This is costumized by redefining the \DescribeMacro{\proclhead}\cmd{\proclhead} command for the header:\begin{verbatim} +%\renewcommand{\proclhead}{\em{\small{Proc.~of the 9\textsuperscript{th} % +%Int.~Conference on Digital Audio Effects (DAFx-06), Montreal, % +%Canada, September 18-20, 2006}}} +%\end{verbatim} +% and the \DescribeMacro{\proccfoot}\cmd{\proccfoot} for the footer:\begin{verbatim} +%\renewcommand{\proccfoot}{{\vskip 11mm}{\small DAFX-\thepage}} +%\end{verbatim} +% In order to check the page numbering when inserting papers with page numbers, you may want to move the footer (using the \Lopt{movepagenumbers} option, see sec.~\ref{sec:headers}) by a few millimeters down using the \DescribeMacro{\procoptfootskip}\cmd{\procoptfootskip} command:\begin{verbatim} +%\setlength{\procoptfootskip}{3mm} +%\end{verbatim} +% As soon as you remove the \Lopt{movepagenumbers} option, the footer comes back to its normal position. +% +% +%^^A ================================================================= +% \subsubsection{Title/author layout}\label{sec:custom:title:author} +% +% The \DescribeMacro{\texorpdfstring}\cmd{\texorpdfstring} command allows for a different text in LaTeX and for the PDF (which is good for having different bookmark titles and table of contents entries). It is then used by default to add a line break between the paper title and the authors' names in the table of contents. You can customize the title font style using the \DescribeMacro{\papertitlestyle}\cmd{\papertitlestyle} command as in:\begin{verbatim} +%\renewcommand{\papertitlestyle}{\sc} +%\end{verbatim} +% that defines the paper's title in small capitals. You can also customize the author font style using the \DescribeMacro{\paperauthorstyle}\cmd{\paperauthorstyle} command as in:\begin{verbatim} +%\renewcommand{\paperauthorstyle}{\texorpdfstring{, }{\break}} +%\end{verbatim} +% that replaces the line break (between the paper title and the list of authors in the table of contents) by a comma in the table of contents only (not in the PDF bookmark). +% +% +%^^A ================================================================= +% \subsubsection{Colors}\label{sec:custom:colors} +% +% When inserting the document class, you may have defined the colors for links with the following options:\begin{verbatim} +%\documentclass[a4paper,10pt,twoside,% +% citecolor=colorforcite,linkcolor=colorforlink,urlcolor=colorforurl,% +% pagecolor=colorforpage]{confproc} +%\end{verbatim} +% This means that you have to define the \verb+citecolor+, \verb+linkcolor+, \verb+urlcolor+ and \verb+pagecolor+ colors somewhere before starting to use them (at least in your document preamble). +% In the provided example, we used the following colors:\begin{verbatim} +%\definecolor{colorforlink}{rgb}{0,0,0.8} +%\definecolor{colorforpage}{rgb}{0,0,0.7} +%\definecolor{colorforcite}{rgb}{0,0.8,0} +%\definecolor{colorforurl}{cmyk}{1,0,0,0} +%\end{verbatim} +% There are a few things you need to know about it: +% \begin{itemize} +% \item the way colors are declared is explained in the \package{color} package. +% \item the \verb+colorforlink+ is used for all links in the table of contents and index of authors, as well as back-references. +% \item the \verb+colorforpage+ is not currently used in the example. It will only be used if you decide to point to a given page from the preamble, for instance. +% \item the \verb+colorforurl+ is useful only if you include URL(s) in you preamble, or in the general bibliography (if any). +% \item the \verb+colorforcite+ is useful only in two cases: +% \begin{itemize} +% \item without a general bibliography: if you cite any document form the preamble (not from a paper); +% \item with a general bibliography: it is only used during the merging process. After this process and when generating the final document, all citations will disappear, as the last page of the paper is properly inserted. +% \end{itemize} +% \end{itemize} +% +% +% +% +%^^A ================================================================= +%^^A \subsection{Recently fixed items} +% +%^^A List of recently fixed items: +%^^A \begin{itemize} +%^^A \item move all about layout insertion from the class to the example. Remove options to change the layout. +%^^A \item move biblio and index section style from section to part, and added the 'Day' entry as parts too. That upper-level allows for longer conferences to have their bookmarks (and table of contents) organized by day, then by session, then by paper... +%^^A \item debug bibliography back-ref, that disappeared in the last version 0.2c..... +%^^A \item allow for 1 or 2 columns bibliography, as for the table of contents and index of authors. +%^^A \item define a \Lopt{verbose} option, that gives all the output messages, \ie{} for the \package{\filename} and \hyperref{hyperref} packages (otherwise = default, give the minimum) +%^^A \item removing the \package{threecolindex.sty} file creation, and placing corresponding index re-definition in the class +%^^A \item adding 1 or 2 column table of contents layout with the adding \Lopt{onecoltoc} and \Lopt{twocoltoc} options +%^^A \item no more re-definition of \package{hyperref} options: all options specific to the \package{hyperref} package are passed to it as unknown options of \package{\filename} +%^^A \item adding the \cmd{\procbibintro} command to customize the biblio introduction +%^^A \item add a \cmd{\procoptfootskip} length, and declare second footer as a vertical shift of the normal footer %\verb+\vskip{\procoptfootskip}\proccfoot}+ +%^^A \item rename commands with the same beginning \cmd{\proc<name>} +%^^A \item macro for the names of bibliography \cmd{\procbibname}, toc \cmd{\proctocname}, index \cmd{\procindexname} +%^^A \item for the \verb+\LaTeXxShift+ command, replace it by a length +%^^A \item add link colors to options +%^^A \item bad author link from the bookmarks: was linking to page 2 instead of page 1 of current paper +%^^A \end{itemize} +% +% +% \changes{0.1c}{2007/07/30}{Example: new} +% \changes{0.2i}{2007/09/21}{Example: move all extra info from the source code to the example, costumization} +%^^A ================================================================= +%^^A A good example (used afterwards to check if still working for DAFx-06) +%^^A ================================================================= +% \section{Full Example} +% \label{sec:example} +% +% Here is a working example file. it was tested by re-generating the DAFx-06 proceedings, almost one year after the conference. The resulting PDFs were almost identical (there are improvements for bookmarks managements), but this solution is much easier to use and read. To generate it, run \file{\filename.ins} through \LaTeX . Better, run the \verb+bash+ script called \file{buildproc} (see sec. \ref{sec:scripts:buildproc}): it will run all the steps for you. +% +% \changes{0.2h}{2007/09/12}{Example: adding class switch and generation of corresponding files} +%^^A ================================================================= +% \subsection{Class option switch!} +% \label{sec:ex:input:class} +% +% As the \LaTeX-runs of the provided example can be automatized using Unix scripts, I found it useful to switch between two set of options used when inserting the class. To do so, two files are created, and the Unix script rename then when needed, so that the example uses the proper file. +% +%^^A ================================================================= +% \subsubsection{Options set for non-final \LaTeX\ runs} +% +% The first file is used for all \LaTeX\ runs except the final one. In this example, it adds headers on all pages (\Lopt{headers=allpages}), and move the footer (\Lopt{movepagenumbers}) so that we can check page numbers. Also, the option is \Lopt{compil=bibbackref}, which creates proper back-references. +% \begin{macrocode} +%<*exclasspre> +\documentclass[a4paper,10pt,twoside,twosidepapers,% + compil=bibbackref,headers=allpages,movepagenumbers,electronic,% + citecolor=colorforcite,linkcolor=colorforlink,urlcolor=colorforurl,% + pagecolor=colorforpage]{confproc} +%</exclasspre> +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Options set for final \LaTeX\ run} +% +% The second file is only use for the final \LaTeX\ run: it then removes options such as \Lopt{movepagenumbers}, and uses headers only on the pages where it is necessary (using \Lopt{headers=exceptpdf}, as you may have finished the page numberings before generating the final version of the proceedings!). It also uses the \Lopt{compil=last} option, in order to insert the last page of each paper with proper back-references generated during the previous \LaTeX\ runs: +% \begin{macrocode} +%<*exclasslast> +\documentclass[a4paper,10pt,twoside,twosidepapers,% + compil=last,headers=exceptpdf,electronic,% + citecolor=colorforcite,linkcolor=colorforlink,urlcolor=colorforurl,% + pagecolor=colorforpage]{confproc} +%</exclasslast> +% \end{macrocode} +% +% +% +%^^A ================================================================= +% \subsection{Main file} +% \label{sec:ex:main} +% +% \begin{macrocode} +%<*example> +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Using the \package{\filename} class} +% +% The class is to be called as would have been the \package{book.cls}. +% Here is a basic example: +% \begin{macrocode} +%%\documentclass[a4paper,10pt,twoside,twosidepapers,% +%% compil=bibbackref,headers=allpages,movepagenumbers,electronic,% +%% citecolor=colorforcite,linkcolor=colorforlink,urlcolor=colorforurl,% +%% pagecolor=colorforpage]{confproc} +% \end{macrocode} +% However, as explained in the previous section, we simplified the switch between class options during all \LaTeX\ runs (in the Unix script) by using 2 files (\file{exclasspre.tex} and \file{exclasslast.tex}). The class is defined in those two files with different options set, and each one is temporary renamed as \file{exclass.tex}, and then simply inserted as: +% \changes{0.1g}{2007/08/08}{Example: adding color options} +% \begin{macrocode} +\input{exclass} +% \end{macrocode} +% +% So, the document class is \package{\filename}. The standard options \Lopt{a4paper}, \Lopt{10pt} and \Lopt{twoside} are simply passed to the book \package{class} used in background. We then provide some \package{\filename} options: \Lopt{twosidepapers} to clear double pages after papers with an odd number of pages, \Lopt{compil=bibbackref} specifying that this compilation is not the last, but one that generates proper back references for the general bibliography; \Lopt{headers=allpages} that adds a header and footer to all pages (including papers inserted); \Lopt{movepagenumbers} that moves the page numbers so that we can compare the ones of the proceeding with thoses of the inserted papers; \Lopt{electronic} to get color links, together with the four colors we use. +% +%^^A ================================================================= +% \subsubsection{Use extra packages} +% +% Then, one should define the extra packages to be used. +% +% \noindent {\bf Important note}: any package that redefines \LaTeX{} macros should be inserted before \package{hyperref}. At present, \package{\filename} does not provide any mechanism for this. Then, adding other such packages may result in bad surprises. A good temporarily solution would be to add them in the class definition itself... which is not a satisfactory solution yet. +%^^A \color{red} {\sc Should we use something like \verb+\AtBeginDocument+ to insert the hyperref package in the class definition?} \color{black} +% \changes{0.2e}{2007/09/01}{Layouts: moved to the example} +% +% At the beginning of proceedings, there often are welcome letters, which texts are not as dense as the papers themselves. Therefore, you may change the line spacing of those letters using the \package{setspace} package: +% \begin{macrocode} +\usepackage{setspace} +% \end{macrocode} +% You then may change the input and font encodings, for instance to allow for running \LaTeX{} on a document with accents (in the list of authors and paper titles): +% \changes{0.2h}{2007/09/12}{Example: using `utf8' instead of `latin' inputenc (no more pb with special accents).} +% \begin{macrocode} +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +% \end{macrocode} +% Also, you may change the default \LaTeX{} font to the Times font, as it displays better in PDF files: +% \begin{macrocode} +\usepackage{times} +% \end{macrocode} +% In the specific case of DAFx-06 proceedings, the headers had to contain a `$9\textsuperscript{th}$', that required to use the AMS packages: +% \begin{macrocode} +\usepackage{amsmath,amssymb} +% \end{macrocode} +% You may wish to finely tune your document layout, using the \package{layout} package: +% \begin{macrocode} +\usepackage{layout} +% \end{macrocode} +% Similarly, you may change the fine tuning of the table of contents layout, in which case the \package{layouts} package is for you: +% \begin{macrocode} +\usepackage{layouts} +% \end{macrocode} +% However, if the table of contents layout is printed too early, it will not properly display its layout... +% +%^^A ================================================================= +% \subsubsection{Define colors for links} +% +% \changes{0.1g}{2007/08/08}{Example: adding example of color definition for links} +% \changes{0.1g}{2007/08/08}{Example: moving color definitions} +% We now choose the colors used for the PDF links: +% \begin{macrocode} +\definecolor{colorforlink}{rgb}{0,0,0.8} +%%\definecolor{colorforpage}{rgb}{0,0,0.7} +\definecolor{colorforcite}{rgb}{0,0.8,0} +\definecolor{colorforurl}{cmyk}{1,0,0,0} +% \end{macrocode} +% +% \changes{0.1f}{2007/08/03}{Cmds: renaming \cmd{\locpdf<author|title|subject>} as \cmd{\procpdf<author|title|subject>}} +%^^A ================================================================= +% \subsubsection{Customize proceedings' commands} +% +% We then customize the text for headers and footers, and second version of footer for checking page numbering. +% \changes{0.2e}{2007/09/01}{Cmds: renaming \cmd{\loclhead} into \cmd{\proclhead}} +% \begin{macrocode} +\renewcommand{\proclhead}{\em{\small{Proc.~of the 9\textsuperscript{th} % + Int.~Conference on Digital Audio Effects (DAFx-06), Montreal, % + Canada, September 18-20, 2006}}} +\renewcommand{\proccfoot}{{\vskip 11mm}{\small DAFX-\thepage}} +\setlength{\procoptfootskip}{3mm} +% \end{macrocode} +% As \package{\filename} is to be used with pdf\LaTeX, we customize the PDF metadata: +% \begin{macrocode} +\renewcommand{\procpdfauthor}{Vincent Verfaille, McGill University} +\renewcommand{\procpdftitle}{DAFx-06 Proceedings} +\renewcommand{\procpdfsubject}{Proc. of the 9th Int. Conf. on% + Digital Audio Effects - Montreal, Quebec, Canada} +% \end{macrocode} +% Note that an alternative way to change the PDF metadata consist in using the \cmd{\hypersetup} command (see the \package{hyperref} package). +% If you wish to change the title for the general bibliography and the index, redefine: +% \begin{macrocode} +\renewcommand{\procbibname}{\large \bfseries Full Bibliography} +\renewcommand{\procindexname}{\large \bfseries Index of Authors} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Declare bibliographic files} +% +% We chose to define the name of bibliography file to be used at the beginning, providing all customization commands at the same place: +% \begin{macrocode} +\newcommand{\procbibfile}{\BIBPATH exbiblio} +% \end{macrocode} +% If you also make a general bibliography, you may use several files (see sec.~\ref{sec:general:bib}), for instance one for common bibliography items, one with the other bibliography items and another one with common strings for journals, conferences, etc. +% +%^^A ================================================================= +% \subsubsection{Declare paths to pictures, papers, texts...} +% +% We then declare paths to folders in which other files included by the \package{example.tex} file when compiled: pictures (containing logos used in your first page and welcome letters, for instance), bibliographies (containing the 3 files included as explained earlier), papers (containing both the PDFs of the papers and all related folders to allow to batch re-compile them all at once), and texts (containing publishing informations, welcome letters, the paper switch, etc.): +% \begin{macrocode} +\newcommand{\PICTPATH}{pictures/} +\newcommand{\BIBPATH}{} +\newcommand{\PAPERPATH}{papers/} +\newcommand{\TEXTPATH}{} +% \end{macrocode} +% +% \changes{0.1g}{2007/08/05}{Cmds: adding an example to change \cmd{\bibnametoc}} +% \changes{0.1g}{2007/08/05}{Cmds: adding an example to change \cmd{\indexnametoc}} +% +% +%^^A ================================================================= +% \subsubsection{Fine tune the document layout} +% +% We then provide information about the default values for fine tuning the proceedings layout in letter format, so that they look as much possible as the one of the paper template. You have to check in the paper templates which settings are used, and to change the following lines accordingly. +% \begin{macrocode} +\oddsidemargin -4.95truemm +\evensidemargin -10.95truemm +\topmargin 0truept +\headheight 12truept +\footskip 0truept +\textheight 229truemm +\textwidth 175truemm +\voffset -28truept +\headsep 20truept +% \end{macrocode} +% Then, set the left/right and up/down shift of the inserted PDFs files: +% \begin{macrocode} +\setlength{\LaTeXxShift}{8.45pt} +\setlength{\LaTeXyShift}{-3pt} +\setlength{\WordxShift}{10pt} +\setlength{\WordyShift}{-40pt} +% \end{macrocode} +% An example for the provided example in A4 format is given in sec. \ref{sec:custom:layout:doc}. +% +%^^A ================================================================= +% \subsubsection{Make the index} +% +% The last step of the preamble is to make the index: +% \begin{macrocode} +\makeindex +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Start the document: front matter} +% +% We can now start the document and its front matter by using: +% \begin{macrocode} +%%%=========== PROCEEDINGS =========== +\begin{document} +\frontmatter +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Display the document layout} +% +% To check your document layout (thanks to the \package{layout} package), uncomment: +% \begin{macrocode} +%%\layout +% \end{macrocode} +% \changes{0.2e}{2007/09/01}{Layouts: moved to the example} +% You can also specifically check the table of contents layout (thanks to the \package{layouts} package), by uncommenting: +% \begin{macrocode} +%%\begin{figure} +%% \setlayoutscale{0.8} \tocdiagram +%% \caption{Table of Contents entry parameters} \label{fig:tocp} +%%\end{figure} +%%\begin{figure} +%% \setlayoutscale{0.8} \currenttoc \tocdesign +%% \caption{Typical Table of Contents entry for this document} +%% \label{fig:thistoc} +%%\end{figure} +% \end{macrocode} +% You can either insert them at the end of the document (not changing page numbering, but you may forget them as you do not so often check the last page) or at its beginning (changing page numbering but being the first page you see when opening it). You may then go to the next right-opening page, using: +% \begin{macrocode} +%%\clearsingleordoublepage +% \end{macrocode} +% You may then ensure that the cover, first page of the proceedings, is numbered 1: +% \begin{macrocode} +\setcounter{page}{1} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Cover page} +% +% We now add a bookmark chapter in the front matter: +% \begin{macrocode} +\pdfbookmark[0]{Preamble}{preamble} +% \end{macrocode} +% That way, we ensure that all the sections in the front matter/preamble (cover page, welcome letters, etc) except the table of contents appear in a same bookmark as sub-items, thus reducing the number of lines appearing that do not deal with days, sessions, papers, etc. +% Note that we do it by hand. This is not as beautiful and general as if the class was doing it for you (which could have been done); however, not automatizing this bookmark entry allows the proceedings editor to decide if he wishes to link to the first pages or not. +% +% We then include the first page and generate its bookmark entry: +% \begin{macrocode} +\pdfbookmark[1]{Cover}{cover} +\author{Bob, Department of blah blah blah} +\title{Proceedings of the blah blah blah} +\date{\today} +\maketitle +% \end{macrocode} +% Instead of using the usual \verb+\maketitle+ command, we could also have included a PDF image of the first page using: +% \begin{macrocode} +%\includepdf[noautoscale,pages=1,link]{\PICTPATH ex_1stpage.pdf} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Publishing informations} +% +% Publishing informations are then given on page 2, inside the cover. +% \begin{macrocode} +\newpage +\vspace*{1.7cm} +\pdfbookmark[1]{Publishing informations}{publishing} +% \end{macrocode} +% As it is printed on page 2, there are no header nor footer on this page. +% \begin{macrocode} +\thispagestyle{empty} +% \end{macrocode} +% We then provide the publishing information itself: +% \begin{macrocode} +\noindent {\bf Published by:}\\ Laboratory Name\\ Department name\\ +School Name\\ University Name\\ +\url{http://www.conferencesite.com}\\ +% \end{macrocode} +% We also indicate the ISBN number: +% \begin{macrocode} +\vspace*{0.15cm}\newline +\noindent {\bf ISBN: X-XXXX-XXXXXX}\\ +% \end{macrocode} +% and the credits: +% \begin{macrocode} +\vspace*{0.35cm}\newline +\noindent {\bf Credits:}\\ +Cover design: Firstname Lastname\\ +Logo photo: Firstname Lastname\\ +\LaTeX{} editor: Firstname Lastname\\ +% \end{macrocode} +% Isn't it a good place for you to acknowledge for the time spent working on this time-saving package? Even though you do not have to include my name, the best way to share the word about the \package{\filename} package is to name it! +% \begin{macrocode} +using \LaTeX's `confproc' class (optional: by V. Verfaille)\\ +% \end{macrocode} +% You may then indicate where and when you proceedings were printed: +% \begin{macrocode} +\vspace*{0.35cm}\newline +\noindent Printed in City by Print-Company --- Month 20XX +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Welcome letters} +% +% To ensure next page is numbered and has proper headers/footers, use: +% \begin{macrocode} +\otherpagestyle +% \end{macrocode} +% Roman page numbers now start to appear. We include all welcome letters\footnote{There is only one in this example, but there could be others: from the faculty dean, the department dean, the conference chair, etc.}: +% \begin{macrocode} +%%%-- Welcome letters +\clearsingleordoublepage +\vspace*{0.6cm} +\thisotherpagestyle +% \end{macrocode} +% We create the bookmark entry by hand (so that you can remove it): +% \begin{macrocode} +\pdfbookmark[1]{Welcome from Firstname Lastname}{welcome} +% \end{macrocode} +% and the corresponding section (and table of contents entry): +% \begin{macrocode} +\section*{Welcome from Firstname Lastname, Conference Chair} +% \end{macrocode} +% Depending on the text length, you may use either 1.5 line spacing: +% \begin{macrocode} +\onehalfspace +\vspace*{1.1cm} +\begin{center} +\begin{minipage}[h]{14cm} +Text of the welcome letter, with 1.5 lines spacing, bla bla bla... +Text of the welcome letter, with 1.5 lines spacing, bla bla bla... +Text of the welcome letter, with 1.5 lines spacing, bla bla bla... +\end{minipage} +\end{center} +% \end{macrocode} +% or double line spacing (both are using the \package{setspace} style): +% \begin{macrocode} +\doublespace +\begin{center} +\begin{minipage}[h]{14cm} +Text of the welcome letter, with 2 lines spacing, bla bla bla... +Text of the welcome letter, with 2 lines spacing, bla bla bla... +Text of the welcome letter, with 2 lines spacing, bla bla bla... +\end{minipage} +\end{center} +% \end{macrocode} +% Do not forget to switch back to normal spacing after welcome letters: +% \begin{macrocode} +\singlespace +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Table of contents} +% +% Let us then insert the proceedings program, or table of contents: +% \begin{macrocode} +\proctableofcontents +% \end{macrocode} +% Note that the bookmark entry is automatically generated for the table of contents. +% +%^^A ================================================================= +% \subsubsection{Proceedings!} +% +% We then switch to the main matter and to arabic page numbering: +% \begin{macrocode} +%%%==== BEGINNING OF PAPERS ==== +\mainmatter +% \end{macrocode} +% and also change the style for entries in the table of contents: +% \begin{macrocode} +\mainmattertocstyle +% \end{macrocode} +% Then, we include the file containing the papers switch, with informations about all the papers: +% \begin{macrocode} +\input{\TEXTPATH expapersswitch} +% \end{macrocode} +% We now insert papers by days and sessions. A day is a part, a session is a chapter and a paper is a section (in the bookmark), and they are declared as follows: +% \begin{macrocode} +%%%== Day 1 +\procday{Day 1} +%%%-- session 1 +\session{Oral Session 1} +% \end{macrocode} +% Papers are simply inserted as: +% \begin{macrocode} +\paperid{01}{p_001} +\paperid{02}{p_003} +% \end{macrocode} +% Let us also insert a poster session with one paper: +% \begin{macrocode} +%%%-- session 2 +\session{Poster Session 1} +\paperid{03}{p_005} +% \end{macrocode} +% and a second oral presentations session with two more papers: +% \begin{macrocode} +%%%== Day 2 +\procday{Day 2} +%%%-- session 3 +\session{Oral Session 2} +\paperid{04}{p_007} +\paperid{05}{p_009} +% \end{macrocode} +% When we are done with the insertion of all papers, we switch to the back matter of the document (\ie{} bibliography and index of authors): +% \begin{macrocode} +%%%==== END OF PAPERS ==== +\backmatter +% \end{macrocode} +% and to its corresponding style for the entries in the table of contents: +% \begin{macrocode} +\backmattertocstyle +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{General bibliography} +% +% The general bibliography is inserted with the following style: +% \begin{macrocode} +\bibliographystyle{newapave} +% \end{macrocode} +% This style is a modification of the \file{newapa} style: the year is indicated at the end, before the back-references, instead of being between parenthesis right after the list of authors. +% In the case you do not wish to use the one developed for DAFx-06 but prefer the \package{newapa} style, you then need to replace this last line by:\begin{verbatim} +%\bibliographystyle{newapa} +%\end{verbatim} +% and to edit the class at the \file{newapave} package insertion. +% +% We now cite the \verb+{bib:intro}+ bib item (does not appear in the document) to allow for customizing the paragraph introducing the general bibliography: +% \begin{macrocode} +\nocite{bib:intro} +% \end{macrocode} +% We then automatically set the bib items to be inserted (for instance all of them, in case you are doing the bib merge process) thanks to: +% \begin{macrocode} +\setbibitems +% \end{macrocode} +% The bibliography is then inserted: +% \begin{macrocode} +{\footnotesize\bibliography{\procbibfile}} +% \end{macrocode} +% Note that the general bibliography may be very long. Changing the font size (for instance to \verb+\footnotesize+ as in the previous line) may then be a good idea. +% +%^^A ================================================================= +% \subsubsection{Index of authors} +% +% We finally insert the index: +% \begin{macrocode} +\insertindex +\end{document} +%</example> +% \end{macrocode} +% +% \changes{0.1f}{2007/08/02}{merging welcome and publishing in the example} +% +% +% +% +%^^A ================================================================= +% \subsection{Paper switch!} +% \label{sec:ex:paper:switch} +% +% Let us now take a look at the paper switch, which is central to the proceedings. +% In fact, it contains a switch to all proceedings papers, so that you can work on the +% proceedings itself without knowing yet the final order of papers! +% +%^^A ================================================================= +% \subsubsection{First way: redefining local commands} +% +% \changes{0.1d}{2007/08/01}{File: create expapersswitch.tex.} +% \changes{0.1f}{2007/08/03}{Cmds: renaming loc<Title|Author|...> as paper<title|author|...>} +%^^A ================================================================= +%^^A Here is the creation of the expapersswitch.tex file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% +% We define the \cmd{\paperid} command: +% \begin{macrocode} +%<*expapersswitch> +\newcommand{\paperid}[2]{ +% \end{macrocode} +% Inside the switch, the \cmd{\paperswitch} command is set to the paper reference: +% \begin{macrocode} +\renewcommand{\paperswitch}{#1} +% \end{macrocode} +% We then define the insertion command for the paper with ID=01: +% \begin{macrocode} +%=========== PAPER ID = 1 =========== +\ifnum\paperswitch=01 { +% \end{macrocode} +% For this first paper inclusion, we chose to use intermediary commands: +% \begin{macrocode} + \renewcommand{\papertitle}{Templates for One Author} + \renewcommand{\paperauthors}{Alfred Alabama} + \renewcommand{\paperindex}{\index{Alabama, Alfred}} + \renewcommand{\paperref}{\paperswitch} + \renewcommand{\paperpagenum}{6} + \renewcommand{\papercite}{Mitra:Kaiser:1993:DSP:handbook,% + Haykin:1991:adaptive:filter,Moorer:2000:AES:audio:millenium,% + Arfib:1998:DAFx} +% \end{macrocode} +% We use the \cmd{\procinsertpaper} command to insert papers. It has 9 arguments: +% \begin{enumerate} +% \item X and Y shifts (with a space in between, as in \verb+{10 12}+); +% \item the number of pages; +% \item the paper reference; +% \item the title; +% \item the list of authors; +% \item the index entries; +% \item the citations for the general bibliography; +% \item the name of the PDF file to insert; +% \item the bookmark entries for the authors. +% \end{enumerate} +% \begin{macrocode} + \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{\paperpagenum}% + {\paperref}{\papertitle}{\paperauthors}{\paperindex}{\papercite}% + {#2}{\pdfbookmark[2]{Alfred Alabama}{#2.author1}}} +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Second way: shorter but less readible} +% +% Even though less readible, it may be shorter not to redefine local commands, and to directly pass arguments to the \cmd{\procinsertpaper} command. This is presented in the next example, and corresponds to what is provided by the Perl script (see sec. \ref{sec:scripts:perl}) that converts the .csv data into \LaTeX{} code to insert in this current file: +% +% \begin{macrocode} +%=========== PAPER ID = 2 =========== +\ifnum\paperswitch=2 + \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{5}{\paperswitch}% + {Templates for One Author with Two Affiliations}% paper title + {Bob Boogie-Woogie}% list of authors + {\index{Boogie-Woogie, Bob}}% authors index entries + {Haykin:1991:adaptive:filter,Serra:1996:sms,% + Moorer:2000:AES:audio:millenium,Arfib:1998:DAFx}% cited bib items + {#2}{\pdfbookmark[2]{Bob Boogie-Woogie}{#2.author1}} +\fi + +%=========== PAPER ID = 3 =========== +\ifnum\paperswitch=3 + \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{4}{\paperswitch}% + {Templates for Two Authors}% + {Alfred Alabama, Chris Christmas}% + {\index{Alabama, Alfred}\index{Christmas, Chris}}% + {Serra:1996:sms,Moorer:2000:AES:audio:millenium,% + Arfib:1998:DAFx,Askenfelt:1976:automatic:transcription}% + {#2}{\pdfbookmark[2]{Alfred Alabama}{#2.author1}% + \pdfbookmark[2]{Chris Christmas}{#2.author2}} +\fi + +%=========== PAPER ID = 4 =========== +\ifnum\paperswitch=4 + \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{6}{\paperswitch}% + {Templates for Three Authors}% + {Bob Boogie-Woogie, Chris Christmas, Don Didon}% + {\index{Boogie-Woogie, Bob}\index{Christmas, Chris}% + \index{Didon, Don}}% + {Arfib:1998:DAFx,Askenfelt:1976:automatic:transcription,% + Egozy:1995:MIT:features:gesture}% + {#2}{\pdfbookmark[2]{Bob Boogie-Woogie}{#2.author1}% + \pdfbookmark[2]{Chris Christmas}{#2.author2}% + \pdfbookmark[2]{Don Didon}{#2.author3}} +\fi + +%=========== PAPER ID = 5 =========== +\ifnum\paperswitch=5 + \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{7}{\paperswitch}% + {Templates f\'or F\`o\"ur Àuthors}% + {J\o{}hn J\"oe, K\'e\~{n}t K\^{\i}ng, L\`ou L\'ou, % + M\`anfr\'ed J. M\^ost\u{e}k\i}% + {\index{J\"oe, J\o{}hn}\index{K\^{\i}ng, K\'e\~{n}t}% + \index{L\'ou, L\`ou}\index{M\^ost\u{e}k\i, M\`anfr\'ed J.}}% + {Arfib:1998:DAFx,Askenfelt:1976:automatic:transcription,% + Egozy:1995:MIT:features:gesture}% + {#2}{\pdfbookmark[2]{J\o{}hn J\"oe}{#2.author1}% + \pdfbookmark[2]{K\'e\~{n}t K\^{\i}ng}{#2.author2}% + \pdfbookmark[2]{L\`ou L\'ou}{#2.author3}% + \pdfbookmark[2]{M\`anfr\'ed J. M\^ost\u{e}k\i}{#2.author4}} +\fi +} +%</expapersswitch> +% \end{macrocode} +% +% If you do not use the \verb+pd1enc.def+ file if you want \package{hyperref} to correctly convert all accents\footnote{and there are many beautiful accents in non-english languages :-).} in the PDF file, such messages will appear at \LaTeX\ runs:\begin{verbatim} +% Package hyperref Warning: Glyph not defined in PD1 encoding, +% (hyperref) removing `\u' on input line 184. +%\end{verbatim} +% +% \changes{0.2d}{2007/08/18}{Adding the description and examples for day and session organized conferences} +% \changes{0.2d}{2007/08/18}{Adding examples of table of contents and bookmarks layouts} +% +%^^A ================================================================= +% \subsubsection{Get page numbers and recompile all papers} +% +% In the case where your papers have headers/footers, you may have to recompile them all with the proper page numbers. Before doing so, compile the proceedings enough times so that the table of contents is generated and inserted. Then, use the page number indicated for each paper to edit accordingly the \file{expages.tex} file. An example is provided here: +% +% \begin{macrocode} +%<*expages> +\newcommand{\setpagenumber}[1]{ + \newcommand{\paperswitch}{#1} + \ifnum\paperswitch=01 {\setcounter{page}{1}}\fi + \ifnum\paperswitch=02 {\setcounter{page}{7}}\fi + \ifnum\paperswitch=03 {\setcounter{page}{13}}\fi + \ifnum\paperswitch=04 {\setcounter{page}{17}}\fi + \ifnum\paperswitch=05 {\setcounter{page}{23}}\fi +} +%</expages> +% \end{macrocode} +% +% You may then recompile all papers (use the \file{buildpapers} Unix script, see sec.~\ref{sec:scripts:buildpapers}), provided that they all have the corresponding line in their preamble:\\ +% \verb+\input{../../expages.tex}\setpagenumber{01}+\\ +% where \verb+01+ is the paper reference (to be changed for each paper). Using the following:\\ +% \verb+\setcounter{page}{1}+\\ +% would of course have the equivalent effect, except that you would have to re-edit each paper after changing your program order. +% +%^^A ================================================================= +% \subsection{Generate the conference program} +% \label{sec:ex:program} +% +%^^A ================================================================= +% \subsubsection{Organize the conference program by sessions of by day?} +% +% Depending on the size of your conference, you may only have a few sessions during 2 or 3 days, or many sessions during 4 to 7 days (or even more). Then, you need to choose wether you want to organize the table of contents and the bookmarks: +% \begin{itemize} +% \item by sessions and then by related papers; or +% \item by day, then by sessions and then by papers (in the case of long conferences where the list of sessions may be too long in the PDF bookmark); +% \end{itemize} +% The mechanism used in \package{\filename} is based on section levels: days are inserted in the table of contents and bookmarks as parts, whereas sessions are inserted as chapters and papers as sections. +% +% Note that the \package{\filename} does not handle programs with parallel sessions. It is then up to you to decide in which order they may appear in the table of contents. +% +% \changes{0.2e}{2007/09/01}{Docu: all sessions/days tables redone with tabular instead of minipage (smaller and easier to read)} +%^^A ================================================================= +% \paragraph{Program organized by sessions} +% +% For a small size conference, if not using days (comment the \cmd{\procday{}} lines in the example), you will obtain the table of contents corresponding to Tab~\ref{tab:program:session}. The corresponding bookmark is depicted closed in Tab.~\ref{tab:program:session:bkmrk0}, opened at its first level in Tab.~\ref{tab:program:session:bkmrk1}, and opened at its second level in Tab.~\ref{tab:program:session:bkmrk2}. +% +% \begin{table}[htb!] +% \centering +% \framebox{ +% \begin{tabular}{ll} +% \multicolumn{2}{l}{\bf Conference Program}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Oral Session 1}}}\\ +% 1 & Templates for One Author\\ +% & {\it Alfred Alabama}\\ +% & \vspace*{-0.3cm}\\ +% 7 & Templates for One Author with Two Affiliations\\ +% & {\it Bob Boogie-Woogie}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Poster Session 1}}}\\ +% 11 & Templates for Two Authors\\ +% & {\it Alfred Alabama, Chris Christmas}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Oral Session 2}}}\\ +% 15 & Templates for Three Authors\\ +% & {\it Bob Boogie-Woogie, Chris Christmas, Don Didon}\\ +% & \vspace*{-0.3cm}\\ +% 21 & Templates f\'or F\`o\"ur \`Authors\\ +% & {\it John J\"oe, K\'e\~{n}t K\^{\i }ng, L\`ou L\'ou, M\`anfr\'ed J. M\^ost\u{e}ki} \\ +% & \vspace*{-0.1cm}\\ +% 27 & {\bf Full Bibliography}\\ +% & \vspace*{-0.1cm}\\ +% 28 & {\bf Index of Authors}\\ +% \end{tabular}} +% \caption{{\it Example of table of contents for a conference organized by sessions.}} +% \label{tab:program:session} +% \end{table} +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{l@{\,}l} \hline +% $\blacktriangleright$ & Preamble\\ +% & Program\\ +% $\blacktriangleright$ & Oral Session 1\\ +% $\blacktriangleright$ & Poster Session 1\\ +% $\blacktriangleright$ & Oral Session 2\\ +% & Full Bibliography\\ +% & Index of Authors\\ \hline +% \end{tabular}} +% \caption{{\it Closed bookmarks for a conference organized by sessions.}} +% \label{tab:program:session:bkmrk0} +% \end{table} +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{l@{\,}l@{\,}l} \hline +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Preamble} \\ +% & & Cover\\ +% & & Publishing informations\\ +% & & Welcome from Firstname Lastname\\ +% & \multicolumn{2}{@{\,}l}{Program} \\ +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Oral Session 1} \\ +% & $\blacktriangleright$ & Template for One Author\\ +% & $\blacktriangleright$ & Template for One Author with Two Affiliations\\ +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Poster Session 1} \\ +% & $\blacktriangleright$ & Template for Two Authors\\ +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Oral Session 2} \\ +% & $\blacktriangleright$ & Template for Three Authors\\ +% & $\blacktriangleright$ & Template f\'or F\`o\"ur \`Authors\\ +% & \multicolumn{2}{@{\,}l}{Full Bibliography} \\ +% & \multicolumn{2}{@{\,}l}{Index of Authors} \\ \hline +% \end{tabular}} +% \caption{{\it First-level opened bookmarks for a conference organized by sessions.}} +% \label{tab:program:session:bkmrk1} +% \end{table} +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{l@{\,}l@{\,}ll} \hline +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Preamble} \\ +% & & \multicolumn{2}{@{\,}l}{Cover}\\ +% & & \multicolumn{2}{@{\,}l}{Publishing informations}\\ +% & & \multicolumn{2}{@{\,}l}{Welcome from Firstname Lastname}\\ +% & \multicolumn{3}{@{\,}l}{Program} \\ +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Oral Session 1} \\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Template for One Author}\\ +% & & & Alfred Alabama\\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Template for One Author with Two Affiliations}\\ +% & & & Bob Boogie-Woogie\\ +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Poster Session 1} \\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Template for Two Authors}\\ +% & & & Alfred Alabama\\ +% & & & Chris Christmas\\ +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Oral Session 2} \\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Template for Three Authors}\\ +% & & & Bob Boogie-Woogie\\ +% & & & Chris Christmas\\ +% & & & Don Didon\\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Template f\'or F\`o\"ur \`Authors}\\ +% & & & John J\"oe\\ +% & & & K\'e\~{n}t K\^{\i}ng\\ +% & & & L\`ou L\'ou\\ +% & & & M\`anfred J. M\^ost\u{e}k\i\\ +% & \multicolumn{3}{@{\,}l}{Full Bibliography} \\ +% & \multicolumn{3}{@{\,}l}{Index of Authors} \\ \hline +% \end{tabular}} +% \caption{{\it Second-level opened bookmarks for a conference organized by sessions.}} +% \label{tab:program:session:bkmrk2} +% \end{table} +% +% \clearpage +% +%^^A ================================================================= +% \paragraph{Program organized by days} +% +% In the case of bigger conferences with a program organized by day, you will get the table of contents corresponding to Tab~\ref{tab:program:day}. The corresponding bookmark is depicted closed in Tab.~\ref{tab:program:day:bkmrk0}, opened at its first level in Tab.~\ref{tab:program:day:bkmrk1}, and opened at its second level Tab.~\ref{tab:program:day:bkmrk2}. +% +% \begin{table}[htb!] +% \centering +% \framebox{ +% \begin{tabular}{ll} +% \multicolumn{2}{l}{\bf Conference Program}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\bf Day 1}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Oral Session 1}}}\\ +% 1 & Templates for One Author\\ +% & {\it Alfred Alabama}\\ +% & \vspace*{-0.3cm}\\ +% 7 & Templates for One Author with Two Affiliations\\ +% & {\it Bob Boogie-Woogie}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Poster Session 1}}}\\ +% 11 & Templates for Two Authors\\ +% & {\it Alfred Alabama, Chris Christmas}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\bf Day 2}\\ +% & \vspace*{-0.1cm}\\ +% \multicolumn{2}{l}{\textbf{\textit{Oral Session 2}}}\\ +% 15 & Templates for Three Authors\\ +% & {\it Bob Boogie-Woogie, Chris Christmas, Don Didon}\\ +% & \vspace*{-0.3cm}\\ +% 21 & Templates f\'or F\`o\"ur \`Authors\\ +% & {\it John J\"oe, K\'e\~{n}t K\^{\i }ng, L\`ou L\'ou, M\`anfr\'ed J. M\^ost\u{e}ki} \\ +% & \vspace*{-0.1cm}\\ +% 27 & {\bf Full Bibliography}\\ +% & \vspace*{-0.1cm}\\ +% 28 & {\bf Index of Authors}\\ +% \end{tabular}} +% \caption{{\it Example of table of contents for a conference organized by day.}} +% \label{tab:program:day} +% \end{table} +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{@{\,}l@{\,}l} \hline +% $\blacktriangleright$ & Preamble\\ +% & Program\\ +% $\blacktriangleright$ & Day 1\\ +% $\blacktriangleright$ & Day 2\\ +% & Full Bibliography\\ +% & Index of Authors\\ \hline +% \end{tabular}} +% \caption{{\it Closed bookmarks for a conference organized by days.}} +% \label{tab:program:day:bkmrk0} +% \end{table} +% +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{@{\,}l@{\,}l@{\,}l} \hline +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Preamble}\\ +% & & Cover\\ +% & & Publishing informations\\ +% & & Welcome from Firstname Lastname\\ +% & \multicolumn{2}{@{\,}l}{Program}\\ +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Day 1}\\ +% & $\blacktriangleright$ & Oral Session 1\\ +% & $\blacktriangleright$ & Poster Session 1\\ +% $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Day 2}\\ +% & $\blacktriangleright$ & Oral Session 2\\ +% & \multicolumn{2}{@{\,}l}{Full Bibliography}\\ +% & \multicolumn{2}{@{\,}l}{Index of Authors}\\ \hline +% \end{tabular}} +% \caption{{\it First-level opened bookmarks for a conference organized by days.}} +% \label{tab:program:day:bkmrk1} +% \end{table} +% +% \begin{table}[htb!] +% \centering +% \textsf{% +% \begin{tabular}{@{\,}l@{\,}l@{\,}l@{\,}l} \hline +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Preamble}\\ +% & & \multicolumn{2}{@{\,}l}{Cover}\\ +% & & \multicolumn{2}{@{\,}l}{Publishing informations}\\ +% & & \multicolumn{2}{@{\,}l}{Welcome from Firstname Lastname}\\ +% & \multicolumn{3}{@{\,}l}{Program}\\ +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Day 1}\\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Oral Session 1}\\ +% & & $\blacktriangleright$ & Template for One Author\\ +% & & $\blacktriangleright$ & Template for One Author with Two Affiliations\\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Poster Session 1}\\ +% & & $\blacktriangleright$ & Template for Two Authors\\ +% $\blacktriangledown$ & \multicolumn{3}{@{\,}l}{Day 2}\\ +% & $\blacktriangledown$ & \multicolumn{2}{@{\,}l}{Oral Session 2}\\ +% & & $\blacktriangleright$ & Template for Three Authors\\ +% & & $\blacktriangleright$ & Template f\'or F\`o\"ur \`Authors\\ +% & \multicolumn{3}{@{\,}l}{Full Bibliography}\\ +% & \multicolumn{3}{@{\,}l}{Index of Authors}\\ \hline +% \end{tabular}} +% \caption{{\it Second-level opened bookmarks for a conference organized by days.}} +% \label{tab:program:day:bkmrk2} +% \end{table} +% +% \clearpage +% +% +%^^A ================================================================= +% \subsubsection{CSV Program of the conference} +% \label{sec:scripts:program} +% +% It may be easier for you to collect data about the papers from a server, manipulate them in a spreadsheet software (for example M\$ Excel), and then generate the program from a \file{.csv} file. We used a Perl script (see sec. \ref{sec:scripts:perl}) to generate the corresponding \file{.tex} files for the example. First, take a look at the following CSV file, that contains the conference program for the example\footnote{This is normal that this text goes on after the margin. Please check the generated file if you wish to read each line.}: +% +%^^A ================================================================= +%^^A Here is the creation of the procwitchandtoc.pl file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% \begin{macrocode} +%<*exprogram> +Type,Paper Number,PC Decision,Pages,Title,File Name,Generated,Citations,Auth1 First Name,Auth1 Last Name,Auth2 First Name,Auth2 Last Name,Auth3 First Name,Auth3 Last Name,Auth4 First Name,Auth4 Last Name,, +Type,-2,O,,,,,,First Name,Last Name,First Name,Last Name,First Name,Last Name, F.Name, L.Name,, +Day,0,,,Day 1: September 18 2007,,,,,,,,,,,,, +Session,0,,,Oral Session 1,,,,,,,,,,,,, +paper,1,O,6,Templates for One Author,p_001,LaTeX,"Mitra:Kaiser:1993:DSP:handbook,Haykin:1991:adaptive:filter,Serra:1996:sms,Moorer:2000:AES:audio:millenium",Alfred,Alabama,,,,,,,, +paper,2,O,5,Templates for One Author with Two Affiliations,p_003,LaTeX,"Mitra:Kaiser:1993:DSP:handbook,Haykin:1991:adaptive:filter,Serra:1996:sms,Arfib:1998:DAFx",Bob,Boogie-Woogie,,,,,,,, +Poster Session,0,,,Poster Session 1,,,,,,,,,,,,, +paper,3,P,4,Templates for Two Authors,p_005,LaTeX,"Mitra:Kaiser:1993:DSP:handbook,Haykin:1991:adaptive:filter,Serra:1996:sms,Askenfelt:1976:automatic:transcription",Alfred,Alabama,Chris,Christmas,,,,,, +Day,0,,,Day 2: September 19 2007,,,,,,,,,,,,, +Session,0,,,Oral Session 2,,,,,,,,,,,,, +paper,4,O,6,Templates for Three Authors,p_007,LaTeX,"Mitra:Kaiser:1993:DSP:handbook,Haykin:1991:adaptive:filter,Serra:1996:sms,Egozy:1995:MIT:features:gesture",Bob,Boogie-Woogie,Chris,Christmas,Don,Didon,,,, +paper,5,O,7,Templates fór Fòür Àuthors,p_009,LaTeX,"Mitra:Kaiser:1993:DSP:handbook,Haykin:1991:adaptive:filter,Serra:1996:sms,Dutilleux:1991,Fitz:Haken:2003:Web:morphing:loris",John,Jöe,Kéñt,Kîng,Lòu,Lóu,Mànfréd J.,Môst\u{e}k\i,, +%</exprogram> +% \end{macrocode} +% +% As we expect when reading the first line, it contains the following columns: +% \begin{enumerate} +% \item {\bf Type:} the script will accept the following values: +% \begin{itemize} +% \item use \verb+Type+ for the items to ignore; +% \item Day: use \verb+Day+; +% \item Session: use \verb+Session+ or \verb+Paper Session+ or \verb+Oral Session+ for oral sessions, \verb+poster session+ for Poster Sessions, and \verb+Demo Session+ for demo sessions; +% \item Paper: use \verb+paper+ or \verb+oral+ for oral presentation; \verb+poster+ for poster presentation; \verb+demo+ for demo. The 3 output identical code anyway: it only helps to organize the program!. +% \end{itemize} +% Note that theses values are not case sensitively processed by the Perl script. +% \item {\bf Number:} paper number or reference, often generated by the submission system. It will be used for paper insertion, for ordering the program, etc. +% \item {\bf PC Decision:} \verb+oral+ or \verb+poster+. it does not change the \LaTeX\ generated code, so you may not use it; +% \item {\bf Pages:} number of pages; +% \item {\bf Title:} title; +% \item {\bf File Name:} name of the corresponding \file{.pdf} file; +% \item {\bf Generated:} \verb+LaTeX+ for \LaTeX\ generated files, and \verb+Word+ for Word generated file. This allows to use different $X$ and $Y$ offset values (we however used the same value for all papers of one kind); +% \item {\bf Citations:} list of bibliography items for the general bibliography (ex: \verb+\cite{bibitem1,bibitem2,bibitem3}+); blank if no general bibliography; +% \item {\bf Auth1 First Name:} first name of author 1; +% \item {\bf Auth1 Last Name:} last name of author 1; +% \item {\bf Auth2 First Name:} first name of author 2, blank if none; +% \item {\bf Auth2 Last Name:} last name of author 2, blank if none; +% \item {\bf Auth3 First Name:} first name of author 3, blank if none; +% \item {\bf Auth3 Last Name:} last name of author 3, blank if none; +% \item {\bf Auth4 First Name:} first name of author 4, blank if none; +% \item {\bf Auth4 Last Name:} last name of author 4, blank if none; +% \item {\bf comments:} there is an extra column, that is not used by the script. +% \end{enumerate} +% +%^^A ================================================================= +% \subsubsection{Perl script to generate the paper switch and program} +% \label{sec:scripts:perl} +% +% \changes{0.2c}{2007/08/17}{Scripts: Perl script 'procswitchandtoc.pl' to generate 'paperswitch.tex' and 'sessions.tex' added} +% \changes{0.2d}{2007/08/18}{Scripts: Perl script to generate 'procswitchandtoc.pl' added} +% \changes{0.2d}{2007/08/18}{Scripts: Perl script 'procswitchandtoc.pl' modified to insert bookmarks, and text shorten} +% \changes{0.2d}{2007/08/20}{Scripts: Perl script modified and authors pdfboomarks added} +% \changes{0.2g}{2007/09/07}{Scripts: changing input file line break style (Unix instead of Max)} +% \changes{0.2h}{2007/09/12}{Scripts: Perl script is case insensitive for session names 9and has more options)} +%^^A ================================================================= +%^^A Here is the creation of the procwitchandtoc.pl file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% \begin{macrocode} +%<*procswitchandtoc> +#!/usr/bin/perl -w + +# procswitchandtoc.pl +# created as dafxproctoc.pl by Marz Zadel, 2006-04-28 +# modified for confproc.cls by Vincent Verfaille, 2007-08-08 +# Execute as +# ./procswitchandtoc.pl < intputfile.txt > + +use strict; +use Text::ParseWords; +open(SWI, ">expapersswitch.tex"); #open for write, overwrite +open(SESSIONS, ">exsessions.tex"); #open for write, overwrite + +# ----- Configuration +# field separator for the input file +my $fieldseparator=','; + +# mac line endings: "\r" / Unix line endings: :\n" +$/ = "\n"; # line endings for the input file +$\ = "\n"; # line endings for the output file + +# ----- Subroutines +# -- split one line of input into a hash with named fields +sub parseinputline { + my ($inputline) = @_; + + # escape single quotes on the input line: they interfere with quotewords()'s + # quote handling (ie, they start to quote stuff) + $inputline =~ s/'/\\'/g; + + # parse the input line + my @wordlist = "ewords($fieldseparator, 0, $inputline); + + # replace accented characters with latex escaped equivalents. To be done after + # quotewords() so the '\' don't get interpreted by quotewords() as escapes + foreach my $word ( @wordlist ) { + if ( $word ) { $word = &latexifyaccentedcharacters($word); } + } + + # extract the fields into local variables. Author names stored as a list + my ($type, $number, $pcdecision, $nbpages, $title, $filename, + $generatedfrom, $cite) = @wordlist; + + # remove the first 8 elements (just parsed out), leaving only author names. + # reminder: list of 8 scalars, though some may be "" if less than 4 authors + splice( @wordlist, 0, 8 ); + + # store the author names as a list of lists. We end up with a list that looks + # like ((Udo,Zoelzer),(Daniel,Arfib)) + my @authors = (); + while ( $wordlist[0] ) { + push( @authors, [splice( @wordlist, 0, 2 )] ); + # "splice( @wordlist, 0, 2 )": cuts the first 2 scalars off of @wordlist + # and returns them; calling [splice(@wordlist,0,2)] returns a *reference* + # to a list containing the first two scalars. (see perldoc perldsc.) + } + + # create a hash reference containing the named fields and return it + my $fields = { + type => $type, + number => $number, + pcdecision => $pcdecision, + nbpages => $nbpages, + title => $title, + generatedfrom => $generatedfrom, + filename => $filename, + cite => $cite, + authors => \@authors, + }; + return $fields; +} + +# -- takes a string in Mac OS Roman encoding and encode the accented +# characters with latex escapes (only for a subset of available characters). +sub latexifyaccentedcharacters { + # for mapping between unicode and mac os western encoding, see: + # http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/ROMAN.TXT + my ($inputstring) = @_; + $inputstring =~ s/\x8a/\\"a/g; # \"a: unicode 0xe4, mac os western 0x8a + $inputstring =~ s/\x87/\\'a/g; # \'a: unicode 0xe9, mac os western 0x87 + $inputstring =~ s/\x88/\\`a/g; # \`a: unicode 0xe8, mac os western 0x88 + $inputstring =~ s/\x8e/\\'e/g; # \'e: unicode 0xe9, mac os western 0x8e + $inputstring =~ s/\x8f/\\`e/g; # \`e: unicode 0xe8, mac os western 0x8f + $inputstring =~ s/\x91/\\"e/g; # \"e: unicode 0xeb, mac os western 0x91 + $inputstring =~ s/\x97/\\'o/g; # \'o: unicode 0xf3, mac os western 0x97 + $inputstring =~ s/\x98/\\`o/g; # \`o: unicode 0xf2, mac os western 0x98 + $inputstring =~ s/\x9a/\\"o/g; # \"o: unicode 0xf6, mac os western 0x9a + $inputstring =~ s/\x99/\\^o/g; # \^o: unicode 0xf4, mac os western 0x99 + $inputstring =~ s/\xbf/\\o /g; # \o: unicode 0xf8, mac os western 0xbf + $inputstring =~ s/\x96/\\~n /g; # \~n: unicode 0xF1, mac os western 0x96 + $inputstring =~ s/\x94/\\^{\\i}/g; # \^{\i}: unicode 0xee, mac os western 0x94 + $inputstring =~ s/\x/\\i/g; # \i: unicode , mac os western + $inputstring =~ s/\x9f/\\"u/g; # \"u: unicode 0xfc, mac os western 0x9f + $inputstring =~ s/\x5c/\\/g; # \: unicode 0x5C, mac os western 0x5C + + return $inputstring; +} + +# -- output the information for a day +sub outputdaylatex { + my ($fields) = @_; + my $sessiontitle = $fields->{'title'}; + open(SESSIONS, ">>exsessions.tex"); #open for append + print SESSIONS ' '; + print SESSIONS '%%%== Day'; + print SESSIONS '\procday{', $sessiontitle, '}' +} + +# -- output the information for a session line +sub outputsessionlatex { + my ($fields) = @_; + my $sessiontitle = $fields->{'title'}; + open(SESSIONS, ">>exsessions.tex"); #open for append + print SESSIONS ' '; + print SESSIONS '%%%-- session'; + print SESSIONS '\session{', $sessiontitle, '}' +} + +# -- in: ref. to a list of lists of author names ((Udo,Zoelzer),(Daniel,Arfib)) +# out: ref. to a Perl list w/ entries "Udo Zoelzer" and "Daniel Arfib" (no quotes) +sub authorsbyfirstname { + my ($authors) = @_; + # generate a list of full "first last" author names + my @authorlistbyfirstname = map { "$_->[0] $_->[1]" } @$authors; + return \@authorlistbyfirstname; # return a ref. to the new list of authors +} + +# -- in: ref. to a list of lists of author names ((Udo,Zoelzer),(Daniel,Arfib)) +# out: ref. to a Perl list w/ entries "Zoelzer, Udo" and "Arfib, Daniel" +sub authorsbysurname { + my ($authors) = @_; + # generate a list of authors with surnames written first + my @authorlistbysurname = map { "$_->[1], $_->[0]" } @$authors; + return \@authorlistbysurname; # return a ref. to the new list of authors +} + +# -- in: ref. to a list of author names: "Zoelzer, Udo" and "Arfib, Daniel" +# out: LaTeX index entries: "\index{Zoelzer, Udo}\index{Arfib, Daniel}" +sub genindex { + my ($authorsbysurname) = @_; + my @indexentries = map { "\\index{$_}" } @$authorsbysurname; + return join('', @indexentries); +} + +# -- in: ref. to a list of author names: "Zoelzer, Udo" and "Arfib, Daniel" +# out: bookmarks cmds: "\pdfbookmark[2]{Udo Zoelzer}{#2.Udo Zoelzer} +# \pdfbookmark[2]{Daniel Arfib}{#2.Daniel Arfib}" +sub genbookmark { + my ($authorsbyfirstname) = @_; + my @indexentries = map { "\\pdfbookmark[2]{$_}{#2.$_}" } + @$authorsbyfirstname; + return join('', @indexentries); +} + +# -- output the information for a paper line +sub outputpaperlatex { + my ($fields) = @_; + open(SWI, ">>expapersswitch.tex"); #open for append + print SWI '%=========== PAPER ID = ', $fields->{'number'}, ' ==========='; + print SWI '\ifnum\paperswitch=', $fields->{'number'}; + print SWI ' \procinsertpaper{\LaTeXxShift{} \LaTeXyShift}{', + $fields->{'nbpages'}, '}{\paperswitch}%'; + print SWI ' {', $fields->{'title'}, '}% paper title'; + print SWI ' {', join( ', ', @{&authorsbyfirstname($fields->{'authors'})}), + '}% list of authors'; + print SWI ' {', &genindex(&authorsbysurname($fields->{'authors'})), + '}% authors index entries'; + print SWI ' {', $fields->{'cite'}, '}% cited bib items'; +# print SWI ' {#2}{\paperbookmark}'; + print SWI ' {#2}{', &genbookmark(&authorsbyfirstname($fields->{'authors'})),'}'; + print SWI '\fi'; + print SWI ' '; + open(SESSIONS, ">>exsessions.tex"); #open for write, overwrite + print SESSIONS '\paperid{', $fields->{'number'}, '}{', $fields->{'filename'}, '}'; +} + +# ----- Main +# FIXME: parse a line, and confirm that all of the fields are set up properly +# --> correct number of fields, and the fields have the correct values +open(SWI, ">>expapersswitch.tex"); #open for write, overwrite +print SWI '\newcommand{\paperid}[2]{'; +print SWI ' '; +print SWI '\renewcommand{\paperswitch}{#1}'; +print SWI ' '; + +while ( <> ) { + chomp; # clear the newline character from the end of the line + my $fields = &parseinputline($_); # parse the line into fields + # take some action depending on what type of line it is; case insensitive + if ( lc($fields->{'type'}) eq lc('day') ) { + &outputdaylatex($fields); + } elsif ( lc($fields->{'type'}) eq lc('session') + || lc($fields->{'type'}) eq lc('paper session') + || lc($fields->{'type'}) eq lc('demo session') + || lc($fields->{'type'}) eq lc('poster session') ) { + &outputsessionlatex($fields); + } elsif ( lc($fields->{'type'}) eq lc('oral') + || lc($fields->{'type'}) eq lc('paper') + || lc($fields->{'type'}) eq lc('demo') + || lc($fields->{'type'}) eq lc('poster') ) { + &outputpaperlatex($fields); + } elsif ( lc($fields->{'type'}) eq lc('Type')) { + } else { print '!!! a day, session or paper (', + $fields->{'type'},') is lost by the script...'; + } +open(SWI, ">>expapersswitch.tex"); #open for append +} +print SWI '}'; +close(SWI); +close(SESSIONS); +%</procswitchandtoc> +% \end{macrocode} +% +% +%^^A ================================================================= +% \subsection{Common bibliography items} +% \label{sec:ex:bib:common} +% +% \changes{0.1d}{2007/08/01}{Biblio: adding the exbiblio.tex creation} +% \changes{0.1i}{2007/08/10}{Biblio: code cleanup} +% \changes{0.1i}{2007/08/10}{Biblio: adding the \cmd{\procbibintro} command to customize the biblio introduction} +%^^A ================================================================= +%^^A Here is the creation of the exbibcommon.tex file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% +% Let us take a look at the common bibliographic items of this example: +% \begin{macrocode} +%<*exbiblio> +%-- This item generates the text under the bibliography title +@misc{bib:intro, + Author = {~}, + Title = {\procbibintro\newline{}% + \centerline{\underline{\hspace*{5cm}}}}} + +%-- references to a book +@book{Mitra:Kaiser:1993:DSP:handbook, + Author = {S.~K. Mitra and J.~F. Kaiser}, + Title = {Handbook for Digital Signal Processing}, + Publisher = {J. Wiley {\&} Sons}, + Year = {1993}} + +@book{Haykin:1991:adaptive:filter, + Author = {Simon Haykin}, + Title = {Adaptive Filter Theory}, + Publisher = {Prentice Hall}, + Address = {Englewood Cliffs}, + Edition = {Second}, + Year = {1991}} + +%-- reference to a book chapter +@inbook{Serra:1996:sms, + Author = {X. Serra}, + Chapter = {Musical Sound Modeling with Sinusoids plus Noise}, + Publisher = {G. D. Poli, A. Picialli, S. T. Pope and C. Roads,% + Eds.~Swets~\&~Zeitlinger}, + Title = {Musical Signal Processing}, + Pages = {91--122}, + Year = {1996}} + +%-- reference to a journal paper +@article{Moorer:2000:AES:audio:millenium, + Author = {James A. Moorer}, + Title = {Audio in the New Millennium}, + Journal = {Journal of the {AES}}, + Volume = 48, + Number = 5, + Year = 2000, + Month = may, + Pages = {490--498}} + +%-- reference to a proceeding paper +@inproceedings{Arfib:1998:DAFx, + Author = {D. Arfib}, + Booktitle = {Proc. of the COST-G6 Workshop on Digital Audio Effects % + (DAFx-98)}, + Title = {Different Ways to Write Digital Audio Effects Programs}, + Address = {Barcelona, Spain}, + Pages = {188--91}, + Year = {1998}} + +%-- reference to a technical report +@techreport{Askenfelt:1976:automatic:transcription, + Author = {A. Askenfelt}, + Title = {Automatic notation of played music (status report)}, + Institution = {{STL-QPSR, Vol. 1, pp. 1--11}}, + Year = {1976}} + +%-- reference to a master thesis +@mastersthesis{Egozy:1995:MIT:features:gesture, + Author = {E.~B. Egozy}, + title = {Deriving musical control features from a real-time timbre % + analysis of the clarinet}, + School = {Massachusetts Institute of Technology}, + Year = {1995}} + +%-- reference to a PhD thesis +@phdthesis{Dutilleux:1991, + Author = {P. Dutilleux}, + School = {University of Aix-Marseille II}, + Title = {Vers la machine \`a sculpter le son, modification en % + temps-r\'eel des caract\'eristiques fr\'equentielles et temporelles% + des sons}, + Year = {1991}} + +%-- reference to a web page +@unpublished{Fitz:Haken:2003:Web:morphing:loris, + Author = {K. Fitz and L. Haken}, + Title = {{Current Research in Real-time Sound Morphing}}, + Note = {Available at \href{http://www.cerlsoundgroup.org/RealTimeMorph/}% + {http://www.cerlsoundgroup.org/RealTimeMorph/}}, + Year = {Accessed March 08, 2006}} +%</exbiblio> +% \end{macrocode} +% +% See sec. \ref{sec:general:bib} for details about the bibliography merging process. +% +%^^A {\sc Explain also that each paper's bibitems' tags were renamed using the paper ID, and each paper was then recompiled with this general bibliography, to ensure coherence between local bibliographies and general bibliography. This implies to work on each paper afterwards to ensure then do not become overlengthen...} +% +%^^A ================================================================= +% \subsection{Unix scripts} +% \label{sec:scripts} +% +% \subsubsection{Compile all papers}\label{sec:scripts:buildpapers} +% +% First, you will notice that you need to make modifications to all papers, then needing to re-compile them all. For instance, you want each individual paper to have the same first page number as the one it has in the proceedings (for papers with page numbers included in the footer). Hopefully, they were all produced in \LaTeX{}, so you can automatize the process with a Unix script, such as: +% +% \changes{0.1d}{2007/08/01}{Adding the exbiblio.tex creation} +%^^A ================================================================= +%^^A Here is the creation of the buildpapers script file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% \begin{macrocode} +%<*buildpapers> +#!/bin/sh + +# Compile all papers with 'pdflatex' of 'latex' +# (depending if they are in 'sources_pdftex' or 'sources_tex') +# and copy resulting pdf files in the 'papers' folder. +# Expected tree structure: +# proceedings/papers/sources_pdftex/ +# proceedings/papers/sources_tex/ +# with this script in 'proceedings/' + +#--- choose if you compile from scratch or only once +#BUILD_TYPE=final #recompile and re-do biblio +BUILD_TYPE=renumber #recompile only once for re-numbering + +#--- set system dependent variables +#LATEXPATH="/usr/local/teTeX/bin/i386-apple-darwin-current/" # teTeX +LATEXPATH="/usr/texbin/" # TexLive 2007 + +#--- paths +LATEX=$LATEXPATH"latex" +DVIPDF=/usr/local/bin/dvipdf +PDFLATEX=$LATEXPATH"pdflatex" +BIBTEX=$LATEXPATH"bibtex" +MAKEINDEX=$LATEXPATH"makeindex" +PROCSTY='dafx_06.sty' + +#--- Compiling .tex files with pdfLaTeX +cd papers/sources_pdftex +for i in *; do + echo; echo; echo '=====> Compiling' $i '.tex with pdfLaTeX <=====' + cd $i + # copy the paper style (in case you changed it) + cp ../../$PROCSTY . + echo; echo ' ---> 1st compilation of ' $i '.tex' + $PDFLATEX $i + if [ $BUILD_TYPE = final ]; then + echo; echo ' ---> Compiling the bibliography ' $i '.tex' + $BIBTEX $i + echo; echo ' --- 2nd compilation of ' $i '.tex' + $PDFLATEX $i + echo; echo ' ---> 3rd compilation of ' $i '.tex' + $PDFLATEX $i + fi + #--- copy the pdf where the proceedings will be assembled + cp $i.pdf ../.. + cd .. +done +#--- Compiling .tex files with LaTeX (problems related with hyperref) +cd ../sources_tex +for i in *; do + echo; echo; echo '=====> Compiling' $i '.tex with LaTeX <=====' + cd $i + #--- copy the paper proceedings style (if you changed the tree) + cp ../../$PROCSTY . + echo; echo ' ---> 1st compilation of ' $i '.tex ' + $LATEX $i.tex + if [ $BUILD_TYPE = final ]; then + echo; echo ' ---> Compiling the bibliography ' $i '.tex ' + $BIBTEX $i + echo; echo ' ---> 2nd compilation of ' $i '.tex ' + $LATEX $i + echo; echo ' ---> 3rd compilation of ' $i '.tex ' + $LATEX $i + fi + #--- produce the pdf from dvi + $DVIPDF $i.dvi $i.pdf + #--- copy the pdf where the proceedings will be assembled + cp $i.pdf ../.. + cd .. +done +%</buildpapers> +% \end{macrocode} +% +% \subsubsection{Copy all PDFs papers at the right place}\label{sec:scripts:buildcppdfpapers} +% +% Eventhough the previous Unix script already does it, you may have to re-copy all PDF files at the right place (\ie{} in 'papers/') without recompiling all the papers. This is achieved with a script such as: +% +% +% \changes{0.1d}{2007/08/01}{Unix scripts: creating buildcppdfpapers.} +% \changes{0.1f}{2007/08/03}{Unix scripts: cleanup for buildcppdfpapers.} +%^^A ================================================================= +%^^A Here is the creation of the buildcppdfpapers script file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% \begin{macrocode} +%<*buildcppdfpapers> +#!/bin/sh +cd papers/sources_tex +for i in *; do + echo '*********' $i '*********' + cp $i/$i.pdf .. +done +cd ../sources_pdftex +for i in *; do + echo '*********' $i '*********' + cp $i/$i.pdf .. +done +%</buildcppdfpapers> +% \end{macrocode} +% +% +%^^A ================================================================= +% \subsubsection{Make the proceedings}\label{sec:confproc:compil:script}\label{sec:scripts:buildproc} +% +% This script if the most important, as it describes all compilation steps to produce the final version of the proceedings. As you can see, it requires many compilations, to create valid table of content, index, bibliography, index of authors, and proper back references from the bibliography. It also manages for you the renaming of the class insertion file, so that you do not need anymore to run a last time by hand after changing the \Lopt{compil=backref} option to \Lopt{compil=last} (as this option change, and others, are in the \file{exclasspre.tex} and \file{exclasslast.tex} files). +% +% +% \changes{0.1d}{2007/08/01}{Adding the buildproc script creation.} +%^^A ================================================================= +%^^A Here is the creation of the buildproc script file, part of the example. +%^^A It is written on first LaTeX run if it does not already exist +%^^A ================================================================= +% \begin{macrocode} +%<*buildproc> +#!/bin/sh + +#--- set user dependent file name +TEXFILE="example" +#--- set system dependent variables +#LATEXPATH="/usr/local/teTeX/bin/i386-apple-darwin-current/" # for teTeX +LATEXPATH="/usr/texbin/" # for TexLive 2007 +#--- set compilers' paths +PDFLATEX=$LATEXPATH"pdflatex" +BIBTEX=$LATEXPATH"bibtex" +MAKEINDEX=$LATEXPATH"makeindex" + +#--- Compile +echo; echo; echo '*** bash: copying class insertion file ***' +cp exclasspre.tex exclass.tex +echo; echo; echo '*** PdfLaTeX: create toc (1/7) ***' +$PDFLATEX $TEXFILE.tex +echo; echo; echo '*** Bibtex: generate the general biblio. (2/7) ***' +$BIBTEX $TEXFILE +echo; echo; echo '*** Makeindex: create index of authors (3/7) ***' +$MAKEINDEX -s confproc.ist $TEXFILE.idx +echo; echo; echo '*** PdfLaTeX: create toc + include index (4/7) ***' +$PDFLATEX $TEXFILE.tex +echo; echo; echo '*** PdfLaTeX: create backrefs (5/7) ***' +$PDFLATEX $TEXFILE.tex +echo; echo; echo '*** PdfLaTeX: give proper toc and backrefs (6/7) ***' +$PDFLATEX $TEXFILE.tex +echo; echo; echo '*** bash: copying class insertion file ***' +cp exclasslast.tex exclass.tex +echo; echo; echo '*** PdfLaTeX: full papers (mod. class insertion) (7/7) ***' +$PDFLATEX $TEXFILE.tex +%</buildproc> +% \end{macrocode} +% +% \changes{0.2g}{2007/09/07}{Docu: starting a more organized `proceedings making'} +%^^A ================================================================= +%^^A Why developing confproc +%^^A ================================================================= +% \section{More about conference proceedings making} +% \label{sec:conference:proc:making} +% +% +% \changes{0.2g}{2007/09/07}{Docu: e-organizing steps' section} +%^^A ================================================================= +%^^A Compilations +%^^A ================================================================= +% \subsection{Steps to generate the final version of your proceedings}\label{sec:confproc:compil} +% +% We now describe the methodology and steps used to produce the final version of the provided example proceedings with the following constraints: +% \begin{itemize} +% \item paper templates have header and footer; +% \item the proceedings must have the same header/footer; +% \item we want a general bibliography; +% \item we want the PDF papers to be named after their first page number; +% \end{itemize} +% +% +%^^A ================================================================= +% \subsubsection{Generate the program and the paper switch} +% +% You may generate the conference program and its corresponding paper switch: +% \begin{itemize} +% \item by hand (read sec. \ref{sec:ex:paper:switch} for an example); +% \item using the \file{procswitchandtoc.pl} Perl script described in sec.~\ref{sec:scripts:perl} to generate both the \file{exsessions.tex} and \file{expapersswitch.tex} files from your \file{exprogram.csv} program file; +% \end{itemize} +% +%^^A ================================================================= +% \subsubsection{Changing papers' first page number} +% +% If you paper template has page numbers included in the footer, you may want each individual paper to have the same first page number as the one it has in the proceedings' table of contents\footnote{When clicking on a paper, the PDF file of this paper will open with the same first page number. Also, if the conference papers are available on the web, knowing the page numbers will help readers to properly cite them.}. To do so, The way to do that is: +% \begin{enumerate} +% \item make at least two runs with the following options:\begin{verbatim} +%\documentclass[a4paper,10pt,twoside,twosidepapers,% +% compil=last,headers=allpages,movepagenumbers,electronic]{confproc} +%\end{verbatim} +% to include all papers and build a table of contents with proper page numbers. +% \item prepare each paper for insertion. There are two ways to do this: +% \begin{enumerate} +% \item lazy way: use the \verb+\setcounter{page}{1}+ line in the paper, and replace the \verb+1+ by the real number; +% \item better way: centralize page numbers in the \file{expages.tex} file, organized by the paper ID. Then, the two steps are: +% \begin{itemize} +% \item add the following in the preamble of each paper:\begin{verbatim} +%\input{../../expages.tex}\setpagenumber{04} +%\end{verbatim} +% Here, the ID paper is \verb+04+, and has to be updated for each paper. +% \item update the \file{expages.tex} file for each paper: set its first page number as it appears in the table of contents. +% \end{itemize} +% By doing so, you can update the program to re-build the table of contents as many times as yuo want, without having to re-edit all papers. +% \end{enumerate} +% \item when the program (and the corresponding paper ordering) is defined, (re)generate each paper independently with proper first page number (using the \file{buildpapers} Unix script provided in sec.~\ref{sec:scripts:buildpapers}); +% \item check that you did not make errors in numbering the first page. You may run \LaTeX\ with at least the \Lopt{headers=allpages,movepagenumbers} options. If there are still errors, re-do step 2--3 till the page numbers are ok. +% \end{enumerate} +% +%^^A ================================================================= +% \subsubsection{Renaming papers} +% +% You may consider renaming all papers according to their first page number (\eg{} \file{p\_NNN.pdf} if you decide to only rename the PDF files). This is very helpful to ensure you CD version of the proceedings is ISO compliant, and has file names with less than 8 characters (+ extensions). This means that you only do this when you are sure of your page numbering. You then have to change file names accordingly in the \file{.csv} file, re-generate the \file{expapersswitch.tex} file, and rebuild the proceedings. It is easily done using the Unix scripts. +% +% \changes{0.2i}{2007/09/21}{Docu: finishing biblio merging and other biblio-related stuff} +%^^A ================================================================= +% \subsubsection{General bibliography}\label{sec:general:bib} +% +% As said previously, for DAFx-06 (but not for the provided example), we worked with three files in order to simplify the bibliography merging process: +% \begin{itemize} +% \item \texttt{exbibconcat.bib} containing all citations for all papers; +% \item \texttt{exbibcommon.bib} containing common bibliography items, added one by one during the merging process; +% \item \texttt{exbibstrings.bib} containing all common strings (conference names, journal names, etc), to ensure coherence among citations from same sources (journal, conference). +% \end{itemize} +% Here is how those files are created and used: +% \begin{enumerate} +% \item create the complete bibliography: +% \begin{enumerate} +% \item for each paper, change its bib item tags to a tag that cannot be common to 2 papers (we used a \verb+paperID:originaltag+ format)\footnote{You may ask your authors to do so if you send them editor's notes.}; +% \item ensure that each paper has a proper list of bibliography items using those new tags; +% \item concat the bibliographys of all individual paper into a single file named \file{exbibconcat.bib}; +% \item set the proceedings bibliography file to \begin{verbatim} +%\renewcommand{\procbibfile}{\BIBPATH exbibconcat.bib} +%\end{verbatim} +% \item run \LaTeX\ with the complete bibliography (using the \Lopt{compil=bibmerge} option that uses \verb+\nocite{*}+) so bib items are include twice: by the paper and globally. You are now ready to merge bibliographies. +% \end{enumerate} +% \item merge the bibliographic items (long step): +% \begin{enumerate} +% \item first, add the \file{exbibcommon.bib} file to the list of bibliography files by setting the proceedings bibliography files to: \begin{verbatim} +%\renewcommand{\procbibfile}{\BIBPATH exbibcommon.bib,% +% \BIBPATH exbibconcat.bib} +%\end{verbatim} +% \item for each item appearing multiple times: +% \begin{enumerate} +% \item create a corresponding entry in the \file{exbibcommon.bib} file; +% \item remove each appearance of it in \file{exbibconcat.bib}; +% \item this is the perfect time for correcting inconsistent references (title, list of authors, page numbers, etc)! Note that this process requires a lot of time, as it is the slowest in the bibliography merging process. +% \end{enumerate} +% \end{enumerate} +% \item merge the bibliography strings: +% \begin{enumerate} +% \item add the \file{exbibstrings.bib} file to the list of bibliography files by setting the proceedings bibliography files to: \begin{verbatim} +%\renewcommand{\procbibfile}{\BIBPATH exbibstrings.bib,% +% \BIBPATH exbibcommon.bib,\BIBPATH exbibconcat.bib} +%\end{verbatim} +% \item merge the common strings. For each string shared by several items: +% \begin{enumerate} +% \item define the corresponding string in the \file{exbibstring.bib} file. For instance, for the IEEE Transactions on Acoustics, Speech, and Signal Processing, add:\begin{verbatim} +%@string{IEEE-TASSP = "{IEEE Trans. Acoust., Speech, +% and Signal Proc.}"} +%\end{verbatim} +% \item use this definition (\eg{} \file{IEEE-TASSP}) to replace any appearance of its in the \file{exbibconcat.bib} file. For instance, use:\begin{verbatim} +%@article{paper027:Mcaulay86, +% Author = {Robert J. McAulay and Thomas F. Quatieri}, +% Title = {Speech Analysis/Synthesis Based on a% +% Sinusoidal Representation}, +% Journal = IEEE-TASSP, +% Volume = {34}, +% Number = {4}, +% Pages = {744-754}, +% Year = {1986}} +%\end{verbatim} +% \end{enumerate} +% \end{enumerate} +% \item updating papers once the general bibliography is ok: +% \begin{enumerate} +% \item for each paper: +% \begin{enumerate} +% \item generate a new bibliography file (\eg{} \file{p\_027.bib} for \file{p\_027.tex}) that included only their own non-common bibliography items remaining in the \file{exbibconcat.bib} file; +% \item edit each paper so that it uses both this new bibliography file (\file{p\_027.bib}) together with the \file{exbibcommon.bib} and the \file{exbibstrings.bib} files. This will provide common and coherent contents to both local and general bibliographies. Since the \file{p\_027.tex} file is placed in the \file{papers/pdftex/p\_027/} folder, its bibliography insertion will then become something like:\begin{verbatim} +%\bibliography{../../exbibstrings.bib,% +% ../../exbibcommon.bib,p_027.bib} +%\end{verbatim} +% \end{enumerate} +% \item re-run \LaTeX\ on all papers, using the \file{buildpapers} Unix script (see sec. \ref{sec:scripts:buildpapers}). This script also copies all resulting PDFs to the right place. +% \item if you did not use the previous script, copy all PDF papers to the \file{papers/} folder. The \file{buildcppdfpapers} Unix script (see sec. \ref{sec:scripts:buildcppdfpapers}) can do it for you, for instance if you changed some of the papers but not all, and do not remember which were to be copied. +% \end{enumerate} +% \end{enumerate} +% You are now done with bibliography merging, and are ready to re-run \LaTeX\ on the proceedings using the \Lopt{compil=backref} options as many times as necessary to provide proper back-references and page numbering. +% +% +% +% +% +%^^A everything else in the proceedings is done (table of contents. index, etc), create the back references with one of those two solutions: +%^^A \begin{itemize} +%^^A \item Good trick: {\sc check this as it seems that it has changed} labels/refs +%^^A \begin{itemize} +%^^A \item insert the $N_i-1$ pages of each paper $i$ and replace last page by a citation of local bibliography. Then, bib items properly appear in the full bibliography +%^^A \item save the \file{DAFx06\_Proceedings.brf} file under another name +%^^A \item recompile the Proceedings without replacing last page by bibliography +%^^A \item rename properly the file \file{DAFx06\_Proceedings.brf} +%^^A \item one last compile, and the backref are ok! +%^^A \item Rk: one should NOT recompile the bibliography without doing this manipulation again +%^^A \end{itemize} +%^^A \item generate the \file{DAFx06\_Proceedings.brf} file by hand! +%^^A \begin{itemize} +%^^A \item create the general backref file \file{DAFx06\_Proceedings.brf} using lines such as:\\ +%^^A \begin{verbatim} +%^^A\backcite{Ref1,Ref2,Ref3}{{12}% +%^^A {(document)}{Doc-Start}} +%^^A \end{verbatim} +%^^A \item update all pages numbers in the \file{DAFx06\_Proceedings.brf} back references file +%^^A \item have a back reference for each page where the reference is appearing (maybe several for each paper). +%^^A \item save your \file{DAFx06\_Proceedings.brf} file under another name, since it will be erase by the next bib compilation +%^^A \end{itemize} +% +% +% +%^^A ================================================================= +% \subsection{Some considerations on bibliographies} +% +% +%^^A ================================================================= +% \subsubsection{Which bib styles for the templates?} +% +% Concerning the paper bibliography style, each conference has its own style, often derived from other ones. For instance, the DAFx-06 templates were using the \package{IEEEbib.bst} style. It however is quite old (1993), and not as compact as the latest \package{IEEEtran.bst}. As the DAFx proceedings use the order of appearance and not alphabetical sorting (as do the IEEE publications it was inspired from), the more recent \package{IEEEtranS.bst} style was not suited. The DAFx-06 templates were corrected so as to use \package{IEEEtran.bst} instead of \package{IEEEbib.bst} before insertion of papers into the proceedings. +% +%^^A ================================================================= +% \subsubsection{Which bib styles for the general bibliography?} +% +% Concerning the general bibliography, the style may be a bit different, as it does not need any numbering. Moreover, we want alphabetical sorting this time, in order to simplify the search for any particular author cited. Therefore, we need to use another bibliographic style than the paper templates one! +% +% The style to use has to look more like APA style, with the first author's last name coming first. For that reason, we used the \package{newapa} style, and derived the \package{newapave} style with minor cosmetic tweaking (those styles have no numbering, the author list is like ``Lastname, F.'', etc). +% +%^^A ================================================================= +% \subsubsection{Right-flushing the biblio back-references} +% +% Usually, the back-references provided by the \package{hyperref} package are a list of numbers that follow the end of the bibliographic items (after the last dot). For instance in the example using the \package{newapa} bibliographic style, one would obtain:\\ +% +% \begin{center} +% \begin{minipage}[c]{9cm} +% \vspace*{-0.2cm}Arfib, D. (1998). Different ways to write digital audio effects programs. +% In {\em Proc. of the COST-G6 Workshop on Digital Audio Effects (DAFx-98)}, +% Barcelona, Spain, (pp. 188--91). \color{blue}6, 11, 16, 22, 29 \color{black} +% \end{minipage} +% \end{center} +% +% We modified the \package{newapa.bst} (resp. \package{newapa.sty}) file by making slight changes (but in many places), and renamed it \package{newapave.bst} (resp. \package{newapave.sty}) for the DAFx-06 proceedings. This modification process was carried out to provide some changes and adjustements in the bibliography style and layout (no parenthesis around page numbers nor around the year; and year is placed at the end), as well as right-flushed back-references. Using the \package{newapa} bibliographic style, the previous example is then modified in:\\ +% +% \begin{center} +% \begin{minipage}[c]{9cm} +% \vspace*{-0.2cm}Arfib, D. Different ways to write digital audio effects programs. +% In {\em Proc. of the COST-G6 Workshop on Digital Audio Effects (DAFx-98)}, +% Barcelona, Spain, pp. 188--91. 1998. \hfill \color{blue}6, 11, 16, 22, 29\color{black} +% \end{minipage} +% \end{center} +% +% With the color links, it is visually easier to see the back-references when they are right-flushed that when they are left-flushed. If you wanted to apply the right-flushed back-references to another style, here is the only trick to keep from the hack. +% Edit the function that displays the last item of the bibliographic element list (\package{output.year.check} in our case, because it was reformatted) so as to add a \package{$\backslash$hfill} at the end of that command (the year definition in our example):\begin{verbatim} +%FUNCTION {output.year.check} +%{ year empty$ +% { ``empty year in `` cite$ * warning$ } +% { write$ +% `` (" year * extra.label * ``)" * +% mid.sentence 'output.state := +% } +% if$ +%} +%\end{verbatim} +% +% {\bf Important note}: if the last displayed item (in our case, the year) was not in last position, you also need to edit the following functions defined under the \verb+FUNCTION {name}+ format (not exhaustive list): \verb+article+, \verb+book+, \verb+booklet+, \verb+inbook+, \verb+incollection+, \verb+inproceedings+, \verb+manual+, \verb+masterthesis+, \verb+misc+, \verb+phdthesis+, \verb+proceedings+, \verb+techreport+, and \verb+unpublished+. +% For instance:\begin{verbatim} +%FUNCTION {misc} +%{ output.bibitem +% format.authors output +% author format.key output % added +% output.year.check % added +% title howpublished new.block.checkb +% format.title output +% new.block +% howpublished output +% new.block +% note output +% fin.entry +%\end{verbatim} was replaced with:\begin{verbatim} +%FUNCTION {misc} +%{ output.bibitem +% format.authors output +% author format.key output +% title howpublished new.block.checkb +% format.title output +% new.block +% howpublished output +% new.block +% note output +% output.year.check % moved +% fin.entry +%\end{verbatim} +% The Unix \verb+diff+ command may help you to compare the original (\package{newapa.bst}) and modified (\package{newapave.bst}) versions of the bibliography style files. +% +%^^A ================================================================= +% \subsubsection{Ensuring that the biblio back-references are right-flushed} +% +% With this hack in the bibliography style, all bibliography back-references should appear as right-flushed. However, it sometimes does not work, due to some \LaTeX{} formatting mechanisms I am not competent to identify. Then, sometimes, a list of numbers will see its last item appearing alone on next line, even though there obviously was enough space on the previous line where the other numbers appear. I noticed that some minor reformatting of the concerned bibliographic item could solve this issue. There is no way to automatically do this, nor general rule, only a few tricks I found efficient to solve this issue in 6 items of the DAFx-06 proceedings: +% \begin{itemize} +% \item moving from optional to compulsory a bib item field; %^^A (such as the proceedings volume number for a proceedings paper); +% \item replacing a \verb+---+ by a \verb+--+ (arg! so ugly...); +% \item adding a missing space (\eg{} between the thesis number and the URL); +% \item using hyphenation at your advantage: you may sometimes get a reference for which the layout will not hyphen the end of the title, just before the last line (this is the reason I suspect to mess the whole process behind the \verb+\hfill+ command). +% \end{itemize} +% +% +%^^A ================================================================= +% \subsection{Quality and production} +% +% We present here some other ideas dealing with the production and the quality of the proceedings. Indeed, to provide the best possible quality proceedings, you may have to edit the individual papers (see sec. \ref{sec:misc:editing}), which can be simplified by sending notes to authors before they submit the final version (see sec. \ref{sec:misc:notes}). You may also want to use only \LaTeX, which may require to convert all Word files to \LaTeX\ when the proceedings templates are provided in the 2 formats to authors (see sec. \ref{sec:misc:word2latex}). The last comments are about the graphical quality (sec. \ref{sec:misc:graph:quality}) and the necessary font embedding in the PDF images (see sec. \ref{sec:misc:images:fonts}). +% +% +%^^A------------------------------------------------------------------------ +% \subsubsection{Editing the papers}\label{sec:misc:editing} +% +% For each paper, we checked: +% \begin{itemize} +% \item proper use of US letter instead of A4 format; +% \item title has a \verb+\break+ at the right place; +% \item affiliation type chosen is the good one and has the minimal size; +% \item affiliation is properly layed out; +% \item author's email exists and works; +% \item captions are italic, with a ``.'' at the end; +% \item all figures are referenced in the text; +% \item bibliographic items have a volume and number, as well as page number or preprint number (AES convention); +% \item bibliographic items are using generally defined strings, so as to be identical each time they are cited; +% \item math units: Physics convention is roman, not italic (\ie{} not LaTeX's math style). Ex: $5$ Hz, and not $5Hz$. +% \end{itemize} +% +% \noindent So as to ensure a uniform look, we changed for all papers: +% \begin{itemize} +% \item the URL font to sans-serif, as its default font is too wide. We added the following command in the preamble of each paper:\\ +% \verb+\usepackage{url}\urlstyle{sf}+ +% \item all \verb+\href{}{}+ commands related to URL (\ie{} all except emails) where converted to URL, as it is more apropriated (it does the hyphenations for you and most of the time it does it better). +% \end{itemize} +% +% \noindent Some not-so-minor comments: +% \begin{itemize} +% \item the only way to do a valid line breaks (with the \file{dafx06.sty} style) in the paper title was not with \verb+\newline+, nor \verb+\\+, but with the \verb+\break+ command (we also noticed that using \verb+\linebreak+ creates unbalanced titles). That way, it works similarly for both the title and the pdftitle in metadata. +% \item using the \package{balance.sty} package allows to well balance the last page, which is especially useful for the bibliography. +% \end{itemize} +% +% +%^^A------------------------------------------------------------------------ +% \subsubsection{Improving the layout quality: Sending edition notes to authors}\label{sec:misc:notes} +% +% In order to improve the quality of the proceedings, we listed many common errors and gave a feedback to authors of all accepted papers. This is how we proceeded: +% \begin{enumerate} +% \item examine all papers and list the common errors and electronic paper info (PDF version, PDF generator, valid hyperref, etc) (10 h); +% \item create the full list of problems, in an \file{.csv} file, with papers' title, index and author's email (1/2 h); +% \item fill in, column by column, the data (30 h) with people's errors; +% \item write a Perl script to convert info in this file into usual sentences and indications of what to do in order to improve the paper quality (4 h); +% \item write an AppleScript converting this text file into a list of email texts, ready to be sent to authors (4 h). +% \end{enumerate} +% Those scripts are not provided in the package, but could be on popular demand. +% +% +%^^A------------------------------------------------------------------------ +% \subsubsection{Manual Word to \LaTeX\ conversion}\label{sec:misc:word2latex} +% +% If you really want to automatize all the processes in you proceedings making, you may want to get rid of non-\LaTeX\ generated documents. If you really cannot ask the conference authors to use \LaTeX, you will have to convert files by yourself. From our experience in DAFx-06, here are the steps to follow: +% \begin{enumerate} +% \item copy and paste the whole text; +% \item update the header (author, title, affiliation); +% \item add sections, subsections, etc. according to the original text; +% \item insert figures and tables with the proceedings template style; +% \item update captions with the proceedings template style; +% \item update labels and references for figures and tables; +% \item edit equations (inside the text and as separated formulae); +% \item update labels and references for equations ; +% \item update labels and references for sections, subsections, etc.; +% \item replace all Word quotes ^^A(double “”‟ and single ‛’ quotes) +% by \LaTeX\ quotes (double ``'', and single `' quotes) to avoid they disappear (Unicode-related issue); +% \item correct any specific formatting such as italic, capitals, bold, etc; +% \item remove useless hyphenations ``-'' produced as line breaks by Word; +% \item replace remaining hyphens by the proper corresponding one: hyphen `-', semi-quadratin `--' and quadratin `---'. +% \end{enumerate} +% +%^^A------------------------------------------------------------------------ +% \subsubsection{How to ensure the graphical quality?}\label{sec:misc:graph:quality} +% +% The best way to ensure excellent quality for you graphics in the electronic version of you proceedings consists in using vectorial images, \ie{} postscript (\file{.ps} or \file{.eps}) or \file{.pdf} files. It should be the same for the printed version, except that the font problem with Matlab described in sec. \ref{sec:misc:images:fonts} may imply to convert vectorial images to bitmap images (such as \file{.png} or \file{.gif}). +% +% +%^^A------------------------------------------------------------------------ +% \subsubsection{How to ensure your fonts are embedded in the PDF?}\label{sec:misc:images:fonts} +% +% With Matlab, the system fonts such as Arial or Helvetica are not embedded at all in the \file{.pdf} nor in the \file{.eps} file. This can be checked by converting any of the two into another format using Ghostscript. For instance, converting a \file{.pdf} to \file{.ps} using \file{pdf2ps} will show the following log info:\begin{verbatim} +% **** Warning: Fonts with Subtype = /TrueType should be embedded. +% The following fonts were not embedded: +% Arial-ItalicMT +% ArialMT +% +% **** This file had errors that were repaired or ignored. +% **** The file was produced by: +% **** >>>> pdfTeX-0.14h <<<< +% **** Please notify the author of the software that produced this +% **** file that it does not conform to Adobe's published PDF +% **** specification. +%\end{verbatim} +% You can check the same by processing a PDF files produced by Matlab using Acrobat Distiller (\$), and you will get the same errors.. +% +% Therefore, when printing on a system that is not yours (and that may be the one you will use to print the proceedings), the printer may be set such as not to replace a missing font by a similar one. Then, Matlab text can be totally scrapped, replaced by other numbers, letters, and so on! +% +% One first step of a solution was to use Acrobat Professional (\$), with the PitStop plug-ins (\$ again), and set is so as to create a report and solve problems concerning partially or not embedded fonts. Unfortunately, the problem is not exactly the font embedding, but the glyph table mapping that is wrong. % +% Another solution consists in converting the PDF files into a bitmap format. It is quite dirty, since it pixellizes a vectorial image, but at least, it is able to print! For instance, we converted {\file{.pdf} images with font problems into \file{.png} format, with a figure width of 8cm and a 600 dpi resolution (this seems too much resolution for printers, as 300 dpi may be enough), and it did the trick. +% +% +% \changes{0.1c}{2007/07/30}{Customization: \file{confproc.cfg}} +% +% +% +% +% +% \vspace*{2cm} +% It now seems that you have all the necessary files and information with a functional and complete example in order to produce you own conference proceedings! +% +% \changes{0.1d}{2007/07/31}{Example: removing old code from previous example} +% Have fun using \package{\filename}!!! +% +%^^A ================================================================= +%^^A We insert the `small print' here. +%^^A ================================================================= +% {\vfill\hfill\scriptsize\package{\filename} is Copyright +% \copyright\ 2007 by Vincent Verfaille +% <vincent@music.mcgill.ca> +% \vspace{1cm} +% +% There is no warranty for the \package{\filename}~package. I +% provide \package{\filename} `as is', without warranty of any +% kind, either expressed or implied, including, but not limited to, +% the implied warranties of merchantability and fitness for a +% particular purpose. The entire risk as to the quality and +% performance of \package{\filename} is with you. Should +% \package{\filename} prove defective, you assume the cost of all +% necessary servicing, repair, or correction. +% +% The \package{\filename}~package may be distributed and/or +% modified under the conditions of the \LaTeX\ Project Public +% License (see \cite{latex3-project:1999:lppl}), either version 1.2 +% of this license or (at your option) any later version. +% +% The latest version of this license is in +% \href{http://www.latex-project.org/lppl.txt}{\sf http://www.latex-project.org/lppl.txt} and version 1.2 or +% later is part of all distributions of \LaTeX\ version 1999/12/01 +% or later.}\par\newpage +% +%^^A ================================================================= +%^^A The `user' documentation ends here, or strictly speaking: it +%^^A ends after the following stuff (the argument of +%^^A \StopEventually). In case of the `user' docu it will be +%^^A appended here, in case of the `programmer' docu it will be +%^^A delayed and inserted below at \Finale +%^^A ================================================================= +% +% \StopEventually{ +% +% \changes{0.2a}{2007/08/12}{Biblio: adding items for the report} +% \changes{0.2g}{2007/09/07}{Biblio: adding missing URLs} +%^^A ================================================================= +%^^A We can't get enough! Of course we also want a bibliography ;-) +%^^A ================================================================= +% \addcontentsline{toc}{section}{References} +% \begin{thebibliography}{1} +% +% \bibitem{Pakin:2004:howto:package} +% Scott Pakin +% \newblock How to Package Your \LaTeX{} Package +% \newblock \ctan: \href{http://www.ctan.org/tex-archive/info/dtxtut/}{\sf www.ctan.org/tex-archive/info/dtxtut/}, November 2004. +% +% \bibitem{LaTeX:class:writers} +% The \LaTeX{}3 Project. +% \newblock \LaTeX2e for class and package writers. +% \newblock \ctan: \href{http://tug.ctan.org/tex-archive/macros/latex/base/cls.dtx}{\sf macros/latex/base/cls.dtx}, March 1999. +% +% \bibitem{mittelbach:1999:docstrip} +% Frank Mittelbach, Denys Duchier, Johannes Braams, Marcin +% Woli{\'{n}}ski, and Mark Wooding. +% \newblock The {DocStrip} program. +% \newblock \ctan: \href{http://tug.ctan.org/tex-archive/macros/latex/base/docstrip.dtx}{\sf macros/latex/base/docstrip.dtx}, March 1999. +% +% \bibitem{latex3-project:1999:lppl} +% The~{\LaTeX}3 Project. +% \newblock The {\LaTeX} {P}roject {P}ublic {L}icense. +% \newblock {\sc Url:} \href{http://www.latex-project.org/lppl.txt}{\sf www.latex-project.org/lppl.txt}, September 1999. +% +% \bibitem{Brazil:2002} +% Eoin Brazil. +% \newblock Creating Conference Proceedings: Tips And Tricks From The Trenches. UL-IDC-02-03. +% \newblock {\sc Url:} \href{http://richie.idc.ul.ie/eoin/research/UL-IDC-02-03.pdf}{\sf richie.idc.ul.ie/eoin/research/UL-IDC-02-03.pdf}, +% \newblock Interactive Design Centre, University of Limerick, 2002. +% +% \bibitem{mini:eConf} +% SLAC +% \newblock eConf: Full-Text Proceeding Instructions and Templates +% \newblock {\sc Url:} \href{http://www.slac.stanford.edu/econf/editors/fulltext-template/instructions.html}{\sf www.slac.stanford.edu/econf/editors/fulltext-template/instructions.html}, Retrieved on Sept. 2007 +% +% \bibitem{AMS:editor} +% American Mathematical Society +% \newblock Guide to AMS Editor's package +% \newblock {\sc Url:} \href{http://www.ams.org/authors/editpkg.html}{\sf www.ams.org/authors/editpkg.html}, Retrieved on Sept. 2007 +% +% \bibitem{Adobe:2007:Acrobat} +% Adobe systems Inc. +% \newblock Acrobat Professional +% \newblock {\sc Url:} \href{http://www.adobe.com/products/acrobatpro/}{\sf www.adobe.com/products/acrobatpro/}, Retrieved on Sept. 2007. +% +% \bibitem{Wilson:2004:combine} +% Peter Wilson. +% \newblock The \package{combine} class and the \package{combinet}, \package{combnat} and \package{combcite} packages +% \newblock \ctan: \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/combine/}{\sf macros/latex/contrib/combine/}, March 2004. +% +% \bibitem{hyperref} +% Sebastian Rahtz and Heiko Oberdiek. +% \newblock The \package{hyperref} package. +% \newblock \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref/}{\sf macros/latex/contrib/hyperref/}, September 2006. +% +% \bibitem{Matthias:2004:pdfpages} +% Andreas Matthias. +% \newblock The \package{pdfpages} package. +% \newblock \ctan: \href{http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/}{\sf macros/latex/contrib/pdfpages/}, 2004. +% +% \bibitem{Verfaille:2006:howto:web} +% Vincent Verfaille. +% \newblock How to make your own proceedings for another conference? +% \newblock {\sc Url:} \href{http://www.dafx.ca/dafx06_proceedings_diy.html}{\sf http://www.dafx.ca/dafx06\_proceedings\_diy.html}, October 2006. +% +% \bibitem{Verfaille:2006:howto:confproc} +% Vincent Verfaille. +% \newblock Report on the edition of the DAFx-06 proceedings. +% \newblock {\sc Url:} \href{http://www.dafx.ca/proceedings/report.pdf}{\sf http://www.dafx.ca/proceedings/report.pdf}, March 2007. +% +% \end{thebibliography} +% +% ^^A\bibliography{confproc} +% ^^A\bibliographystyle{plain} +% +%^^A ================================================================= +%^^A By default we'll build the `user' docu, that is: without an +%^^A index. But if the user made an index we should include it. +%^^A ================================================================= +% \addcontentsline{toc}{section}{Index} +% \PrintIndex +% +%^^A ================================================================= +%^^A Same as with the index above: if the user has specified +%^^A `RecordChanges' in her `ltxdoc.cfg', we should print the +%^^A changes here. +%^^A ================================================================= +% \addcontentsline{toc}{section}{Change history} +% \PrintChanges +% +%^^A ================================================================= +%^^A Make sure that the index and the changes are not printed twice +%^^A since ltxdoc.cfg might have a second \PrintIndex or +%^^A \PrintChanges command. (See everysel.dtx by Martin Schr\"oder) +%^^A ================================================================= +% \let\PrintChanges=\relax +% \let\PrintIndex=\relax +% } ^^A end of \StopEventually +% +% \changes{0.1d}{2007/07/31}{Implementation: bug for creating class corrected} +% \changes{0.1d}{2007/07/31}{Implementation: moved into the document itself} +%^^A ================================================================= +%^^A The following will only be included into the `programmer' docu +%^^A We follow the structure suggested in [Kopka: `LateX', Vol. 3, +%^^A section 2.5] +%^^A ================================================================= +% \section{Implementation} +% \label{sec:implement} +% +% \emph{Please note:} The macros containing a `@' are internal +% commands. They do \emph{not} belong to the user interface and +% should not be called directly by the end user! You may get +% unpredictable results if you don't know what you are doing. +% Internal macros may be changed by me without announcement or +% warning, so be careful. Use them at your own risk if you cannot +% resist\ldots +% +%^^A ================================================================= +%^^A Initial initialization +%^^A ================================================================= +% \subsection{Initialization} +% \label{subsec:init} +% +% As you can see, this package is based on the book package for all its layout aspects. +% \changes{0.1g}{2007/08/06}{Doc: adding comments to the class code} +% \begin{macrocode} +%<*package> +\LoadClass{book} +% \end{macrocode} +% +% \changes{0.2g}{2007/09/07}{Options: adding DescribeMacro for all} +%^^A ================================================================= +%^^A Declaration of the options we want to provide +%^^A ================================================================= +% \subsection{Option declaration} +% \label{subsec:optiondeclare} +% +% \subsubsection{Options of the \package{book} package} +% +% Right now, options about paper size and font sizes are used to set the document parameters. For paper size, only \DescribeMacro{a4paper}\Lopt{a4paper}: +% \begin{macrocode} +\DeclareOption{a4paper} + {\setlength\paperheight {297mm}% + \setlength\paperwidth {210mm}% + \setlength\oddsidemargin {-4.95truemm}% + \setlength\evensidemargin {-10.95truemm}% + \def\shiftsafourpaper{}} +% \end{macrocode} +% and \DescribeMacro{letterpaper}\Lopt{letterpaper}: +% \begin{macrocode} +\DeclareOption{letterpaper} + {\setlength\paperheight {11in}% + \setlength\paperwidth {8.5in}% + \setlength\oddsidemargin {-4.95truemm}% + \setlength\evensidemargin {-4.95truemm}% + \def\shiftsletterpaper{}} +% \end{macrocode} +% are defined. They are use to set the document and also passed to the book package. +% \begin{macrocode} +\PassOptionsToPackage{a4paper,letterpaper}{book} +\PassOptionsToPackage{a4paper,letterpaper}{hyperref} +% \end{macrocode} +% Only three font sizes are supported yet (namely 10pt\DescribeMacro{10pt,11pt,12pt}, 11pt and 12pt), as it did not seem obvious to me how bigger/smaller font sizes could be useful for proceedings. +% \begin{macrocode} +\DeclareOption{10pt}{\renewcommand\@ptsize{0}} +\DeclareOption{11pt}{\renewcommand\@ptsize{1}} +\DeclareOption{12pt}{\renewcommand\@ptsize{2}} +% \end{macrocode} +% Both \DescribeMacro{oneside} \Lopt{oneside} and \DescribeMacro{twoside} \Lopt{twoside} options are re-defined, exactly as they were in the book package: +% \begin{macrocode} +\DeclareOption{oneside}{\@twosidefalse \@mparswitchfalse% + \def\conf@WithClearsinglepage{}} +\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue% + \def\conf@WithCleardoublepage{}} +% \end{macrocode} +% Right now, they are not passed to the book package. +%^^A \begin{macrocode} +%^^A\PassOptionsToPackage{10pt,11pt,12pt,twoside,oneside}{book} +%^^A \end{macrocode} +% We define both \DescribeMacro{onesidepapers} \Lopt{onesidepapers} and \DescribeMacro{twosidepapers} \Lopt{twosidepapers} options, to allow or not for a double page clear after each paper (so that they all start on a right and odd page, as for chaters in a book): +% \begin{macrocode} +\DeclareOption{onesidepapers}{% + \def\conf@WithClearsinglepagePapers{}} +\DeclareOption{twosidepapers}{% + \def\conf@WithCleardoublepagePapers{}} +% \end{macrocode} +% +% \subsubsection{Options passed to the \package{hyperref} package} +% +% \changes{0.1i}{2007/08/10}{Options: no more re-definition of \package{hyperref} options: all options specific to the \package{hyperref} package are passed to it as unknown options of \package{\filename}.} +% In its very first version, the \package{\filename} package was passing the following \package{hyperrref}-specific options to it: \Lopt{colorlinks}, \Lopt{colorlinks} and \Lopt{colorlinks=true}, \Lopt{colorlinks=false}, \Lopt{linkcolor}, \Lopt{citecolor}, \Lopt{urlcolor}, \Lopt{pagecolor}, \Lopt{bookmarksopen}, \Lopt{bookmarksopen=true}, \Lopt{bookmarksopen=false}. Not knowing how to use the \package{keyval} package, I used a simple and dirty trick, re-defining and passing these options, but it was limitating the customization of \package{hyperref} to what I believed was useful. So, to remove this biais, I treat them as any unknown options, that are passed to the \package{hyperref} package. If you decide to use other options of \package{hyperref}, you may unfortunately break some of the mechanisms for the proceedings making. +% +% \changes{0.2b}{2007/08/16}{Options: changing \Lopt{bibmergecompil} to 'compil=bibmerge', \Lopt{bibbackrefcompil} to 'compil=bibbackref' and \Lopt{finalcompil} to 'compil=final'} +% \changes{0.2d}{2007/08/18}{Cmds: renaming all internal commands by adding the `conf\@' prefix} +% \changes{0.2e}{2007/09/01}{Options: finishing the description of the class options} +%^^A ================================================================= +% \subsubsection{Options specific to the \package{\filename} package}\label{sec:def:options:confproc} +% +% \subsubsection*{Compilation step:} changes the page numbering and the speed of the \LaTeX\ run. +% For working on the bibliography merging process with \Lopt{compil=bibmerge}\DescribeMacro{compil=bibmerge}: +% \begin{macrocode} +\DeclareOption{compil=bibmerge} + {\typeout{confproc: LaTeX run-> bib. items only (merging process)}% + \def\conf@BibMerge{}} +% \end{macrocode} +% The \Lopt{compil=bibbackref} \DescribeMacro{compil=bibbackref} option is to be used to create proper index and table of contents page numbering, as well as back-references: +% \begin{macrocode} +\DeclareOption{compil=bibbackref} + {\typeout{confproc: LaTeX run-> generating biblio back references}% + \def\conf@BibBackRef{}} +% \end{macrocode} +% The compilation option \Lopt{compil=last} \DescribeMacro{compil=last} option is to be used at last (when all proper page numbers and back references have been generated): +% \begin{macrocode} +\DeclareOption{compil=last} + {\typeout{!!! confproc: LaTeX run-> LAST !!!}% + \def\conf@FinalVersion{}} +% \end{macrocode} +% +% \subsubsection*{Draft/final} +% The \Lopt{draft} \DescribeMacro{draft} option is passed to the \package{pdfpages} package to speed up \LaTeX\ runs: +% \begin{macrocode} +\DeclareOption{draft} + {\typeout{confproc: not including PDF files}% + \PassOptionsToPackage{draft}{pdfpages}% + \def\conf@DoNotIncludePDFs{}} +% \end{macrocode} +% as well as the \Lopt{final} \DescribeMacro{final} option (no speed up of \LaTeX\ runs): +% \begin{macrocode} +\DeclareOption{final} + {\typeout{confproc: including PDF files}% + \PassOptionsToPackage{final}{pdfpages}% + \def\conf@IncludePDFs{}} +% \end{macrocode} +% +% \subsubsection*{Electronic/printed} +% For an electronic document (color hyperlinks), we define the \Lopt{electronic} \DescribeMacro{electronic} option: +% \begin{macrocode} +\DeclareOption{electronic}% + {\typeout{confproc: adding colors for hyperlinks}% + \PassOptionsToPackage{colorlinks=true}{hyperref}% + \def\conf@procWithColors{}} +% \end{macrocode} +% For a printed document (black hyperlinks), we define the \Lopt{printed} \DescribeMacro{printed} option: +% \begin{macrocode} +\DeclareOption{printed}% + {\typeout{confproc: hyperref with no color for hyperlinks} + \PassOptionsToPackage{colorlinks=false}{hyperref}% + \def\conf@procWithoutColors{}} +% \end{macrocode} +% +% \subsubsection*{Headers} +% We define four options for adding headers on some specific pages only:\\ +% on no page with the \Lopt{headers=no} \DescribeMacro{headers=no} option (default): +% \begin{macrocode} +\DeclareOption{headers=no}% + {\typeout{confproc: no fancy headers}% + \def\conf@NoFancyHeaders{}} +% \end{macrocode} +% on inserted PDFs only with the \Lopt{headers=pdfonly} \DescribeMacro{headers=pdfonly} option: +% \begin{macrocode} +\DeclareOption{headers=pdfonly}% + {\typeout{confproc: fancy headers on inserted PDFs only}% + \def\conf@FancyHeadersOnPapers{}} +% \end{macrocode} +% on all pages except the inserted PDFs, with the \Lopt{headers=exceptpdf} \DescribeMacro{headers=exceptpdf} option: +% \begin{macrocode} +\DeclareOption{headers=exceptpdf}% + {\typeout{confproc: fancy headers for all pages except PDFs}% + \def\conf@FancyHeadersExceptPapers{}} +% \end{macrocode} +% and on all pages with the \Lopt{headers=allpages} \DescribeMacro{headers=allpages} option: +% \begin{macrocode} +\DeclareOption{headers=allpages}% + {\typeout{confproc: fancy headers on all pages, PDFs included}% + \def\conf@FancyHeadersOnPapers{}% + \def\conf@FancyHeadersExceptPapers{}} +% \end{macrocode} +% +% \subsubsection*{Two/three columns index of authors} +% The \Lopt{twocolindex} \DescribeMacro{twocolindex} option provides a 2 columns index of authors: +% \begin{macrocode} +\DeclareOption{twocolindex} + {\typeout{confproc: 2 columns index}% + \def\conf@TwoColumnIndex{}} +% \end{macrocode} +% whereas the \Lopt{threecolindex} \DescribeMacro{threecolindex} provides a 3 column index of authors (default): +% \begin{macrocode} +\DeclareOption{threecolindex} + {\typeout{confproc: 3 columns index}% + \def\conf@ThreeColumnIndex{}} +% \end{macrocode} +% \changes{0.2c}{2007/08/17}{Options: adding \Lopt{onecolbib} and \Lopt{twocolbib} options} +% +% \subsubsection*{One/two columns general bibliography} +% The \Lopt{twocolbib} \DescribeMacro{twocolbib} option provides a 2 columns bibliography (default): +% \begin{macrocode} +\DeclareOption{twocolbib} + {\typeout{confproc: 2 columns biblio}% + \def\conf@TwoColumnBib{}} +% \end{macrocode} +% whereas the \Lopt{onecolbib} \DescribeMacro{onecolbib} option provides a 1 column bibliography: +% \begin{macrocode} +\DeclareOption{onecolbib} + {\typeout{confproc: 1 column biblio}% + \def\conf@OneColumnBib{}} +% \end{macrocode} +% +% \changes{0.1i}{2007/08/10}{Options: adding \Lopt{onecoltoc} and \Lopt{twocoltoc} options} +% \subsubsection*{One/two columns table of contents} +% The \Lopt{twocoltoc} \DescribeMacro{twocoltoc} option provides a 2 columns table of contents: +% \begin{macrocode} +\DeclareOption{twocoltoc} + {\typeout{confproc: 2 columns TOC}% + \def\conf@TwoColumnTOC{}} +% \end{macrocode} +% whereas the \Lopt{onecoltoc} \DescribeMacro{onecoltoc} option provides a usual 1 column table of contents (default): +% \begin{macrocode} +\DeclareOption{onecoltoc} + {\typeout{confproc: 1 column TOC}% + \def\conf@OneColumnTOC{}} +% \end{macrocode} +% +% \subsubsection*{Numbering the table of contents} +% the table of contents can be numbered on the left using the \Lopt{tocnumleft} \DescribeMacro{tocnumleft} option: +% \begin{macrocode} +\DeclareOption{tocnumleft} + {\typeout{confproc: TOC numbering on left}% + \def\conf@TocNumberingLeft{}} +% \end{macrocode} +% or on the right using the \Lopt{tocnumright} \DescribeMacro{tocnumright} option: +% \begin{macrocode} +\DeclareOption{tocnumright} + {\typeout{Confproc: TOC numbering on right}% + \def\conf@TocNumberingRight{}} +% \end{macrocode} +% +% \subsubsection*{Moving footer with page number} +% Move the footer (to check page numbers) with the \Lopt{movepagenumbers} \DescribeMacro{movepagenumbers} option: +% \begin{macrocode} +\DeclareOption{movepagenumbers} + {\typeout{confproc: moving page numbers to check PDFs numbering}% + \def \conf@TestPageNumbering{}} +% \end{macrocode} +% +% \subsubsection*{Clearpage} clear single or double page, depending if the document is oneside or twoside, with the \Lopt{clearsinglepage} \DescribeMacro{clearsinglepage} and \Lopt{cleardoublepage} \DescribeMacro{cleardoublepage} options: \\ +% \color{red} {\sc Is this still useful???}\color{black}\\ +% \begin{macrocode} +\DeclareOption{cleardoublepage}% + {\typeout{confproc: using double page clearing}% + \def\conf@WithCleardoublepage{}} +\DeclareOption{clearsinglepage}% + {\typeout{confproc: using double page clearing}% + \def\conf@WithClearsinglepage{}} +% \end{macrocode} +% Define \Lopt{debug} \DescribeMacro{debug,verbose} and \Lopt{verbose} options to print debug (\package{\filename} and \package{hyperref}): +% \changes{0.2a}{2007/08/12}{Options: adding the \Lopt{verbose} option} +% \changes{0.2b}{2007/08/16}{Options: adding the \Lopt{debug} option} +% \begin{macrocode} +\DeclareOption{debug} + {\typeout{Confproc: printing debug for confproc, hyperref}% + \PassOptionsToPackage{debug}{hyperref}% + \def\conf@procWithDebug{}} +\DeclareOption{verbose} + {\typeout{Confproc: printing debug for confproc, hyperref}% + \PassOptionsToPackage{debug}{hyperref}% + \def\conf@procWithDebug{}} +% \end{macrocode} +% We are now done withe the options declarations. +% +%^^A ================================================================= +% \subsection{Options processing} +% +%^^A ================================================================= +% \subsubsection{Unknown options} +% +% Give a warning for unknown options, and pass them by default to \package{hyperref}: +% \changes{0.1i}{2007/08/10}{Options: passing all unknown options to \package{hyperref}, to avoid redefining all link colors, etc.} +% \begin{macrocode} +\DeclareOption*{\PackageWarning{procconf}% + {Unknown option `\CurrentOption'; passed to 'hyperref'}% + \PassOptionsToClass{\CurrentOption}{hyperref}} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Default values for options} +% +% Options that are not set by the user have the following default settings: +% \changes{0.1i}{2007/08/10}{Option: changing default link colors for \package{hyperref}} +% \begin{macrocode} +\ExecuteOptions{letterpaper,10pt,twoside,twosidepapers,% + compil=bibbackref,tocnumleft,onecoltoc,threecolindex,twocolbib,% + colorlinks=true,linkcolor=red,citecolor=blue,pagecolor=red,urlcolor=blue,% + bookmarksopen=true,bookmarksopenlevel=1,headers=no} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Options processing} +% +% Options can now be processed: +% \begin{macrocode} +\ProcessOptions +% \end{macrocode} +%^^A ================================================================= +% \subsection{Required packages} +% +% Several packages are included, among which many are required. \\ +% The \package{graphicx} package is for users to insert logos (first page, welcome letters): +% \begin{macrocode} +\RequirePackage{graphicx} +% \end{macrocode} +% Use the \package{pdfpages} package (core of this class) to insert the paers as PDF documents, page-by-page, as images: +% \begin{macrocode} +\RequirePackage{pdfpages} +% \end{macrocode} +% Use the \package{fancyhdr} package to customize the headers and footers so that they match those of the the paper templates: +% \begin{macrocode} +\RequirePackage{fancyhdr} +% \end{macrocode} +% Use the \package{tocbibind} package to change the \cmd{\indexname} command; its options are to disable automatic insertion in the table of contents (hand made insertion instead): +% \begin{macrocode} +\RequirePackage[nottoc,notbib,notindex]{tocbibind} +% \end{macrocode} +% Use the \package{titletoc} package (part of the \package{titelsec} package) to change the table of contents layout (order of text, numbers, fonts, etc.): +% \begin{macrocode} +\RequirePackage{titletoc} +% \end{macrocode} +% Use \package{multitoc} with the \Lopt{toc} option for a two columns table of contents: +% \changes{0.1i}{2007/08/10}{Options: adding \Lopt{onecoltoc} and \Lopt{twocoltoc} options} +% \begin{macrocode} +\ifdefined\conf@TwoColumnTOC + \RequirePackage[toc]{multitoc} +\fi +% \end{macrocode} +% \changes{0.2a}{2007/08/12}{Cmds: get rid of \package{threecolindex.sty} package and related \cmd{\gtindexname} command} +% Use the \package{index} package to enable the creation of the index of authors: +% \begin{macrocode} +\RequirePackage{index} +% \end{macrocode} +% Use the \package{multitoc} package for a multi-columns table of contents or index: +% \changes{0.1i}{2007/08/10}{Options: adding \Lopt{onecoltoc} and \Lopt{twocoltoc} options} +% \begin{macrocode} +\RequirePackage{multicol} +% \end{macrocode} +% Also, when asking for a 2 or 3 columns index, redefine the \cmd{\theindex} environment (modified form the \package{gatech-thesis-index.sty} package) as: +% \begin{macrocode} +\ifdefined\conf@TwoColumnIndex + \renewenvironment{theindex}{% + \if@twocolumn \@restonecolfalse + \else \@restonecoltrue \fi + \vspace*{-0.8cm} + \section*{{\procindexname}} + \let\item\@idxitem + \columnseprule \z@ + \columnsep 35\p@ + \begin{multicols}{2}[% + \ifx\index@prologue\@empty\else + \index@prologue + \bigskip + \fi]% + \parindent\z@ + \parskip\z@ \@plus .3\p@\relax + }{\end{multicols}% + \if@restonecol \onecolumn + \else \clearpage \fi} +\else + \ifdefined\conf@ThreeColumnIndex% + \renewenvironment{theindex}{% + \if@twocolumn \@restonecolfalse + \else \@restonecoltrue \fi + \vspace*{-0.8cm} + \section*{{\procindexname}} + \let\item\@idxitem + \columnseprule \z@ + \columnsep 35\p@ + \begin{multicols}{3}[% + \ifx\index@prologue\@empty\else + \index@prologue + \bigskip + \fi]% + \parindent\z@ + \parskip\z@ \@plus .3\p@\relax + }{\end{multicols}% + \if@restonecol \onecolumn + \else \clearpage \fi } + \fi +\fi +% \end{macrocode} +% Use the \package{sectsy} package to change the sections font in the table of contents: +% \begin{macrocode} +\RequirePackage{sectsty} +% \end{macrocode} +% Use the \package{newapave} style for the general bibliography: +% \begin{macrocode} +\newcommand{\confcite}[1]{\cite{#1}} +\RequirePackage{newapave} +% \end{macrocode} +% If you do not wish to use the one developed for DAFx-06 but prefer to use the original \package{newapa} style, replace this last line in \file{\filename.cls} by:\begin{verbatim} +% \RequirePackage{newapa} +%\end{verbatim} +% Links in the PDF files require to use the \package{color} package: +% \begin{macrocode} +\RequirePackage{color} +% \end{macrocode} +% We predefine here the names and values for the color links, so that they can be used: +% \begin{macrocode} +\definecolor{colorforlink}{rgb}{0,0,0.5} +\definecolor{colorforpage}{rgb}{0,0,0.5} +\definecolor{colorforcite}{rgb}{0,0.5,0} +\definecolor{colorforurl}{cmyk}{0,1,0,0} +% \end{macrocode} +% together with the \package{hyperref} package with the following default options: +% \begin{macrocode} +\RequirePackage[pdftex,raiselinks,hyperindex,backref,pagebackref,% + plainpages=false,pdfpagelabels,breaklinks,linktocpage,% + pdfstartview=XYZ]{hyperref} +% \end{macrocode} +% and with the \package{hypcap} package, for including floats (figures or tables): +% \begin{macrocode} +\RequirePackage[figure,table]{hypcap} +% \end{macrocode} +% +%^^A ================================================================= +% \subsection{Proceedings specific commands} +% +% We now define the default values of some proceedings-specific commands. +% +%^^A ================================================================= +% \subsubsection{PDF metadata} +% +% Define commands to set the PDF metadata: \DescribeMacro{\procpdfauthor}\cmd{\procpdfauthor} for the author: +% \begin{macrocode} +\newcommand{\procpdfauthor}{Proceedings author/editor} +% \end{macrocode} +% \DescribeMacro{\procpdftitle}\cmd{\procpdftitle} for the title: +% \begin{macrocode} +\newcommand{\procpdftitle}{Proceedings title} +% \end{macrocode} +% and \DescribeMacro{\procpdfsubject}\cmd{\procpdfsubject} for the subject: +% \begin{macrocode} +\newcommand{\procpdfsubject}{Proceedings description} +% \end{macrocode} +% These commands are used in the \DescribeMacro{\hypersetup}\cmd{\hypersetup} command: +% \begin{macrocode} +\hypersetup{ + pdfauthor = \procpdfauthor, + pdftitle = \procpdftitle, + pdfsubject = \procpdfsubject, + pdfkeywords = {}, + pdfcreator = {LaTeX with `confproc' package}, + pdfproducer = {pdfLaTeX}} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Page layout} +% +% The proceedings default page layout is: +% \begin{macrocode} +\topmargin 0truept +\headheight 12truept +\footskip 0truept +\textheight 229truemm +\textwidth 175truemm +\voffset -28truept +\headsep 20truept +% \end{macrocode} +% Those values may be changed in the preamble, depending on your paper template. +% +%^^A ================================================================= +% \subsubsection{Special section names} +% +% We define the names of the table of contents (as it should appear in itself): +% \begin{macrocode} +\renewcommand{\contentsname}{\vspace*{-0.8cm}\Large % + \bfseries Conference Program} +% \end{macrocode} +% of the index of authors (in the document and in the table of contents): +% \begin{macrocode} +\newcommand{\procindexname}{\large \bfseries Index of Authors} +% \end{macrocode} +% and of the general bibliography (in the document and in the table of contents): +% \begin{macrocode} +\newcommand{\procbibname}{\large \bfseries Full Bibliography} +% \end{macrocode} +% \changes{0.1g}{2007/08/05}{Cmds: changing \cmd{\bibnametoc} into \cmd{\procbibname}} +% \changes{0.1g}{2007/08/05}{Cmds: changing \cmd{\indexnametoc} into \cmd{\procindexname}} +% +%^^A ================================================================= +% \subsubsection{Header and footer} +% +% We first define the default header: +% \changes{0.2e}{2007/09/01}{Cmds: renaming \cmd{\loclhead} into \cmd{\proclhead}} +% \begin{macrocode} +\newcommand{\proclhead}{\em{\small{Proceedings of the blah blah blah}}} +% \end{macrocode} +% and the default footer: +% \begin{macrocode} +\newcommand{\proccfoot}{{\vskip 11mm}{\small Proc-\thepage}} +% \end{macrocode} +% +% We now define the default page styles for use with headers: +% \changes{0.2e}{2007/09/01}{Cmds: renaming \cmd{\loclhead} into \cmd{\proclhead}} +% \begin{macrocode} +\pagestyle{fancyplain} +% \end{macrocode} +% together with the corresponding settings: +% \begin{macrocode} +\renewcommand{\headrulewidth}{0pt} +\renewcommand{\footrulewidth}{-5mm} +\lhead{\proclhead} +\rhead{} +\lfoot{} +\rfoot{} +\cfoot{\proccfoot}{} +% \end{macrocode} +% Depending on the value of the \Lopt{headers} option, we change the default page style: +% \begin{macrocode} +\ifdefined \conf@FancyHeadersExceptPapers + \pagestyle{fancy} +\else + \pagestyle{empty} +\fi +% \end{macrocode} +% \changes{0.1h}{2007/08/09}{Cmds: changing \cmd{\loccfoot} for \cmd{\proccfoot}, and removing \cmd{\testloccfoot} for a length \cmd{\procoptfootskip}} +% We set the optional vertical shift for the footer (for checking page numbers): +% \begin{macrocode} +\newlength{\procoptfootskip} +\ifdefined\conf@TestPageNumbering% + \setlength{\procoptfootskip}{3mm}% + \cfoot{\vskip \procoptfootskip \proccfoot}% +\else% + \setlength{\procoptfootskip}{0mm}% +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Table of contents layouts} +% +% Using the \package{titletoc} commands, we define the default table of contents layout. +% +% \subsubsection*{Default} +% +% For right numbering: +% \begin{macrocode} +\ifdefined\conf@TocNumberingRight +% \end{macrocode} +% we first set the left margin of papers inserted as sections: +% \begin{macrocode} + \titlecontents{section}[2.5em]% left margin +% \end{macrocode} +% we then set the table of contents spacing between 2 papers: +% \begin{macrocode} + {\vspace*{0.3em}}% space between two papers in the TOC +% \end{macrocode} +% and the filler and page number: +% \begin{macrocode} + {}{}{\contentsmargin{0pt} \hfill \contentspage}% filler and page +% \end{macrocode} +% For left numbering: +% \begin{macrocode} +\else% + \dottedcontents{section}[]{\fillright}{}{1pc} + \titlecontents{section}[2.5em]% + {\vspace*{0.3em}}% +% \end{macrocode} +% we set the left shift of page numbers: +% \begin{macrocode} + {\hspace*{-2.5em}\contentspage\hspace*{2.5em}}% left shifting page num. + {\hspace*{-2.5em}\contentspage\hspace*{2.5em}}% idem + {}% filler and page +\fi +% \end{macrocode} +% +% \subsubsection*{At document frontmatter} +% +% \begin{macrocode} +\newcommand{\tocmattertocstyle}{ +% \end{macrocode} +% Parts are used for the preamble: +% \begin{macrocode} +\titlecontents{part}[-1em]{\addvspace{1pc}}% + {\contentspage\hspace*{3.2em}\contentsmargin{0pt}% + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentspage\hspace*{3.2em}\contentsmargin{0pt}\large}% + {}[\addvspace{.5pc}]} +% \end{macrocode} +% and chapters for each page for the preamble: +% \begin{macrocode} +\titlecontents{chapter}[-1em]{\addvspace{1pc}}% + {\contentspage\hspace*{3.2em}\contentsmargin{0pt}% + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentspage\hspace*{3.2em}\contentsmargin{0pt}\large}% + {}[\addvspace{.5pc}] +% \end{macrocode} +% +% \subsubsection*{At document mainmatter} +% +% Parts are used for days, or for sessions of no days are used; chapters are used for sessions (if days are used); sections are always used for papers. +% \begin{macrocode} +\ifdefined\conf@TocNumberingRight + \newcommand{\mainmattertocstyle}{ + \titlecontents{chapter}[0pt]% + {\addvspace{1pc}\bfseries\itshape}% + {\contentsmargin{0pt}\bfseries% + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentsmargin{0pt}\large}{}[\addvspace{.5pc}]% + \titlecontents{part}[0pt]% + {\addvspace{1pc}\bfseries}% + {\contentsmargin{0pt}\bfseries% + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentsmargin{0pt}\large}{}[\addvspace{.5pc}]% +\else + \ifdefined\conf@TocNumberingLeft% default + \newcommand{\mainmattertocstyle}{% + \titlecontents{chapter}[0pt]% + {\addvspace{1pc}\bfseries \itshape}% + {\contentsmargin{0pt}\bfseries % + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentsmargin{0pt}\large}{}[\addvspace{.5pc}]% + \titlecontents{part}[0pt]% + {\addvspace{1pc}\bfseries}% + {\contentsmargin{0pt}\bfseries % + \makebox[0pt][r]{\huge\thecontentslabel\enspace}\large}% + {\contentsmargin{0pt}\large}{}[\addvspace{.5pc}]% + } + \else + \newcommand\mainmattertocstyle{} + \fi +\fi +% \end{macrocode} +% +% \subsubsection*{At document backmatter} +% +% Sections are used to format/display the general bibliography and index of authors, but they appear as parts in the table of contents: +% \begin{macrocode} +\ifdefined\conf@TocNumberingRight + \newcommand{\backmattertocstyle}{ + \titlecontents{section}[]{}{}{}{}[]% + \titlecontents{part}% + [0pt]{\addvspace{1pc}}{}{}% + {\contentsmargin{0pt} \large \hfill\contentspage}% + [\addvspace{.5pc}]% + }% +\else% + \ifdefined\conf@TocNumberingLeft% + \newcommand{\backmattertocstyle}{% + \titlecontents{section}[]{}{}{}{}[]% + \titlecontents{part}% + [0pt]% + {\addvspace{1pc}}% + {\contentspage\hspace*{2.5em}\contentsmargin{0pt}% + \bfseries% + \makebox[0pt][r]{\huge\thecontentslabel\enspace}% + \large}% + {\contentspage\hspace*{2.5em}\contentsmargin{0pt} \large}% + {}% + [\addvspace{.5pc}]% + }% + \else% + \newcommand\backmattertocstyle{}% + \fi% +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Headers/footers} +% +% The default page style (and corresponding headers and footers) is set for non PDF-inserted pages: +% \begin{macrocode} +\ifdefined\conf@FancyHeadersExceptPapers + \newcommand{\otherpagestyle}{\pagestyle{fancy}} + \newcommand{\thisotherpagestyle}{\thispagestyle{fancy}} +\else + \newcommand{\otherpagestyle}{\pagestyle{empty}} + \newcommand{\thisotherpagestyle}{\thispagestyle{empty}} +\fi +% \end{macrocode} +% and for PDF-inserted pages: +% \begin{macrocode} +\ifdefined\conf@FancyHeadersOnPapers + \newcommand{\PDFpagestyle}{\thispagestyle{fancy}} +\else + \newcommand{\PDFpagestyle}{\thispagestyle{empty}} +\fi +% \end{macrocode} +% Using the \package{sectsty} package, all chapters have the same font in the table of contents: +% \begin{macrocode} +\chapterfont{\thisotherpagestyle} +% \end{macrocode} +% We then define what the \cmd{\clearsingleordoublepage} \DescribeMacro{\clearsingleordoublepage} stands for, depending if the document is single-sided or double-sided: +% \begin{macrocode} +\ifdefined\conf@WithCleardoublepage + \newcommand{\clearsingleordoublepage}{\cleardoublepage} +\else + \ifdefined\conf@WithClearsinglepage + \newcommand{\clearsingleordoublepage}{\clearpage} + \else + \newcommand{\clearsingleordoublepage}{\cleardoublepage} + \fi +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Creating back-references} +% +% We declare the commands related to bibliography insertion, depending on the compilation option, using the back-references previously generated: +% \begin{macrocode} +\ifdefined\conf@FinalVersion + \newcommand{\UseBackRef}{} +% \end{macrocode} +% and generating the back-references to be used in the last compilation: +% \begin{macrocode} +\else + \newcommand{\CreateBackRef}{} +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{$X$ and $Y$ shifts} +% +% \changes{0.1g}{2007/08/08}{Cmds: changing \cmd{\LaTeXxShift} from a command to a length (idem for \cmd{\LaTeXyShift}, \cmd{\WordxShift} and \cmd{\WordyShift})} +% \changes{0.2a}{2007/08/12}{Cmds: adding \cmd{\paperbookmark} for correct use in the Perl scripts} +% We now define the $X$ and $Y$ shifts for \LaTeX{} (\DescribeMacro{\LaTeXxShift}\cmd{\LaTeXxShift} and \DescribeMacro{\LaTeXyShift}\cmd{\LaTeXyShift}) and Word (\DescribeMacro{\WordxShift}\cmd{\WordxShift}, \DescribeMacro{\WordyShift}\cmd{\WordyShift}) generated papers as lengths: +% \begin{macrocode} +\newlength{\LaTeXxShift} +\newlength{\LaTeXyShift} +\newlength{\WordxShift} +\newlength{\WordyShift} +% \end{macrocode} +% Their default values are set to those used for the example, depending on the document formant (A4/letter): +% \begin{macrocode} +\ifdefined\shiftsafourpaper + \setlength{\LaTeXxShift}{0pt} + \setlength{\LaTeXyShift}{28pt} + \setlength{\WordxShift}{10pt} + \setlength{\WordyShift}{-40pt} +\else + \ifdefined\shiftsletterpaper + \setlength{\LaTeXxShift}{8.45pt} + \setlength{\LaTeXyShift}{-3pt} + \setlength{\WordxShift}{10pt} + \setlength{\WordyShift}{-40pt} + \fi +\fi +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Paper insertion commands} +% +% We now pre-define (as empty) the commands used to insert the PDF papers (for including the first paper in the example), \ie{} the paper title: \DescribeMacro{\papertitle} +% \begin{macrocode} +\newcommand{\papertitle}{} +% \end{macrocode} +% the paper authors: \DescribeMacro{\paperauthors} +% \begin{macrocode} +\newcommand{\paperauthors}{} +% \end{macrocode} +% the commands for insertion in the index: \DescribeMacro{\paperindex} +% \begin{macrocode} +\newcommand{\paperindex}{} +% \end{macrocode} +% the paper reference, \ie{} a tag (\eg{} the file name, or the submission number): \DescribeMacro{\paperref} +% \begin{macrocode} +\newcommand{\paperref}{} +% \end{macrocode} +% the number of pages: \DescribeMacro{\paperpagenum} +% \begin{macrocode} +\newcommand{\paperpagenum}{} +% \end{macrocode} +% the bibliographic references (for the general bibliography): \DescribeMacro{\papercite} +% \begin{macrocode} +\newcommand{\papercite}{} +% \end{macrocode} +% the style for the title: \DescribeMacro{\papertitlestyle} +% \begin{macrocode} +\newcommand{\papertitlestyle}{} +% \end{macrocode} +% and finally the style both the list of authors and the text between the title and the list of authors: \DescribeMacro{\paperauthorstyle} +% \begin{macrocode} +\newcommand{\paperauthorstyle}{\texorpdfstring{\newline\it}{\break}} +% \end{macrocode} +% \changes{0.1f}{2007/08/03}{Bug: fixed wrong bookmark link to author (2nd page instead of 1st) by moving the \cmd{\pdfbookmark[]} cmd into the \cmd{\pagecommand} cmd.} +% \changes{0.1i}{2007/08/10}{Cmd: changing \cmd{\includepaperthread} to hide the TOC layout.} +% \changes{0.1i}{2007/08/10}{Cmd: adding \cmd{\proctoctitleauthor} to define the TOC format of author and paper} +% \changes{0.1i}{2007/08/10}{Cmd: renaming \cmd{\includepaperthread} into \cmd{\procinsertpaper}} +% \changes{0.2b}{2007/08/16}{Cmd: adding a \cmd{\paperpagenum} counter to compute Nb pages -1} +% +% A new counter \Lopt{paperpagenum} \DescribeMacro{paperpagenum} is added, for the number of pages of a paper: +% \begin{macrocode} +\newcounter{paperpagenum} +% \end{macrocode} +% The \cmd{\proctoctitleauthor} \DescribeMacro{\proctoctitleauthor} command defines the style for title/author entry in the table of contents using the style \cmd{\papertitlestyle} for the paper with title \cmd{\papertitle} and the style \cmd{\paperauthorstyle} for the paper with authors \cmd{\paperauthors} : +% \begin{macrocode} +\newcommand{\proctoctitleauthor}[2]{% + \texorpdfstring{{\papertitlestyle#1}{\paperauthorstyle#2}}% + {{\papertitlestyle#1}}} +% \end{macrocode} +% We chose to insert both the paper title and the list of authors in the table of contents, whereas only the title is inserted as a section in the bookmark. Then, the authors will be inserted, for each of them, as a subsection in the \cmd{\procinsertpaper} command. +% +% We now come to the paper insertion \cmd{\procinsertpaper} \DescribeMacro{\procinsertpaper} command, one of the most important command of the whole class. +% \begin{macrocode} +\newcommand{\procinsertpaper}[9]{ +% \end{macrocode} +% It has the following 9 arguments: i) X and Y shifts (with a space in between), ii) number of pages, iii) a reference, iv) the title, v) the list of authors, vi) the index entries, vii) the citations for the general bibliography, viii) the PDF file name and ix the bookmark entries for the authors. +% The insertion is made in two steps. First, the number of pages is set, and the index entries are given (for proper links from the index of authors to the paper's first page): +% \begin{macrocode} + \setcounter{paperpagenum}{#2} + #6% +% \end{macrocode} +% and the first page of the paper is inserted with proper offsets, filename, reference, title, list of authors: +% \begin{macrocode} + \includepdf[noautoscale,offset= #1,pages=1,% + linktodoc,linkname=\PAPERPATH #8.pdf,% + addtotoc={1, section, 1, \proctoctitleauthor{#4}{#5}, #3},% + pagecommand = {#9\PDFpagestyle}% + ]{\PAPERPATH #8.pdf}% +% \end{macrocode} +% Note where the bookmark entries are placed (argument \verb+#9+): it was the only place I found where the bookmark link would be valid\footnote{if you check in the electronic version of the DAFx-06 proceedings, you will see what happens with unproper links... You will be directed to the second page of the paper!}. +% +% The second step consists in inserting the reminding pages. In the case of bibliography merging, we do not care yet about proper page numbering, but we want to see each paper's first and last page: +% \changes{0.2a}{2007/08/12}{Options: adding the output text for the \Lopt{verbose} option} +% \changes{0.2b}{2007/08/16}{Options: adding the last page (with bibliography) insertion for 'compil=bibmerge' option} +% \begin{macrocode} + \ifdefined\conf@BibMerge% + \includepdf[noautoscale,offset= #1,pages=\thepaperpagenum,% + linktodoc,linkname=\PAPERPATH #8.pdf,% + ]{\PAPERPATH #8.pdf}% + \PDFpagestyle{}% + \confcite{#7}% + \ifdefined\conf@procWithDebug + \typeout{confproc: bibliography insertion only} + \fi + \else +% \end{macrocode} +% If running \LaTeX{} to create proper back-references, we insert all remaining pages except the last one (decrementing the page number), that is replaced by references to the paper's bibliographic items: +% \changes{0.2a}{2007/08/12}{Options: adding the output text for the \Lopt{verbose} option} +% \changes{0.2b}{2007/08/16}{Cmds: removing 1 to the \Lopt{paperpagenum} counter} +% \begin{macrocode} + \ifdefined\CreateBackRef + \addtocounter{paperpagenum}{-1} + \includepdf[noautoscale,offset= #1,pages=2-\thepaperpagenum,% + linktodoc,linkname=\PAPERPATH #8.pdf,% + pagecommand = {\PDFpagestyle}% + ]{\PAPERPATH #8.pdf}% + \PDFpagestyle{}% + \confcite{#7}% + \ifdefined\conf@procWithDebug + \typeout{confproc: partial paper insertion (last page=bib items)} + \fi +% \end{macrocode} +% Otherwise, for the last run (assuming that proper back-references were created), all remaining pages are inserted: +% \changes{0.2a}{2007/08/12}{Options: adding the output text for the \Lopt{verbose} option} +% \begin{macrocode} + \else + \ifdefined\UseBackRef + \includepdf[noautoscale,offset= #1,pages=2-,% + linktodoc,linkname=\PAPERPATH #8.pdf,% + pagecommand = {\PDFpagestyle}% + ]{\PAPERPATH #8.pdf}% + \fi + \ifdefined\conf@procWithDebug + \typeout{confproc: full paper insertion (last LaTeX run)} + \fi + \fi + \fi + \ifdefined\conf@procWithDebug + \typeout{---> file: #8.pdf (#2 pages)} + \typeout{---> title: #4} + \typeout{---> author(s): #5} + \typeout{---> index: #6} + \fi +% \end{macrocode} +% In any case, we go to next page, so that bookmarks go to the right spot: +% \begin{macrocode} + \newpage +% \end{macrocode} +% Then, depending if we want all papers to start on the right page or not, we do a \cmd{cleardoublepage}: +% \begin{macrocode} + \ifdefined\conf@WithClearsinglepagePapers + \clearpage + \else + \ifdefined\conf@WithCleardoublepagePapers + \cleardoublepage + \fi + \fi +} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Modifying the bibliography style} +% +% We now set the commands \cmd{\bibhang}\DescribeMacro{\bibhang}, \cmd{\itemindent} \DescribeMacro{\itemindent} and \cmd{\leftmargin} \DescribeMacro{\leftmargin} for the general bibliography layout: +% \begin{macrocode} +\setlength{\itemindent}{-2em} +\setlength{\leftmargin}{1em} +\setlength{\bibhang}{0.5em} +% \end{macrocode} +% We redefine the \verb+\thebibliography+ environment, for proper use and insertion of the new section title in the table of contents. We also slightly reduce the space between bibliography item blocks (cosmetics change): +% \begin{macrocode} +\def\thebibliography#1{% + \section*{\bibname} + \addcontentsline{toc}{part}{\bibname} + \list + {\relax}{\setlength{\labelsep}{0em} + \setlength{\itemindent}{-\bibhang} + \setlength{\leftmargin}{\bibhang}} +% \def\newblock{\hskip .11em plus .33em minus .07em} % ORIGINAL + \def\newblock{\hskip 0em plus 0.0em minus .07em} % DAFx-06 + \sloppy\clubpenalty4000\widowpenalty4000 + \sfcode`\.=1000\relax} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Table of contents insertion} +% +% The \cmd{\proctableofcontents} \DescribeMacro{\proctableofcontents} command inserts the table of contents, adds it to the PDF bookmark, and switches to the corresponding section style for insertion in the table of contents: +% \begin{macrocode} +\newcommand{\proctableofcontents}{% + \tocmattertocstyle + \clearsingleordoublepage + \addtocontents{toc}{\protect\vspace*{-1.3cm}} + \pdfbookmark[0]{Program}{contents} + \tableofcontents + \clearsingleordoublepage +} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Organize the program by days or sessions} +% +% The \cmd{\procday} \DescribeMacro{\procday} command inserts the day given as argument in the table of contents: +% \changes{0.2d}{2007/08/18}{Cmds: adding the \cmd{\procday} command for inserting the day (upper level in the bookmark)} +% \begin{macrocode} +\newcommand{\procday}[1]{% + \phantomsection% + \addcontentsline{toc}{part}{#1}} +% \end{macrocode} +% The \cmd{\session} \DescribeMacro{\session} command inserts the session name given as argument in the table of contents: +% \begin{macrocode} +\newcommand{\session}[1]{% + \phantomsection% + \addcontentsline{toc}{chapter}{#1}} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Paper switch} +% +% The \cmd{\paperswitch} \DescribeMacro{\paperswitch} command will be redefined in the \file{expapersswitch.tex} file, containing information about all papers. It is therefore declared empty: +% \begin{macrocode} +\newcommand{\paperswitch}{} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Set the bibliographic items to be inserted} +% +% The \cmd{\setbibitems} \DescribeMacro{\setbibitems} command defines the bibliography items to be inserted, depending on the compilation option. +% \begin{macrocode} +\newcommand{\setbibitems}{% +% \end{macrocode} +% We first set in a 2 columns format if needed: +% \begin{macrocode} + \ifdefined\conf@TwoColumnBib% + \twocolumn + \fi +% \end{macrocode} +%^^A As a general bibliography is very long, the font size is set to \verb+\footnotesize+: +%^^A \begin{macrocode} +%^^A {\footnotesize% +%^^A \end{macrocode} +% If working on the merging process, all bibliographic items are inserted (so that one can see duplicates): +% \begin{macrocode} + \ifdefined\conf@BibMerge% + \nocite{*}% +% \end{macrocode} +% Otherwise, there no need to insert the citations (they already are inserted as the last page): +% \begin{macrocode} + \else% + \clearsingleordoublepage% + \fi% +% \end{macrocode} +% We finally set the bibliography name accordingly to the user-defined value. +% \begin{macrocode} + \renewcommand{\bibname}{\procbibname} +%% \addcontentsline{toc}{part}{\procbibname} +} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{General bibliography introduction} +% +% The \cmd{\procbibintro} \DescribeMacro{\procbibintro} cmd defines the introduction text the general bibliography as the first inserted bibliographic item: +% \begin{macrocode} +\newcommand{\procbibintro}{{\it ~~~This bibliography is a compilation + of all bibliographic references from each paper. Page numbers that + appear at the end of each entry link to the bibliography sections that + include it. Please click on the URL or on the page number to access + the linked item.}} +% \end{macrocode} +% +%^^A ================================================================= +% \subsubsection{Index insertion} +% +% The \cmd{\insertindex} \DescribeMacro{\insertindex} cmd defines the index insertion: +% \changes{0.2e}{2007/09/01}{Cmds: renaming \cmd{\loclhead} into \cmd{\proclhead}} +% \begin{macrocode} +\newcommand{\insertindex}{ +% \end{macrocode} +% We first clear the page, so that two-sided documents start on a right (odd) page: +% \begin{macrocode} + \clearsingleordoublepage +% \end{macrocode} +% We then back to the 1-column format, in case one adds text before the index: +% \begin{macrocode} + \onecolumn +% \end{macrocode} +% We then include a phantom section and a link to bookmark (do not remove, as this dirty hack provides a valid pointer to the index): +% \begin{macrocode} +% \section*{\addcontentsline{toc}{part}{\bibname} \bibname}% + \section*{~~}% + \addcontentsline{toc}{part}{\procindexname}% +% \end{macrocode} +% The index of authors has no header/footer, as it is the last page and may be printed inside the cover (as for the printed version of the DAFx-06 proceedings): +% \begin{macrocode} + \renewcommand{\proclhead}{}% + \renewcommand{\proccfoot}{}% +% \end{macrocode} +% \changes{0.1g}{2007/08/05}{Cmds: using \cmd{\procindexname} in \package{threecolindex.sty} package} +% \changes{0.2a}{2007/08/12}{Cmds: get rid of \package{threecolindex.sty} package and related \cmd{\gtindexname} command} +% \changes{0.2d}{2007/08/18}{Cmds: the index is now inserted as a part instead of a chapter} +% The index name is then set: +% \begin{macrocode} + \renewcommand{\indexname}{\procindexname}% + \printindex} +% \end{macrocode} +% and we are done for the index of authors, as well as for the whole \file{\filename} class! +% +%^^A ================================================================= +%^^A Config file +%^^A ================================================================= +% \subsection{Load Configuration} +% \label{subsec:loadconfig} +% +% Input a local configuration file (\file{confproc.cfg}), if it +% exists. +% \begin{macrocode} +\InputIfFileExists{confproc.cfg} + {\typeout{************^^J% + * Local config file confproc.cfg used *^^J% + ************} + }{}% +%</package> +% \end{macrocode} +% +%^^A ================================================================= +%^^A Here the \StopEventually stuff will be appended (if we build +%^^A the `programmer' docu) +%^^A ================================================================= +% \Finale +% +\endinput +% +% \fi +% end of file `confproc.dtx' +%%% Local Variables: +%%% mode: latex +%%% TeX-master: t +%%% End:
\ No newline at end of file diff --git a/Master/texmf-dist/source/latex/confproc/confproc.ins b/Master/texmf-dist/source/latex/confproc/confproc.ins new file mode 100644 index 00000000000..352797e49ae --- /dev/null +++ b/Master/texmf-dist/source/latex/confproc/confproc.ins @@ -0,0 +1,200 @@ +%% LaTeX2e file `confproc.ins' +%% generated by the `filecontents' environment +%% from source `confproc' on 2007/09/28. +%% +%% confproc.ins, the batch file for the confproc package +%% Copyright (C) 2007 by Vincent Verfaille +%% <vincent@music.mcgill.ca> +%% +%% This file is part of the confproc package. +%% ------------------------------------------- +%% +%% It may be distributed and/or modified under the conditions of the +%% LaTeX Project Public License, either version 1.2 of this license or +%% (at your option) any later version. +%% +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.2 or later is part of all distributions of LaTeX +%% version 1999/12/01 or later. +%% +%% In particular, NO PERMISSION is granted to modify the contents of +%% this file since it contains the legal notices that are placed in +%% the files it generates. +%% +%% This file may not be distributed without the original source file +%% confproc.dtx. +%% +%% The list of all files belonging to the confproc package is given +%% in the file `readme.txt'. +%% +%% This file will generate fast loadable files and documentation +%% driver files from the .dtx files in this package when run through +%% LaTeX or TeX. +%% +%% ------------------- start of docstrip commands ------------------- +\def\batchfile{confproc.ins} +\input docstrip.tex +% +\ifToplevel{\ifx\askonceonly\undefined% +\Msg{******************}% +\Msg{*}% +\Msg{* This installation requires docstrip}% +\Msg{* version 2.4e or later.}% +\Msg{*}% +\Msg{* An older version of docstrip has been input}% +\Msg{*}% +\Msg{******************}% +\errhelp{Move or rename old docstrip.tex.}% +\errmessage{Old docstrip in input path}% +\batchmode% +\csname @@end\endcsname% +\fi% +}% +% +%% Define standard text: +% +\def\nline{^^J\MetaPrefix\space}% +\def\stdtext{% +Copyright (C) 2007 by Vincent Verfaille + <vincent@music.mcgill.ca>\nline\nline% +This file is part of the confproc package.\nline% +-------------------------------------------\nline\nline% +It may be distributed and/or modified under the conditions of the\nline% +LaTeX Project Public License, either version 1.2 of this license or\nline% +(at your option) any later version.\nline\nline% +The latest version of this license is in\nline% +\space\space http://www.latex-project.org/lppl.txt\nline% +and version 1.2 or later is part of all distributions of LaTeX version\nline% +1999/12/01 or later.\nline\nline% +This file may not be distributed without the original source file\nline% +`\inFileName'.\nline\nline% +The list of all files belonging to the confproc package is given in\nline% +the file `readme.txt'.} +% +%% Declare preambles (and use \stdtext): +% +\declarepreamble\driver + +This is `\outFileName', the documentation driver for the confproc package. +\stdtext + +This is the driver file to produce the LaTeX documentation +from the original source file `\inFileName'. + +Make changes to it as needed. (Never edit the file `\inFileName'!) + +\endpreamble% +% +\declarepreamble\package + +This is `\outFileName', a LaTeX2e package to build conference proceedings. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\declarepreamble\example + +This is `\outFileName', an example file for the confproc package. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\declarepreamble\config + +This is `\outFileName', a configuration file for the confproc package. +\stdtext + +For more details, LaTeX the source `\inFileName'. + +\endpreamble% +% +\keepsilent% +% +%% Greeting: +% +\askforoverwritetrue% +\askonceonly% +% +\ifToplevel{% + \Msg{}% + \Msg{**********************}% + \Msg{* Hello to the installation of the `confproc' package. *}% + \Msg{**********************}% + \Msg{}% + \Msg{*********}% + \Msg{* Generating files... *}% + \Msg{*********}% +}% +% +%% File generation: +% +\generate{% + \usepreamble\example\file{example.tex}{\from{confproc.dtx}{example}}% + \usepreamble\example\file{expapersswitch.tex}{\from{confproc.dtx}{expapersswitch}}% + \usepreamble\example\file{expages.tex}{\from{confproc.dtx}{expages}}% + \usepreamble\example\file{exclasspre.tex}{\from{confproc.dtx}{exclasspre}}% + \usepreamble\example\file{exclasslast.tex}{\from{confproc.dtx}{exclasslast}}% + \usepreamble\example\file{exbiblio.bib}{\from{confproc.dtx}{exbiblio}}% + \nopreamble\nopostamble\file{procswitchandtoc.pl}{\from{confproc.dtx}{procswitchandtoc}}% + \nopreamble\nopostamble\file{exprogram.csv}{\from{confproc.dtx}{exprogram}}% + \nopreamble\nopostamble\file{buildpapers}{\from{confproc.dtx}{buildpapers}}% + \nopreamble\nopostamble\file{buildproc}{\from{confproc.dtx}{buildproc}}% + \nopreamble\nopostamble\file{buildcppdfpapers}{\from{confproc.dtx}{buildcppdfpapers}}% + \usepreamble\driver\file{confproc.drv}{\from{confproc.dtx}{driver}}% + \usepreamble\config\file{confproc.cfg}{\from{confproc.dtx}{config}}% +% \usedir{tex/latex/misc}% + \usepreamble\package\file{confproc.cls}{\from{confproc.dtx}{package}% + \nopreamble\nopostamble\file{buildcls}{\from{confproc.dtx}{buildcls}}% + \nopreamble\nopostamble\file{cleancls}{\from{confproc.dtx}{cleancls}}% + }% +}% +% +%% Report: +% +\ifToplevel{% + \Msg{}% + \Msg{********************}% + \Msg{*}% +\makeatletter\@ifundefined{basedir}{% + \Msg{* To finish the installation you have to move the following}% + \Msg{* file into a directory searched by LaTeX:}% +}{% + \Msg{* The following file has been automatically created in a} + \Msg{* directory searched by LaTeX:} +}\makeatother% + \Msg{*}% + \Msg{* \space\space confproc.cls}% + \Msg{*}% +\makeatletter\@ifundefined{basedir}{% + \Msg{* Using a TDS compatible TeX distribution, this would be e.g.}% + \Msg{* tex/latex/misc of your main or your local or your private}% + \Msg{* texmf path. If you don't know these paths, have a look}% + \Msg{* at your `texmf.cnf' or try:}% + \Msg{* \space\space kpsexpand \string\$TEXMFMAIN}% + \Msg{* \space\space kpsexpand \string\$TEXMFLOCAL}% + \Msg{* \space\space kpsexpand \string\$HOMETEXMF}% + \Msg{* You may also use another folder at your TEXINPUTS path.}% +}{}\makeatother% + \Msg{* To produce the documentation and a example, run the}% + \Msg{* following files through LaTeX:}% + \Msg{*}% + \Msg{* \space\space confproc.drv (three times)}% + \Msg{* \space\space example.tex}% + \Msg{*}% + \Msg{* For the legal stuff please have a look at:}% + \Msg{*}% + \Msg{* \space\space readme.txt}% + \Msg{*}% + \Msg{*}% + \Msg{* Happy TeXing!}% + \Msg{*}% + \Msg{********************}% + \Msg{}% +}% +% +\endbatchfile |