summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmeconf/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/asmeconf/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/asmeconf/README.md')
-rw-r--r--macros/latex/contrib/asmeconf/README.md98
1 files changed, 98 insertions, 0 deletions
diff --git a/macros/latex/contrib/asmeconf/README.md b/macros/latex/contrib/asmeconf/README.md
new file mode 100644
index 0000000000..54508416ac
--- /dev/null
+++ b/macros/latex/contrib/asmeconf/README.md
@@ -0,0 +1,98 @@
+
+ #asmeconf: A template for ASME conference papers#
+
+ Version 1.11 dated 2019/07/08.
+
+ ####Overview####
+ This class provides a template to format ASME Conference papers according to
+ the requirements on ASME's web pages (as posted in July 2019).
+
+ [www.asme.org/publications-submissions/proceedings/formatting-the-paper](https://www.asme.org/publications-submissions/proceedings/formatting-the-paper)
+
+ This work is not a publication of ASME itself.
+
+ Files in this distribution are:
+
+ README.md -- this file
+ asmeconf.cls -- the class file
+ asmeconf.bst -- bibtex style for ASME conference format
+ asmeconf-template.tex -- a latex template/example for this class
+ asmeconf-template.pdf -- documentation/sample paper
+ asmeconf-sample.bib -- a sample bibliography file
+ *
+ sample-figure-1.pdf,
+ sample-figure-2a.pdf,
+ sample-figure-2b.pdf -- figures for the example
+
+ The .tex and .cls files are commented and should be self-explanatory.
+
+
+
+
+ This template was designed to approach the following aims:
+
+- match ASME's font current specifications and layout
+
+- match ASME's current citation formats
+
+- support hyperref package (hyperlinks to figures, tables, references, web)
+
+- support pdf bookmarks
+
+- enable various math and text features with newtxmath and newtxtext packages
+
+- support bold face, sans serif math in section headings
+
+- support footnotes in section headings
+
+- provide automatic layout of author and addresses in one of two styles
+
+
+ ####Author####
+
+ John H. Lienhard V
+
+ Department of Mechanical Engineering
+
+ Massachusetts Institute of Technology
+
+ Cambridge, MA 02139-4307 USA
+
+
+ ---
+
+ ####Change log####
+
+ v1.11: minor adjustments to title, author, and affiliation layout
+
+ v1.1: revise several parts of the layout to match ASME's updated specifications from Summer 2019 (including author block, abstract font, placement of nomenclature, and minor spacings); add .bst support for online references and eprints; expand documentation significantly; guidance on fitting equations into columns.
+
+ v1.07: improve support for numbered section headings; allow omission of corresponding author email; edit documentation
+
+ v1.06: automate bold sans math in captions and headings; small adjustments to default spacings; adjust font of paper number to 18 pt; edit documentation
+
+ v1.05: minor code clean-up; change to keyvalue for to control font for superiors
+
+ v1.04: fix option passing for mathalfa package; adjust \\entry to create nomenclature subheadings efficiently.
+
+
+ ---
+
+ ####License####
+
+ Copyright (c) 2019 John H. 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,
+ including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ subject to the following two conditions:
+
+ The above copyright notice and this permission notice shall be included in all copies or
+ substantial portions of the Software.
+
+ The software is provided "as is", without warranty of any kind, express or implied, including but
+ not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.
+ In no event shall the authors or copyright holders be liable for any claim, damages or other liability,
+ whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
+ software or the use or other dealings in the software.