README.md

   1 # Documentation for `iidtitlepage` package
   2 TODO: what is it
   3
   4 ## Package usage
   5 The process of adding the title page to your manuscript is following:
   6
   7 1. Create the PDF file of title page with all the information.
   8 2. Include the title page into your manuscript.
   9
  10 ### Creating the title page PDF
  11 First, either download the whole `iidtitlepage` project or clone its git.
  12 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.
  13 Build the title page PDF using `pdflatex` command.
  14
  15 ### Including the title page into your manuscript
  16 Copy the generated title page `title_page.pdf` to directory with your manuscript LaTeX project.
  17 Include a `pdfpages` package into your project
  18 ```latex
  19 \usepackage{pdfpages}
  20 ```
  21
  22 The following action depends on the journal publisher.
  23
  24 #### Elsevier
  25 Locate `\begin{frontmatter}` command and replace it with the following
  26 ```latex
  27 \begin{frontmatter}
  28 \includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
  29 ```
  30
  31 #### IEEE
  32 Locate `\maketitle` command and replace it with the following
  33 ```latex
  34 \null
  35 \includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
  36 \maketitle
  37 ```
  38 #### Springer
  39 If your manuscript is two-column, then locate `\maketitle` command and replace it with the following
  40 ```latex
  41 \null
  42 \includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
  43 \maketitle
  44 ```
  45
  46 For a single column manuscript, locate `\maketitle` command and replace it with the following
  47 ```latex
  48 \pagenumbering{gobble}
  49 \includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
  50 \pagenumbering{arabic}
  51 \maketitle
  52 ```