<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">IEEE</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>
+<h4 id="springer">Springer</h4>
+<p>If your manuscript is two-column, then 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>
+<p>For a single column manuscript, 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">\pagenumbering</span>{gobble}
+<span class="fu">\includepdf</span>[pages=1,fitpaper,noautoscale]{title_page.pdf}
+<span class="fu">\pagenumbering</span>{arabic}
+<span class="fu">\maketitle</span></code></pre></div>
</body>
</html>
projects / modosist / iidtitlepage.git / blobdiff