summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/asmejour/README.md
blob: 963ec282a7554f3492b3cd111d097acf4f8292ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
  #asmejour: A template for ASME journal papers#
 
  Version 1.02 dated 2019/05/22.

  ####Overview####
  This class provides a template to format preprints submitted to ASME journals in the style that 
  is being used in early 2019.
  
  This work is not a publication of ASME itself.

  Files in this distribution are:

          README.md              --  this file
          asmejour.cls           --  the class file
          asmejour.bst           --  bibtex style for ASME journal references
          asmejour-template.tex  --  a latex template/example for this class
          asmejour-template.pdf  --  documentation/sample paper
          asmejour-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:

- closely approximate ASME's fonts and layout

- follow ASME's current citation formats

- support use of hyperref package (hyperlink references to figures, tables, citations, and web)

- support pdf bookmarks

- use the newtxtext and newtxmath font packages, which enable a variety of text and math features

- support bold face, math, and footnotes in section headings

- provide automatic layout of author blocks for multiple addresses


  ####Author####
  
  John H. Lienhard V
  
  Department of Mechanical Engineering
          
  Massachusetts Institute of Technology
          
  Cambridge, MA 02139-4307 USA


 ---
 
 ####Change log####
 
v1.02:  adjust formats of 2nd and 3rd level headings; add option for line numbers; eqn tags in blue
 
v1.01:  edit documentation, remove development code
 
v1.00:  initial release
 
 ---
 
 ####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.