README.md

   1 # Documentation for `iidtitlepage` package
   2 TODO: what is it
   3
   4
   5 ## Package installation
   6 Put files `iidtitlepage.sty` and `iid-logo.pdf` into the root directory of your article, i.e., where your main `.tex` file is located.
   7 The package has a few dependencies, you may either check them in `.sty` file (`\RequirePackage` commands) or just keep building your article until you will have no errors left ;).
   8
   9 TODO: installation to system LaTeX?
  10
  11 ## Package usage
  12 File `example.tex` shows a complete example on how to use the package.
  13
  14 To import the package, use following
  15 ```latex
  16 \usepackage[elsevier]{iidtitlepage}
  17 ```
  18 The package has one mandatory argument which is either `elsevier` or `ieee`, depending on the publisher of your article.
  19
  20 Then, you need to provide some mandatory information such as title name, authors, year and citation text
  21 ```latex
  22 % Title.
  23 \title{An example document using \texttt{iidtitlepage} package}
  24
  25 % Authors.
  26 % Unfortunately, we cannot use \author command, since some journal templates require to use a specific macros that might be not compatible with the package.
  27 \IidTitlePageAuthors{Istv\'{a}n M\'{o}dos, Va\v{s}ek Chv\'{a}tal}
  28
  29 % Year of publication.
  30 \IidTitlePageYear{2017}
  31
  32 % How to cite this article. Can be either full-text or, as in this case, a bibtex entry.
  33 \IidTitlePageCiteAs{modos2018}
  34 ```
  35
  36 You may specify some optional information such as DOI and source code url
  37 ```latex
  38 \IidTitlePageDoi{https://doi.org/10.1016/j.cie.2017.08.011}
  39 \IidTitlePageSourceCodes{https://github.com/torvalds/linux}
  40 ```
  41
  42 After all information is specified, call `\IidTitlePage{}` to create a title page
  43 ```latex
  44 \begin{document}
  45 ...
  46 \IidTitlePage{}
  47 ...
  48 \maketitle
  49 ...
  50 \end{document}
  51 ```