User Tools

Site Tools


eoacommands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
eoacommands [2019/11/27 15:46]
sszenti [6. Figures and equations]
eoacommands [2021/02/17 13:48] (current)
kthoden
Line 1: Line 1:
 ===== Edition Open Access — Summary of Commands ===== ===== Edition Open Access — Summary of Commands =====
  
-English Version, 4. November2013+
  
 ==== 1. General Setup ==== ==== 1. General Setup ====
Line 17: Line 17:
 </​code>​ </​code>​
  
-''​\EOAbibliographytype''​ may be anthology or monograph. With monograph you can produce one bibliography per chapter; anthology would produce a complete bibliography for the entirepublication. ''​\EOAbibliographydatabase''​ should include the filename of your BibTeX-database. ''​\EOAseriesmay''​ be Studies, Sources, Textbooks or Proceedings. This command determines the dimensions of the book and also the numbering scheme.+''​\EOAbibliographytype''​ may be anthology or monograph. With monograph you can produce one bibliography per chapter; anthology would produce a complete bibliography for the entirepublication. ''​\EOAbibliographydatabase''​ should include the filename of your BibTeX-database. ''​\EOAseries'' ​may be Studies, Sources, Textbooks or Proceedings. This command determines the dimensions of the book and also the numbering scheme.
  
 ==== 2. Text structure ==== ==== 2. Text structure ====
Line 110: Line 110:
  
 The text in the curly brackets will be given in //​italics//​. The text in the curly brackets will be given in //​italics//​.
 +
 +=== Bold text ===
 +
 +<code eoatex>
 +\EOAbold{Text}
 +</​code>​
 +
 +The text in the curly brackets will be given in **bold**.
  
 === Superscript and subscript === === Superscript and subscript ===
Line 120: Line 128:
 The text in curly brackets will be given in <​sup>​superscript</​sup>​ or in <​sub>​subscript</​sub>​. The text in curly brackets will be given in <​sup>​superscript</​sup>​ or in <​sub>​subscript</​sub>​.
  
 +=== Red text ===
 +
 +<code eoatex>
 +\EOAred{Text}
 +</​code>​
 +
 +The text in curly braces will appear in red.
 === Internet addresses URL === === Internet addresses URL ===
  
 <code eoatex> <code eoatex>
-\EOAurl{http://​www.example.com}+\EOAurl{https://​www.example.com}
 </​code>​ </​code>​
  
-This will format Internet addresses. The address in the curly brackets should not be masked or modified in any way.+This will format Internet addresses. The address in the curly brackets should not be masked or modified in any way. It is good practice to also note the date when that site was last accessed. You can add a formatted string as an optional argument. It will be appended to the URL, separated by a comma: 
 + 
 +<code eoatex>​ 
 +\EOAurl[accessed August 13, 2018]{https://​www.example.com} 
 +</​code>​
  
 === Greek, Chinese,​Russian and Hebrew characters === === Greek, Chinese,​Russian and Hebrew characters ===
Line 178: Line 197:
  
 <code eoatex> <code eoatex>
-\begin{EOAtranscripted}{Header left}{Headerright}+\begin{EOAtranscripted}{Header left}{Header right}
 Transcribed text on the left-hand page Transcribed text on the left-hand page
 \EOAnewpage \EOAnewpage
Line 190: Line 209:
  
 <code eoatex> <code eoatex>
-\EOAletterhead{Recipientand ​Date}{Archive identification}+\EOAletterhead{Recipient and Date}{Archive identification}
 {Additional information}{pages} {Additional information}{pages}
 </​code>​ </​code>​
Line 323: Line 342:
 </​code>​ </​code>​
  
-This command compiles an array of equations. A label is obligatory. For an array of unnumbered equations without a label, use the environment ''​\begin{EOAequationarraynonumber} ... \end{EOAequationarraynonumber}''​.+This command compiles an array of equations. A label is obligatory. For an array of unnumbered equations without a label, use the environment 
 +''​\begin{EOAequationarraynonumber} ... \end{EOAequationarraynonumber}''​.
  
 === Subequations === === Subequations ===
Line 333: Line 353:
  
 This command compiles an array of equations. There should be no arbitrary text between the equations. This command compiles an array of equations. There should be no arbitrary text between the equations.
 +
 +==== 7. Tables ====
 +
 +
 +=== Basic layout of a table ===
 +
 +<code eoatex>
 +\begin{EOAtable}{Column definitions}{Caption}{Label}{Positioning}
 +columns & divided & by & ampersands\\
 +\end{EOAtable}
 +</​code>​
 +
 +  * __Definition of columns__: To define a column, an abbreviation in the form ''​Alignment{Width}''​ is used. ''​L''​ stands for left-aligned text, ''​C''​ for centered text, and ''​R''​ for right-aligned text. The indication of width is given in cm. The indication ''​L{4cm}''​ will define a column of 4cm width whose text will be left aligned. The sum width of all the columns in a table should not exceed 9.5cm.
 +  * __Caption__:​ The caption should not exceed three to four lines. If ''​nonumber''​ is given in place of a caption, then neither a number nor a caption will appear
 +  * __Label__: The label will be used for cross-referencing purposes.
 +  * __Positioning__:​ Two abbreviations can be used to influence the positioning of the table in the text. The abbreviation ''​ht''​ will cause the tableto be positioned as close as possible to the insertion point in the text or in a suitable position at the top of one of the following pages. Using ''​H''​ will cause the table to appear at the exact insertion point in the text.
 +
 +Example:
 +<code eoatex>
 +\begin{EOAtable}{L{3cm}C{3cm}R{3.5cm}}{This is a caption}{Table1}{ht}
 +ragged left text in column 1 & centered text in column 2 & right ragged text \\
 +2nd row, 1st column & 2nd row, 2nd column & 2nd row, 3rd column
 +\end{EOAtable}
 +</​code>​
 +
 +This will define a table with three columns. The first column is left aligned and 3cm wide. The second column is centered and is also 3cm wide. The third column is right aligned and 3.5cm wide.
 +
 +=== Table header ===
 +
 +<code eoatex>
 +\EOAtablehead{columns & divided & by & ampersands}
 +</​code>​
 +
 +For an offset header, this command can be used directly after ''​\begin{EOAtable}''​.The column headings are separated by ''​‘&​’''​. A closing line break ''​\\''​ is not used.
 +
 +==== 8. Cross-­referencing ====
 +
 +
 +=== Assigning a label ===
 +
 +<code eoatex>
 +\EOAlabel{Label}
 +</​code>​
 +
 +To cross-reference a particular part of the text, set up a jump label as follows ''​\EOAlabel{SectionX}''​.
 +
 +=== Cross-reference to a label: section, figure or equation ===
 +
 +<code eoatex>
 +\EOAref{SectionX/​FigureX/​Eq.X}
 +</​code>​
 +
 +This command will create a cross-reference to the number of the referenced section, figure or equation.
 +
 +=== Page reference ===
 +
 +<code eoatex>
 +\EOApageref{Label}
 +</​code>​
 +
 +This will produce the page number on which the referenced (labeled) item appears.
 +
 +==== 9. Bibliographic details ====
 +
 +
 +=== References with author and year ===
 +
 +<code eoatex>
 +\EOAciteauthoryear[page-range]{Reference_key}
 +</​code>​
 +
 +This will produce the author’s name and the year of the publication only. The reference key refers to the identification of the entry in the BibTeX-database. Information such as the page range or the volume or chapter number can be given in the square brackets (optional).
 +
 +=== References with year ===
 +
 +<code eoatex>
 +\EOAciteyear[page-range]{Reference_key}
 +</​code>​
 +
 +This will produce the year of the publication only; the author'​s name will be suppressed.
 +
 +
 +=== Individual referencing ===
 +
 +<code eoatex>
 +\EOAcitemanual[Character string]{Reference_key}
 +</​code>​
 +
 +This command is used to indicate source references with an arbitrary character string. The character string may also involve just single characters, for example, for source references in the form //Einstein 1916a,​b,​c//​.
 +
 +
 +=== References with numbers ===
 +
 +<code eoatex>
 +\EOAcitenumeric[page-range]{Reference_keys}
 +</​code>​
 +
 +The command ''​\EOAcitenumeric''​ is used in conjunction with the numerical citation that is activated by using ''​\EOAbibliographytype{anthology-numeric}''​ or ''​\EOAbibliographytype{monograph-numeric}''​. It is the only citation command that is able to divide a list of sources using commas.
 +
 +
 +=== Bibliography ===
 +
 +<code eoatex>
 +\EOAprintbibliography
 +</​code>​
 +
 +At this point, a list of the references will be given.
 +
 +==== 10. Indices ====
 +
 +
 +=== Index entry ===
 +
 +<code eoatex>
 +\EOAindex{Index_term}
 +</​code>​
 +
 +This command adds an entry to the index. If the entry begins with a special character, for example, with an **umlaut** or **é**, then the **@** symbol can be used as a sort key. For example, a normal entry would be ''​Smith\index{Smith,​ J.}''​ and produce //Smith, J.// in the index. An entry with a special character such as é would be ''​Géhéniau\index{Geheniau,​ J.@Géhéniau,​ J.}''​. Here the entry is sorted under G, but as //​Geheniau//​ and not //​Géhéniau//​. The command ''​\EOAindexperson{}''​ adds an entry to the index of names.
 +
 +=== Compiling the index ===
 +
 +<code eoatex>
 +\EOAprintindex
 +</​code>​
 +
 +This command compiles the index. The index of names is displayed using the command ''​\EOAprintpersonindex''​.
 +Please note: The indices may need some adjustments before going to print. This will be done by the Development Team.
 +
 +==== 11. Facsimiles ====
 +
 +
 +=== Facsimile part ===
 +
 +<code eoatex>
 +\EOAfacsimilepart{Text}
 +</​code>​
 +
 +This introduces the part of the book, if any, containing facsimiles. More than one part can be introduced. The facsimiles should always be positioned at the end of a book.
 +
 +=== Facsimile ===
 +
 +<code eoatex>
 +\EOAfacsimile{File_name}{Label}{Header}
 +</​code>​
 +
 +This will produce each separate image file on one whole page. The obligatory label can be used to cross-reference the facsimiles. The header will appear in the heading of the page and may be used to describe a particular page, i.e. //​57verso//​.
 +
 +==== 12. Other permitted commands ====
 +
 +
 +The following commands can be used to optimize the layout of the book. However it must be noted that these commands will be ignored during the conversion process for the Web layouts. The commands should not be used in making scientific statements.
 +
 +Admissible commands: **\noindent \medskip \smallskip \bigskip \vspace \,** as well as **\followed by a space** to reduce the spread.
eoacommands.1574865999.txt.gz · Last modified: 2019/11/27 15:46 by sszenti