<body>
<h1 id="documentation-for-iidtitlepage-package">Documentation for <code>iidtitlepage</code> package</h1>
<p>TODO: what is it</p>
-<h2 id="package-installation">Package installation</h2>
-<p>Put files <code>iidtitlepage.sty</code> and <code>iid-logo.pdf</code> into the root directory of your article, i.e., where your main <code>.tex</code> file is located. The package has a few dependencies, you may either check them in <code>.sty</code> file (<code>\RequirePackage</code> commands) or just keep building your article until you will have no errors left ;).</p>
-<p>TODO: installation to system LaTeX?</p>
<h2 id="package-usage">Package usage</h2>
-<p>File <code>example.tex</code> shows a complete example on how to use the package.</p>
-<p>To import the package, use following</p>
-<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="bu">\usepackage</span>[elsevier]{<span class="ex">iidtitlepage</span>}</code></pre></div>
-<p>The package has one mandatory argument which is either <code>elsevier</code> or <code>ieee</code>, depending on the publisher of your article.</p>
-<p>Then, you need to provide some mandatory information such as title name, authors, year and citation text</p>
-<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="co">% Title.</span>
-<span class="fu">\title</span>{An example document using <span class="fu">\texttt</span>{iidtitlepage} package}
-
-<span class="co">% Authors.</span>
-<span class="co">% Unfortunately, we cannot use \author command, since some journal templates require to use a specific macros that might be not compatible with the package.</span>
-<span class="fu">\IidTitlePageAuthors</span>{Istv<span class="fu">\'</span>{a}n M<span class="fu">\'</span>{o}dos, Va<span class="fu">\v</span>{s}ek Chv<span class="fu">\'</span>{a}tal}
-
-<span class="co">% Year of publication.</span>
-<span class="fu">\IidTitlePageYear</span>{2017}
-
-<span class="co">% How to cite this article. Can be either full-text or, as in this case, a bibtex entry.</span>
-<span class="fu">\IidTitlePageCiteAs</span>{modos2018}</code></pre></div>
-<p>You may specify some optional information such as DOI and source code url</p>
-<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="fu">\IidTitlePageDoi</span>{https://doi.org/10.1016/j.cie.2017.08.011}
-<span class="fu">\IidTitlePageSourceCodes</span>{https://github.com/torvalds/linux}</code></pre></div>
-<p>After all information is specified, call <code>\IidTitlePage{}</code> to create a title page</p>
-<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="kw">\begin</span>{<span class="ex">document</span>}
-...
-<span class="fu">\IidTitlePage</span>{}
-...
-<span class="fu">\maketitle</span>
-...
-<span class="kw">\end</span>{<span class="ex">document</span>}</code></pre></div>
+<p>The process of adding the title page to your manuscript is following:</p>
+<ol style="list-style-type: decimal">
+<li>Create the PDF file of title page with all the information.</li>
+<li>Include the title page into your manuscript.</li>
+</ol>
+<h3 id="creating-the-title-page-pdf">Creating the title page PDF</h3>
+<p>First, either download the whole <code>iidtitlepage</code> project or clone its git. To change the information on the title page (such as name of the authors, title etc.), edit the file <code>title_page.tex</code> using your favorite editor and follow the LaTeX comments to include the necessary info. Build the title page PDF using <code>pdflatex</code> command.</p>
+<h3 id="including-the-title-page-into-your-manuscript">Including the title page into your manuscript</h3>
+<p>Copy the generated title page <code>title_page.pdf</code> to directory with your manuscript LaTeX project. Include a <code>pdfpages</code> package into your project</p>
+<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="bu">\usepackage</span>{<span class="ex">pdfpages</span>}</code></pre></div>
+<p>The following action depends on the journal publisher.</p>
+<h4 id="elsevier">Elsevier</h4>
+<p>Locate <code>\begin{frontmatter}</code> command and replace it with the following</p>
+<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="kw">\begin</span>{<span class="ex">frontmatter</span>}
+<span class="fu">\includepdf</span>[pages=1,fitpaper,noautoscale]{title_page.pdf}</code></pre></div>
+<h4 id="ieee-and-springer">IEEE and Springer</h4>
+<p>Locate <code>\maketitle</code> command and replace it with the following</p>
+<div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="fu">\null</span>
+<span class="fu">\includepdf</span>[pages=1,fitpaper,noautoscale]{title_page.pdf}
+<span class="fu">\maketitle</span></code></pre></div>
</body>
</html>
# Documentation for `iidtitlepage` package
TODO: what is it
+## Package usage
+The process of adding the title page to your manuscript is following:
-## Package installation
-Put files `iidtitlepage.sty` and `iid-logo.pdf` into the root directory of your article, i.e., where your main `.tex` file is located.
-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 ;).
-
-TODO: installation to system LaTeX?
+1. Create the PDF file of title page with all the information.
+2. Include the title page into your manuscript.
-## Package usage
-File `example.tex` shows a complete example on how to use the package.
+### Creating the title page PDF
+First, either download the whole `iidtitlepage` project or clone its git.
+To change the information on the title page (such as name of the authors, title etc.), edit the file `title_page.tex` using your favorite editor and follow the LaTeX comments to include the necessary info.
+Build the title page PDF using `pdflatex` command.
-To import the package, use following
+### Including the title page into your manuscript
+Copy the generated title page `title_page.pdf` to directory with your manuscript LaTeX project.
+Include a `pdfpages` package into your project
```latex
-\usepackage[elsevier]{iidtitlepage}
+\usepackage{pdfpages}
```
-The package has one mandatory argument which is either `elsevier` or `ieee`, depending on the publisher of your article.
-
-Then, you need to provide some mandatory information such as title name, authors, year and citation text
-```latex
-% Title.
-\title{An example document using \texttt{iidtitlepage} package}
-% Authors.
-% Unfortunately, we cannot use \author command, since some journal templates require to use a specific macros that might be not compatible with the package.
-\IidTitlePageAuthors{Istv\'{a}n M\'{o}dos, Va\v{s}ek Chv\'{a}tal}
+The following action depends on the journal publisher.
-% Year of publication.
-\IidTitlePageYear{2017}
-
-% How to cite this article. Can be either full-text or, as in this case, a bibtex entry.
-\IidTitlePageCiteAs{modos2018}
-```
-
-You may specify some optional information such as DOI and source code url
+#### Elsevier
+Locate `\begin{frontmatter}` command and replace it with the following
```latex
-\IidTitlePageDoi{https://doi.org/10.1016/j.cie.2017.08.011}
-\IidTitlePageSourceCodes{https://github.com/torvalds/linux}
+\begin{frontmatter}
+\includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
```
-After all information is specified, call `\IidTitlePage{}` to create a title page
+#### IEEE and Springer
+Locate `\maketitle` command and replace it with the following
```latex
-\begin{document}
-...
-\IidTitlePage{}
-...
+\null
+\includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
\maketitle
-...
-\end{document}
-```
+```
\ No newline at end of file
-@article{modos2018,
+@article{manuscript,
title = "An example document using iidtitlepage package",
journal = "Computers \& Industrial Engineering",
volume = "112",
issn = "0360-8352",
doi = "https://doi.org/10.1016/j.cie.2017.08.011",
url = "http://www.sciencedirect.com/science/article/pii/S0360835217303534",
-author = "Istvan Modos and Vasek Chvatal",
+author = "Erdős, Pál and Chvátal, Vašek",
}
\ No newline at end of file
+++ /dev/null
-\documentclass[twocolumn,a4paper,12pt]{article}
-
-\usepackage[springer]{iidtitlepage}
-
-% Lorem ipsum, dummy text
-\usepackage{blindtext}
-
-\title{An example document using \texttt{iidtitlepage} package}
-\author{Istv\'{a}n M\'{o}dos, Va\v{s}ek Chv\'{a}tal}
-\IidTitlePageAuthors{Istv\'{a}n M\'{o}dos, Va\v{s}ek Chv\'{a}tal}
-\IidTitlePageDoi{https://doi.org/10.1016/j.cie.2017.08.011}
-\IidTitlePageYear{2017}
-\IidTitlePageCiteAs{modos2018}
-\IidTitlePageSourceCodes{https://github.com/torvalds/linux}
-\date{\today}
-
-\begin{document}
-
-\IidTitlePage{}
-
-\maketitle
-
-\cite{modos2018}\Blindtext
-
-\bibliographystyle{abbrv}
-\bibliography{bibfile}
-
-\end{document}
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{iidtitlepage}
+\RequirePackage[utf8]{inputenc}
+\RequirePackage[czech]{babel}
\RequirePackage{etoolbox}
\RequirePackage{geometry}
\RequirePackage{graphicx}
\RequirePackage{mdframed}
\RequirePackage{fancyhdr}
+\bibliographystyle{abbrv}
+
\newtoggle{iidieee}
\newtoggle{iidelsevier}
\newtoggle{iidspringer}
\DeclareOption{springer}{ \toggletrue{iidspringer} }
\ProcessOptions{}
-\newcommand{\IidTitlePageAuthors}[1]{
- \newcommand{\@IidTitlePageAuthors}{#1}
-}
-
\newcommand{\IidTitlePageYear}[1]{
\newcommand{\@IidTitlePageYear}{#1}
}
\vspace{0.3cm}
- \noindent\nohyphens{{\large \@IidTitlePageAuthors}}
+ \noindent\nohyphens{{\large \@author}}
\vfill
\end{titlepage}
\makeatother
\restoregeometry{}
+ \nobibliography{bibfile}
}
\endinput
\ No newline at end of file
--- /dev/null
+% DO NOT CHANGE THIS!
+\documentclass[a4paper,12pt]{article}
+
+% Select the journal template for your manuscript.
+% Options: elsevier, ieee, springer
+\usepackage[elsevier]{iidtitlepage}
+
+% Mandatory: The title of the manuscript.
+\title{An example title page using \texttt{iidtitlepage} package}
+
+% Mandatory: the authors. Will appear on the title page exactly as provided to the command.
+\author{Pál Erdős and Vašek Chvátal}
+
+% Optional: DOI of the journal article.
+\IidTitlePageDoi{https://doi.org/10.1007/s10479-016-2184-6}
+
+% Mandatory: year when the manuscript was produced.
+\IidTitlePageYear{2017}
+
+% Optional: link to the corresponding source codes (e.g., for algorithm described in the manuscript).
+\IidTitlePageSourceCodes{https://github.com/torvalds/linux}
+
+% Mandatory: bibtex entry that represents the citation to the manuscript. To change the citation, modify bibfile.bib file.
+\IidTitlePageCiteAs{manuscript}
+
+% Generates the title page.
+\begin{document}
+\IidTitlePage{}
+\end{document}
projects / modosist / iidtitlepage.git / commitdiff