README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <meta http-equiv="Content-Style-Type" content="text/css" />
   6   <meta name="generator" content="pandoc" />
   7   <title></title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <style type="text/css">
  10 div.sourceCode { overflow-x: auto; }
  11 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  12   margin: 0; padding: 0; vertical-align: baseline; border: none; }
  13 table.sourceCode { width: 100%; line-height: 100%; }
  14 td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
  15 td.sourceCode { padding-left: 5px; }
  16 code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
  17 code > span.dt { color: #902000; } /* DataType */
  18 code > span.dv { color: #40a070; } /* DecVal */
  19 code > span.bn { color: #40a070; } /* BaseN */
  20 code > span.fl { color: #40a070; } /* Float */
  21 code > span.ch { color: #4070a0; } /* Char */
  22 code > span.st { color: #4070a0; } /* String */
  23 code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
  24 code > span.ot { color: #007020; } /* Other */
  25 code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
  26 code > span.fu { color: #06287e; } /* Function */
  27 code > span.er { color: #ff0000; font-weight: bold; } /* Error */
  28 code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
  29 code > span.cn { color: #880000; } /* Constant */
  30 code > span.sc { color: #4070a0; } /* SpecialChar */
  31 code > span.vs { color: #4070a0; } /* VerbatimString */
  32 code > span.ss { color: #bb6688; } /* SpecialString */
  33 code > span.im { } /* Import */
  34 code > span.va { color: #19177c; } /* Variable */
  35 code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
  36 code > span.op { color: #666666; } /* Operator */
  37 code > span.bu { } /* BuiltIn */
  38 code > span.ex { } /* Extension */
  39 code > span.pp { color: #bc7a00; } /* Preprocessor */
  40 code > span.at { color: #7d9029; } /* Attribute */
  41 code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
  42 code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
  43 code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
  44 code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  45   </style>
  46 </head>
  47 <body>
  48 <h1 id="documentation-for-iidtitlepage-package">Documentation for <code>iidtitlepage</code> package</h1>
  49 <p>TODO: what is it</p>
  50 <h2 id="package-installation">Package installation</h2>
  51 <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>
  52 <p>TODO: installation to system LaTeX?</p>
  53 <h2 id="package-usage">Package usage</h2>
  54 <p>File <code>example.tex</code> shows a complete example on how to use the package.</p>
  55 <p>To import the package, use following</p>
  56 <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>
  57 <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>
  58 <p>Then, you need to provide some mandatory information such as title name, authors, year and citation text</p>
  59 <div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="co">% Title.</span>
  60 <span class="fu">\title</span>{An example document using <span class="fu">\texttt</span>{iidtitlepage} package}
  61
  62 <span class="co">% Authors.</span>
  63 <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>
  64 <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}
  65
  66 <span class="co">% Year of publication.</span>
  67 <span class="fu">\IidTitlePageYear</span>{2017}
  68
  69 <span class="co">% How to cite this article. Can be either full-text or, as in this case, a bibtex entry.</span>
  70 <span class="fu">\IidTitlePageCiteAs</span>{modos2018}</code></pre></div>
  71 <p>You may specify some optional information such as DOI and source code url</p>
  72 <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}
  73 <span class="fu">\IidTitlePageSourceCodes</span>{https://github.com/torvalds/linux}</code></pre></div>
  74 <p>After all information is specified, call <code>\IidTitlePage{}</code> to create a title page</p>
  75 <div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex"><span class="kw">\begin</span>{<span class="ex">document</span>}
  76 ...
  77 <span class="fu">\IidTitlePage</span>{}
  78 ...
  79 <span class="fu">\maketitle</span>
  80 ...
  81 <span class="kw">\end</span>{<span class="ex">document</span>}</code></pre></div>
  82 </body>
  83 </html>