diff options
Diffstat (limited to 'macros')
31 files changed, 1490 insertions, 4313 deletions
diff --git a/macros/generic/chemfig/README b/macros/generic/chemfig/README index ebfc2cb79f..145bdfed79 100644 --- a/macros/generic/chemfig/README +++ b/macros/generic/chemfig/README @@ -2,9 +2,9 @@ ___________________________________ The Chemfig package - v1.51 + v1.52 - 2020/04/06 + 2020/04/14 ___________________________________ Maintainer: Christian Tellechea diff --git a/macros/generic/chemfig/chemfig-en.pdf b/macros/generic/chemfig/chemfig-en.pdf Binary files differindex 306b0e9e16..250d8500c9 100644 --- a/macros/generic/chemfig/chemfig-en.pdf +++ b/macros/generic/chemfig/chemfig-en.pdf diff --git a/macros/generic/chemfig/chemfig-fr.pdf b/macros/generic/chemfig/chemfig-fr.pdf Binary files differindex 295e912146..4e63fadd1d 100644 --- a/macros/generic/chemfig/chemfig-fr.pdf +++ b/macros/generic/chemfig/chemfig-fr.pdf diff --git a/macros/generic/chemfig/chemfig.tex b/macros/generic/chemfig/chemfig.tex index 77bc5b8811..bf66ce58d1 100644 --- a/macros/generic/chemfig/chemfig.tex +++ b/macros/generic/chemfig/chemfig.tex @@ -4,9 +4,9 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % \def\CFname {chemfig} % -\def\CFver {1.51} % +\def\CFver {1.52} % % % -\def\CFdate {2020/04/06} % +\def\CFdate {2020/04/14} % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % @@ -499,18 +499,20 @@ }% {\scantokens\expandafter{% \the\toks0{% - \csname CF_exec% - \ifdim\csname CF_currentangle\endcsname pt>90pt - \ifdim\csname CF_currentangle\endcsname pt<270pt - first% + \expanded{% bugfix 1.52 + \csname CF_exec% + \ifdim\csname CF_currentangle\endcsname pt>90pt + \ifdim\csname CF_currentangle\endcsname pt<270pt + first% + \else + second% + \fi \else second% \fi - \else - second% - \fi - \endcsname - {#2}{#3}% + \endcsname + {\unexpanded{#2}}{\unexpanded{#3}}% + }% }% }% }% @@ -3066,4 +3068,8 @@ v1.5 2020/03/05 - ajout d'une section dans le manuel (placement des atomes) ---------------------------------------------------------------------- v1.51 2020/04/06 - - bug corrig dans \chargerect_a et \chargeline_a
\ No newline at end of file + - bug corrig dans \chargerect_a et \chargeline_a +---------------------------------------------------------------------- +v1.52 2020/04/14 + - bug : dfinition corrige de \CFthesubmol dans \def_submolc pour + qu'elle se dveloppe en 1 coup seulement
\ No newline at end of file diff --git a/macros/latex/contrib/asmeconf/README.md b/macros/latex/contrib/asmeconf/README.md index 87f8916cbb..e611fea975 100644 --- a/macros/latex/contrib/asmeconf/README.md +++ b/macros/latex/contrib/asmeconf/README.md @@ -1,7 +1,7 @@ #asmeconf: A template for ASME conference papers# - Version 1.17 dated 2020/02/29. + Version 1.18 dated 2020/04/14. ####Overview#### This class provides a template to format ASME Conference papers according to @@ -37,7 +37,7 @@ - support hyperref package (hyperlinks to figures, tables, references, web) -- support pdf bookmarks +- support pdf bookmarks and metadata - enable various math and text features with newtxmath and newtxtext packages @@ -67,6 +67,8 @@ ####Change log#### + v1.18 (2020/04/14): edit and expand documentation; revise sample .bib file; extensive edits to asmeconf.bst, to better support hyperlinks, to correct eid error, and for better conformance to ASME style (details listed in .bst file); add foreign language example. + v1.17: set T1 font encoding with utf-8 input, ensure LuaLaTeX compatibility; load hologo and metalogo packages; edit documentation. v1.16: remove xpatch and comment packages from class file; disable \\( and \\) in pdf bookmarks to avoid warnings; edit documentation. diff --git a/macros/latex/contrib/asmeconf/asmeconf-sample.bib b/macros/latex/contrib/asmeconf/asmeconf-sample.bib index 3b4e5194e2..6cd209464b 100644 --- a/macros/latex/contrib/asmeconf/asmeconf-sample.bib +++ b/macros/latex/contrib/asmeconf/asmeconf-sample.bib @@ -1,200 +1,179 @@ -%% Revised 2 October 2019 +%% Revised 14 April 2020 +%% John H. Lienhard, MIT @article{ning2002, - title = {On the Sliding Friction Characteristics of Unidirectional Continuous FRP Deposits}, - journal = {ASME Journal of Tribology}, - year = {2002}, - volume = {48}, - number = {5}, - pages = {2000--2008}, - author = {Xiang Ning and Mary Rose Lovell}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, + author = {Xiang Ning and Mary Rose Lovell}, + title = {On the Sliding Friction Characteristics of Unidirectional Continuous FRP Deposits}, + journal = {ASME Journal of Tribology}, + year = {2002}, + volume = {48}, + number = {5}, + pages = {2000--2008}, + doi = {10.1115/1.4042912}, } -%% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. +%% article supports these fields: author, year, title, journal, volume, number, pages OR eid (and numpages), +%% doi, url, eprint with archive, note. +%% There's no need to give the URL if it is simply the DOI, since the DOI itself will be hyperlinked. +%% url = {https://doi.org/10.1115/1.4042912}. ASME requests that a URL point to the abstract. @BOOK{gibson2008, - title = {The Big Book of Cellular Studies}, + title = {The Big Book of Cellular Studies}, publisher = {John Wiley and Sons}, - year = {2008}, - author = {Tom A. Gibson and Matthew A. Tucker}, - address = {New York}, + year = {2008}, + author = {Tom A. Gibson and Matthew A. Tucker}, + address = {New York}, } -%% If a URL or DOI is available, it may be included as in the article above. +%% book supports these fields: author OR editor, year, title, edition, series, volume OR number +%% publisher, address, doi, url, eprint with archive, note. @INCOLLECTION{stevens1999, - title = {Stochastic Fields and Their Digital Simulation}, - publisher = {Martimius Publishers}, - pages = {22--36}, - year = {1999}, + author = {Thomas T. Stevens}, + title = {Stochastic Fields and Their Digital Simulation}, booktitle = {Stochastic Methods}, - author = {Thomas T. Stevens}, - address = {Dordrecht}, + publisher = {Martimius Publishers}, + address = {Dordrecht}, + year = {1999}, + pages = {22--36}, } -%% If a URL or DOI is available, it may be included as in the article above. - +%% incollection supports these fields: author, year, title, booktitle, edition, editor, series, +%% volume OR number, publisher, address, type, +%% chapter, pages, doi, note, eprint with archive, url, urldate. +%% type = { } changes default "Chap." to something else. @inproceedings{wions2005, - author = {Thomas Wions and Christopher D. Mills}, - title = {Structural Dynamics in Parallel Manipulation}, + author = {Thomas Wions and Christopher D. Mills}, + title = {Struct\-ur\-al Dynamics in Parallel Manipulation}, booktitle = {Proceedings of the ASME IDETC/CIE}, - year = {2005}, - pages = {777--798}, - number = {DETC2005-99532}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, - venue = {New Orleans, LA}, - confmonth = {September 10--13}, + number = {DETC2005-99532}, + venue = {New Orleans, LA}, + eventdate = {September 10--13}, + year = {2005}, + pages = {777--798}, + doi = {10.1115/1.4042912}, + url = {https://doi.org/10.1115/1.4042912}, } -% Note that venue and confmonth are specific to this .bst style -% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. - +%% inproceedings supports these fields: author, year, title, booktitle, edition, editor, volume, +%% organization OR publisher, address, venue, eventdate, +%% [paper] number, pages, doi, note, eprint with archive, url, urldate. +%% Note that venue and eventdate are specific to the asmeconf.bst style. +%% There's really no need to give the URL if it is simply the DOI because the DOI itself will be hyperlinked. +%% ASME requests that the URL point to the abstract. @phdthesis{smith2002, - author = {Robert Smith}, - title = {Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Non-Steady Motion}, - school = {Rochester Institute of Technology}, - address = {Rochester, NY}, - year = {2002}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, + author = {Robert Smith}, + title = {Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Non-Steady Motion}, + school = {Rochester Institute of Technology}, + address = {Rochester, NY}, + year = {2002}, + doi = {10.1115/1.4042912}, + url = {https://doi.org/10.1115/1.4042912}, } -% type = {Sc{D} Thesis}, could be added to change the type of thesis. See example below. -% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. - - -@techreport{watson1982, - author = {David Watson}, - title = {Evaporative Heat Transfer in the Contact Line of a Mixture}, - year = {1982}, - number = {HTL-26, CFD-4}, - institution = {Iowa State University}, - address = {Ames, IA}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, -} -% type can be changed here also, see example below -% see example below. +% type = {Sc{D} {T}hesis}, could be added to change the type of thesis. See two examples below. +% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. +% eprint with archive is also supported. +%% ASME requests that the URL point to the abstract. @mastersthesis{smith1998, - author = {Robert Smith}, - title = {Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Steady Motion}, - school = {Rochester Institute of Technology}, - address = {Rochester, NY}, - year = {1998}, + author = {Robert Smith}, + title = {Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Steady Motion}, + school = {Rochester Institute of Technology}, + address = {Rochester, NY}, + year = {1998}, } +%% mastersthesis supports these fields: author, year, title, type, school, address, note. +%% These fields are also supported, but don't use them all: doi, eprint with archive, url, urldate, urltype +%% type={} can optionally be used to change the type of thesis. Default is "Master's thesis" @mastersthesis{smith1996, -author = {Robert Smith}, -title = {Cylindrical Surfaces Involved in a Steady Motion}, -type = {{BS} Thesis}, -school = {Rochester Institute of Technology}, -address = {Rochester, NY}, -year = {1996}, + author = {Robert Smith}, + title = {Cylindrical Surfaces Involved in a Steady Motion}, + type = {{BS} {T}hesis}, + school = {Rochester Institute of Technology}, + address = {Rochester, NY}, + year = {1996}, } +%% To get a bachelor's thesis, use type = {} as above. - -@techreport{watson1981, -author = {David Watson}, -title = {Evaporative Heat Transfer in the Contact Line of a Mixture}, -year = {1981}, -number = {TN-1234}, -institution = {National Aeronautics and Space Administration}, -address = {Washington, DC}, -URL = {https://doi.org/10.1115/1.4042912}, -type = {NASA Technical Memorandum No.} +@techreport{watson1982, + author = {David Watson}, + title = {Evaporative Heat Transfer in the Contact Line of a Mixture}, + institution = {Iowa State University}, + address = {Ames, IA}, + number = {HTL-26, CFD-4}, + year = {1982}, + doi = {10.1115/1.4042912}, + url = {https://doi.org/10.1115/1.4042912}, } - -@BOOK{bejan, - title = {Advanced Engineering Thermodynamics}, - publisher = {John Wiley {\&} Sons, Inc.}, - year = {1988}, - author = {Adrian Bejan}, - address = {New York, NY}, +%% techreport supports the fields: author, title, number, institution, address, year, doi, url, +%% eprint with archive, note. +% if type = is omitted, it will default to "Tech. Rep." See the example below for changing this. + +@techreport{reynolds58, + author = {W. C. Reynolds and W. M. Kays and S. J. Kline}, + title = {Heat Transfer in the Incompressible Turbulent Boundary Layer. {I}--{C}onstant Wall Temperature}, + type = {Memorandum}, + institution = {NASA}, + address = {Washington, DC}, + number = {12-1-58W}, + year = {1958}, + eprint = {2060/19980228020}, + archive = hdl, } +% if type = is omitted, it will default to "Tech. Rep." @incollection{DKE70, - author = {Donald K. Edwards}, - title = {Thermal Radiation Measurements}, - editor = {Ernst R. G. Eckert and Richard J. Goldstein}, - booktitle = {Measurement Techniques in Heat Transfer}, - chapter = {9}, - pages = {353--396}, - volume ={130}, - series ={{AGARD}ograph}, - month = {November}, - type = {{C}hapter}, - publisher = {Technivision Services}, - address = {Slough, England}, - year ={1970}, - note ={Published by the Advisory Group for Aerospace Research and Development of {NATO}}, -} - -@incollection{Lienhard2017, - author = {John H. Lienhard and Karan H. Mistry and Mostafa H. Sharqawy and Gregory P. Thiel}, - title ={Thermodynamics, Exergy, and Energy Efficiency in Desalination Systems}, - editor = {Hassan A. Arafat}, - booktitle = {Desalination Sustainability}, - chapter = 4, - pages = {127--206}, - publisher ={Elsevier Publishing Co.}, - address = {Amsterdam}, - year =2017, - month = {June}, - url = {https://www.elsevier.com/books/desalination-sustainability/unknown/978-0-12-809791-5}, + author = {Donald K. Edwards}, + title = {Thermal Radiation Measurements}, + editor = {Ernst R. G. Eckert and Richard J. Goldstein}, + booktitle = {Measurement Techniques in Heat Transfer}, + chapter = {9}, + pages = {353--396}, + volume = {130}, + series = {{AGARD}ograph}, + publisher = {Technivision Services}, + address = {Slough, England}, + year = {1970}, + note = {Published by the Advisory Group for Aerospace Research and Development of {NATO}}, } +%% If you need to change "Chap." to something else, use for example: type = {{C}hapter}, +%% It's uncommon to have the "series" field as above. @article{Lienhard2019b, - title = "Exterior Shape Factors from Interior Shape Factors", - journal = {J. Heat Transfer}, - year = "2019", - doi = "10.1115/1.4042912", - author = {Lienhard, V, John H.}, - eid = {061301}, - volume = {141}, - number = {6}, + author = {Lienhard, V, John H.}, + title = {Exterior Shape Factors from Interior Shape Factors}, + journal = jht, + doi = {10.1115/1.4042912}, + volume = {141}, + number = {6}, + eid = {061301}, + year = {2019}, } +%% Note eid field rather than page numbers. Will not produce "pp." before the eid number. +%% May include numpages = {} to get "eid (numpages pages)" +%% Note use of jht macro for title title (produces "ASME J. Heat Transfer"). All ASME journals have macros. -@misc{narayan2017, - author = {Prakash Narayan Govindan and Steven Lam and Maximus G. {St. John}}, - title = {Systems including a condensing apparatus such as a bubble column condenser}, - year = {2017}, +@misc{govindan2017, + author = {Prakash Narayan Govindan and Steven Lam and Maximus G. {St. John}}, + title = {Systems Including a Condensing Apparatus Such As a Bubble Column Condenser}, howpublished = {US Patent {\#}9700811}, + year = {2017}, + url = {https://patents.google.com/patent/US9700811B2}, } -@conference{Swaminathan2017IDABRO, - Author = {Swaminathan, Jaichander and Stover, Richard L. and Tow, Emily W. and Warsinger, David M. and Lienhard, John H.}, - Booktitle = {Proceedings of IDA World Congress on Desalination and Water Reuse}, - Title = {Effect of practical losses on optimal design of batch {RO} systems}, - Year = {2017}, - Month = 10, - Publisher = {International Desalination Association}, - address = {Topsfield, MA}, - venue ={S{\~a}o Paulo, Brazil}, - confmonth = {October 15--20}, - number = {IDA17WC-58334}, - eprint = {1721.1/111971}, - archive = hndl, -} -% number = {Paper No.\ IDA17WC-58334}, could be used instead. -% url = {http://hdl.handle.net/1721.1/111971}, - @misc{Fong2015, - title = {Analytical Methods for Squaring the Disc}, - author = {Chamberlain Fong}, + title = {Analytical Methods for Squaring the Disc}, + author = {Chamberlain Fong}, howpublished = {{\itshape ArXiv e-prints}}, - eprint = {1509.06344}, - archive=arxiv, - year = {2015}, - month = {sep}, + year = {2015}, + eprint = {1509.06344}, + archive = arxiv, } -% URL = {https://arxiv.org/abs/1509.06344v3}, +% eprint + arxiv produces the same result as: url = {https://arxiv.org/abs/1509.06344v3}, @manual{GSL, - title = {{GNU} Scientific Library Release 2.4}, - URL = {https://www.gnu.org/software/gsl/}, - author = {Mark Galassi + title = {{GNU} Scientific Library Release 2.4}, + author = {Mark Galassi and Jim Davies and James Theiler and Brian Gough @@ -203,109 +182,150 @@ type = {NASA Technical Memorandum No.} and Michael Booth and Fabrice Rossi and Rhys Ulerich}, - year = 2017, - organization = {Free Software Foundation}, - address = {Boston, MA}, - month = {June}, + organization = {Free Software Foundation}, + address = {Boston, MA}, + year = 2017, + url = {https://www.gnu.org/software/gsl/}, } +%% manual supports these fields: author, year, title, edition, organization, address, doi, eprint with archive, urldate, url, note. @online{mpl, - title={mpl colormaps}, - author={St{\'e}fan {van der Walt} and Nathaniel Smith}, - URL = {http://bids.github.io/colormap/}, - urldate = {26 August 2018}, - year = 2015, - organization = {GitHub}, - address = {San Francisco, CA}, - month = {September}, + title = {mpl colormaps}, + author = {St{\'e}fan {van der Walt} and Nathaniel Smith}, + organization = {GitHub}, + address = {San Francisco, CA}, + year = 2015, + url = {http://bids.github.io/colormap/}, + urldate = {August 26, 2018}, } - +%% online supports these fields: author OR editor, year, title, organization, address, +%% note, url OR eprint with archive, urldate, urltype +%% You can change "Accessed" with "urltype", e.g., urltype = {retrieved}, @BOOK{johnson1980, - title = {Title of edited book}, + editor = {Howard Johnson}, + title = {Title of Edited Book}, publisher = {John Wiley and Sons, Inc.}, - year = {1980}, - editor = {Howard Johnson}, - address = {New York, NY}, + address = {New York, NY}, + year = {1980}, } @proceedings{proceedings, - title = {The title of the proceedings}, - year = 2015, - editor = {Howard Johnson}, - volume = 2, - address = {Address of publisher}, - organization = {The organization}, - publisher = {Name of publisher}, - note = {Optional note} + title = {The Title of the Proceedings}, + year = 2015, + editor = {Al Yankovich and Howard Stern}, + volume = {15}, + organization = {Organization}, + venue = {Boston, MA}, + eventdate = {April 27--28}, + url = {http://web.mit.edu}, + note = {Optional note}, } -% series = {Series A, +%% proceedings supports these fields: author OR editor, year, title, edition, editor, +%% series, volume OR number, organization, publisher, +%% address [of organization or publisher], venue, eventdate, +%% doi, url, eprint with archive. +%% The organization will appear as author/editor if those fields are empty. +%% In most instances, the publisher is the organization so only one should be given @online{amsmath, -author = {{American Mathematical Society} and {LATEX3 Project}}, -title = {User's Guide for the \textsf{amsmath} Package, Version 2.1}, -year = {2018}, -organization = {Comprehensive \TeX\ Archive Network}, -url = {https://ctan.org/tex-archive/macros/latex/required/amsmath/amsldoc.pdf}, -urldate = {5 July 2019}, + author = {{American Mathematical Society} and {LATEX3 Project}}, + title = {User's Guide for the \textsf{amsmath} Package, Version 2.1}, + organization = {Comprehensive \TeX\ Archive Network}, + year = {2018}, + url = {https://ctan.org/tex-archive/macros/latex/required/amsmath/amsldoc.pdf}, + urldate = {July 5, 2019}, } -%% urltype = {retrieved}, @online{sharpe1, -author = {Michael Sharpe}, -title = {New {TX} font package, Version 1.554}, -year = {2018}, -organization = {Comprehensive \TeX\ Archive Network}, -url = {https://ctan.org/pkg/newtx}, -urldate = {27 April 2019}, + author = {Michael Sharpe}, + title = {New {TX} Font Package, Version 1.554}, + organization = {Comprehensive \TeX\ Archive Network}, + year = {2018}, + url = {https://ctan.org/pkg/newtx}, + urldate = {April 27, 2019}, } @online{sharpe2, -author = {Michael Sharpe}, -title = {The \textsf{mathalfa} package, Version 1.10}, -year = {2018}, -organization = {Comprehensive \TeX\ Archive Network}, -url = {https://ctan.org/pkg/mathalfa}, -urldate = {27 April 2019}, + author = {Michael Sharpe}, + title = {The \textsf{mathalfa} Package, Version 1.10}, + organization = {Comprehensive \TeX\ Archive Network}, + year = {2018}, + url = {https://ctan.org/pkg/mathalfa}, + urldate = {April 27, 2019}, } - @online{tolusis, - author = {Sigitas Tolu{\v{s}}is}, - title = {The \textsf{flushend} package}, - year = {2017}, +@online{tolusis, + author = {Sigitas Tolu{\v{s}}is}, + title = {The \textsf{flushend} Package, Version 3.3}, organization = {Comprehensive \TeX\ Archive Network}, - url = {https://www.ctan.org/pkg/flushend}, - urldate = {October 1, 2019}, - version = {3.3}, + year = {2017}, + url = {https://www.ctan.org/pkg/flushend}, + urldate = {October 1, 2019}, } @online{bottcher, - author = {Stephan I. B{\"o}ttcher and Uwe L{\"u}ck}, - title = {\textsf{lineno.sty}: A {\LaTeX} package to attach line numbers to paragraphs}, - year = {2005}, + author = {Stephan I. B{\"o}ttcher and Uwe L{\"u}ck}, + title = {\textsf{lineno.sty}: A {\LaTeX} Package to Attach Line Numbers to Paragraphs, Version 4.41}, organization = {Comprehensive \TeX\ Archive Network}, - url = {https://www.ctan.org/pkg/lineno}, - urldate = {August 17, 2019}, - version = {4.41}, + year = {2005}, + url = {https://www.ctan.org/pkg/lineno}, + urldate = {August 17, 2019}, } @online{oostrum, - author = {Piet van Oostrum}, - title = {The \textsf{fancyhdr} and \textsf{extramarks} packages}, - year = {2019}, + author = {Piet van Oostrum}, + title = {The \textsf{fancyhdr} and \textsf{extramarks} Packages, Version 3.10}, organization = {Comprehensive \TeX\ Archive Network}, - url = {https://www.ctan.org/pkg/lineno}, - urldate = {August 17, 2019}, - version = {3.10}, + year = {2019}, + url = {https://www.ctan.org/pkg/lineno}, + urldate = {August 17, 2019}, } @online{fairbairns, - author = {Robin Fairbairns and Sebastian Rahtz and Leonor Barroca}, - title = {A package for rotated objects in \LaTeX}, - year = {2016}, + author = {Robin Fairbairns and Sebastian Rahtz and Leonor Barroca}, + title = {A Package for Rotated Objects in \LaTeX, Version 2.16d}, organization = {Comprehensive \TeX\ Archive Network}, - url = {https://www.ctan.org/pkg/rotating}, - urldate = {October 2, 2019}, - version = {v2.16d}, -} + year = {2016}, + url = {https://www.ctan.org/pkg/rotating}, + urldate = {October 2, 2019}, +} + +@BOOK{book, + author = {James Tiberius Kirk}, + year = {2288}, + title = {Decline and Fall of the Romulan Empire}, + edition = {7}, + series = {Humankind's Greatest Writings}, + volume = {23}, + url = {http://web.mit.edu}, + publisher = {Vulcan Free Press}, + address = {T'Paal}, + note = {to appear}, +} + +@inbook{inbook, + author = {Winston S. Churchill}, + year = {1948}, + title = {The Gathering Storm}, + edition = {1}, + series = {The Second World War}, + volume = {1}, + chapter = {5}, + pages = {66--89}, + publisher = {Houghton Mifflin Co.}, + address = {Boston}, + note = {{``The Locust Years''}}, +} +%% inbook supports these fields: author OR editor, year, title, edition, version, series, volume OR number, doi, url, eprint with archive, publisher, address, note. type={} field changes "Chap." to something else. + +@book{fourier1822, + author = {Jean Baptiste Joseph Fourier}, + year = {1822}, + title = {Th\'{e}orie Analytique de la Chaleur}, + publisher = {Firmin Didot, P\`{e}re et Fils}, + address = {Paris}, + url = {https://archive.org/details/analyticaltheory00fourrich}, +} + diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.pdf b/macros/latex/contrib/asmeconf/asmeconf-template.pdf Binary files differindex 6e64eb32b9..840922971e 100644 --- a/macros/latex/contrib/asmeconf/asmeconf-template.pdf +++ b/macros/latex/contrib/asmeconf/asmeconf-template.pdf diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.tex b/macros/latex/contrib/asmeconf/asmeconf-template.tex index 4010bd1f0e..af6ca23847 100644 --- a/macros/latex/contrib/asmeconf/asmeconf-template.tex +++ b/macros/latex/contrib/asmeconf/asmeconf-template.tex @@ -3,10 +3,11 @@ %% This file is asmeconf-template.tex, a template to format ASME Conference papers according to %% the requirements on ASME's conference web pages. %% -%% This file is version 1.17 dated 2020/02/29 +%% This file is version 1.18 dated 2020/04/14 %% %% As of version 1.11, this template follows ASME's newer conference guidelines first posted July 2019. -%% The new guidelines have changed the requested author block formatting (old format is also supported) +%% The new guidelines have changed the requested author block formatting to be inline. +%% (This template supports the old grid format as a package option.) %% Nomenclature now follows the abstract. Abstract is in italics. %% %% Author: John H. Lienhard V @@ -85,8 +86,7 @@ %% Class options are described above. -\documentclass[varvw,largesc,upint,mathalfa=cal=euler,colorlinks,hyphenate,balance]{asmeconf} % <=== remove colorlinks for submission to ASME - +\documentclass[varvw,largesc,upint,mathalfa=cal=euler,hyphenate,balance,lang-second=french,lang=english,colorlinks]{asmeconf} % <=== remove colorlinks before submission to ASME! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -104,7 +104,7 @@ \begin{document} -% Change these fields to the right content for your conference! +% Change these fields to the right content for your conference. % You can comment these out if for some reason you don't want a header. % Use title case (first letters capitalized), not all capitals @@ -140,8 +140,9 @@ \maketitle -%%% For tracking various versions of your draft. Change text to suit your own needs. Remove from final version. -%%% \date{..} is the same command. +%%% Use this footnote for tracking various versions of your draft. Change text to suit your own needs. +%%% Remove from final version. +%%% \date{..} calls the same command. \versionfootnote{Documentation for \texttt{asmeconf.cls}. Version \versionno; \today.}% <=== Delete before final submission. @@ -158,7 +159,7 @@ %% %% Abstract should be no more than 200 words \begin{abstract} -This paper is an example and template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of early 2020. The class is compatible with the {\upshape\texttt{hyperref}} package for producing pdf files with links. The optional argument of \verb|\section| has been modified for manually setting pdf bookmarks when macros or complicated mathematics are included in section headings. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class may be invoked with several options, most of which address math fonts. The class calls a number of packages, all of which are in {\upshape\TeX\ Live} and on CTAN. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}. +This paper is an example of and a template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of early 2020. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class is compatible with the {\upshape\texttt{hyperref}} package, so that pdfs will contain internal and external hyperlinks, pdf bookmarks, and metadata. Links may be colored, for online use, or black, for publication. Section headers may contain mathematics, references, citations, and footnotes. The class enables inline author names, following ASME's current style, but is backward compatible to the traditional block style. The class includes many options, e.g., for math fonts. The class calls a number of packages, all of which are in {\upshape\TeX\ Live} and on CTAN. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}. \end{abstract} %%%%%%%%% NOMENCLATURE (OPTIONAL) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -193,7 +194,7 @@ This paper is an example and template for typesetting ASME Conference Papers in \section{Introduction} The \texttt{asmeconf} class file will typeset papers with margins, fonts, headings, captions, and reference formats that follow those specified for conference papers of the American Society of Mechanical Engineers (ASME). Internal and external hyperlinks will be set automatically, and the pdf file will contain bookmarks and metadata. This class is not a publication of ASME. -The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar distributions. If you find you are missing one of these packages, you may obtain it from CTAN (\href{http://ctan.org}{ctan.org}). +The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar distributions. If you find you are missing one of these packages, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}). \subsection{Essential Initial Commands} To begin, fill in the fields to be completed at top of the \texttt{asmeconf-template.tex} file. These fields include the headers for your conference and your paper number. Specified metadata will be placed into the pdf file itself. @@ -201,30 +202,36 @@ The title should be placed into \verb|\title{..}|. Put author names into the \verb|\SetAuthors{name, name,...}| command in the desired order; follow the syntax illustrated \texttt{asmeconf-template.tex} file. Put each distinct address sequentially into a separate \verb|\SetAffiliation{n}{address}|, where $n = 1,2,\ldots$ Tag each author with the right affiliation by putting \verb|\affil{n}| after that author's name inside the \verb|\SetAuthors{..| command. -Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (other international authors). +Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (for other international authors). One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{#}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{#}|. After setting up the headers, authors, and title, issue the \verb|\maketitle| command. -The abstract text must be placed into \verb|\begin{abstract}..\end{abstract}|. The abstract will automatically be italicized. Keywords may optionally be including using the \verb|\keywords{..}| command. This command \textit{must} be issued before the abstract environment. +The abstract text must be placed into \verb|\begin{abstract}| \ldots \verb|\end{abstract}|. The abstract will automatically be italicized. Keywords may be included using the \verb|\keywords{..}| command. The \texttt{keyword} command \textit{must} be issued before the abstract environment. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Equations and Nomenclature} -Equations are typeset in the usual way. The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features (see Sect.~\ref{sec:moremath}). + +\section{Referring to Citations, Figures, and Equations} +Citations are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982}. +A specific reference may be named with an abbreviation, as in Ref.~\cite{watson1982}. +See the \texttt{asmeconf-sample.bib} file and Sect.~\ref{sec:references} for examples of how to enter your references. + +For ASME conference papers, the labels Equation and Figure should be abbreviated when they do not start a sentence, as in Eq.~\eqref{eqn:dw} and Fig.~\ref{fig:1}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:dw} is spelled out when it starts a sentence. + +Equations are typeset in the usual way and will be automatically numbered. The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features (see Sect.~\ref{sec:moremath}). \begin{equation}\label{eqn:fourier} \vec{q} = -k\nabla T \end{equation} -ASME prefers SI units. U.S.\ style units may follow in parentheses. Be sure to put your symbols into the nomenclature list, including the units. - -For ASME conference papers, the labels Equation and Figure should be abbreviated when they do not start a sentence, as in Eq.~\eqref{eqn:dw} and Fig.~\ref{fig:1}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:dw} is spelled out when it starts a sentence. +ASME prefers SI units. (U.S.\ style units may follow in parentheses.) Be sure to put all symbols into the nomenclature list, including their units. %%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%% %% captions go below figures + \begin{figure} \centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf} \caption{Figure caption with math, eqn.~\eqref{eqn:fourier}: $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}} @@ -234,15 +241,17 @@ For ASME conference papers, the labels Equation and Figure should be abbreviated %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %% Use title case for subsections and subsubsections + \section{Section Headings and Captions} -ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and mathematics into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnote.} +ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and mathematics into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnotes are automatically separated by a comma.} Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{..}| command. Sections may either be numbered or left unnumbered. -Simple mathematical expressions can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf-template.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported. +Simple mathematical expressions can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf-template.tex} source file for examples of this procedure. These bookmarks should usually be text expressions, although some math is supported. If you wish to override the default math format in captions, put \verb|\mathversion{normal}| in the caption. @@ -293,16 +302,71 @@ Our competitor's test & 72.321 & 141.384 \\ \section{Tables and Figures} Table \ref{tab:1} is an example of a simple table. Table captions should be placed above tables. -The class loads the \texttt{booktabs} package (used for horizontal rules in both Table \ref{tab:1} and \ref{tab:2}), and the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (used in Table \ref{tab:2}). Table \ref{tab:3} is an example of a table that spans two columns. +The class loads the \texttt{booktabs} package (used for horizontal rules in both Table \ref{tab:1} and \ref{tab:2}), and the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (used in Table \ref{tab:2}). Table \ref{tab:3} is an example of a table that spans two columns. Two column tables (and figures) will always float to the top of a later page. -Figure captions go below figures. Figure~\ref{fig:2} is an example of a figure that spans two columns and includes subfigures. The text in figures (and tables) should be no smaller than 6~point type. Images in figures are handles by the standard \texttt{graphicx} package. +Figure captions go below figures. Figure~\ref{fig:2} is an example of a figure that spans two columns and includes subfigures. The text in figures (and tables) should be no smaller than 6~point type. Images in figures are handled by the standard \texttt{graphicx} package. Landscape figures and tables may be produced at full-page size by putting \verb|\usepackage[figuresright]{rotating}| in your \texttt{.tex} file's preamble and using the \texttt{sidewaystable*} and \texttt{sidewaysfigure*} environments~\cite{fairbairns}. +%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%% +\begin{table*} +\caption{A table spanning two columns\label{tab:3}}% +\centering{% +\begin{tabular*}{0.8\textwidth}{@{\hspace*{1.5em}}@{\extracolsep{\fill}}ccc!{\hspace*{3.em}}ccc@{\hspace*{1.5em}}} +\toprule +\multicolumn{1}{@{\hspace*{1.5em}}c}{$x$\rule{0pt}{11pt}} & +\multicolumn{1}{c}{$\textrm{erf}(x)$} & +\multicolumn{1}{c!{\hspace*{3.em}}}{$\textrm{erfc}(x)$} & +\multicolumn{1}{c}{$x$} & +\multicolumn{1}{c}{$\textrm{erf}(x)$} & +\multicolumn{1}{c@{\hspace*{1.5em}}}{$\textrm{erfc}(x)$} \\ \midrule +0.00 & 0.00000 & 1.00000 & 1.10 & 0.88021 & 0.11980\rule{0pt}{11pt} \\ +0.05 & 0.05637 & 0.94363 & 1.20 & 0.91031 & 0.08969 \\ +0.10 & 0.11246 & 0.88754 & 1.30 & 0.93401 & 0.06599 \\ +0.15 & 0.16800 & 0.83200 & 1.40 & 0.95229 & 0.04771 \\ +0.20 & 0.22270 & 0.77730 & 1.50 & 0.96611 & 0.03389 \\ +0.30 & 0.32863 & 0.67137 & 1.60 & 0.97635 & 0.02365 \\ +0.40 & 0.42839 & 0.57161 & 1.70 & 0.98379 & 0.01621 \\ +0.50 & 0.52050 & 0.47950 & 1.80 & 0.98909 & 0.01091 \\ +0.60 & 0.60386 & 0.39614 & 1.82\makebox[0pt][l]{14} & 0.99000 & 0.01000 \\ +0.70 & 0.67780 & 0.32220 & 1.90 & 0.99279 & 0.00721 \\ +0.80 & 0.74210 & 0.25790 & 2.00 & 0.99532 & 0.00468 \\ +0.90 & 0.79691 & 0.20309 & 2.50 & 0.99959 & 0.00041 \\ +1.00 & 0.84270 & 0.15730 & 3.00 & 0.99998 & 0.00002 \\[2pt] +\bottomrule\end{tabular*} +} +\end{table*} + +%%%%%%%%%%%%%%%%% end two column table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{Reference Formatting with \NoCaseChange{\texttt{asmeconf.bst}}\footnote{If you have text in a section heading or caption that you do not want to be capitalized, such as an SI unit, enclose it in a \texttt{\textbackslash NoCaseChange} command.}}\label{sec:references} + +The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Citations and references are managed by the standard \texttt{natbib} package. Nevertheless, a few comments are necessary. + +%% sub-subsections should *not* be numbered + +\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given. ASME requests that URLs point to a document's abstract. + +Elementary support for \texttt{eprint} numbers is also included, generating a url at the end of the citation. The \texttt{archive} type may be specified using the macros \texttt{arxiv, googlebooks, hdl, jstore, oclc}, or \texttt{pubmed} (e.g., \texttt{archive=hdl}, \textit{without} braces). Both \texttt{eprint} and \texttt{archive} fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|. + +\subsubsection*{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url} or \texttt{eprint} with \texttt{archive} must be included. See the examples of use in the \texttt{asmeconf-sample.bib} file. + +\subsubsection*{Date Accessed} The \verb|urldate={..}| field may be used to provide the date on which a given url was accessed. By default, the text printed will be \texttt{Accessed `date',}. The word ``Accessed'' may be changed using the \verb|urltype={..}| field. + +\subsubsection*{Conference Location and Date} For the entry types \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and the date of a conference. + +\subsubsection*{Capitalization of Titles} ASME's bibliography style requires that document titles be in title case. The first letters of principal words are capitalized. Do this when writing the \texttt{.bib} file. + + -%%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%% -\begin{figure*}[t] +\begin{figure*} \begin{subfigure}[t]{0.5\textwidth} %subfigure is basically the same as minipage \vbox{ \vspace*{1.7em} @@ -313,7 +377,7 @@ Landscape figures and tables may be produced at full-page size by putting \verb| } \subcaption{Interior region\label{fig:interior-region}} \end{subfigure}% -%%%%%%%%%%%%% no spaces or line breaks between these two minipages +%%%%%%%%%%%%% no spaces or line breaks between these two subfigures \begin{subfigure}[t]{0.5\textwidth} \centering{% \includegraphics{sample-figure-2b.pdf} @@ -322,36 +386,16 @@ Landscape figures and tables may be produced at full-page size by putting \verb| \caption{A figure with two subfigures \cite{Lienhard2019b}}\label{fig:2} \end{figure*} -%%%%%%%%%%%%%%%%%%% end wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Reference Formatting with \NoCaseChange{\texttt{asmeconf.bst}}\footnote{If you have text in a section heading or caption that you do not want to be capitalized, such as an SI unit, enclose it in a \texttt{\textbackslash NoCaseChange} command.}} - -Citations are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references. Citations and references are managed by the standard \texttt{natbib} package. - -The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles posted on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary. - -%% subsubsections are not numbered -\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given. - -Elementary support for \texttt{eprint} numbers is also included, generating a url at the end of the citation. The \texttt{archive} type may be specified using the macros \texttt{arxiv, googlebooks, hndl, jstore}, or \texttt{pubmed} (e.g., \texttt{archive=hndl}, \textit{without} braces). Both \texttt{eprint} and \texttt{archive} fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|. - -\subsubsection*{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. See the examples of use in the \texttt{asmeconf-sample.bib} file. - -\subsubsection*{Date Accessed} The \verb|urldate={..}| field may be used to provide the date on which a given url was accessed. By default, the text printed will be \texttt{accessed `date',}. The word ``accessed'' may be changed using the \verb|urltype={..}| field. - -\subsubsection*{Conference Location and Date} For the entry types \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and the date of a conference. +%%%%%%%%%%%%%%%%%%% end two column figure %%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%% MORE ON MATH %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% Dealing with complicated math in a section or subsection heading: -%% the optional argument to \section will provide the pdf bookmark -%% without losing characters or producing warnings/errors. +%% the optional argument to \section will provide the pdf bookmark +%% without losing characters or producing warnings/errors. %% -%% In this heading, u is forced to be upright with \mathrm{u} +%% In this heading, letter u is forced to be upright with \mathrm{u} %% \section[More on math: u\cdot\omega=0]{More on math: $\vec{\mathrm{u}}\cdot\vec{\omega}=0$}\label{sec:moremath} @@ -360,11 +404,11 @@ In most cases, the need for a wide equation can be eliminated by using one of th \texttt{multline} environment: \begin{multline}\label{eqn:energy} \frac{\partial}{\partial t}\left[\rho\bigl(e + \lvert\vec{u}\rvert^2\big/2\bigr)\right] + \nabla\cdot\left[\rho\bigl(h + \lvert\vec{u}\rvert^2\big/2 \bigr)\vec{u}\right] \\ - ={}-\nabla \cdot \vec{q} + \rho \vec{u}\cdot\vec{g}+ \frac{\partial}{\partial x_j}\left(d_{ji}u_i\right) + \dot{Q}_v + ={}-\nabla \cdot \vec{q} + \rho \vec{u}\cdot\vec{g}+ \frac{\partial}{\partial x_j}\bigl(d_{ji}u_i\bigr) + \dot{Q}_v \end{multline} An example using \texttt{align} appears in Appendix~\ref{appendix:a}. -An alternative solution may be to set large equations into two-column-wide tables or figures. (You can find code online that sets equations across two columns, but the results may be sketchy.) +An alternative solution may be to set large equations into two-column-wide tables or figures. While a package exists for setting equations that span two columns (\texttt{widetext.sty}), that code is erratic in relation to floats and page breaks. Math italics are used for roman and greek letters by default. If you want an upright letter in math, you can use the relevant math alphabet, e.g., \verb|\mathrm, \mathbf, \mathsf|: \begin{equation}\label{eqn:dw} @@ -372,30 +416,32 @@ Math italics are used for roman and greek letters by default. If you want an up \end{equation} To get additional symbols in bold math, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. -The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots \bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how greek letters are presented). +The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g., $\sfalpha, \sfbeta, \sfgamma, \sfdelta$ \ldots $\bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how greek letters are presented). -\subsection{The \texttt{newtxmath} and \texttt{mathalpha} packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics. Most options can be called as options to \verb|\documentclass|. For example, the \texttt{upint} option of \texttt{newtxmath} selects upright integral signs (rather than slanted integral signs): +\subsection{The \texttt{newtxmath} and \texttt{mathalpha} Packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics, most of which can be called as options to \verb|\documentclass|. For example, the \texttt{upint} option of \texttt{newtxmath} selects upright integral signs (rather than slanted integral signs): \begin{quote} \verb|\documentclass[upint]{asmeconf}|. \end{quote} These math options are discussed further in the \texttt{asmejour-template.tex} file. -In addition, many options for calligraphic, script, and fraktur fonts are available as options to the \texttt{mathalfa} package, which is also loaded. These may be invoked, for example, as +In addition, many options for calligraphic, fraktur, and script fonts are available as options to the \texttt{mathalfa} package, which is also loaded. These may be invoked, for example, as \begin{center} \verb|\documentclass[mathalfa=cal=euler]{asmeconf}| \end{center} which selects the Euler font for \verb|\mathcal| (this is our default). To find all the font options, refer to the \texttt{mathalfa} package documentation \cite{sharpe2}. -The typewriter font loaded is \texttt{inconsolata} (which is sans serif), as suggested by the \texttt{newtx} package documentation. The class is not set up for use with the \texttt{fontspec} or \texttt{unicode-math} packages. +The typewriter font loaded is \texttt{inconsolata} (which is sans serif), as suggested by the \texttt{newtx} package documentation. +The \texttt{asmeconf} class is not set up for use with the \texttt{fontspec} or \texttt{unicode-math} packages. -%%%%%%%%%%%%%%% ADDITIONAL PACKAGE OPTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%% ADDITIONAL PACKAGE OPTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Additional Options for \NoCaseChange{\texttt{asmeconf.cls}}} The class accepts a number of options in addition to those already described. These options are discussed next. \subsection{Colored hyperlinks} -ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors may +ASME requires that all text be \textbf{in black} when the paper is submitted for publication. For other uses, authors may obtain colored hyperlinks with the [\texttt{colorlinks}] option. \subsection{Final Column Balancing} The option \texttt{[balance]} invokes the the \texttt{flushend} package~\cite{tolusis}. @@ -403,7 +449,7 @@ This package will attempt to give equal height to the two columns on the last pa \subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This option will produce line numbers in the margins. You must run \LaTeX\ \textit{twice} for proper placement of the numbers. Tables, captions, and footnotes will not be numbered. Line numbers can be helpful for review and editing, but should not be used in your final manuscript. See the documentation of the \texttt{lineno} package for further commands to control line numbering. -The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is disabled when this option is called. +The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is automatically disabled when this option is called. \subsection{Changing the Footer Text} The option \texttt{[nofoot]} will omit the ASME copyright from the first page footer. The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum}, so you can change them in any way you like using the commands of that package. Only the default arrangement of footers matches ASME's style, however. @@ -417,44 +463,15 @@ Hyphenation is normally suppressed for typewriter mode because this font is ofte \subsection{Support for Other Languages} The package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:c} for details. - -%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%% -\begin{table*}[t] -\caption{A table spanning two columns\label{tab:3}}% -\centering{% -\begin{tabular*}{0.8\textwidth}{@{\hspace*{1.5em}}@{\extracolsep{\fill}}ccc!{\hspace*{3.em}}ccc@{\hspace*{1.5em}}} -\toprule -\multicolumn{1}{@{\hspace*{1.5em}}c}{$x$\rule{0pt}{11pt}} & -\multicolumn{1}{c}{$\textrm{erf}(x)$} & -\multicolumn{1}{c!{\hspace*{3.em}}}{$\textrm{erfc}(x)$} & -\multicolumn{1}{c}{$x$} & -\multicolumn{1}{c}{$\textrm{erf}(x)$} & -\multicolumn{1}{c@{\hspace*{1.5em}}}{$\textrm{erfc}(x)$} \\ \midrule -0.00 & 0.00000 & 1.00000 & 1.10 & 0.88021 & 0.11980\rule{0pt}{11pt} \\ -0.05 & 0.05637 & 0.94363 & 1.20 & 0.91031 & 0.08969 \\ -0.10 & 0.11246 & 0.88754 & 1.30 & 0.93401 & 0.06599 \\ -0.15 & 0.16800 & 0.83200 & 1.40 & 0.95229 & 0.04771 \\ -0.20 & 0.22270 & 0.77730 & 1.50 & 0.96611 & 0.03389 \\ -0.30 & 0.32863 & 0.67137 & 1.60 & 0.97635 & 0.02365 \\ -0.40 & 0.42839 & 0.57161 & 1.70 & 0.98379 & 0.01621 \\ -0.50 & 0.52050 & 0.47950 & 1.80 & 0.98909 & 0.01091 \\ -0.60 & 0.60386 & 0.39614 & 1.82\makebox[0pt][l]{14} & 0.99000 & 0.01000 \\ -0.70 & 0.67780 & 0.32220 & 1.90 & 0.99279 & 0.00721 \\ -0.80 & 0.74210 & 0.25790 & 2.00 & 0.99532 & 0.00468 \\ -0.90 & 0.79691 & 0.20309 & 2.50 & 0.99959 & 0.00041 \\ -1.00 & 0.84270 & 0.15730 & 3.00 & 0.99998 & 0.00002 \\[2pt] -\bottomrule\end{tabular*} -} -\end{table*} - -%%%%%%%%%%%%%%%% end two column table %%%%%%%%%%%%%%%%%%% - - +%%%%% Conclusions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Conclusion} Provide a brief conclusion (3-4 lines). -\section*{Acknowledgment} + +%%%%% Acknowledgments %%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section*{Acknowledgments} Place any acknowledgments here. @@ -462,26 +479,26 @@ Place any acknowledgments here. %%% REFERENCES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% Put your references into your .bib file in the usual way. Run latex once, bibtex once, then latex twice. -%% This specific .bst style allows: venue = {location of conference}, and confmonth = {Month days} +%% The asmeconf.bst style allows: venue = {Location of Conference}, and eventdate = {Month, days} +%% for @inproceedings and @proceedings %% -\nocite{*} %% <=== delete this line unless you want to typeset the entire contents of your .bib file. +\nocite{*} %% <=== Delete this line unless you want to typeset the entire contents of your .bib file! \bibliographystyle{asmeconf} %% .bst file following ASME conference format. Do not change. \bibliography{asmeconf-sample} %% <=== change this to name of your bib file - - %%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \appendix %% Note that appendices will be "numbered" A, B, C, ... etc. Use \section, not \section* -%% Equations should be numbered sequentially following those in the paper. Don't reset the equation counter. +%% Equations will be numbered sequentially following those in the paper. Do not reset the equation counter. %% Here we use the optional argument for the pdf bookmark. \section[The vector product A\times B]{The vector product $\vec{A}\times\vec{B}$}\label{appendix:a} -This is just a brief illustration of an appendix, showing numbering of the appendix and equations. Equations are numbered + +This brief illustration of an appendix shows the numbering of the appendix and equations. Equations are numbered consecutively, following those in the paper. \begin{align} \frac{d\Gamma}{dt} &{}= \int_{\mathcal{C}} \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{r}\\ @@ -492,8 +509,8 @@ consecutively, following those in the paper. \section{Option to use an author grid}\label{appendix:b} -ASME's most recent templates place author names inline, with affiliations for all authors in rows below. This style is the -default for this template. +ASME's most recent templates place author names inline, with affiliations for all authors in rows below. +This style is the default for this template. The historical style of authors with affiliation in a grid of blocks may be invoked with the option [\texttt{oldauthors}]. When using this form, the author names and addresses should be entered as below: @@ -507,16 +524,21 @@ the option [\texttt{oldauthors}]. When using this form, the author names and ad \noindent\hbox{}\hfil\verb|Institution \\ City, Country}| \verb|\SetAuthorBlock{\CorrespondingAuthor{John Lienhard%| \hbox{}\hfil\verb|}{lienhard@mit.edu}}{Institution \\ City, State}| + +Directly usable code is contained at the very end of the \texttt{asmeconf-template.tex} file. -%% directly usable code follows \end{document}, below. +%% directly usable code follows the \end{document} command below. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Language Support}\label{appendix:c} ASME publishes in English, but the \texttt{babel} package is loaded for -users who may wish to include other languages. Options are supported to load a primary language, \texttt{lang=}, as well -as a secondary and tertiary language, \texttt{lang-second} and \texttt{lang-third}. The primary language must be specified explicitly if a secondary language is loaded. If no language option is given, the package defaults to English. +users who may wish to include other languages. Options are supported to load a primary language, \texttt{lang=}, +as well as a secondary and tertiary language, \texttt{lang-second} and \texttt{lang-third}. +The primary language must be specified explicitly if a secondary language is loaded. +If no language option is given, the package defaults to English. An example of use is +shown in \selectlanguage{french}\appendixname\ \ref{app:fourier}.\selectlanguage{english} The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'', ``Nomenclature'', ``Corresponding author'', and ``Joint first authors'' by renewing the commands \verb|\keywordname|, \verb|\nomname|, \verb|\CAwords|, and \verb|\JAwords|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' may be changed by renewing \verb|\appendicesname|. @@ -527,6 +549,15 @@ Font encoding is set to T1 with utf-8 input supported: No effort has been made to support customization of language-specific fonts, although this is possible by modifying the class file (examples are given in the \texttt{newtx} documentation). The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}. +\selectlanguage{french} +\section{Discours Préliminaire de Fourier}\label{app:fourier} + +Les causes primordiales ne nous sont point connues; mais elles sont assujetties à des lois simples et constantes, que l'on peut découvrir par l'observation, et dont l'étude est l'objet de la philosophie naturelle. + +La chale ur pénètre, comme la gravité, toutes les substances de l'univers, ses rayons occupent toutes les parties de l'espace. Le but de notre ouvrage est d'exposer les lois mathématiques que suit cet élément. Cette théorie formera désormais une des branches les plus importantes de la physique générale~\cite{fourier1822}. + +\selectlanguage{english} + \end{document} @@ -548,7 +579,7 @@ No effort has been made to support customization of language-specific fonts, alt % Can omit second argument of \CorrespondingAuthor if putting email into address % i.e., can just use \CorrespondingAuthor{name}. -% Can also put multiple emails and use command more than once for multiple corresponding authors. +% Can also put multiple emails in the command and use more than once for multiple corresponding authors. \SetAuthorBlock{\CorrespondingAuthor{John H.\ Lienhard V}{lienhard@mit.edu}}{% Massachusetts Institute of Technology \\ Cambridge, MA} diff --git a/macros/latex/contrib/asmeconf/asmeconf.bst b/macros/latex/contrib/asmeconf/asmeconf.bst index 961645f7fe..1388b084f8 100644 --- a/macros/latex/contrib/asmeconf/asmeconf.bst +++ b/macros/latex/contrib/asmeconf/asmeconf.bst @@ -1,10 +1,10 @@ %%%%% %%%%% *** This .bst produces the reference format for ASME conference papers. *** -%%%%% *** Follows the examples given on ASME's conference web pages in early 2019. *** +%%%%% *** Follows the examples given on ASME's conference web pages in early 2020. *** %%%%% *** https://www.asme.org/shop/proceedings/conference-publications/references *** -%%%%% *** The examples given by ASME do not cover all possibilities *** +%%%%% *** The examples given by ASME do *not* cover all possibilities *** %%%%% -%%%%% This file is version 1.1 dated 2019/07/07 +%%%%% This file is version 1.11 dated 2020/04/14 %%%%% %%%%% Author: John H. Lienhard V %%%%% Department of Mechanical Engineering @@ -26,13 +26,29 @@ %%%%% Added: urlprefix = {}, format.web.urldate, bbl.urldate; urltype field changes "accessed" to something else. %%%%% Added: venue and eventdate to @inproceedings %%%%% +%%%%% Edits in version 1.11, 2020/04/14: +%%%%% correct error in journal eid code. +%%%%% remove comma between Vol. and No. in article, per ASME style +%%%%% capitalize "Thesis", per ASME style +%%%%% insert "." after techreport number, per ASME style +%%%%% edits to @inbook, @proceedings, @incollection related to chapter and series. +%%%%% make punctuation after "(ed.)" consistent across entries. +%%%%% adjust block breaks in @online. +%%%%% allow for venue and eventdate in @proceedings +%%%%% add macros for ASME journal titles. add hdl as an equivalent to hndl archive macro. +%%%%% add numpages functionality for eid: "eid (numpages pages)" +%%%%% remove "doi" field from @online (since doi is a digital object identifier, not a web page). +%%%%% add "urldate" to eprint format, for optional use. +%%%%% warn in @online not to use both eprint and url, and warn if neither is given. +%%%%% remove series and add volume to @inproceedings. +%%%%% %%%%% Feel free to edit this file to suit your own needs, but please make note of changes in this header. %%%%% %%========================================================= %% LICENSE: %% This file is a derivative work from the generated file, as envisioned by the LaTeX Project Public License. %% -%% Copyright (c) 2019 John Lienhard +%% Copyright (c) 2020 John Lienhard %% %% Permission is hereby granted, free of charge, to any person obtaining a copy of this software and %% associated documentation files (the "Software"), to deal in the Software without restriction, @@ -319,6 +335,9 @@ FUNCTION {bbl.nr} FUNCTION {bbl.in} { "in" } +FUNCTION {bbl.paperno} +{ "" } + FUNCTION {bbl.pages} { "pp." } @@ -335,10 +354,10 @@ FUNCTION {bbl.techrep} { "Technical Report" } FUNCTION {bbl.mthesis} -{ "Master's thesis" } +{ "Master's Thesis" } FUNCTION {bbl.phdthesis} -{ "Ph.D. thesis" } +{ "Ph.D. Thesis" } FUNCTION {bbl.first} { "1st" } @@ -368,7 +387,7 @@ FUNCTION {bbl.th} { "th" } FUNCTION {bbl.urldate} - { "accessed" } + { "Accessed" } MACRO {jan} {"Jan."} @@ -420,13 +439,75 @@ MACRO {arxiv} {"https://arxiv.org/abs/"} MACRO {googlebooks} {"http://books.google.com/books?id="} +MACRO {hdl} {"http://hdl.handle.net/"} MACRO {hndl} {"http://hdl.handle.net/"} MACRO {jstor} {"http://www.jstor.org/stable/"} +MACRO {oclc} {"http://www.worldcat.org/oclc/"} + MACRO {pubmed} {"http://www.ncbi.nlm.nih.gov/pubmed/"} +MACRO {amr} {"Appl. Mech. Rev."} + +MACRO {lds} {"ASME Letters Dynamic Systems"} + +MACRO {jru} {"ASME J. Risk Uncertainty"} + +MACRO {jsbc} {"ASME J. Sustainable Bldg. and Cities"} + +MACRO {jam} {"ASME J. Appl. Mech."} + +MACRO {jbe} {"ASME J. Biomed. Eng."} + +MACRO {jcnd} {"ASME J. Comput. Nonlin. Dyn."} + +MACRO {jcise} {"ASME J. Comput. Inf. Sci. Eng."} + +MACRO {jds} {"J. Dyn. Syst.-T. ASME"} + +MACRO {jep} {"ASME J. Electron. Packag."} + +MACRO {jert} {"ASME J. Energy Resour."} + +MACRO {jegtp} {"ASME J. Eng. Gas Turbines Power"} + +MACRO {jem} {"ASME J. Eng. Mater."} + +MACRO {jfe} {"ASME J. Fluids Eng."} + +MACRO {jfcst} {"ASME J. Fuel Cell Sci. Tech."} + +MACRO {jht} {"ASME J. Heat Transfer"} + +MACRO {jmse} {"ASME J. Manuf. Sci. E."} + +MACRO {jmd} {"ASME J. Mech. Des."} + +MACRO {jmr} {"ASME J. Mech. Robot."} + +MACRO {jmdv} {"ASME J. Med. Devices"} + +MACRO {jmnm} {"ASME J. Micro Nano-Manuf."} + +MACRO {jnem} {"ASME J. Nanotech Eng. Med."} + +MACRO {joma} {"ASME J. Offshore Mech. Arct."} + +MACRO {jpv} {"ASME J. Press. Vess."} + +MACRO {jse} {"ASME J. Sol. Energy"} + +MACRO {jtsea} {"ASME J. Therm. Sci. Eng. Appl."} + +MACRO {jtb} {"ASME J. Tribol."} + +MACRO {jtm} {"ASME J. Turbomach."} + +MACRO {jva} {"ASME J. Vib. Acoust."} + + MACRO {acmcs} {"ACM Computing Surveys"} MACRO {acta} {"Acta Informatica"} @@ -504,21 +585,6 @@ FUNCTION {bibinfo.warn} if$ } - -FUNCTION {format.eprint} -{ eprint duplicate$ empty$ - 'skip$ - { "\eprint" - archive empty$ - { "there's an eprint but no archive in " cite$ * warning$ } - { "[" * archive * "]" * } - if$ - "{" * swap$ * "}" * - } - if$ -} - - FUNCTION {format.web.urldate} { urldate empty$ {""} @@ -537,6 +603,20 @@ FUNCTION {format.web.urldate} if$ } +FUNCTION {format.eprint} +{ eprint duplicate$ empty$ + 'skip$ + { "\eprint" + archive empty$ + { "there's an eprint but no archive in " cite$ * warning$ } + { "[" * archive * "]" * } + if$ + "{" * swap$ * "}" * + format.web.urldate swap$ * + } + if$ +} + FUNCTION {format.url} { url @@ -616,7 +696,6 @@ FUNCTION {get.bbl.editor} FUNCTION {format.editors} { editor "editor" format.names duplicate$ empty$ 'skip$ { - "," * " " * get.bbl.editor "(" swap$ * ")" * @@ -788,6 +867,20 @@ FUNCTION {format.bvolume} } if$ } + +FUNCTION {format.paper.number} +{ number "number" bibinfo.check + type duplicate$ empty$ + { pop$ bbl.paperno } + 'skip$ + if$ + "type" bibinfo.check + swap$ duplicate$ empty$ + { pop$ "t" change.case$ } + { tie.or.space.prefix * * } + if$ +} + FUNCTION {format.number.series} { volume empty$ { number empty$ @@ -800,7 +893,7 @@ FUNCTION {format.number.series} if$ number tie.or.space.prefix "number" bibinfo.check * * bbl.in space.word * - series "series" bibinfo.check * + series emphasize "series" bibinfo.check * } if$ } @@ -939,19 +1032,21 @@ FUNCTION {format.journal.eid} { eid "eid" bibinfo.check duplicate$ empty$ 'pop$ { swap$ duplicate$ empty$ 'skip$ - { + { " " * - } - if$ - swap$ * - numpages empty$ 'skip$ - { bbl.eidpp numpages tie.or.space.prefix - "numpages" bibinfo.check * * - " (" swap$ * ")" * * + format.year * ": " * + swap$ + * + numpages empty$ 'skip$ + { numpages bbl.eidpp tie.or.space.prefix + "numpages" bibinfo.check * * + " (" swap$ * ")" * * + } + if$ } if$ - } - if$ + } + if$ } FUNCTION {format.vol.num.pages} { volume field.or.null @@ -969,14 +1064,14 @@ FUNCTION {format.vol.num.pages} 'skip$ if$ swap$ - ", " bbl.nr * number tie.or.space.prefix pop$ * swap$ * + " " bbl.nr * number tie.or.space.prefix pop$ * swap$ * } if$ * } FUNCTION {format.chapter.pages} { chapter empty$ - { "" } + 'format.pages { type empty$ { bbl.chapter } { type "l" change.case$ @@ -985,6 +1080,10 @@ FUNCTION {format.chapter.pages} if$ chapter tie.or.space.prefix "chapter" bibinfo.check + pages empty$ + 'skip$ + { ", " * format.pages * } + if$ * * } if$ @@ -1003,7 +1102,7 @@ FUNCTION {format.in.ed.booktitle} "" * " " * get.bbl.editor - "(" swap$ * ") " * + "(" swap$ * "). " * * swap$ * } if$ @@ -1193,7 +1292,6 @@ FUNCTION {book} { output.bibitem author empty$ { format.editors "author and editor" output.check - add.blank } { format.authors output.nonnull crossref missing$ @@ -1227,6 +1325,7 @@ FUNCTION {book} format.note output fin.entry } + FUNCTION {booklet} { output.bibitem format.authors output @@ -1263,22 +1362,23 @@ FUNCTION {inbook} new.block crossref missing$ { + format.bvolume output format.number.series output + new.block + new.sentence format.publisher.address output - format.bvolume output - format.chapter.pages "chapter and pages" output.check new.block new.sentence } { - format.chapter.pages "chapter and pages" output.check new.block format.book.crossref output.nonnull } if$ format.date "year" output.check date.block - format.pages "pages" output.check + format.chapter.pages "chapter and pages" output.check + new.block format.doi output new.block format.eprint output @@ -1297,9 +1397,9 @@ FUNCTION {incollection} crossref missing$ { format.in.ed.booktitle "booktitle" output.check format.edition output + new.block format.number.series output format.bvolume output - format.chapter.pages output new.sentence format.publisher.address output } @@ -1309,7 +1409,7 @@ FUNCTION {incollection} if$ format.date "year" output.check conf.date.block - format.pages "pages" output.check + format.chapter.pages "pages" output.check format.doi output new.block format.eprint output @@ -1327,8 +1427,13 @@ FUNCTION {inproceedings} new.block crossref missing$ { format.in.ed.booktitle "booktitle" output.check + volume empty$ 'skip$ + { bbl.volume volume tie.or.space.prefix + "volume" bibinfo.check * * output + } + if$ new.sentence - format.number.series output + format.paper.number output conf.date.block format.pages "pages" output.check new.sentence @@ -1355,6 +1460,7 @@ FUNCTION {inproceedings} fin.entry } FUNCTION {conference} { inproceedings } + FUNCTION {manual} { output.bibitem author empty$ @@ -1435,6 +1541,46 @@ FUNCTION {misc} empty.misc.check } +FUNCTION {online} +{ output.bibitem + author empty$ + { format.editors "author and editor" output.check + } + { format.authors output.nonnull + crossref missing$ + { "author and editor" editor either.or.check } + 'skip$ + if$ + } + if$ + new.block + format.title + "title" output.check + new.block + organization "organization" bibinfo.warn output + address "address" bibinfo.check output + format.date "year" output.check + new.block + url empty$ + { eprint empty$ + { "missing url and eprint in" cite$ * warning$ } + { format.eprint output } + if$ + } + { "url and eprint" eprint either.or.check + format.url "url" bibinfo.warn output + } + if$ + new.block + format.note output + fin.entry +} + +FUNCTION {electronic} { online } + +FUNCTION {www} { online } + + FUNCTION {phdthesis} { output.bibitem format.authors "author" output.check @@ -1461,11 +1607,16 @@ FUNCTION {proceedings} editor empty$ { organization "organization" bibinfo.check output } - { format.editors output.nonnull } + { format.editors output.nonnull + } if$ new.block format.btitle "title" output.check format.bvolume output + new.block + venue "venue" output.check + eventdate "eventdate" output.check + new.block editor empty$ { publisher empty$ { format.number.series output } @@ -1490,7 +1641,7 @@ FUNCTION {proceedings} if$ } if$ - format.date "year" output.check + format.date "year" output.check format.doi output new.block format.eprint output @@ -1508,6 +1659,7 @@ FUNCTION {techreport} "title" output.check new.block format.tr.number output.nonnull + new.block institution "institution" bibinfo.warn output address "address" bibinfo.check output new.block @@ -1521,35 +1673,6 @@ FUNCTION {techreport} fin.entry } -FUNCTION {online} -{ output.bibitem - author empty$ - { format.editors "author and editor" output.check - } - { format.authors output.nonnull - crossref missing$ - { "author and editor" editor either.or.check } - 'skip$ - if$ - } - if$ - format.title - "title" output.check - new.block - organization "organization" bibinfo.warn output - address "address" bibinfo.check output - format.date "year" output.check - format.doi output - format.note output - format.eprint output - format.url "url" bibinfo.warn output - fin.entry -} - -FUNCTION {electronic} { online } - -FUNCTION {www} { online } - FUNCTION {unpublished} { output.bibitem format.authors "author" output.check diff --git a/macros/latex/contrib/asmeconf/asmeconf.cls b/macros/latex/contrib/asmeconf/asmeconf.cls index 11cf01aba5..be225271d9 100644 --- a/macros/latex/contrib/asmeconf/asmeconf.cls +++ b/macros/latex/contrib/asmeconf/asmeconf.cls @@ -1,13 +1,13 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% This file provides the asmeconf class for formatting conference papers according to -%% ASME conference requirements as represented on ASME's conference web pages in mid-2019. +%% ASME conference requirements as represented on ASME's conference web pages in 2020. %% %% Please note that ASME's journals follow specifications different from ASME conference papers. %% -%% This file is version 1.17 dated 2020/02/29. - \def\versionno{1.17} - \def\versiondate{2020/02/29\space} +%% This file is version 1.18 dated 2020/04/14. + \def\versionno{1.18} + \def\versiondate{2020/04/14\space} %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering diff --git a/macros/latex/contrib/embedfile/embedfile.dtx b/macros/latex/contrib/embedfile/embedfile.dtx index 1fb0ed84b6..dbdfbaeafc 100644 --- a/macros/latex/contrib/embedfile/embedfile.dtx +++ b/macros/latex/contrib/embedfile/embedfile.dtx @@ -1,12 +1,12 @@ % \iffalse meta-comment % % File: embedfile.dtx -% Version: 2019/12/03 v2.9 +% Version: 2020-04-14 v2.10 % Info: Embed files into PDF % % Copyright (C) % 2006-2011 Heiko Oberdiek -% 2016-2019 Oberdiek Package Support Group +% 2016-2020 Oberdiek Package Support Group % https://github.com/ho-tex/embedfile/issues % % This work may be distributed and/or modified under the @@ -89,7 +89,7 @@ \input docstrip.tex \Msg{************************************************************************} \Msg{* Installation} -\Msg{* Package: embedfile 2019/12/03 v2.9 Embed files into PDF (HO)} +\Msg{* Package: embedfile 2020-04-14 v2.10 Embed files into PDF (HO)} \Msg{************************************************************************} \keepsilent @@ -101,11 +101,11 @@ This is a generated file. Project: embedfile -Version: 2019/12/03 v2.9 +Version: 2020-04-14 v2.10 Copyright (C) 2006-2011 Heiko Oberdiek - 2016-2019 Oberdiek Package Support Group + 2016-2020 Oberdiek Package Support Group This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either @@ -179,7 +179,7 @@ and the derived files %<*driver> \NeedsTeXFormat{LaTeX2e} \ProvidesFile{embedfile.drv}% - [2019/12/03 v2.9 Embed files into PDF (HO)]% + [2020-04-14 v2.10 Embed files into PDF (HO)]% \documentclass{ltxdoc} \usepackage{holtxdoc}[2011/11/22] \begin{document} @@ -193,7 +193,7 @@ and the derived files % \GetFileInfo{embedfile.drv} % % \title{The \xpackage{embedfile} package} -% \date{2019/12/03 v2.9} +% \date{2020-04-14 v2.10} % \author{Heiko Oberdiek\thanks % {Please report any issues at \url{https://github.com/ho-tex/embedfile/issues}}} % @@ -201,7 +201,7 @@ and the derived files % % \begin{abstract} % This package embeds files to a PDF document. -% Currently the only supported driver is \pdfTeX\ $>=$ 1.30 in PDF mode. +% Currently the only supported drivers are \pdfTeX\ $>=$ 1.30 and lua\TeX\ in PDF mode. % \end{abstract} % % \tableofcontents @@ -302,6 +302,9 @@ and the derived files % for a list of officially registered types. % \item[\xoption{desc}] % The description for the file. +% \item[\xoption{afrelationship}] +% This adds the /AFRelationship key to the filespec dicrectory. The value is +% a pdf name with or without the leading slash.% % \item[\xoption{stringmethod}] % The package must convert the values of the keys \xoption{ucfilespec} % and \xoption{desc} into a PDF string (before version 2.4: \xoption{filespec} @@ -620,7 +623,7 @@ You need Acrobat Reader 8 or higher. %<*dtxattach> \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{dtx-attach} - [2019/12/03 v2.9 Embed \string\jobname.dtx (HO)]% + [2020-04-14 v2.10 Embed \string\jobname.dtx (HO)]% \RequirePackage{embedfile}[2019/12/03] \embedfile[% stringmethod=escape,% @@ -711,7 +714,7 @@ You need Acrobat Reader 8 or higher. \fi \expandafter\x\csname ver@embedfile.sty\endcsname \ProvidesPackage{embedfile}% - [2019/12/03 v2.9 Embed files into PDF (HO)]% + [2020-04-14 v2.10 Embed files into PDF (HO)]% % \end{macrocode} % % \subsection{Catcodes} @@ -1376,6 +1379,7 @@ You need Acrobat Reader 8 or higher. % \end{macro} % \begin{macro}{\EmFi@embedfile} % \begin{macrocode} +\def\EmFi@removeslash#1{\if/#1\else#1\fi}% \def\EmFi@embedfile[#1]#2{% \ifEmFi@finished \EmFi@Error{% @@ -1412,7 +1416,8 @@ You need Acrobat Reader 8 or higher. \ifx\EmFi@afrelationship\ltx@empty \let\EmFi@@afrelationship\ltx@empty \else - \EmFi@convert\EmFi@afrelationship\EmFi@@afrelationship + \expandafter\edef\expandafter\EmFi@@afrelationship\expandafter + {\expandafter\EmFi@removeslash\EmFi@afrelationship} \fi \ifEmFi@item \let\do\EmFi@do @@ -1454,7 +1459,7 @@ You need Acrobat Reader 8 or higher. \fi \ifx\EmFi@@afrelationship\ltx@empty \else - /AFRelationship\EmFi@@afrelationship% + /AFRelationship/\pdf@escapename{\EmFi@@afrelationship}% \fi /EF<<% /F \the\pdflastobj\ltx@space 0 R% @@ -1947,7 +1952,7 @@ You need Acrobat Reader 8 or higher. % \end{Version} % \begin{Version}{2018/11/01 v2.8} % \item -% Remove luatex85 package depenency. +% Remove luatex85 package dependency. % \end{Version} % \begin{Version}{2019/12/03 v2.9} % \item @@ -1957,6 +1962,10 @@ You need Acrobat Reader 8 or higher. % \item % update to use \xpackage{iftex} % \end{Version} +% \begin{Version}{2020-04-14 v2.10} +% \item Fix issue \#4, the value of afrelationship should not be +% converted but name escaped. +% \end{Version} % \end{History} % % \PrintIndex diff --git a/macros/latex/contrib/embedfile/embedfile.pdf b/macros/latex/contrib/embedfile/embedfile.pdf Binary files differindex a91594eaf5..66682ebd9f 100644 --- a/macros/latex/contrib/embedfile/embedfile.pdf +++ b/macros/latex/contrib/embedfile/embedfile.pdf diff --git a/macros/latex/contrib/iodhbwm/tex/i18n.def b/macros/latex/contrib/iodhbwm/tex/iodhbwm-i18n.def index 42dda7a3ff..42dda7a3ff 100644 --- a/macros/latex/contrib/iodhbwm/tex/i18n.def +++ b/macros/latex/contrib/iodhbwm/tex/iodhbwm-i18n.def diff --git a/macros/latex/contrib/iodhbwm/tex/iodhbwm-templates.sty b/macros/latex/contrib/iodhbwm/tex/iodhbwm-templates.sty index b52807439e..15ef8e9317 100644 --- a/macros/latex/contrib/iodhbwm/tex/iodhbwm-templates.sty +++ b/macros/latex/contrib/iodhbwm/tex/iodhbwm-templates.sty @@ -23,8 +23,8 @@ % % ---------------------------------------------------------- -\newcommand*{\iodhbwm@pkg@version}{v1.2} -\newcommand*{\iodhbwm@pkg@date}{2020-04-01} +\newcommand*{\iodhbwm@pkg@version}{v1.2.1} +\newcommand*{\iodhbwm@pkg@date}{2020-04-13} \newcommand*{\iodhbwm@pkg@info}{Inoffical DHBW Mannheim thesis package} \newcommand*{\iodhbwm@pkg@name}{iodhbwm-templates} @@ -84,7 +84,7 @@ \def\iodhbwm@thesis@type@sa{Studienarbeit} \iflanguage{ngerman}{\booltrue{iodhbwm@if@supported@language}}{} -\input{i18n.def} +\input{iodhbwm-i18n.def} % ---------------------------------------------------------- % Define internal commands diff --git a/macros/latex/contrib/iodhbwm/tex/iodhbwm.cls b/macros/latex/contrib/iodhbwm/tex/iodhbwm.cls index c1ffa62ff6..2c3e62ea26 100644 --- a/macros/latex/contrib/iodhbwm/tex/iodhbwm.cls +++ b/macros/latex/contrib/iodhbwm/tex/iodhbwm.cls @@ -23,8 +23,8 @@ % % ---------------------------------------------------------- -\newcommand*{\iodhbwm@cls@version}{v1.2} -\newcommand*{\iodhbwm@cls@date}{2020-04-01} +\newcommand*{\iodhbwm@cls@version}{v1.2.1} +\newcommand*{\iodhbwm@cls@date}{2020-04-13} \newcommand*{\iodhbwm@cls@info}{Inoffical DHBW Mannheim thesis class} \ProvidesClass{iodhbwm}[% diff --git a/macros/latex/contrib/latex-tds/README b/macros/latex/contrib/latex-tds/README deleted file mode 100644 index e44f39c4bb..0000000000 --- a/macros/latex/contrib/latex-tds/README +++ /dev/null @@ -1,947 +0,0 @@ -============================ -README for project latex-tds -============================ - -Heiko Oberdiek -2014/11/12 - - -Table of Contents -================= - - 1. Project latex-tds - 1.1. How it has started - 1.2. Goals of the project - 1.3. Scope - 1.4. Module list - 2. Abbreviations, Glossary - 3. Download - 4. Installation Hints - 4.1. Hints - 5. Copyright, License - 6. Manifest - 6.1. Documentation - 6.2. Licenses - 6.3. Scripts - 6.4. Configuration - 6.5. Documentation driver - 6.6. Patches - 7. Design Principles - 8. Remarks - 8.1. Base - 8.2. Tools - 8.3. Knuth - 8.4. e-TeX - 9. Build Hints - 10. History - - -1. Project latex-tds -===================== - -Bundle `latex-tds' provides a set of ZIP file modules containing TDS-compliant -trees for items of the LaTeX distribution (both the base system and required -packages), together with `user-friendly' documentation (PDF files with -navigation support using bookmarks and links). - -Version: - - 2014/11/12 - -Author: - - Heiko Oberdiek - -Email and bug report address: - - heiko.oberdiek at googlemail.com - -CTAN home page with distribution files: - - CTAN:macros/latex/contrib/latex-tds/ - -Source repository (without distribution files): - - https://github.com/oberdiek/latex-tds - -1.1. How it has started ------------------------- - -The project started as I wanted to install the new LaTeX release 2005/12/01 -that was announced at 2006/04/27. However the files are not packed in TDS -format, ready for unpacking in the destination directory. And the documentation -files were not yet generated or the provided PDF files are lacking of basic -features such as bookmarks or link support. Thus this project has started. I -thought it could be finished during the afternoon at the day of the -announcement … - -1.2. Goals of the project --------------------------- - - • From the sources a TDS compliant tree is constructed and populated. The - zipped result is distributed. - - • All the documentation is generated from the sources. The PDF files are user - friendly and provide navigational support with bookmarks and links. - - • The PDF files are post-processed to reduce the file size. - -1.3. Scope ------------ - -I do not have the time to assemble a TeX distribution with thousands of -packages. Therefore I restricted myself to the LaTeX base distribution and the -required bundles. In the following I will use the term ‘module’ for a package -bundle. - -1.4. Module list ------------------ - -The link addresses are the sources for the modules. - -base - - CTAN:macros/latex/base.zip - CTAN:macros/latex/doc.zip - http://www.latex-project.org/guides/lb2.err - http://www.latex-project.org/guides/lgc2.err - http://www.latex-project.org/guides/manual.err - http://www.latex-project.org/guides/tlc2.err - -tools - - CTAN:macros/latex/required/tools.zip - -cyrillic - - CTAN:macros/latex/required/cyrillic.zip - -amslatex - - CTAN:install/macros/latex/required/amslatex/amscls.tds.zip - CTAN:install/macros/latex/required/amslatex/math.tds.zip - CTAN:macros/latex/contrib/amsrefs.zip - CTAN:macros/latex/required/amslatex.zip - ftp://ftp.ams.org/pub/tex/amsrefs/amsrefs.zip - ftp://ftp.ams.org/pub/tex/amscls.zip - ftp://ftp.ams.org/pub/tex/amsmath.zip - patch/amsbooka.zip - -amsfonts - - CTAN:install/fonts/amsfonts.tds.zip - -psnfss - - CTAN:macros/latex/required/psnfss.zip - -tds - - CTAN:tds.zip - -knuth - - CTAN:systems/knuth/dist/errata.zip - CTAN:systems/knuth/dist/etc.zip - CTAN:systems/knuth/dist/mfware.zip - CTAN:systems/knuth/dist/texware.zip - CTAN:systems/knuth/dist/web.zip - CTAN:systems/knuth/dist/tex.zip - CTAN:systems/knuth/dist/mf.zip - -etex - - CTAN:systems/e-tex/v2.1/etex_doc.zip - - -2. Abbreviations, Glossary -=========================== - -CTAN - - Comprehensive TeX Archive Network. - FAQ entry: http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives - For example, you can resolve the prefix CTAN: by using http:// - mirror.ctan.org/. - -latex-tds - - The name of this project. - -TDS - - TeX Directory Structure. - FAQ entry: http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds - Specification: http://www.ctan.org/pkg/tds - - -3. Download -============ - -The home of the project is located at: - -CTAN:macros/latex/contrib/latex-tds/ - -The following files can be downloaded: - - • README, README.html, README.pdf: The README file in different formats. - - • <module>.tds.zip: The module distribution files, see section ‘Module list’ - above for the available modules. - - • source.tds.zip: The sources, mainly the build script, configuration and - driver files, and patches. Some of the used tools are not provided, see - section ‘Build Hints’. - - • latex-tds.tds.zip: The universe, the contents of all the ZIP files above, - merged together. - - -4. Installation Hints -====================== - -Hopefully the result of this project helps you in the installation process. You -get a TDS compliant tree just by unpacking. - -Example: - - cd /some/where/texmf - unzip latex-tds - -or unzip’s option -d: - - unzip latex-tds -d /some/where/texmf - -Instead of the universe ZIP file single modules can be selected. - -Important to remember, point your unpack process right in the root directory of -your TDS tree. The directory structure in the ZIP files start with the -top-level directories: - - doc/latex/base/... - tex/latex/tools/... - source/... - -Rationale: The root directory of a TDS tree can have different names, such as -texmf-dist, texmf-local, … - -4.1. Hints ------------ - - • Refresh the file name database. - - • Be aware that unpacking can insert and update files, but never deletes - obsolete ones. Remainders of previous releases can cause trouble. - - • Depending on the module further installation steps can be necessary, - consult the module’s own documentation. - -4.1.1. Module base - - • The default texsys.cfg that LaTeX provides is put into TDS:tex/latex/base. - It must be removed, if you need a specialized version. Consult your TeX - distribution and TDS:doc/latex/base/source2e.pdf (module ltdirchk). Usually - changes are not required for many TeX distributions such as Unix (web2c), - MikTeX, … - - • Formats need rebuilding (e.g., fmtutil). - -4.1.2. Module psnfss - - • The map files need further configuring (e.g., updmap). - -4.1.3. Module graphics - - • Module graphics does not provide all driver files, because some are - developed independently (pdftex.def, …). - - -5. Copyright, License -====================== - -Copyright © 2006-2014 Heiko Oberdiek. - -License is LPPL 1.3c: - -This work may be distributed and/or modified under the conditions of the LaTeX -Project Public License, either version 1.3 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.3c or later is part of all distributions of LaTeX version 2005/12 -/01 or later. - -This work has the LPPL maintenance status ‘maintained’. - -The Current Maintainer of this work is Heiko Oberdiek. - -See the following section ‘Manifest’ for a list of all files belonging to the -project ‘latex-tds’. - - -6. Manifest -============ - -Included are the projects ‘adjust_checksum’ and ‘ziptimetree’. They are -projects of their own. - -6.1. Documentation -------------------- - -README plain text file - -README.html standalone HTML file - -README.pdf PDF version - -README.asciidoc main source code in text document format AsciiDoc - -README-docinfo.html source code, read by asciidoc to generate - README.html - -6.2. Licenses --------------- - -license/lppl.txt LPPL (The LaTeX Project Public License) for - latex-tds and adjust_checksum - -license/ziptimetree/lgpl.txt LGPL (GNU Lesser General Public License) for - ziptimetree, check-ascii, check-eolspaces - -6.3. Scripts -------------- - -build.pl main script for building the distribution - -lib/adjust_checksum.pl Perl script that runs a DTX file through LaTeX - and corrects its \Checksum if necessary - -lib/check-ascii.pl Perl script that looks for non-ASCII characters - -lib/check-eolspaces.pl Perl script that looks for trailing spaces - -lib/check-tds-installation.pl Perl script that compares a module with an - installation inside a TDS tree. - -lib/ziptimetree.pl Perl script that generates a ZIP file from a - directory tree with sorted entries (LGPL) - -6.4. Configuration -------------------- - -tex/docstrip.cfg enables TDS feature and creates directories - -tex/errata.cfg for errata lists of latex/base - -tex/fix-expl3-lua.ini fix for expl3, if used in format file - -tex/hyperref.cfg hyperref configuration file - -tex/ltnews.cfg for LaTeX News of latex/base - -tex/ltugboat.cls setup for class ltugboat - -tex/ltxdoc.cfg setup for class ltxdoc - -tex/ltxguide.cfg setup for the guide manuals in latex/base and - required/psnfss - -tex/lualatex-tds.ini init file for format generation for LuaTeX - -tex/lualatex-tds2.ini init file for LuaTeX format without LM Math - -tex/manual.cfg setup for errata list of the LaTeX manual in latex/ - base - -tex/pdflatex-tds.ini init file for format generation for pdfTeX - -tex/tdsguide.cfg setup for class tdsguide.cls - -6.5. Documentation driver --------------------------- - -tex/ams.drv generic doc driver for files from the amslatex - bundle - -tex/doc_lppl.tex doc driver for base/lppl.tex - -tex/errata.all doc driver for knuth/errata/errata.pdf - -tex/errata.drv doc driver for knuth/errata/errata_*.pdf - -tex/errorlog.drv doc driver for knuth/errata/errorlog.tex - -tex/etex_man.drv doc driver for etex/etex_man.tex - -tex/knuth.drv doc driver for knuth/{texware,mfware,etc}+/*.web+ - -tex/knuth-outline.tex outline file list for module knuth - -tex/ltnews.tex master file that merges all base/ltnews*.tex - -tex/ltxcheck.drv doc driver with patches for ltxcheck.tex - -tex/psnfss2e.drv doc driver with patches for psnfss2e.tex - -tex/tools-overview.cls class for tools.tex - -tex/tools.tex master file for tools overview, generated by the - build.pl script from tools/manifest.txt - -6.6. Patches -------------- - -Diff/patch file Patched file - -patch/amsbooka.zip amslatex/amsbooka.* - -patch/amsclass.dtx.diff amslatex/amsclass.dtx - -patch/amsfndoc.def.diff amsfonts/amsfndoc.def - -patch/amsfndoc.tex.diff amsfonts/amsfndoc.tex - -patch/amsldoc.tex.diff amslatex/amsldoc.tex - -patch/changes.tex.diff amslatex/amsrefs/changes.tex - -patch/encguide.tex.diff base/encguide.tex - -patch/errorlog.tex.diff knuth/errata/errorlog.tex - -patch/logmac.tex.diff knuth/errata/logmac.tex - -patch/source2e.tex.diff base/source2e.tex - -patch/tlc2.err.diff base/tlc2.err - -patch/trapman.tex.diff knuth/mf/trapman.tex - -patch/tripman.tex.diff knuth/tex/tripman.tex - -patch/utf8ienc.dtx.diff base/utf8ienc.dtx - -patch/webman.tex.diff knuth/web/webman.tex - - -7. Design Principles -===================== - - • Compliance with the latest TDS specification. - - • No redundancy. - - • User friendly PDF files with navigational support: - - □ bookmarks - - □ links - - • Complete documentation. The documentation generation with enhanced PDF - files is the tricky part and should be saved from the user. - - • Output format of generated documentation is PDF, see above. Other formats - such as DVI or PS are not generated and provided. - - • Documentation bundles are preferred to many partial documentation files - (e.g. source2e.pdf or ltnews.pdf). - - • If several expansion stages of a documentation are available, then just the - most complete expansion stage should be used. - - • Files that do not fit in a program sub tree of TDS stay below TDS:source - (e.g. latexbug.el from latex/base). Then they do not get lost at least. - - • Page layout: a4paper with reduced vertical margins (exception: ltnews). - (This also decreases the page number usually.) - - • … - - -8. Remarks -=========== - -8.1. Base ----------- - - • source2e.pdf is used instead of many single lt*.pdf files. - - • ltnews.pdf is introduced to avoid cluttering the doc directory with many - single sheet ltnews*.pdf files. - - • Patch for ltfssdcl.dtx: Checksum fixed. - - • … - -8.2. Tools ------------ - - • Added: tools.pdf as overview/contents/index file with links and short - descriptions of the single packages. (It uses the data from manifest.txt). - - • … - -8.3. Knuth ------------ - - • Current CTAN → TDS mapping in use: CTAN:systems/knuth/dist → TDS:<toplevel> - /knuth - - • Unsure where to put trip/trap files. Currently they are put in TDS:source, - because the documentation files (tripman.pdf, trapman.pdf) are in TDS:doc. - They lists the trip/trap files already. - - • Not covered is CTAN:systems/knuth/dist/lib/ In TeX Live 2007/2008 the files - are installed at different locations: - - texmf-dist/fonts/source/public/mflogo/logo10.mf - texmf-dist/fonts/source/public/mflogo/logo8.mf - texmf-dist/fonts/source/public/mflogo/logo9.mf - texmf-dist/fonts/source/public/mflogo/logobf10.mf - texmf-dist/fonts/source/public/mflogo/logo.mf - texmf-dist/fonts/source/public/mflogo/logosl10.mf - texmf-dist/fonts/source/public/misc/grayf.mf - texmf-dist/fonts/source/public/misc/manfnt.mf - texmf-dist/fonts/source/public/misc/slant.mf - texmf-dist/metafont/base/expr.mf - texmf-dist/metafont/base/io.mf - texmf-dist/metafont/base/null.mf - texmf-dist/metafont/base/plain.mf - texmf-dist/metafont/misc/3test.mf - texmf-dist/metafont/misc/6test.mf - texmf-dist/metafont/misc/rtest.mf - texmf-dist/metafont/misc/test.mf - texmf-dist/metafont/misc/waits.mf - texmf-dist/metafont/misc/ztest.mf - texmf-dist/mft/base/cmbase.mft - texmf-dist/mft/base/plain.mft - texmf-dist/tex/generic/misc/null.tex - texmf-dist/tex/plain/base/manmac.tex - texmf-dist/tex/plain/base/mftmac.tex - texmf-dist/tex/plain/base/plain.tex - texmf-dist/tex/plain/base/story.tex - texmf-dist/tex/plain/base/testfont.tex - texmf-dist/tex/plain/base/webmac.tex - texmf/tex/generic/hyphen/hyphen.tex - -8.4. e-TeX ------------ - - • Only the manual ‘etex_man’ is covered by this module. - - -9. Build Hints -=============== - -The most important advice I can give: ‘Forget it’! The purpose of the source -files are rather to show, what was done in which way. The *.zip with TDS trees -are the goal of the project, not the build process. Some remarks, if someone -wants to build the modules himself: - - • TeX compiler: LuaTeX and pdfTeX (≥ 1.30). - - • An up-to-date LaTeX installation, at least TeX Live 2012. - - • Additional packages can be necessary, e.g. CTAN:language/armenian/ - armtex.zip is not part of TeX Live 2012. - - • Most of the PDF files are generated using lualatex and package ‘fontspec’ - that uses the Latin Modern fonts as default. They are available as OpenType - fonts. LuaTeX generates with OpenType fonts considerably smaller PDF files. - Also PDF object stream compression is used (PDF 1.5). Therefore the further - post-processing of PDF files are currently dropped. - - • (Outdated since 2011-07-01) PDF post-processing, I have used two steps: - - 1. First step: - - 1. I have written a tool that analyzes page stream contents and - optimizes them (removal of unnecessary color settings, minimize - translation operations, …) → pdfbox-rewrite.jar. - - 2. For reading and writing the PDF file I have used PDFBox → - PDFBox-0.7.2.jar (http://pdfbox.apache.org/). - - 3. To get better results I patched some of the classes of PDFBox - (especially the write module) → pdfbox-rewrite.jar. - - 2. The final conversion step was done by Multivalent, because it makes a - very good job in PDF compression: → Multivalent20060102.jar (http:// - multivalent.sourceforge.net/) - - Multivalent and PDFBox are available, pdfbox-rewrite.jar, however, is just - a first prototype, not ripe for a release. Therefore this step of - post-processing is optional for the project latex-tds. The build script - looks for the library and skips this steps automatically if necessary. If - you give the build script the option --nopostprocess, then it will skip the - postprocess steps (building is faster, the pdf files a little larger). - Install the jar files in the directory lib where they are expected by the - build script. - - • Unix, Perl background is expected. - - • No support or documentation. - - -10. History -============ - -2006/04/27 - □ Start of the project (without babel, amslatex, psnfss). - -2006/06/01 - □ Module amslatex added. - -2006/06/03 - □ Modules psnfss and babel added, now all modules are covered. - -2006/06/07 - □ The project uploaded to CTAN. - -2006/07/31 - □ Index added to base/classes.dtx. - - □ ZIP files renamed: *-tds.zip → *.zip - - □ Comment added to ZIP files. - - □ Update of readme.txt. - -2006/08/26 - □ Module tds for CTAN:tds/ added. - - □ Obsolete hyphenation patterns added to babel’s source directory to - avoid violation of LPPL. - - □ Script adjust_checksum added and scripts are put below TDS:scripts. - - □ TDS:makeindex/base/ renamed to TDS:makeindex/latex/ - - □ Exception for sample2e.tex and small2e.tex that now go into TDS:tex/ - latex/base/. - -2006/08/28 - □ Default texsys.cfg is generated. - - □ adjust_checksum.pl and ziptimetree.pl now moved from the scripts branch - to TDS:source/latex/latex-tds/lib/. - -2006/12/27 - □ Fix of ltxguide.cfg that had loaded doc.sty that disturbs the verbatim - stuff in fntguide.tex. - -2007/01/08 - □ Fix for documentation of longtable. - -2007/03/19 - □ Patch for babel/latin.dtx added (babel/3922). - -2007/09/04 - □ A minor update on CTAN regarding babel: iahyphen.tex, icehyph.tex, and - lahyph.tex are now symbolic links to their location in CTAN:language/ - hyphenation/. Therefore also lahyph.tex is now installed in TDS:tex/ - generic/hyphen/. - -2007/10/18 - □ Update of module amslatex because of updated package amsrefs. - - □ Fix in latin.dtx.diff. - -2007/10/24 - □ Update of babel. - - □ Update of amsrefs (TDS:tex/latex/amscls → TDS:tex/latex/amsrefs). - -2008/04/01 - □ Update of babel (2008/03/17). - -2008/04/02 - □ Fix: latex/base/*.err added to TDS:source/latex/base/. - -2008/04/05 - □ Using .tds.zip instead of .zip to follow CTAN:install's naming - conventions. - -2008/06/28 - □ Update of babel (2008/06/01). - - □ Babel documentation: table of contents reformatted. - -2008/07/07 - □ Update of babel (2008/07/06). - -2008/07/10 - □ Module knuth added. - - □ Update of babel (2008/07/07). - -2008/07/11 - □ Fixes and additions for module knuth. - -2008/07/25 - □ Module amslatex: instr-l.tex vanished from CTAN (but not at AMS side). - - □ Some unwanted spaces in generated PDF files fixed. (Caused by a wrong - package file that was found on my system first.) - -2008/08/10 - □ Module latex3 added. - - □ Module base: CTAN hyperlinks fixed. - - □ Module amslatex: Outdated URL fixed in amsldoc.tex. - - □ Module babel: Problem with already defined \meta in tb1604.tex fixed. - -2008/09/06 - □ Module base: - - ☆ Using uptodate versions from LaTeX project page for errata lists. - - ☆ lgc2.err added (LaTeX Graphics Companion, 2. ed.). - - ☆ Various fixes in errata lists. - - □ Module tools: array.dtx: documentation fixed (tools/4044). - -2008/09/10 - □ Module base: Missing title date for utf8ienc.pdf fixed. - -2009/09/05 - □ Module amslatex: updated. - - □ Module latex3: xpackages updated. - - □ Module latex3: expl3 removed, because nothing to do. - -2009/09/25 - □ Module amslatex: updated. - - □ Module babel: updated. - - □ Update of LaTeX, release 2009/09/24. - -2009/12/07 - □ Module amslatex: Unhappily the .zip files are quite a mess, because - they contain a mixup of old and new versions. Tried to sort this out - and fix the last update. - - □ Module latex3: xpackages removed, because nothing to do. - - □ Module latex3 removed, nothing left to do. - -2010/05/04 - □ Module base: page layout for source2e fixed (changes, index). - - □ Module base: update of .err files. - -2010/10/27 - □ Module amslatex: amscls and amsrefs updated. - - □ Module etex added (only for etex_man). - - □ Erratas updated. - -2011/03/10 - □ Module base: patch for latex/4148 (Missing \label and \ref in - lppl.tex). - -2011/04/18 - □ Module amslatex: There is an outdated version of amsthm.sty in - CTAN:install/macros/latex/required/amslatex/amscls.tds.zip. The package - amsthm.sty is now generated from the source. - - □ Using TDS tree for missing packages that are not part of TeX Live. - Module base: CTAN:language/armenian/armtex.zip. - -2011/06/24 - □ Module amslatex: Two downloads from AMS server removed, because the - files are not longer available (and they are on CTAN). - - □ Module amslatex: 00readme.txt and amsrefs.dtx taken from CTAN:macros/ - latex/contrib/amsrefs.zip instead of CTAN:install/macros/latex/contrib/ - amsrefs.tds.zip because the later archive file is out of sync. - -2011/06/30 - □ Module base: - - ☆ Update of LaTeX, release 2011/06/27. - - ☆ Patch ltpatch.ltx to match the kernel version. - - ☆ Patch lppl.tex.diff removed (no longer needed). - - ☆ Patch ltfssdcl.dtx.diff added (checksum fixed). - - □ Module tools: Release 2011/06. - - □ Module babel: Release 2011/06. - -2011/07/01 - □ PDF generation: - - ☆ Use of LuaTeX instead of pdfTeX for most of the files. - - ☆ Use of package ‘fontspec’ with Latin Modern fonts as default in - OpenType format (smaller PDF file sizes). The post-processing of - PDF files is skipped. - - ☆ Various patches and fixes for LuaLaTeX and package ‘fontspec’. - - □ Module base: - - ☆ Update of LaTeX. - - ☆ Patches ltpatch.ltx.diff and ltfssdcl.dtx.diff removed (no longer - needed). - - □ Module tools: Update. - -2011/07/03 - □ build.pl: - - ☆ Caching for PDF generation added. - - ☆ ‘FINAL’ markers in the output of build.pl for final (Lua|pdf)TeX - runs. - -2011/07/26 - □ PDF generation: Use of package unicode-math with Latin Modern Math - where possible. - -2011/08/10 - □ Update of tools. - -2011/10/05 - □ Update of tools (varioref). - -2011/11/16 - □ Update of babel. - -2012/05/12 - □ Update of amslatex (amsrefs). - - □ Update of readme.txt that is renamed to README (CTAN convention). - - □ Update of tlc2.err. - -2013/02/14 - □ Update of amslatex (amsrefs). - - □ Module amslatex: cite-x*.tex, jb.bib in TDS:source/, because these - files are now classified as test files. - - □ Module base: lb2.err and tlc2.err updated. - - □ Change in version control system from CVS to git with public source - repository. - -2013/02/15 - □ Module amsfonts added. - -2013/02/25 - □ Patch file lb2.err.diff removed by call of sed inside build.pl. - - □ README rewritten in text document format AsciiDoc and added as HTML and - PDF files. - - □ README.asciidoc updated. - - □ Makefile: Target ‘check-links’ added. - -2013/02/26 - □ README generated from README.asciidoc via README.html. - -2013/02/27 - □ README.asciidoc: Additions and updates. - - □ README.pdf generated by wkhtmltopdf via README.html. - -2013/03/07 - □ Update of amslatex (amsrefs 2013/03/06 v2.13). - -2013/03/10 - □ Update of amslatex (amsrefs 2013/03/07 v2.14). - -2013/03/30 - □ Update of babel (3.9) including reorganization of language files. - -2014/02/03 - □ Removal of module babel. It has a new maintainer and the languages are - now maintained separately. - - □ Update of knuth (2014/01/19). - - □ Update of base (errata lists: lb2.err, tlc2.err). - -2014/05/03 - □ Update of LaTeX, release 2014/05/01 using public subversion repository - of LaTeX2e. Modules: base, cyrillic, graphics, tools. - - □ Line ends are normalized in source text files of the LaTeX modules. - Trailing spaces are removed and the line ends are Unix line ends. - - □ Update of armtex (needed to generate module base). - - □ New options --vcs and --vcs-update for using the files of the public - source repository of the LaTeX project. - -2014/05/05 - □ Using LaTeX modules from CTAN. - -2014/05/08 - □ Update of base and graphics. - - □ README.html with Unix line ends. - - □ ZIP file for CTAN upload with top level directory latex-tds. - -2014/05/10 - □ Module cyrillic: Missing 00readme.txt added. - -2014/05/15 - □ Module base: fix-cm updated (2014/05/13 v1.1q). - - □ Module tools: tabularx updated (2014/05/13 v2.10). - - □ Module tools: readme.txt renamed to 00readme.txt. - - □ Module knuth: .web files are put below TDS:web/knuth//. - -2014/05/16 - □ Module base: Formatting of ltnews.pdf fixed. - - □ fix-expl3-lua.ini added to support putting package expl into a format. - - □ Script check-tds-installation.pl added. - - □ Module amslatex: TDS:bibtex/bst/ams renamed to TDS:bibtex/bst/amscls. - -2014/05/21 - □ Module amslatex: Sources for amsbooka added. - -2014/06/12 - □ Module base: Update of fixltx2e.dtx. - -2014/09/17 - □ Module tools: Update of packages varioref and multicol. - - □ Module base: Update of fixltx2e. - -2014/11/03 - □ Module base: Update (2014-10-12). - - □ Module tools: Update (2014-10-28). - -2014/11/12 - □ Module graphics: Update (2014-11-07). - - □ Modules base, cyrillic, graphics, tools: 00readme.txt renamed to - README. - - □ Module amslatex: Missing amsbooka.zip added to directory patch (until - it is resolved at the AMS side). - -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -Last updated 2014-11-11 22:53:51 CET diff --git a/macros/latex/contrib/latex-tds/README.html b/macros/latex/contrib/latex-tds/README.html deleted file mode 100644 index 2241a1950f..0000000000 --- a/macros/latex/contrib/latex-tds/README.html +++ /dev/null @@ -1,2897 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> -<head> -<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.7" /> -<meta name="description" content="Bundle `latex-tds' provides a set of ZIP file modules containing TDS-compliant trees for items of the LaTeX distribution (both the base system and required packages), together with `user-friendly' documentation (PDF files with navigation support using bookmarks and links)." /> -<title>README for project latex-tds</title> -<style type="text/css"> -/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ - -/* Default font. */ -body { - font-family: Georgia,serif; -} - -/* Title font. */ -h1, h2, h3, h4, h5, h6, -div.title, caption.title, -thead, p.table.header, -#toctitle, -#author, #revnumber, #revdate, #revremark, -#footer { - font-family: Arial,Helvetica,sans-serif; -} - -body { - margin: 1em 5% 1em 5%; -} - -a { - color: blue; - text-decoration: underline; -} -a:visited { - color: fuchsia; -} - -em { - font-style: italic; - color: navy; -} - -strong { - font-weight: bold; - color: #083194; -} - -h1, h2, h3, h4, h5, h6 { - color: #527bbd; - margin-top: 1.2em; - margin-bottom: 0.5em; - line-height: 1.3; -} - -h1, h2, h3 { - border-bottom: 2px solid silver; -} -h2 { - padding-top: 0.5em; -} -h3 { - float: left; -} -h3 + * { - clear: left; -} -h5 { - font-size: 1.0em; -} - -div.sectionbody { - margin-left: 0; -} - -hr { - border: 1px solid silver; -} - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -ul, ol, li > p { - margin-top: 0; -} -ul > li { color: #aaa; } -ul > li > * { color: black; } - -pre { - padding: 0; - margin: 0; -} - -#author { - color: #527bbd; - font-weight: bold; - font-size: 1.1em; -} -#email { -} -#revnumber, #revdate, #revremark { -} - -#footer { - font-size: small; - border-top: 2px solid silver; - padding-top: 0.5em; - margin-top: 4.0em; -} -#footer-text { - float: left; - padding-bottom: 0.5em; -} -#footer-badges { - float: right; - padding-bottom: 0.5em; -} - -#preamble { - margin-top: 1.5em; - margin-bottom: 1.5em; -} -div.imageblock, div.exampleblock, div.verseblock, -div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, -div.admonitionblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.admonitionblock { - margin-top: 2.0em; - margin-bottom: 2.0em; - margin-right: 10%; - color: #606060; -} - -div.content { /* Block element content. */ - padding: 0; -} - -/* Block element titles. */ -div.title, caption.title { - color: #527bbd; - font-weight: bold; - text-align: left; - margin-top: 1.0em; - margin-bottom: 0.5em; -} -div.title + * { - margin-top: 0; -} - -td div.title:first-child { - margin-top: 0.0em; -} -div.content div.title:first-child { - margin-top: 0.0em; -} -div.content + div.title { - margin-top: 0.0em; -} - -div.sidebarblock > div.content { - background: #ffffee; - border: 1px solid #dddddd; - border-left: 4px solid #f0f0f0; - padding: 0.5em; -} - -div.listingblock > div.content { - border: 1px solid #dddddd; - border-left: 5px solid #f0f0f0; - background: #f8f8f8; - padding: 0.5em; -} - -div.quoteblock, div.verseblock { - padding-left: 1.0em; - margin-left: 1.0em; - margin-right: 10%; - border-left: 5px solid #f0f0f0; - color: #888; -} - -div.quoteblock > div.attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock > pre.content { - font-family: inherit; - font-size: inherit; -} -div.verseblock > div.attribution { - padding-top: 0.75em; - text-align: left; -} -/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ -div.verseblock + div.attribution { - text-align: left; -} - -div.admonitionblock .icon { - vertical-align: top; - font-size: 1.1em; - font-weight: bold; - text-decoration: underline; - color: #527bbd; - padding-right: 0.5em; -} -div.admonitionblock td.content { - padding-left: 0.5em; - border-left: 3px solid #dddddd; -} - -div.exampleblock > div.content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } -a.image:visited { color: white; } - -dl { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -dt { - margin-top: 0.5em; - margin-bottom: 0; - font-style: normal; - color: navy; -} -dd > *:first-child { - margin-top: 0.1em; -} - -ul, ol { - list-style-position: outside; -} -ol.arabic { - list-style-type: decimal; -} -ol.loweralpha { - list-style-type: lower-alpha; -} -ol.upperalpha { - list-style-type: upper-alpha; -} -ol.lowerroman { - list-style-type: lower-roman; -} -ol.upperroman { - list-style-type: upper-roman; -} - -div.compact ul, div.compact ol, -div.compact p, div.compact p, -div.compact div, div.compact div { - margin-top: 0.1em; - margin-bottom: 0.1em; -} - -tfoot { - font-weight: bold; -} -td > div.verse { - white-space: pre; -} - -div.hdlist { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -div.hdlist tr { - padding-bottom: 15px; -} -dt.hdlist1.strong, td.hdlist1.strong { - font-weight: bold; -} -td.hdlist1 { - vertical-align: top; - font-style: normal; - padding-right: 0.8em; - color: navy; -} -td.hdlist2 { - vertical-align: top; -} -div.hdlist.compact tr { - margin: 0; - padding-bottom: 0; -} - -.comment { - background: yellow; -} - -.footnote, .footnoteref { - font-size: 0.8em; -} - -span.footnote, span.footnoteref { - vertical-align: super; -} - -#footnotes { - margin: 20px 0 20px 0; - padding: 7px 0 0 0; -} - -#footnotes div.footnote { - margin: 0 0 5px 0; -} - -#footnotes hr { - border: none; - border-top: 1px solid silver; - height: 1px; - text-align: left; - margin-left: 0; - width: 20%; - min-width: 100px; -} - -div.colist td { - padding-right: 0.5em; - padding-bottom: 0.3em; - vertical-align: top; -} -div.colist td img { - margin-top: 0.3em; -} - -@media print { - #footer-badges { display: none; } -} - -#toc { - margin-bottom: 2.5em; -} - -#toctitle { - color: #527bbd; - font-size: 1.1em; - font-weight: bold; - margin-top: 1.0em; - margin-bottom: 0.1em; -} - -div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { - margin-top: 0; - margin-bottom: 0; -} -div.toclevel2 { - margin-left: 2em; - font-size: 0.9em; -} -div.toclevel3 { - margin-left: 4em; - font-size: 0.9em; -} -div.toclevel4 { - margin-left: 6em; - font-size: 0.9em; -} - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } - -div.unbreakable { page-break-inside: avoid; } - - -/* - * xhtml11 specific - * - * */ - -tt { - font-family: "Courier New", Courier, monospace; - font-size: inherit; - color: navy; -} - -div.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-weight: bold; - color: #527bbd; -} -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - - -/* - * html5 specific - * - * */ - -.monospaced { - font-family: "Courier New", Courier, monospace; - font-size: inherit; - color: navy; -} - -table.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -thead, p.tableblock.header { - font-weight: bold; - color: #527bbd; -} -p.tableblock { - margin-top: 0; -} -table.tableblock { - border-width: 3px; - border-spacing: 0px; - border-style: solid; - border-color: #527bbd; - border-collapse: collapse; -} -th.tableblock, td.tableblock { - border-width: 1px; - padding: 4px; - border-style: solid; - border-color: #527bbd; -} - -table.tableblock.frame-topbot { - border-left-style: hidden; - border-right-style: hidden; -} -table.tableblock.frame-sides { - border-top-style: hidden; - border-bottom-style: hidden; -} -table.tableblock.frame-none { - border-style: hidden; -} - -th.tableblock.halign-left, td.tableblock.halign-left { - text-align: left; -} -th.tableblock.halign-center, td.tableblock.halign-center { - text-align: center; -} -th.tableblock.halign-right, td.tableblock.halign-right { - text-align: right; -} - -th.tableblock.valign-top, td.tableblock.valign-top { - vertical-align: top; -} -th.tableblock.valign-middle, td.tableblock.valign-middle { - vertical-align: middle; -} -th.tableblock.valign-bottom, td.tableblock.valign-bottom { - vertical-align: bottom; -} - - -/* - * manpage specific - * - * */ - -body.manpage h1 { - padding-top: 0.5em; - padding-bottom: 0.5em; - border-top: 2px solid silver; - border-bottom: 2px solid silver; -} -body.manpage h2 { - border-style: none; -} -body.manpage div.sectionbody { - margin-left: 3em; -} - -@media print { - body.manpage div#toc { display: none; } -} -</style> -<script type="text/javascript"> -/*<+'])'); - // Function that scans the DOM tree for header elements (the DOM2 - // nodeIterator API would be a better technique but not supported by all - // browsers). - var iterate = function (el) { - for (var i = el.firstChild; i != null; i = i.nextSibling) { - if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { - var mo = re.exec(i.tagName); - if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { - result[result.length] = new TocEntry(i, getText(i), mo[1]-1); - } - iterate(i); - } - } - } - iterate(el); - return result; - } - - var toc = document.getElementById("toc"); - if (!toc) { - return; - } - - // Delete existing TOC entries in case we're reloading the TOC. - var tocEntriesToRemove = []; - var i; - for (i = 0; i < toc.childNodes.length; i++) { - var entry = toc.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' - && entry.getAttribute("class") - && entry.getAttribute("class").match(/^toclevel/)) - tocEntriesToRemove.push(entry); - } - for (i = 0; i < tocEntriesToRemove.length; i++) { - toc.removeChild(tocEntriesToRemove[i]); - } - - // Rebuild TOC entries. - var entries = tocEntries(document.getElementById("content"), toclevels); - for (var i = 0; i < entries.length; ++i) { - var entry = entries[i]; - if (entry.element.id == "") - entry.element.id = "_toc_" + i; - var a = document.createElement("a"); - a.href = "#" + entry.element.id; - a.appendChild(document.createTextNode(entry.text)); - var div = document.createElement("div"); - div.appendChild(a); - div.className = "toclevel" + entry.toclevel; - toc.appendChild(div); - } - if (entries.length == 0) - toc.parentNode.removeChild(toc); -}, - - -///////////////////////////////////////////////////////////////////// -// Footnotes generator -///////////////////////////////////////////////////////////////////// - -/* Based on footnote generation code from: - * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html - */ - -footnotes: function () { - // Delete existing footnote entries in case we're reloading the footnodes. - var i; - var noteholder = document.getElementById("footnotes"); - if (!noteholder) { - return; - } - var entriesToRemove = []; - for (i = 0; i < noteholder.childNodes.length; i++) { - var entry = noteholder.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") - entriesToRemove.push(entry); - } - for (i = 0; i < entriesToRemove.length; i++) { - noteholder.removeChild(entriesToRemove[i]); - } - - // Rebuild footnote entries. - var cont = document.getElementById("content"); - var spans = cont.getElementsByTagName("span"); - var refs = {}; - var n = 0; - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnote") { - n++; - var note = spans[i].getAttribute("data-note"); - if (!note) { - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - spans[i].setAttribute("data-note", note); - } - noteholder.innerHTML += - "<div class='footnote' id='_footnote_" + n + "'>" + - "<a href='#_footnoteref_" + n + "' title='Return to text'>" + - n + "</a>. " + note + "</div>"; - var id =spans[i].getAttribute("id"); - if (id != null) refs["#"+id] = n; - } - } - if (n == 0) - noteholder.parentNode.removeChild(noteholder); - else { - // Process footnoterefs. - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnoteref") { - var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); - href = href.match(/#.*/)[0]; // Because IE return full URL. - n = refs[href]; - spans[i].innerHTML = - "[<a href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - } - } - } -}, - -install: function(toclevels) { - var timerId; - - function reinstall() { - asciidoc.footnotes(); - if (toclevels) { - asciidoc.toc(toclevels); - } - } - - function reinstallAndRemoveTimer() { - clearInterval(timerId); - reinstall(); - } - - timerId = setInterval(reinstall, 500); - if (document.addEventListener) - document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); - else - window.onload = reinstallAndRemoveTimer; -} - -} -asciidoc.install(2); -/*]]>*/ -</script> -<meta name="author" content="Heiko Oberdiek" /> -<meta name="date" content="2014-11-11" /> -</head> -<body class="article"> -<div id="header"> -<h1>README for project latex-tds</h1> -<span id="author">Heiko Oberdiek</span><br /> -<span id="revdate">2014/11/12</span> -<div id="toc"> - <div id="toctitle">Table of Contents</div> - <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript> -</div> -</div> -<div id="content"> -<div class="sect1"> -<h2 id="_project_latex_tds">1. Project latex-tds</h2> -<div class="sectionbody"> -<div class="quoteblock"> -<div class="content"> -<div class="paragraph"><p>Bundle `latex-tds' provides a set of ZIP file modules containing TDS-compliant trees for items of the LaTeX distribution (both the base system and required packages), together with `user-friendly' documentation (PDF files with navigation support using bookmarks and links).</p></div> -</div> -<div class="attribution"> -</div></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -Version: -</dt> -<dd> -<p> - 2014/11/12 -</p> -</dd> -<dt class="hdlist1"> -Author: -</dt> -<dd> -<p> - Heiko Oberdiek -</p> -</dd> -<dt class="hdlist1"> -Email and bug report address: -</dt> -<dd> -<p> - heiko.oberdiek at googlemail.com -</p> -</dd> -<dt class="hdlist1"> -CTAN home page with distribution files: -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/macros/latex/contrib/latex-tds/">CTAN:macros/latex/contrib/latex-tds/</a> -</p> -</dd> -<dt class="hdlist1"> -Source repository (without distribution files): -</dt> -<dd> -<p> - <a href="https://github.com/oberdiek/latex-tds">https://github.com/oberdiek/latex-tds</a> -</p> -</dd> -</dl></div> -<div class="sect2"> -<h3 id="_how_it_has_started">1.1. How it has started</h3> -<div class="paragraph"><p>The project started as I wanted to install the new LaTeX release 2005/12/01 -that was announced at 2006/04/27. However the files are not packed in -TDS format, ready for unpacking in the destination directory. And -the documentation files were not yet generated or the provided -PDF files are lacking of basic features such as bookmarks or link support. -Thus this project has started. I thought it could be finished during -the afternoon at the day of the announcement …</p></div> -</div> -<div class="sect2"> -<h3 id="_goals_of_the_project">1.2. Goals of the project</h3> -<div class="ulist"><ul> -<li> -<p> -From the sources a TDS compliant tree is constructed and populated. - The zipped result is distributed. -</p> -</li> -<li> -<p> -All the documentation is generated from the sources. The PDF files - are user friendly and provide navigational support with bookmarks - and links. -</p> -</li> -<li> -<p> -The PDF files are post-processed to reduce the file size. -</p> -</li> -</ul></div> -</div> -<div class="sect2"> -<h3 id="_scope">1.3. Scope</h3> -<div class="paragraph"><p>I do not have the time to assemble a TeX distribution with -thousands of packages. Therefore I restricted myself to the -LaTeX base distribution and the required bundles. -In the following I will use the term ‘module’ for a package bundle.</p></div> -</div> -<div class="sect2"> -<h3 id="_module_list">1.4. Module list</h3> -<div class="paragraph"><p>The link addresses are the sources for the modules.</p></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -<strong>base</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/macros/latex/base.zip">CTAN:macros/latex/base.zip</a><br /> - <a href="http://mirror.ctan.org/macros/latex/doc.zip">CTAN:macros/latex/doc.zip</a><br /> - <a href="http://www.latex-project.org/guides/lb2.err">http://www.latex-project.org/guides/lb2.err</a><br /> - <a href="http://www.latex-project.org/guides/lgc2.err">http://www.latex-project.org/guides/lgc2.err</a><br /> - <a href="http://www.latex-project.org/guides/manual.err">http://www.latex-project.org/guides/manual.err</a><br /> - <a href="http://www.latex-project.org/guides/tlc2.err">http://www.latex-project.org/guides/tlc2.err</a><br /> -</p> -</dd> -<dt class="hdlist1"> -<strong>tools</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/macros/latex/required/tools">CTAN:macros/latex/required/tools.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>cyrillic</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/macros/latex/required/cyrillic.zip">CTAN:macros/latex/required/cyrillic.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>amslatex</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/install/macros/latex/required/amslatex/amscls.tds.zip">CTAN:install/macros/latex/required/amslatex/amscls.tds.zip</a><br /> - <a href="http://mirror.ctan.org/install/macros/latex/required/amslatex/math.tds.zip">CTAN:install/macros/latex/required/amslatex/math.tds.zip</a><br /> - <a href="http://mirror.ctan.org/macros/latex/contrib/amsrefs.zip">CTAN:macros/latex/contrib/amsrefs.zip</a><br /> - <a href="http://mirror.ctan.org/macros/latex/required/amslatex.zip">CTAN:macros/latex/required/amslatex.zip</a><br /> - <a href="ftp://ftp.ams.org/pub/tex/amsrefs/amsrefs.zip">ftp://ftp.ams.org/pub/tex/amsrefs/amsrefs.zip</a><br /> - <a href="ftp://ftp.ams.org/pub/tex/amscls.zip">ftp://ftp.ams.org/pub/tex/amscls.zip</a><br /> - <a href="ftp://ftp.ams.org/pub/tex/amsmath.zip">ftp://ftp.ams.org/pub/tex/amsmath.zip</a><br /> - patch/amsbooka.zip -</p> -</dd> -<dt class="hdlist1"> -<strong>amsfonts</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/install/fonts/amsfonts.tds.zip">CTAN:install/fonts/amsfonts.tds.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>psnfss</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/macros/latex/required/psnfss.zip">CTAN:macros/latex/required/psnfss.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>tds</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/tds.zip">CTAN:tds.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>knuth</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/systems/knuth/dist/errata.zip">CTAN:systems/knuth/dist/errata.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/etc.zip">CTAN:systems/knuth/dist/etc.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/mfware.zip">CTAN:systems/knuth/dist/mfware.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/texware.zip">CTAN:systems/knuth/dist/texware.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/web.zip">CTAN:systems/knuth/dist/web.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/tex.zip">CTAN:systems/knuth/dist/tex.zip</a><br /> - <a href="http://mirror.ctan.org/systems/knuth/dist/mf.zip">CTAN:systems/knuth/dist/mf.zip</a> -</p> -</dd> -<dt class="hdlist1"> -<strong>etex</strong> -</dt> -<dd> -<p> - <a href="http://mirror.ctan.org/systems/e-tex/v2.1/etex_doc.zip">CTAN:systems/e-tex/v2.1/etex_doc.zip</a> -</p> -</dd> -</dl></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_abbreviations_glossary">2. Abbreviations, Glossary</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -CTAN -</dt> -<dd> -<p> - Comprehensive TeX Archive Network.<br /> - FAQ entry: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives</a><br /> - For example, you can resolve the prefix <tt>CTAN:</tt> by using - <tt>http://mirror.ctan.org/</tt>. -</p> -</dd> -<dt class="hdlist1"> -latex-tds -</dt> -<dd> -<p> - The name of this project. -</p> -</dd> -<dt class="hdlist1"> -TDS -</dt> -<dd> -<p> - TeX Directory Structure.<br /> - FAQ entry: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds</a><br /> - Specification: <a href="http://www.ctan.org/pkg/tds">http://www.ctan.org/pkg/tds</a> -</p> -</dd> -</dl></div> -</div> -</div> -<div class="sect1"> -<h2 id="_download">3. Download</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The home of the project is located at:</p></div> -<div class="quoteblock"> -<div class="content"> -<div class="paragraph"><p><a href="http://mirror.ctan.org//macros/latex/contrib/latex-tds/">CTAN:macros/latex/contrib/latex-tds/</a></p></div> -</div> -<div class="attribution"> -</div></div> -<div class="paragraph"><p>The following files can be downloaded:</p></div> -<div class="ulist"><ul> -<li> -<p> -<tt>README</tt>, <tt>README.html</tt>, <tt>README.pdf</tt>: - The README file in different formats. -</p> -</li> -<li> -<p> -<tt><module>.tds.zip</tt>: The module distribution files, - see section ‘<a href="#_module_list">Module list</a>’ above - for the available modules. -</p> -</li> -<li> -<p> -<tt>source.tds.zip</tt>: The sources, mainly the build script, configuration and - driver files, and patches. - Some of the used tools are not provided, see section - ‘<a href="#_build_hints">Build Hints</a>’. -</p> -</li> -<li> -<p> -<tt>latex-tds.tds.zip</tt>: The universe, the contents of all the ZIP files above, - merged together. -</p> -</li> -</ul></div> -</div> -</div> -<div class="sect1"> -<h2 id="_installation_hints">4. Installation Hints</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Hopefully the result of this project helps you in the installation -process. You get a TDS compliant tree just by unpacking.</p></div> -<div class="paragraph"><p>Example:</p></div> -<div class="listingblock"> -<div class="content"> -<pre><tt> cd /some/where/texmf - unzip latex-tds</tt></pre> -</div></div> -<div class="paragraph"><p>or unzip’s option <tt>-d</tt>:</p></div> -<div class="listingblock"> -<div class="content"> -<pre><tt> unzip latex-tds -d /some/where/texmf</tt></pre> -</div></div> -<div class="paragraph"><p>Instead of the universe ZIP file single modules can be selected.</p></div> -<div class="paragraph"><p>Important to remember, point your unpack process right in -the root directory of your TDS tree. The directory structure -in the ZIP files start with the top-level directories:</p></div> -<div class="listingblock"> -<div class="content"> -<pre><tt> doc/latex/base/... - tex/latex/tools/... - source/...</tt></pre> -</div></div> -<div class="paragraph"><p>Rationale: The root directory of a TDS tree can have different -names, such as texmf-dist, texmf-local, …</p></div> -<div class="sect2"> -<h3 id="_hints">4.1. Hints</h3> -<div class="openblock"> -<div class="content"> -<div class="ulist"><ul> -<li> -<p> -Refresh the file name database. -</p> -</li> -<li> -<p> -Be aware that unpacking can insert and update files, but never - deletes obsolete ones. Remainders of previous releases can - cause trouble. -</p> -</li> -<li> -<p> -Depending on the module further installation steps can be - necessary, consult the module’s own documentation. -</p> -</li> -</ul></div> -</div></div> -<div class="sect3"> -<h4 id="_module_base">4.1.1. Module base</h4> -<div class="ulist"><ul> -<li> -<p> -The default <tt>texsys.cfg</tt> that LaTeX provides is put - into <tt>TDS:tex/latex/base</tt>. It must be removed, if you need - a specialized version. Consult your TeX distribution - and <tt>TDS:doc/latex/base/source2e.pdf</tt> (module ltdirchk). - Usually changes are not required for many TeX distributions - such as Unix (web2c), MikTeX, … -</p> -</li> -<li> -<p> -Formats need rebuilding (e.g., fmtutil). -</p> -</li> -</ul></div> -</div> -<div class="sect3"> -<h4 id="_module_psnfss">4.1.2. Module psnfss</h4> -<div class="ulist"><ul> -<li> -<p> -The map files need further configuring (e.g., updmap). -</p> -</li> -</ul></div> -</div> -<div class="sect3"> -<h4 id="_module_graphics">4.1.3. Module graphics</h4> -<div class="ulist"><ul> -<li> -<p> -Module graphics does not provide all driver files, because some are - developed independently (<tt>pdftex.def</tt>, …). -</p> -</li> -</ul></div> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_copyright_license">5. Copyright, License</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Copyright © 2006-2014 Heiko Oberdiek.</p></div> -<div class="paragraph"><p>License is <strong>LPPL 1.3c</strong>:</p></div> -<div class="paragraph"><p>This work may be distributed and/or modified under the -conditions of the LaTeX Project Public License, either version 1.3 -of this license or (at your option) any later version. -The latest version of this license is in</p></div> -<div class="listingblock"> -<div class="content"> -<pre><tt> http://www.latex-project.org/lppl.txt</tt></pre> -</div></div> -<div class="paragraph"><p>and version 1.3c or later is part of all distributions of LaTeX -version 2005/12/01 or later.</p></div> -<div class="paragraph"><p>This work has the LPPL maintenance status ‘maintained’.</p></div> -<div class="paragraph"><p>The Current Maintainer of this work is Heiko Oberdiek.</p></div> -<div class="paragraph"><p>See the following section ‘<a href="#_manifest">Manifest</a>’ for a list of all files -belonging to the project ‘latex-tds’.</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_manifest">6. Manifest</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Included are the projects ‘adjust_checksum’ and ‘ziptimetree’. -They are projects of their own.</p></div> -<div class="sect2"> -<h3 id="_documentation">6.1. Documentation</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>README </tt></pre></div></td> -<td align="left" valign="top"><p class="table">plain text file</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>README.html </tt></pre></div></td> -<td align="left" valign="top"><p class="table">standalone HTML file</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>README.pdf </tt></pre></div></td> -<td align="left" valign="top"><p class="table">PDF version</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>README.asciidoc </tt></pre></div></td> -<td align="left" valign="top"><p class="table">main source code in text document format <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>README-docinfo.html </tt></pre></div></td> -<td align="left" valign="top"><p class="table">source code, read by asciidoc to generate <tt>README.html</tt></p></td> -</tr> -</tbody> -</table> -</div> -</div> -<div class="sect2"> -<h3 id="_licenses">6.2. Licenses</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>license/lppl.txt </tt></pre></div></td> -<td align="left" valign="top"><p class="table">LPPL (The LaTeX Project Public License) - for latex-tds and adjust_checksum</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>license/ziptimetree/lgpl.txt </tt></pre></div></td> -<td align="left" valign="top"><p class="table">LGPL (GNU Lesser General Public License) - for ziptimetree, check-ascii, check-eolspaces</p></td> -</tr> -</tbody> -</table> -</div> -</div> -<div class="sect2"> -<h3 id="_scripts">6.3. Scripts</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>build.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">main script for building the distribution</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>lib/adjust_checksum.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">Perl script that runs a DTX file through - LaTeX and corrects its <tt>\Checksum</tt> if necessary</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>lib/check-ascii.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">Perl script that looks for non-ASCII characters</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>lib/check-eolspaces.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">Perl script that looks for trailing spaces</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>lib/check-tds-installation.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">Perl script that compares a module with - an installation inside a TDS tree.</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>lib/ziptimetree.pl </tt></pre></div></td> -<td align="left" valign="top"><p class="table">Perl script that generates a ZIP file from - a directory tree with sorted entries (LGPL)</p></td> -</tr> -</tbody> -</table> -</div> -</div> -<div class="sect2"> -<h3 id="_configuration">6.4. Configuration</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/docstrip.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">enables TDS feature and creates directories</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/errata.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">for errata lists of latex/base</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/fix-expl3-lua.ini </tt></pre></div></td> -<td align="left" valign="top"><p class="table">fix for expl3, if used in format file</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/hyperref.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">hyperref configuration file</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltnews.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">for LaTeX News of latex/base</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltugboat.cls </tt></pre></div></td> -<td align="left" valign="top"><p class="table">setup for class ltugboat</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltxdoc.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">setup for class ltxdoc</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltxguide.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">setup for the guide manuals in latex/base - and required/psnfss</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/lualatex-tds.ini </tt></pre></div></td> -<td align="left" valign="top"><p class="table">init file for format generation for LuaTeX</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/lualatex-tds2.ini </tt></pre></div></td> -<td align="left" valign="top"><p class="table">init file for LuaTeX format without LM Math</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/manual.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">setup for errata list of the LaTeX manual - in latex/base</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/pdflatex-tds.ini </tt></pre></div></td> -<td align="left" valign="top"><p class="table">init file for format generation for pdfTeX</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/tdsguide.cfg </tt></pre></div></td> -<td align="left" valign="top"><p class="table">setup for class <tt>tdsguide.cls</tt></p></td> -</tr> -</tbody> -</table> -</div> -</div> -<div class="sect2"> -<h3 id="_documentation_driver">6.5. Documentation driver</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ams.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">generic doc driver for files from the - amslatex bundle</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/doc_lppl.tex </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>base/lppl.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/errata.all </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>knuth/errata/errata.pdf</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/errata.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>knuth/errata/errata_*.pdf</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/errorlog.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>knuth/errata/errorlog.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/etex_man.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>etex/etex_man.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/knuth.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver for <tt>knuth/</tt>{<tt>texware</tt>,<tt>mfware</tt>,<tt>etc</tt>}+/*.web+</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/knuth-outline.tex </tt></pre></div></td> -<td align="left" valign="top"><p class="table">outline file list for module knuth</p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltnews.tex </tt></pre></div></td> -<td align="left" valign="top"><p class="table">master file that merges all <tt>base/ltnews*.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/ltxcheck.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver with patches for <tt>ltxcheck.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/psnfss2e.drv </tt></pre></div></td> -<td align="left" valign="top"><p class="table">doc driver with patches for <tt>psnfss2e.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/tools-overview.cls </tt></pre></div></td> -<td align="left" valign="top"><p class="table">class for <tt>tools.tex</tt></p></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>tex/tools.tex </tt></pre></div></td> -<td align="left" valign="top"><p class="table">master file for tools overview, generated - by the <tt>build.pl</tt> script from <tt>tools/manifest.txt</tt></p></td> -</tr> -</tbody> -</table> -</div> -</div> -<div class="sect2"> -<h3 id="_patches">6.6. Patches</h3> -<div class="tableblock"> -<table rules="rows" -width="100%" -frame="hsides" -cellspacing="0" cellpadding="4"> -<col width="30%" /> -<col width="70%" /> -<thead> -<tr> -<th align="left" valign="top">Diff/patch file</th> -<th align="left" valign="top">Patched file</th> -</tr> -</thead> -<tbody> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/amsbooka.zip </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amslatex/amsbooka.*</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/amsclass.dtx.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amslatex/amsclass.dtx</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/amsfndoc.def.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amsfonts/amsfndoc.def</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/amsfndoc.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amsfonts/amsfndoc.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/amsldoc.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amslatex/amsldoc.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/changes.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>amslatex/amsrefs/changes.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/encguide.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>base/encguide.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/errorlog.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>knuth/errata/errorlog.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/logmac.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>knuth/errata/logmac.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/source2e.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>base/source2e.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/tlc2.err.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>base/tlc2.err</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/trapman.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>knuth/mf/trapman.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/tripman.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>knuth/tex/tripman.tex</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/utf8ienc.dtx.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>base/utf8ienc.dtx</tt></pre></div></td> -</tr> -<tr> -<td align="left" valign="top"><div class="literal"><pre><tt>patch/webman.tex.diff </tt></pre></div></td> -<td align="left" valign="top"><div class="literal"><pre><tt>knuth/web/webman.tex</tt></pre></div></td> -</tr> -</tbody> -</table> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_design_principles">7. Design Principles</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -Compliance with the latest TDS specification. -</p> -</li> -<li> -<p> -No redundancy. -</p> -</li> -<li> -<p> -User friendly PDF files with navigational support: -</p> -<div class="ulist"><ul> -<li> -<p> -bookmarks -</p> -</li> -<li> -<p> -links -</p> -</li> -</ul></div> -</li> -<li> -<p> -Complete documentation. The documentation generation with - enhanced PDF files is the tricky part and should be saved - from the user. -</p> -</li> -<li> -<p> -Output format of generated documentation is PDF, see above. - Other formats such as DVI or PS are not generated and provided. -</p> -</li> -<li> -<p> -Documentation bundles are preferred to many partial documentation - files (e.g. <tt>source2e.pdf</tt> or <tt>ltnews.pdf</tt>). -</p> -</li> -<li> -<p> -If several expansion stages of a documentation are available, - then just the most complete expansion stage should be used. -</p> -</li> -<li> -<p> -Files that do not fit in a program sub tree of TDS stay below - <tt>TDS:source</tt> (e.g. <tt>latexbug.el</tt> from latex/base). Then they do not - get lost at least. -</p> -</li> -<li> -<p> -Page layout: <tt>a4paper</tt> with reduced vertical margins (exception: ltnews). - (This also decreases the page number usually.) -</p> -</li> -<li> -<p> -… -</p> -</li> -</ul></div> -</div> -</div> -<div class="sect1"> -<h2 id="_remarks">8. Remarks</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_base">8.1. Base</h3> -<div class="ulist"><ul> -<li> -<p> -<tt>source2e.pdf</tt> is used instead of many single <tt>lt*.pdf</tt> files. -</p> -</li> -<li> -<p> -<tt>ltnews.pdf</tt> is introduced to avoid cluttering the doc directory - with many single sheet <tt>ltnews*.pdf</tt> files. -</p> -</li> -<li> -<p> -Patch for <tt>ltfssdcl.dtx</tt>: Checksum fixed. -</p> -</li> -<li> -<p> -… -</p> -</li> -</ul></div> -</div> -<div class="sect2"> -<h3 id="_tools">8.2. Tools</h3> -<div class="ulist"><ul> -<li> -<p> -Added: <tt>tools.pdf</tt> as overview/contents/index file with links - and short descriptions of the single packages. (It uses - the data from <tt>manifest.txt</tt>). -</p> -</li> -<li> -<p> -… -</p> -</li> -</ul></div> -</div> -<div class="sect2"> -<h3 id="_knuth">8.3. Knuth</h3> -<div class="ulist"><ul> -<li> -<p> -Current CTAN → TDS mapping in use: - <tt>CTAN:systems/knuth/dist</tt> → <tt>TDS:<toplevel>/knuth</tt> -</p> -</li> -<li> -<p> -Unsure where to put trip/trap files. Currently they are - put in <tt>TDS:source</tt>, because the documentation files - (<tt>tripman.pdf</tt>, <tt>trapman.pdf</tt>) are in <tt>TDS:doc</tt>. They lists the - trip/trap files already. -</p> -</li> -<li> -<p> -Not covered is - <a href="http://mirror.ctan.org/systems/knuth/dist/lib/">CTAN:systems/knuth/dist/lib/</a> - In TeX Live 2007/2008 the files are installed at different - locations: -</p> -<div class="literalblock"> -<div class="content"> -<pre><tt>texmf-dist/fonts/source/public/mflogo/logo10.mf -texmf-dist/fonts/source/public/mflogo/logo8.mf -texmf-dist/fonts/source/public/mflogo/logo9.mf -texmf-dist/fonts/source/public/mflogo/logobf10.mf -texmf-dist/fonts/source/public/mflogo/logo.mf -texmf-dist/fonts/source/public/mflogo/logosl10.mf -texmf-dist/fonts/source/public/misc/grayf.mf -texmf-dist/fonts/source/public/misc/manfnt.mf -texmf-dist/fonts/source/public/misc/slant.mf -texmf-dist/metafont/base/expr.mf -texmf-dist/metafont/base/io.mf -texmf-dist/metafont/base/null.mf -texmf-dist/metafont/base/plain.mf -texmf-dist/metafont/misc/3test.mf -texmf-dist/metafont/misc/6test.mf -texmf-dist/metafont/misc/rtest.mf -texmf-dist/metafont/misc/test.mf -texmf-dist/metafont/misc/waits.mf -texmf-dist/metafont/misc/ztest.mf -texmf-dist/mft/base/cmbase.mft -texmf-dist/mft/base/plain.mft -texmf-dist/tex/generic/misc/null.tex -texmf-dist/tex/plain/base/manmac.tex -texmf-dist/tex/plain/base/mftmac.tex -texmf-dist/tex/plain/base/plain.tex -texmf-dist/tex/plain/base/story.tex -texmf-dist/tex/plain/base/testfont.tex -texmf-dist/tex/plain/base/webmac.tex -texmf/tex/generic/hyphen/hyphen.tex</tt></pre> -</div></div> -</li> -</ul></div> -</div> -<div class="sect2"> -<h3 id="_e_tex">8.4. e-TeX</h3> -<div class="ulist"><ul> -<li> -<p> -Only the manual ‘etex_man’ is covered by this module. -</p> -</li> -</ul></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_build_hints">9. Build Hints</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The most important advice I can give: ‘Forget it’! -The purpose of the source files are rather to show, what was -done in which way. -The <tt>*.zip</tt> with TDS trees are the goal of the project, not the -build process. Some remarks, if someone wants to build the -modules himself:</p></div> -<div class="ulist"><ul> -<li> -<p> -TeX compiler: LuaTeX and pdfTeX (≥ 1.30). -</p> -</li> -<li> -<p> -An up-to-date LaTeX installation, at least TeX Live 2012. -</p> -</li> -<li> -<p> -Additional packages can be necessary, e.g. - <a href="http://mirror.ctan.org/language/armenian/armtex.zip">CTAN:language/armenian/armtex.zip</a> - is not part of TeX Live 2012. -</p> -</li> -<li> -<p> -Most of the PDF files are generated using lualatex and package - ‘fontspec’ that uses the Latin Modern fonts as default. They - are available as OpenType fonts. LuaTeX generates with OpenType - fonts considerably smaller PDF files. Also PDF object stream - compression is used (PDF 1.5). Therefore the further - post-processing of PDF files are currently dropped. -</p> -</li> -<li> -<p> -(Outdated since 2011-07-01) PDF post-processing, I have used two steps: -</p> -<div class="openblock"> -<div class="content"> -<div class="olist arabic"><ol class="arabic"> -<li> -<p> -First step: -</p> -<div class="olist loweralpha"><ol class="loweralpha"> -<li> -<p> -I have written a tool that analyzes page stream contents and - optimizes them (removal of unnecessary color settings, minimize - translation operations, …) - → <tt>pdfbox-rewrite.jar</tt>. -</p> -</li> -<li> -<p> -For reading and writing the PDF file I have used PDFBox - → <tt>PDFBox-0.7.2.jar</tt> (<a href="http://pdfbox.apache.org/">http://pdfbox.apache.org/</a>). -</p> -</li> -<li> -<p> -To get better results I patched some of the classes - of PDFBox (especially the write module) - → <tt>pdfbox-rewrite.jar</tt>. -</p> -</li> -</ol></div> -</li> -<li> -<p> -The final conversion step was done by Multivalent, because - it makes a very good job in PDF compression: - → <tt>Multivalent20060102.jar</tt> (<a href="http://multivalent.sourceforge.net/">http://multivalent.sourceforge.net/</a>) -</p> -</li> -</ol></div> -<div class="paragraph"><p>Multivalent and PDFBox are available, <tt>pdfbox-rewrite.jar</tt>, however, - is just a first prototype, not ripe for a release. - Therefore this step of post-processing is optional for the - project latex-tds. The build script looks for the library and - skips this steps automatically if necessary. - If you give the build script the option <tt>--nopostprocess</tt>, - then it will skip the postprocess steps (building is faster, - the pdf files a little larger). - Install the jar files in the directory <tt>lib</tt> where - they are expected by the build script.</p></div> -</div></div> -</li> -<li> -<p> -Unix, Perl background is expected. -</p> -</li> -<li> -<p> -No support or documentation. -</p> -</li> -</ul></div> -</div> -</div> -<div class="sect1"> -<h2 id="_history">10. History</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -2006/04/27 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Start of the project (without babel, amslatex, psnfss). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/06/01 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex added. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/06/03 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Modules psnfss and babel added, now all modules are covered. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/06/07 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -The project uploaded to CTAN. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/07/31 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Index added to base/classes.dtx. -</p> -</li> -<li> -<p> -ZIP files renamed: <tt>*-tds.zip</tt> → <tt>*.zip</tt> -</p> -</li> -<li> -<p> -Comment added to ZIP files. -</p> -</li> -<li> -<p> -Update of <tt>readme.txt</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/08/26 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module tds for <a href="http://mirror.ctan.org/tds/">CTAN:tds/</a> added. -</p> -</li> -<li> -<p> -Obsolete hyphenation patterns added to babel’s source directory - to avoid violation of LPPL. -</p> -</li> -<li> -<p> -Script adjust_checksum added and scripts are put below <tt>TDS:scripts</tt>. -</p> -</li> -<li> -<p> -<tt>TDS:makeindex/base/</tt> renamed to <tt>TDS:makeindex/latex/</tt> -</p> -</li> -<li> -<p> -Exception for <tt>sample2e.tex</tt> and <tt>small2e.tex</tt> that now go into - <tt>TDS:tex/latex/base/</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/08/28 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Default <tt>texsys.cfg</tt> is generated. -</p> -</li> -<li> -<p> -<tt>adjust_checksum.pl</tt> and <tt>ziptimetree.pl</tt> now moved from the <tt>scripts</tt> - branch to <tt>TDS:source/latex/latex-tds/lib/</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2006/12/27 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Fix of <tt>ltxguide.cfg</tt> that had loaded doc.sty that disturbs the - verbatim stuff in <tt>fntguide.tex</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2007/01/08 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Fix for documentation of longtable. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2007/03/19 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Patch for <tt>babel/latin.dtx</tt> added (babel/3922). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2007/09/04 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -A minor update on CTAN regarding babel: - <tt>iahyphen.tex</tt>, <tt>icehyph.tex</tt>, and <tt>lahyph.tex</tt> are now symbolic links - to their location in <a href="http://mirror.ctan.org/language/hyphenation/">CTAN:language/hyphenation/</a>. - Therefore also - <tt>lahyph.tex</tt> is now installed in <tt>TDS:tex/generic/hyphen/</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2007/10/18 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of module amslatex because of updated package amsrefs. -</p> -</li> -<li> -<p> -Fix in <tt>latin.dtx.diff</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2007/10/24 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel. -</p> -</li> -<li> -<p> -Update of amsrefs (<tt>TDS:tex/latex/amscls</tt> → <tt>TDS:tex/latex/amsrefs</tt>). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/04/01 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel (2008/03/17). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/04/02 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Fix: <tt>latex/base/*.err</tt> added to <tt>TDS:source/latex/base/</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/04/05 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Using <tt>.tds.zip</tt> instead of .zip to follow <tt>CTAN:install</tt>'s naming - conventions. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/06/28 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel (2008/06/01). -</p> -</li> -<li> -<p> -Babel documentation: table of contents reformatted. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/07/07 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel (2008/07/06). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/07/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module knuth added. -</p> -</li> -<li> -<p> -Update of babel (2008/07/07). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/07/11 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Fixes and additions for module knuth. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/07/25 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: <tt>instr-l.tex</tt> vanished from CTAN (but not at AMS side). -</p> -</li> -<li> -<p> -Some unwanted spaces in generated PDF files fixed. - (Caused by a wrong package file that was found on my system first.) -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/08/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module latex3 added. -</p> -</li> -<li> -<p> -Module base: CTAN hyperlinks fixed. -</p> -</li> -<li> -<p> -Module amslatex: Outdated URL fixed in <tt>amsldoc.tex</tt>. -</p> -</li> -<li> -<p> -Module babel: Problem with already defined <tt>\meta</tt> in <tt>tb1604.tex</tt> fixed. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/09/06 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: -</p> -<div class="ulist"><ul> -<li> -<p> -Using uptodate versions from LaTeX project page for errata lists. -</p> -</li> -<li> -<p> -<tt>lgc2.err</tt> added (LaTeX Graphics Companion, 2. ed.). -</p> -</li> -<li> -<p> -Various fixes in errata lists. -</p> -</li> -</ul></div> -</li> -<li> -<p> -Module tools: <tt>array.dtx</tt>: documentation fixed (tools/4044). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2008/09/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: Missing title date for utf8ienc.pdf fixed. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2009/09/05 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: updated. -</p> -</li> -<li> -<p> -Module latex3: xpackages updated. -</p> -</li> -<li> -<p> -Module latex3: expl3 removed, because nothing to do. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2009/09/25 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: updated. -</p> -</li> -<li> -<p> -Module babel: updated. -</p> -</li> -<li> -<p> -Update of LaTeX, release 2009/09/24. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2009/12/07 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: Unhappily the <tt>.zip</tt> files are quite a mess, - because they contain a mixup of old and new versions. - Tried to sort this out and fix the last update. -</p> -</li> -<li> -<p> -Module latex3: xpackages removed, because nothing to do. -</p> -</li> -<li> -<p> -Module latex3 removed, nothing left to do. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2010/05/04 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: page layout for source2e fixed (changes, index). -</p> -</li> -<li> -<p> -Module base: update of <tt>.err</tt> files. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2010/10/27 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: amscls and amsrefs updated. -</p> -</li> -<li> -<p> -Module etex added (only for etex_man). -</p> -</li> -<li> -<p> -Erratas updated. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/03/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: patch for latex/4148 (Missing <tt>\label</tt> and <tt>\ref</tt> in <tt>lppl.tex</tt>). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/04/18 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: There is an outdated version of amsthm.sty in - <a href="http://mirror.ctan.org/install/macros/latex/required/amslatex/amscls.tds.zip">CTAN:install/macros/latex/required/amslatex/amscls.tds.zip</a>. - The package <tt>amsthm.sty</tt> is now generated from the source. -</p> -</li> -<li> -<p> -Using TDS tree for missing packages that are not part of TeX Live. - Module base: <a href="http://mirror.ctan.org/language/armenian/armtex.zip">CTAN:language/armenian/armtex.zip</a>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/06/24 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: Two downloads from AMS server removed, because - the files are not longer available (and they are on CTAN). -</p> -</li> -<li> -<p> -Module amslatex: 00readme.txt and amsrefs.dtx taken from - <a href="http://mirror.ctan.org/macros/latex/contrib/amsrefs.zip">CTAN:macros/latex/contrib/amsrefs.zip</a> instead of - <a href="http://mirror.ctan.org/install/macros/latex/contrib/amsrefs.tds.zip">CTAN:install/macros/latex/contrib/amsrefs.tds.zip</a> - because the later archive file is out of sync. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/06/30 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: -</p> -<div class="ulist"><ul> -<li> -<p> -Update of LaTeX, release 2011/06/27. -</p> -</li> -<li> -<p> -Patch <tt>ltpatch.ltx</tt> to match the kernel version. -</p> -</li> -<li> -<p> -Patch <tt>lppl.tex.diff</tt> removed (no longer needed). -</p> -</li> -<li> -<p> -Patch <tt>ltfssdcl.dtx.diff</tt> added (checksum fixed). -</p> -</li> -</ul></div> -</li> -<li> -<p> -Module tools: Release 2011/06. -</p> -</li> -<li> -<p> -Module babel: Release 2011/06. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/07/01 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -PDF generation: -</p> -<div class="ulist"><ul> -<li> -<p> -Use of LuaTeX instead of pdfTeX for most of the files. -</p> -</li> -<li> -<p> -Use of package ‘fontspec’ with Latin Modern fonts as - default in OpenType format (smaller PDF file sizes). - The post-processing of PDF files is skipped. -</p> -</li> -<li> -<p> -Various patches and fixes for LuaLaTeX and package ‘fontspec’. -</p> -</li> -</ul></div> -</li> -<li> -<p> -Module base: -</p> -<div class="ulist"><ul> -<li> -<p> -Update of LaTeX. -</p> -</li> -<li> -<p> -Patches <tt>ltpatch.ltx.diff</tt> and <tt>ltfssdcl.dtx.diff</tt> removed - (no longer needed). -</p> -</li> -</ul></div> -</li> -<li> -<p> -Module tools: Update. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/07/03 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -build.pl: -</p> -<div class="ulist"><ul> -<li> -<p> -Caching for PDF generation added. -</p> -</li> -<li> -<p> -‘FINAL’ markers in the output of <tt>build.pl</tt> - for final (Lua|pdf)TeX runs. -</p> -</li> -</ul></div> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/07/26 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -PDF generation: Use of package unicode-math with Latin Modern Math - where possible. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/08/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of tools. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/10/05 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of tools (varioref). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2011/11/16 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2012/05/12 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of amslatex (amsrefs). -</p> -</li> -<li> -<p> -Update of <tt>readme.txt</tt> that is renamed to <tt>README</tt> (CTAN convention). -</p> -</li> -<li> -<p> -Update of <tt>tlc2.err</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/02/14 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of amslatex (amsrefs). -</p> -</li> -<li> -<p> -Module amslatex: <tt>cite-x*.tex</tt>, <tt>jb.bib</tt> in <tt>TDS:source/</tt>, because - these files are now classified as test files. -</p> -</li> -<li> -<p> -Module base: <tt>lb2.err</tt> and <tt>tlc2.err</tt> updated. -</p> -</li> -<li> -<p> -Change in version control system from CVS to git with public - source repository. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/02/15 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amsfonts added. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/02/25 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Patch file <tt>lb2.err.diff</tt> removed by call of sed inside <tt>build.pl</tt>. -</p> -</li> -<li> -<p> -<tt>README</tt> rewritten in text document format <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a> - and added as HTML and PDF files. -</p> -</li> -<li> -<p> -<tt>README.asciidoc</tt> updated. -</p> -</li> -<li> -<p> -<tt>Makefile</tt>: Target ‘check-links’ added. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/02/26 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -<tt>README</tt> generated from <tt>README.asciidoc</tt> via <tt>README.html</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/02/27 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -<tt>README.asciidoc</tt>: Additions and updates. -</p> -</li> -<li> -<p> -<tt>README.pdf</tt> generated by wkhtmltopdf via <tt>README.html</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/03/07 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of amslatex (amsrefs 2013/03/06 v2.13). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/03/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of amslatex (amsrefs 2013/03/07 v2.14). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2013/03/30 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of babel (3.9) including reorganization of language files. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/02/03 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Removal of module babel. It has a new maintainer and the - languages are now maintained separately. -</p> -</li> -<li> -<p> -Update of knuth (2014/01/19). -</p> -</li> -<li> -<p> -Update of base (errata lists: <tt>lb2.err</tt>, <tt>tlc2.err</tt>). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/03 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of LaTeX, release 2014/05/01 - using public subversion repository of LaTeX2e. - Modules: base, cyrillic, graphics, tools. -</p> -</li> -<li> -<p> -Line ends are normalized in source text files of the LaTeX modules. - Trailing spaces are removed and the line ends are Unix line ends. -</p> -</li> -<li> -<p> -Update of armtex (needed to generate module base). -</p> -</li> -<li> -<p> -New options <tt>--vcs</tt> and <tt>--vcs-update</tt> for using the files of - the public source repository of the LaTeX project. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/05 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Using LaTeX modules from CTAN. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/08 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Update of base and graphics. -</p> -</li> -<li> -<p> -<tt>README.html</tt> with Unix line ends. -</p> -</li> -<li> -<p> -ZIP file for CTAN upload with top level directory <tt>latex-tds</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/10 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module cyrillic: Missing <tt>00readme.txt</tt> added. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/15 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: <tt>fix-cm</tt> updated (2014/05/13 v1.1q). -</p> -</li> -<li> -<p> -Module tools: <tt>tabularx</tt> updated (2014/05/13 v2.10). -</p> -</li> -<li> -<p> -Module tools: <tt>readme.txt</tt> renamed to <tt>00readme.txt</tt>. -</p> -</li> -<li> -<p> -Module knuth: <tt>.web</tt> files are put below <tt>TDS:web/knuth//</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/16 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: Formatting of <tt>ltnews.pdf</tt> fixed. -</p> -</li> -<li> -<p> -<tt>fix-expl3-lua.ini</tt> added to support putting package expl into a format. -</p> -</li> -<li> -<p> -Script <tt>check-tds-installation.pl</tt> added. -</p> -</li> -<li> -<p> -Module amslatex: <tt>TDS:bibtex/bst/ams</tt> renamed to <tt>TDS:bibtex/bst/amscls</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/05/21 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module amslatex: Sources for <tt>amsbooka</tt> added. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/06/12 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: Update of <tt>fixltx2e.dtx</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/09/17 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module tools: Update of packages <tt>varioref</tt> and <tt>multicol</tt>. -</p> -</li> -<li> -<p> -Module base: Update of <tt>fixltx2e</tt>. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/11/03 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module base: Update (2014-10-12). -</p> -</li> -<li> -<p> -Module tools: Update (2014-10-28). -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -2014/11/12 -</dt> -<dd> -<div class="ulist"><ul> -<li> -<p> -Module graphics: Update (2014-11-07). -</p> -</li> -<li> -<p> -Modules base, cyrillic, graphics, tools: - <tt>00readme.txt</tt> renamed to <tt>README</tt>. -</p> -</li> -<li> -<p> -Module amslatex: Missing <tt>amsbooka.zip</tt> added to directory <tt>patch</tt> - (until it is resolved at the AMS side). -</p> -</li> -</ul></div> -</dd> -</dl></div> -</div> -</div> -</div> -<div id="footnotes"><hr /></div> -<div id="footer"> -<div id="footer-text"> -Last updated 2014-11-11 22:53:51 CET -</div> -</div> -</body> -</html> diff --git a/macros/latex/contrib/latex-tds/README.pdf b/macros/latex/contrib/latex-tds/README.pdf Binary files differdeleted file mode 100644 index f0d1e77345..0000000000 --- a/macros/latex/contrib/latex-tds/README.pdf +++ /dev/null diff --git a/macros/latex/contrib/media4svg/ChangeLog b/macros/latex/contrib/media4svg/ChangeLog index 17962b8f39..aed1d22826 100644 --- a/macros/latex/contrib/media4svg/ChangeLog +++ b/macros/latex/contrib/media4svg/ChangeLog @@ -1,3 +1,7 @@ +2020-04-14 + * v0.4 + * fix: playback control via keyboard in Firefox + 2020-04-13 * v0.2 * fix: playback control on touch screens; expl3 fix diff --git a/macros/latex/contrib/media4svg/README.md b/macros/latex/contrib/media4svg/README.md index 8b8f376bde..cfdb7027e8 100644 --- a/macros/latex/contrib/media4svg/README.md +++ b/macros/latex/contrib/media4svg/README.md @@ -1,6 +1,6 @@ # The `media4svg` LaTeX Package -Version 0.2, 2020/04/13 +Version 0.3, 2020/04/14 © 2020--today, Alexander Grahn diff --git a/macros/latex/contrib/media4svg/example/beamer-example-1.svg b/macros/latex/contrib/media4svg/example/beamer-example-1.svg index 7ec641a064..729a51b1b9 100644 --- a/macros/latex/contrib/media4svg/example/beamer-example-1.svg +++ b/macros/latex/contrib/media4svg/example/beamer-example-1.svg @@ -9,12 +9,12 @@ function $(id) {return document.getElementById("msvg@"+id.toString().trim());}; </script> </defs> <style type='text/css'> -<] | +[[PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf)] + +Scientific publications are too dry. Too much math, too little emotions. Science +needs emojis! +Leave a small heart to value the hard work gone into a paper (Smith, 2014 ❤️ ). +Flag self-citations as in (Sixt et al., 2019 🤳) +Finally, you can express what you truly think directly as in (Wakefield et. al, 1998 🤦). +We could also indicate, how thoroughly we read papers (Van Wesel et al., 2014 🙈) + +## Basic Usage + +``` +\documentclass{article} + +\usepackage{emojicite} +\setcitestyle{authoryear, round} +\bibliographystyle{plainnat} + +\begin{document} + +\emojicitep{einstein, kissing-heart} + +\bibliography{bibliography} +\end{document} +``` + +See [example.tex](./example.tex) for basic usage. + +## Examples + +Table 1: How did you liked the cited work? + +| Citation | Emoji | Description | +|--------------------------------|:--------------:|:---------------------| +| (Einstein, 1905 😘) | kissing-heart | I like this work. Here is a kiss. +| (Shannon, 1948 🙇) | bow | Wow, I can only bow to this work. +| (Kim et al., 2017 👍) | +1 | Good work! +| (Zhang and Cheok, 2016 😕 ) | confused | I am confused by this work. +| (Le Cun et al., 1989 🥱) | yawning-face | Boring work. +| (Tishby and Zaslavsky, 2015 🤨)| raised-eyebrow | I have some serious questions... +| (Wakefield et al., 1998 🤦) | facepalm | omg, this work sucks! + + +Table 2: How thoroughly have you read the work? + +| Citation | Emoji | Description | +|--------------------------------|:--------------:|:---------------------| +| (Kingma and Welling, 2013 🤓) | nerd-face | I know everything about this work. +| (Kim et al., 2017 🎓) | graduation-cap | I know this work well. +| (Shannon, 1948 🤔) | thinking | I read it but I still have questions. +| (Jones, 1972 🙈) | see-no-evil | Ups, I did not read this work in-depth. +| (Einstein, 1905 🤷) | shrug | too long; did not read + +See [PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf) for more examples. + + +## Requirements + +The package requires the Tex Live 2020 distributon and you need to use lualatex. +If you use the `latexmk` tool, simple use `latexmk -pdflua`. See the +[emoji](https://github.com/stone-zeng/latex-emoji) package for are in-depth +description on the requirements. + + +----- + +Copyright (C) 2020 by Leon Sixt. + +🙏 to Xiangdong Zeng creator of [emoji](https://github.com/stone-zeng/latex-emoji) diff --git a/macros/luatex/latex/emojicite/emojicite-doc.pdf b/macros/luatex/latex/emojicite/emojicite-doc.pdf Binary files differnew file mode 100644 index 0000000000..4ef79c3566 --- /dev/null +++ b/macros/luatex/latex/emojicite/emojicite-doc.pdf diff --git a/macros/luatex/latex/emojicite/emojicite-doc.tex b/macros/luatex/latex/emojicite/emojicite-doc.tex new file mode 100644 index 0000000000..baf37b8991 --- /dev/null +++ b/macros/luatex/latex/emojicite/emojicite-doc.tex @@ -0,0 +1,182 @@ +\documentclass{l3doc} +\usepackage{fontspec} +\usepackage{emojicite} +\usepackage{listings} +\usepackage{float} +\usepackage{array,booktabs,fontspec,geometry,graphicx,longtable,xcolor} + +\setcitestyle{authoryear, round} +\bibliographystyle{plainnat} +\hypersetup{citecolor=black} + + +\definecolor{mygreen}{rgb}{0,0.6,0} +\definecolor{mygray}{rgb}{0.5,0.5,0.5} +\definecolor{mymauve}{rgb}{0.58,0,0.82} + +\lstset{ + backgroundcolor=\color{white}, % choose the background color; you must add \usepackage{color} or \usepackage{xcolor}; should come as last argument + basicstyle=\small, % the size of the fonts that are used for the code + breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace + breaklines=true, % sets automatic line breaking + captionpos=b, % sets the caption-position to bottom + commentstyle=\color{mygreen}, % comment style + deletekeywords={...}, % if you want to delete keywords from the given language + escapeinside={\%*}{*)}, % if you want to add LaTeX within your code + extendedchars=true, % lets you use non-ASCII characters; for 8-bits encodings only, does not work with UTF-8 + firstnumber=1, % start line enumeration with line 1000 + frame=single, % adds a frame around the code + keepspaces=true, % keeps spaces in text, useful for keeping indentation of code (possibly needs columns=flexible) + keywordstyle=\color{blue}, % keyword style + language=Octave, % the language of the code + morekeywords={*,...}, % if you want to add more keywords to the set + numbers=left, % where to put the line-numbers; possible values are (none, left, right) + numbersep=5pt, % how far the line-numbers are from the code + numberstyle=\tiny\color{mygray}, % the style that is used for the line-numbers + rulecolor=\color{black}, % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. comments (green here)) + showspaces=false, % show spaces everywhere adding particular underscores; it overrides 'showstringspaces' + showstringspaces=false, % underline spaces within strings only + showtabs=false, % show tabs within strings adding particular underscores + stepnumber=1, % the step between two line-numbers. If it's 1, each line will be numbered + stringstyle=\color{mymauve}, % string literal style + tabsize=2, % sets default tabsize to 2 spaces + title=\lstname % show the filename of files included with \lstinputlisting; also try caption instead of title +} + +\setlength{\parskip}{0.0em} +\setlength\parindent{0pt} + +\makeatletter +\ExplSyntaxOn +\def\@fnsymbol#1{ + \ensuremath{ + \ifcase #1 + \or \text{\emoji{globe-with-meridians}} + \or \text{\emoji{email}} + \fi}} +\ExplSyntaxOff +\makeatother + + +\title{The \pkg{emojicite} package \thanks{\url{https://github.com/berleon/emojicite}} \\ + Adds Emojis to Citations \\ + \normalsize (requires Lua\LaTeX)} + \author{Leon Sixt \thanks{\url{mail@leon-sixt.com}}} +\date{\emoji{date} 2020/04/13\quad v0.1} + + +\begin{document} +\maketitle + +\tableofcontents + +\setlength{\parskip}{0.5em} + +\section{Introduction} + +Scientific publications are too dry. Too much math, too little emotions. Science +needs emojis! +Leave a small heart to value the hard work gone into a paper \emojicitep{smith2014honey, heart}. +Finally, you can express what you truly think as in \emojicitep{wakefield1998retracted, facepalm}. +We could also indicate, how thoroughly we read papers \emojicitep{van2014difference, see-no-evil}. + +\begin{verbatim} + \emojicitep{van2014difference, see-no-evil}. +\end{verbatim} + + +The package is based on the \pkg{emoji} package\footnote{\url{https://ctan.org/pkg/emoji}}. +See their documentation for the emoji codes\footnote{\url{http://mirrors.ctan.org/macros/luatex/latex/emoji/emoji-doc.pdf}}. You can also use \texttt{\textbackslash setemojifont\{\dots\}} to select a different emoji font. + + +%\emojicitep{wakefield1998retracted, facepalm, see-no-evil} +You can use up to two emojis \emojicitep{shannon1948, bow, thinking}. The package also supports +to cite multiple works as in \emojicitep{sixt2019explanations, selfie; adebayo2018sanity, +1}. +\pkg{emojicite} does not support more than two emojis. +\texttt{\textbackslash emojicitep\{wakefield1998retracted, facepalm, roll-eyes, shrug\}} +renders as \emojicitep{wakefield1998retracted, facepalm, roll-eyes, shrug}. +Let's ensure science does not get to emotional \emoji{point-up-2}\emoji{neutral-face}. + +\newpage +\subsection{Example} + +\lstinputlisting[language=Tex,caption={Output of the example is: \emojicitep{einstein, kissing-heart} }]{example.tex} +\subsection{Requirements} + +The package works with the Tex Live 2020 distributon and you need to use \texttt{lualatex}. +If you use the \texttt{latexmk} tool, use it with this flag: \texttt{latexmk -pdflua}. +See the \pkg{emoji} package for are an in-depth description of the requirements. + + +\section{Examplary Usage} + +Here are some emoji, I found fitting. + +\begin{table}[H] + \centering + \caption{How did you liked the cited work?} + \begin{tabular}{l l l} + %\hline \hline + \textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline + \emojicitep{einstein, kissing-heart} & \texttt{kissing-heart} & I like this work. Here is a kiss. \\ + \emojicitep{shannon1948, bow} &\texttt{bow} & Wow, I can only bow to this work. \\ + \emojicitep{kim2017interpretability, +1} &\texttt{+1} & Good work! \\ + \emojicitep{zhang20167kissing, confused} &\texttt{confused} & I am confused by this work. \\ + \emojicitep{le1989gemini, yawning-face} & \texttt{yawning-face} & Boring work.\\ + \emojicitep{tishby2015deep, raised-eyebrow} &\texttt{raised-eyebrow}& I have some serious questions...\\ + \emojicitep{wakefield1998retracted, facepalm} &\texttt{facepalm}& omg, this work sucks! \\ + \end{tabular} +\end{table} + +\begin{table}[H] + \centering + \caption{How thoroughly have you read the work?} + \begin{tabular}{l l l} + \textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline + \emojicitep{kingma2013auto, nerd-face} & \texttt{nerd-face}& I know everything about this work. \\ + \emojicitep{kim2017interpretability, graduation-cap} & \texttt{graduation-cap}& I know this work well. \\ + \emojicitep{shannon1948, thinking} &\texttt{thinking}& I read it but I still have questions. \\ + \emojicitep{jones1972statistical, see-no-evil} &\texttt{see-no-evil}& Ups, I did not read this work in-depth. \\ + \emojicitep{einstein, shrug} &\texttt{shrug}& too long; did not read \\ + \end{tabular} +\end{table} + + +\begin{table}[H] + \centering + \caption{Special emojis} + \begin{tabular}{l l l} + + \textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline + \emojicitep{sixt2019explanations, selfie} & \texttt{selfie} & Citing myself. It just fits perfectly.\\ + \emojicitep{blei2003latent, writing-hand, +1} & \texttt{writing-hand, +1} & Well written work.\\ + \end{tabular} +\end{table} + +\begin{table}[H] + \centering + \caption{Short summary of papers} + \begin{tabular}{l l l} + + \textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline + \emojicitep{watson1953molecular, dna} & \texttt{dna} & Helix structure of DNA.\\ + \emojicitep{smith2014honey, grimacing, bee} & \texttt{grimacing, bee} & Getting sting by honey bees. \\ + \emojicitep{zhang20167kissing, kissing-heart, robot} & \texttt{kissing-heart, robot} & Kissing machine. \\ + \emojicitep{nakanishi2014remote, handshake, mechanical-arm} & \texttt{handshake, mechanical-arm} & Handshake machine. \\ + \end{tabular} +\end{table} + + +\section{Limitations} + +Currently, only the name-year format is supported but using a number format is also simple wrong. +Unfortunatly, the Tex Live package required by this verison is not yet available +on ArXiv. If you want to publish on ArXiv, you probably would have to upload the PDF. +Another problem could be that scientific journals and conferences might not see +the same great value in emojis \emoji{roll-eyes}. Every revolution requires +a bit of time. + + + +\bibliography{bibliography} +\end{document} diff --git a/macros/luatex/latex/emojicite/emojicite.sty b/macros/luatex/latex/emojicite/emojicite.sty new file mode 100644 index 0000000000..3b459046b3 --- /dev/null +++ b/macros/luatex/latex/emojicite/emojicite.sty @@ -0,0 +1,101 @@ +%% +%% Copyright (C) 2020 by Leon Sixt <ctan@leon-sixt.de> +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3c 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.3 or later is part of all distributions of +%% LaTeX version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Leon Sixt. +%% +\NeedsTeXFormat{LaTeX2e}[2020/02/02] +\ProvidesExplPackage{emoji}{2020/04/14}{0.1}{Add Emojis to Citations (in LuaLaTeX)} + +\usepackage{emoji} +\usepackage{natbib} + +\usepackage{xparse} +\ExplSyntaxOn + +\makeatletter +\NewDocumentCommand{\emojicite}{m} + { + \mjb_multicitep:n { #1 } + } +\makeatother + + +\makeatletter +\NewDocumentCommand{\emojicitep}{m} + { + \NAT@open + \mjb_multicitep:n { #1 } + \NAT@close + } +\makeatother + +\seq_new:N \l_mjb_multicite_in_seq +\seq_new:N \l_mjb_multicite_out_seq +\seq_new:N \l_mjb_cite_seq + +\cs_new_protected:Npn \mjb_multicitep:n #1 + { + \seq_set_split:Nnn \l_mjb_multicite_in_seq { ; } { #1 } + \seq_clear:N \l_mjb_multicite_out_seq + \seq_map_inline:Nn \l_mjb_multicite_in_seq + { + \mjb_cite_process:n { ##1 } + } + \seq_use:Nn \l_mjb_multicite_out_seq { ;~ } + } + +\cs_new_protected:Npn \mjb_cite_process:n #1 +{ + \seq_set_split:Nnn \l_mjb_cite_seq { , } { #1 } + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 1 } + { + \seq_put_right:Nn \l_mjb_multicite_out_seq + { \citeauthor{#1},~\citeyear{#1} } + } + { + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 2 } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \emoji{\seq_item:Nn \l_mjb_cite_seq { 2 }} + } + } + % we can handle up to 2 emojis + { + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 3 } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \emoji{\seq_item:Nn \l_mjb_cite_seq { 2 }} + \emoji{\seq_item:Nn \l_mjb_cite_seq { 3 }} + } + } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \exp_not:N \textbf{emojicite~does~not~support~more~than~two~emojis}. + } + } + } + } + } +\ExplSyntaxOff + diff --git a/macros/luatex/latex/emojicite/example.tex b/macros/luatex/latex/emojicite/example.tex new file mode 100644 index 0000000000..5a43430434 --- /dev/null +++ b/macros/luatex/latex/emojicite/example.tex @@ -0,0 +1,12 @@ +\documentclass{article} + +\usepackage{emojicite} +\setcitestyle{authoryear, round} +\bibliographystyle{plainnat} + +\begin{document} + +\emojicitep{einstein, kissing-heart} + +\bibliography{bibliography} +\end{document} |
