]> rtime.felk.cvut.cz Git - modosist/iidtitlepage.git/commitdiff
Improve title page tex documentation
authorJiri Vlasak <jiri.vlasak.2@cvut.cz>
Tue, 31 Oct 2023 13:54:54 +0000 (14:54 +0100)
committerJiri Vlasak <jiri.vlasak.2@cvut.cz>
Tue, 31 Oct 2023 13:54:54 +0000 (14:54 +0100)
title_page.tex

index 6d68f1efeed00b57b9eee6ef5112ed17b61b4cc6..96d673048d9ec0842bbe73312a2e4f4a6950d361 100644 (file)
@@ -3,30 +3,42 @@
 
 % Select the journal template for your manuscript.
 % Options: elsevier, ieee, springer, acm
+% Default is elsevier which is good for other publishers, too.
 \usepackage[elsevier]{iidtitlepage}
 
-% Mandatory: The title of the manuscript.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% The following are *mandatory* settings:
+
+% 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.
+% The authors. Appears on the title page exactly as provided:
 \author{Pál Erdős and Vašek Chvátal}
 
-% Optional (mandatory for ACM style): DOI of the journal article.
-\IidTitlePageDoi{https://doi.org/10.1007/s10479-016-2184-6}
+% Year when the manuscript was produced:
+\IidTitlePageYear{2017}
 
-% Mandatory only for ACM style: Source publication
+% Only for ACM -- Source publication:
 \IidPublishedIn{Sample publication}
 
-% Mandatory: year when the manuscript was produced.
-\IidTitlePageYear{2017}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% The following are *optional* settings,
+% feel free to comment when appropriate:
+
+% Mandatory for ACM style -- DOI of the journal article:
+\IidTitlePageDoi{https://doi.org/10.1007/s10479-016-2184-6}
 
-% Optional: link to the corresponding source codes (e.g., for algorithm described in the manuscript).
+% Link to the corresponding source codes (e.g., for algorithm described
+% in the manuscript).
 \IidTitlePageSourceCodes{https://github.com/torvalds/linux}
 
-% Optional: link to video
+% Link to video
 \IidTitlePageVideoLink{https://www.youtube.com/watch?v=u_Vqfd5Cn8Q}
 
-% Mandatory: bibtex entry that represents the citation to the manuscript. To change the citation, modify bibfile.bib file.
+% Bibtex entry that represents the citation to the manuscript. To change
+% the citation, modify bibfile.bib file. When commented, title page
+% build fails with "I found no \citation commands" -- feel free to
+% ignore the error until your paper is accepted.
 \IidTitlePageCiteAs{manuscript}
 
 % Generates the title page.