path: root/Master/texmf-dist/doc/latex/ijsra/ijsra.tex

\documentclass[
%	year=2016,
%	month=October,
%	number=1,
%	volume=2,
	]{ijsra}
\def\IJSRAidentifier{\currfilebase}


\def\shorttitle{The \texttt{ijsra}-class, Version \IJSRAversion\ -- \IJSRAversiondate}
\def\maintitle{The \texttt{ijsra}-class, Version \IJSRAversion\ -- \IJSRAversiondate}
\def\shortauthor{Lukas C. Bossert}
\def\authormail{lukas@digitales-altertum.de}
\def\affiliation{Humboldt-Universität zu Berlin | Excellence-Cluster Topoi}
\def\thanknote{The coding of this documentclass is done at \href{https://github.com/LukasCBossert/documentclass-ijsra}{https://github.com/LukasCBossert/documentclass-ijsra} }
%\def\keywordname{}
\def\keywords{documentclass, \LaTeX , IJSRA}
%--------------------------------------------------------------


\begin{filecontents}{\IJSRAidentifier.bib}
@Incollection{Orengo2015,
  author       = {Orengo, H.},
  title        = {Open Source GIS and Geospatial Software in Archaeology},
  subtitle     = {Towards Their Integration into Everyday Archaeological Practice},
  pages        = {64--82},
  editor       = {Wilson, A. T. and Edwards, B.},
  booktitle    = {Open Source Archaeology},
  booksubtitle = {Ethics and Practice},
  publisher    = {deGruyter Open},
  location     = {Warsaw},
  year         = {2015},
}

@Article{Pikirayi2015,
  author       = {Pikirayi, I.},
  title        = {The Future of Archaeology in Africa},
  journaltitle = {Antiquity},
  volume       = {89},
  pages        = {531--541},
  year         = {2015},
  issue        = {345},
}

@Article{Bossert-ijsra,
  author    = {Lukas C. Bossert},
  title     = {›ijsra‹ -- bib\LaTeX-style which is used for the \emph{International Journal of Student Research in Archaeology}},
  subtitle  = {Version: 0.1},
  url       = {http://www.ctan.org/pkg/biblatex-ijsra},
  keywords  = {latex},
  year ={2016},
  note      = {https://github.com/LukasCBossert/biblatex-ijsra},
  owner     = {Lukas C. Bossert},
  timestamp = {2016-07-04},
}

\end{filecontents}

\begin{document}
\lstMakeShortInline[style=code]|
\IJSRAopening

	{\Large\scshape
	\shortauthor}%
	\footnote\thanknote%
	\\[1em]
	\email\\
	\affiliation

\IJSRAmid

\begin{IJSRAabstract}%
This is a documentation of the class \texttt{ijsra} which is used for the
 \emph{International Journal of Student Research in Archaeology}.
 Read this documentation carefully.
 When you start editing do it according to the structure shown in \cref{document}.
\end{IJSRAabstract}

%\IJSRAseparator

\lettrine[nindent=0em,lines=3]{E}{very}  article\marginnote{starting} starts with a lettrine as the first letter.
This bigger letter functions as an eye catcher to make clear where the article starts.
It effects the whole word: The first letter reaches down to the third line, the other letters of the word are capitalised. 
In \cref{lettrine} you see the code how this is achieved.

 \begin{lstlisting}[label=lettrine,caption={Starting letter}]
\lettrine[nindent=0em,lines=3]{E}{very} article ... 
\end{lstlisting}
If you have a letter which is rather slanted you can define the slope. 
Let’s have a look at the letter ›A‹.
 \begin{lstlisting}[label=lettrine,caption={Starting letter ›A‹}]
\lettrine[slope=4pt,findent=-3pt,lines=3]{A}{rchaeologists}  …
\end{lstlisting}
And it changes of course if we start the article with a ›W‹. 
 \begin{lstlisting}[label=lettrine,caption={Starting letter ›W‹}]
\lettrine[slope=-4pt,nindent=-4pt,lines=3]{W}{hen} ...
\end{lstlisting}

\IJSRAseparator
Each article contains several information about the author, title, etc. 
This is done with some definitions. 
You have to fill in the information in the curly brackets.
\begin{lstlisting}[label=information,caption={Information about the article}]
\def\IJSRAidentifier{\currfilebase} %<---- don’t change this!
\def\shorttitle{} %<---- this is for the short title
\def\maintitle{} %<---- full title
\def\shortauthor{} %<---- full name of the author
\def\authormail{} %<--- email address name@email.com
\def\affiliation{} %<--- university or institution
\def\thanknote{} %<--- further information regarding the author
\def\keywords{} %<---- keywords describing the article
%\def\keywordname{} %<---- name of keywords in an other language
\end{lstlisting}
\IJSRAseparator
After the definitions there is the block regarding the bibliographical entries.
Those are written in the section 
\begin{lstlisting}[label=bibliography,caption={Bibliographical information}]
\begin{filecontents}{\IJSRAidentifier.bib} %<--- don’t change this

@Incollection{Orengo2015,
  author       = {Orengo, H.},
  title        = {Open Source GIS and Geospatial Software in Archaeology},
  subtitle     = {Towards Their Integration into Everyday Archaeological Practice},
  pages        = {64--82},
  editor       = {Wilson, A. T. and Edwards, B.},
  booktitle    = {Open Source Archaeology},
  booksubtitle = {Ethics and Practice},
  publisher    = {deGruyter Open},
  location     = {Warsaw},
  year         = {2015},
}

@Article{Pikirayi2015,
  author       = {Pikirayi, I.},
  title        = {The Future of Archaeology in Africa},
  journaltitle = {Antiquity},
  volume       = {89},
  pages        = {531--541},
  year         = {2015},
  issue        = {345},
}

@Article{Bossert-ijsra,
  author    = {Lukas C. Bossert},
  title     = {›ijsra‹ -- bib\LaTeX-style which is used for the \emph{International Journal of Student Research in Archaeology}},
  subtitle  = {Version: 0.1},
  url       = {http://www.ctan.org/pkg/biblatex-ijsra},
  keywords  = {latex},
  note      = {https://github.com/LukasCBossert/biblatex-ijsra},
  owner     = {Lukas C. Bossert},
  timestamp = {2016-07-04},
}
.
.
.

\end{filecontents}
\end{lstlisting}

After that we have completed the preamble and get to main part of the document.
Here we define the layout of the headline.

\begin{lstlisting}[label=headline,caption={Headline layout}]
\IJSRAopening %<---- don’t change or forget this
	{\Large\scshape
	\shortauthor}%
	\footnote\thanknote% 
	\\[1em]
	\email\\
	\affiliation
\IJSRAmid %<---- don’t change or forget this
\end{lstlisting}
If there is no \texttt{thanknote} you only have to comment line no. 4 and there will be no footnote.
\IJSRAseparator
After that we come to the abstract. 
The abstract is set in the enviroment \texttt{IJSRAabstract}:
\begin{lstlisting}[label=abstract,caption={IJSRAabstract}]
\begin{IJSRAabstract}
Abstract
\end{IJSRAabstract}
\end{lstlisting}
\IJSRAseparator
Then you can copy/paste the text of the article and make further editing.
At the very end you have to insert 
\begin{lstlisting}[label=closing,caption={IJSRAclosing}]
\IJSRAclosing
\end{lstlisting}

\clearpage
Following there is a minimal template how the plain document should look like when you begin to edit.
\begin{lstlisting}[label=document,caption={Plain document}]
\documentclass{ijsra}
\def\IJSRAidentifier{\currfilebase}
\def\shorttitle{}
\def\maintitle{}
\def\shortauthor{}
\def\authormail{}
\def\affiliation{}
\def\thanknote{}
\def\keywords{}
%\def\keywordname{}
\begin{filecontents}{\IJSRAidentifier.bib}
Bibliography-files
\end{filecontents}

\begin{document}
\IJSRAopening
	{\Large\scshape
	\shortauthor}%
	\footnote\thanknote%
	\\[1em]
	\email\\
	\affiliation
\IJSRAmid

\begin{IJSRAabstract}
Abstract
\end{IJSRAabstract}

\lettrine[nindent=0em,lines=3]{M}{ain} text ... 


\IJSRAclosing
\end{document}
\end{lstlisting}
\clearpage
Before we have a closer look how to do certain editing
let me give you some advice about naming the |tex|-file and the related figures.
The |tex|-file has to be saved under an unique and individual name.
Usually this is the family name of the author: e.g. |winckelmann.tex|
If you think this is not enough because the author has quite a common family (as it might be with \emph{Johnson}) 
plese use a word from the title, e.g. |Johnson_prehistory.tex|.
Notice there must not be a blank in the name, use instead |_| or |-|.

The name of the |tex|-file is what we have defined as the |\IJSRAidentifier|, 
with that we can differentiate between all the texts from the authors.

We need this |IJSRAidentifier| again for the figures:
put the figures in a folder called |figures|.
Do not name the figures e.g. |figure1|, |figure2| etc. but use again this 
|IJSRAidentifier| (e.g. |Johnson_prehistory|) and name the figures like this:
|Johnson_prehistory_fig01.jpg| or |winckelmann_fig01.png|.
You can also name tables in the same way:
|Johnson_prehistory_tab01.jpg| or |winckelmann_tab01.png|.

\alertinfo{But please make sure that the \emph{IJSRAidentifier} is used with correct spelling of the author’s name etc.}

\IJSRAseparator
How to do quotes:\marginnote{quotes}
Quotes are inserted between the enviroment |IJSRAquote|.
Let me give you an example:

\begin{lstlisting}[label=quote,caption={Quote}]
\begin{IJSRAquote}{Johann Joachim Winckelmann}
Grace can never properly be said to exist without beauty; 
for it is only in the elegant proportions of beautiful forms 
that can be found that harmonious variety of line and motion 
which is the essence and charm of grace.
\end{IJSRAquote}
\end{lstlisting}
It will be displayed as this:
 
\begin{IJSRAquote}{Johann Joachim Winckelmann}
Grace can never properly be said to exist without beauty; 
for it is only in the elegant proportions of beautiful forms 
that can be found that harmonious variety of line and motion 
which is the essence and charm of grace.
\end{IJSRAquote}
Of course you can also use |\cite[page]{bibtex-key}| for the author of the quote.

\IJSRAseparator
You can\marginnote{separator} insert a separation mark between some paragraphs,
as it is inserted automatically just before the bibliography. 
For that we edited a special form a separation mark. 
You can use it with |\IJSRAseparator|.

\IJSRAseparator
When suitable \marginnote{caption}we try to insert figures as a |wrapefigure| into the text.
Otherwise we insert them into the |figure|-enviroment.

If you have a table which is saved as a figure, 
you have to make a change to the caption. 
I show you how to do that. 
\begin{lstlisting}[label=caption,caption={Modify the caption}]
\captionof{table}{Put the caption here.}
\end{lstlisting}

\IJSRAseparator
Modifying\marginnote{references}  e.g. the caption is important for referencing in the text.
We use the special macro |\cref{label}| to reference to a figure, a table or anything else.
It makes it easier because we can omit to write ›fig.‹ or ›table‹ before the number of the figure or the table. 
The correct form (›fig.‹ etc.)  will be inserted automatically by \LaTeX .
If you like to have the first letter capitalised you can use |\Cref| instead.

Furthermore you can insert several |label| into a |\cref| by |\cref{label1,label2,label3}|.

\IJSRAseparator
If you\marginnote{numbers \& units} have a number or a number with an unit, 
please use the macros which are provided my |\SI|.
Let me show you some examples.
\begin{labeling}{range phrase (1)}
\item[meter] |100 m| has to be written as |\SI{100}{\meter}|;
\item[percent] |75 %| has to be written as |\SI{75}{\percent}|;
\item[range phrase (1)] |10x10 m|  has to be written as |\SIrange{10}{10}{\meter}|;
\item[range phrase (2)] |10--15 cm|  has to be written as |\SIrange[range-phrase=--]{10}{15}{\centi\meter}|;
\item[number] |23.394| has to be written as |\num{23394}|;
\item[angle] |56°| has to be written as |\ang{56}|;
\item[round precision] If you want to make a round precision of your numbers you can set it yourself by |\SI[round-precision=2]{23.3390}{\meter}| which will make |23.34 m|.
\end{labeling}



\IJSRAseparator
We have\marginnote{Different abstracts} the abstract of the article in english in the beginning,
just as shown in the template in \cref{document,abstract}.
If there is another abstract in a different language we put that at the end of the article.
For that we need also to redefine the keywords and usually the name \emph{keywords} according to the language of the abstract.

I give you an example how to edit a second abstract.
\begin{lstlisting}[label=abstract2,caption={Different abstract}]
\def\keywordname{Mots clés}
\def\keywords{keywords in French, \LaTeX , IJSRA, journal}
\foreignlanguage{french}{%
\begin{IJSRAabstract}
Abstract\marginnote{Abstract (French)} in French: Copy and paste the abstract in the different language here!
\end{IJSRAabstract}
}
\end{lstlisting}
\def\keywordname{Mots clés}
\def\keywords{keywords in French, \LaTeX , IJSRA, journal}
\foreignlanguage{french}{%
\begin{IJSRAabstract}
Abstract\marginnote{Abstract (French)} in French: Copy and paste the abstract in the different language here!
\end{IJSRAabstract}
}

%Do not forget to add the language in the options of the documentclass
%\begin{lstlisting}[label=abstract2,caption={Add the language of the abstract into the preamble}]
%\documentclass[
%	french,%<--- add the language if not English
%	]{ijsra}
%\end{lstlisting}



\IJSRAseparator
Some general information:
\begin{itemize}
\item Be aware of different brackets, e.g. |[] {}|;
These are part of \LaTeX -programming-language, every opening bracket needs a closing one.
\item Replace e.g. |19 %| with |\SI{19}{\percent}| otherwise everything after |%| will be omitted by \LaTeX;
\item Replace |&| with |\&|; 
\item Replace the citation of authors (e.g |Blesser \& Salter 2006|) with |\cite{Blesser2006}|;
	 if you have a page-range write: 	|\cite[23--45]{Blesser2006}|;
\item To compile with bibliography-references;
use 1 $\times$ \hologo{XeLaTeX}, then 1 $\times$ compiler ›biber‹, then 1 $\times$ \hologo{XeLaTeX}.
\item If you want to know how to cite properly
please have a look at the documentation of \texttt{biblatex-ijsra}.\footnote{\cite[see][]{Bossert-ijsra};\\ \url{http://mirrors.ctan.org//macros/latex/contrib/biblatex-contrib/biblatex-ijsra/biblatex-ijsra.pdf}}
\end{itemize}
\nocite{*}
\IJSRAclosing

\clearpage
You find the code using to write this documentation below.

\lstinputlisting[language={[AlLaTeX]{TeX}}]{\jobname.tex}
\end{document}