path: root/Master/texmf-dist/doc/latex/navygame/navygame.tex

\documentclass[a4paper]{ltxdoc}%
\usepackage[english]{babel}%
\usepackage[latin1]{inputenc}%
\usepackage[T1]{fontenc}%
\usepackage{textcomp}%
\usepackage{lmodern}%
\usepackage{bera}%
\usepackage{microtype}%
\usepackage{ltxdocext}%
\usepackage{listings}
\usepackage{marginnote}%
\usepackage[svgnames,rgb]{xcolor}%
\usepackage[automark,nouppercase]{scrpage2}
\usepackage[width=4cm,shipcolor=Teal,scale=0.66,fontsize=large,
sbindent=0.6cm,sbwidth=3.4cm]{navygame}%
\usepackage{hyperref}
%
\makeatletter
\setlength{\headheight}{1.1\baselineskip}%
%
\hypersetup{colorlinks=true,urlcolor=NavyBlue,linkcolor=NavyBlue,citecolor=CornflowerBlue,naturalnames=true,hypertexnames=false}%
\lstset{language=[LaTeX]TeX,numbers=left,numberstyle=\tiny,basicstyle=\ttfamily\small,frame=single,backgroundcolor=\color{LightGoldenrodYellow},keywordstyle=\color{Blue},emph={mathstyle,style}, emphstyle=\color{Tomato},emph={[2]rows,columns,width,shipcolor,fontsize,scale,sbindent,sbwidth,sbshipscale},emphstyle={[2]\color{SeaGreen}},morekeywords={navygame,ship,shipH,shipV,shipbox,Ship,ShipC,ShipL,ShipR,ShipB,ShipT,[,]}}
\renewcommand{\maketitle}%
{%
  \thispagestyle{empty}%
  \pagecolor{Ivory}%
  \begin{titlepage}%
    \begin{tikzpicture}[remember picture,overlay]%
      \node[yshift=-2cm] at (current page.north west)%
      {%
        \begin{tikzpicture}[remember picture, overlay]%
          \draw[fill=CornflowerBlue,color=CornflowerBlue] (0,0) rectangle%
            (\paperwidth,2cm);%
          \draw[anchor=west,yshift=-4cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\RaggedRight\Huge\sffamily\textbf{\@title}}};%
          \draw[anchor=west,yshift=-6cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\huge\sffamily\textbf{\@fileversion}}};%
          \draw[anchor=west,yshift=-9cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\RaggedRight\huge\sffamily\textbf{\@subtitle}}};%
          \draw[anchor=west,yshift=-13cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\includegraphics[height=5cm]{navygame.png}};%
          \draw[anchor=west,yshift=-17cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\huge\sffamily\textbf{\@date}}};%
          \draw[anchor=west,yshift=-20cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\Large\sffamily{\@authorline\\\textbf{\@author}}}};%
        \end{tikzpicture}%
      };%
      \node[yshift=0cm] at (current page.south west)%
      {%
        \begin{tikzpicture}[remember picture, overlay]%
          \draw[fill=NavyBlue,color=NavyBlue,yshift=6cm,xshift=2cm] (0,0) rectangle (0.2cm,19cm);%
          \draw[fill=CornflowerBlue,color=CornflowerBlue] (0,0) rectangle (\paperwidth,2cm);%
          \draw[anchor=west,yshift=1cm,xshift=3cm,color=NavyBlue] (0,0) node%
            {\parbox{15cm}{\large\sffamily{\@refline}}};%
        \end{tikzpicture}%
      };%
    \end{tikzpicture}%
  \end{titlepage}%
  \pagecolor{white}%
}%
%
\newcommand*{\@tikzhead}[1]%
{%
  \begin{tikzpicture}[remember picture,overlay]%
    \node[yshift=-2cm] at (current page.north west)%
    {%
      \begin{tikzpicture}[remember picture, overlay]%
        \draw[fill=CornflowerBlue] (0,0) rectangle (\paperwidth,2cm);%
        \draw[anchor=west,yshift=1cm,xshift=1.5cm,color=NavyBlue] (0,0) node%
          {\parbox{15cm}{\LARGE\sffamily\textbf{\@title}}};%
        \node[anchor=east,xshift=.9\paperwidth,rectangle,%
              rounded corners=15pt,inner sep=11pt,fill=NavyBlue]%
              {\color{white}\textsc{#1}};%
      \end{tikzpicture}%
    };%
  \end{tikzpicture}%
}%
\clearscrheadings%
\ihead{\@tikzhead{\headmark}}%
\cfoot{\upshape\thepage}%
\pagestyle{scrheadings}%
%
%\newcommand*{\headline}[1]{\@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}}%
\newcommand*{\Headline}[1]{\@mkboth{#1}{#1}}%
%
\renewcommand{\headfont}{\normalfont\mdseries\scshape}
%
\gdef\@subtitle{}%
\providecommand*{\Subtitle}[1]{\gdef\@subtitle{#1}}%
\gdef\@fileversion{}%
\providecommand*{\Fileversion}[1]{\gdef\@fileversion{#1}}%
\gdef\@author{}%
\providecommand*{\Author}[1]{\gdef\@author{#1}}%
\gdef\@authorline{Package author:}%
\providecommand*{\Authorline}[1]{\gdef\@authorline{#1}}%
\gdef\@refline{}%
\providecommand*{\Refline}[1]{\gdef\@refline{#1}}%
\gdef\and{\unskip{}, }%
\newcommand\doubledash{-\kern0.5pt-}
\def\enoteformat{\rightskip\z@ \leftskip\z@ \parindent=1em\leavevmode\llap{\makeenmark}}
\makeatother
%
\def\filename{navygame.sty}%
\def\XeLaTeX{Xe\LaTeX}%
%
\makeatletter%
\renewcommand\tableofcontents%
{%
  %\section*{\contentsname}%
  \@mkboth{%
  \MakeUppercase\contentsname}{\MakeUppercase\contentsname}%
  \@starttoc{toc}%
}%
%
\newcommand\styleoption{\name@idx{style option}}%
\newcommand\stylename{\name@idx{document style}}%
\def\name@idx#1#2{%
 {\ttfamily#2}%
 \index{#2\space#1=\string\ttt{#2}\space#1}\index{#1>#2=\string\ttt{#2}}%
}%
\newcommand*\margcs[1]{\marginnote{\raggedleft\scriptsize #1}}%
\newcommand*\package[1]{\texttt{#1}\index{#1=\string\ttt{#1}}}%
\newcommand*\mco[1]{\mbox{\LANGLE\itshape#1\RANGLE}\index{#1, class option value}\index{class option value>#1}}%
%
\renewcommand\@biblabel[1]{\makebox[1.5cm][l]{[#1]}}
\renewcommand*\l@subsection{\@dottedtocline{2}{1.2em}{2.3em}}
\renewcommand*\l@subsubsection{\@dottedtocline{3}{2.4em}{3.7em}}
\makeatother
%
\setlength\parindent{0pt}%
\hypersetup{pdfauthor={Josef Kleber},pdftitle={A style file for typesetting navy games},pdfsubject={Documentation for LaTeX style \filename}}%
%
\begin{document}
\title{\filename}%
\Subtitle{A style file for typesetting navy games}%
\author{Josef Kleber}
\Fileversion{v1.0}
\Refline{\href{mailto:josef.kleber@gmx.de}{\texttt{josef.kleber@gmx.de}}\\\href{https://bitbucket.org/kleberj/navygame/}{\texttt{https://bitbucket.org/kleberj/navygame/}}}
\maketitle

\tableofcontents
\clearpage

\section{The game}

Try to find the positions of the ships listed below the puzzle. The numbers on the side of the puzzle reveals how many ship parts can be found in the rows and columns. All remaining fields indicate 'water'. Consider the following rules: The ships lie only horizontally and vertically in the puzzle, not diagonally. No ship touchs another ship at any point, not even diagonally. Here's a little self-explanatory example:

\begin{center}
\begin{navygame}
\ship{4}{5}{\ShipR}
\shipH{3,2,2,1,3}
\shipV{3,1,4,0,3}
\shipbox{3,3,2,2,1}
\end{navygame}
\hspace{1.2cm}
\begin{navygame}
\ship{1}{5}{\Ship}
\ship{2}{3}{\ShipC}
\ship{5}{2}{\ShipC}
\ship{5}{1}{\ShipB}
\ship{5}{3}{\ShipT}
\ship{1}{1}{\ShipL}
\ship{1}{3}{\ShipL}
\ship{3}{5}{\ShipL}
\ship{2}{1}{\ShipR}
\ship{3}{3}{\ShipR}
\ship{4}{5}{\ShipR}
\shipH{3,2,2,1,3}
\shipV{3,1,4,0,3}
\end{navygame}
\end{center}
\begin{lstlisting}
\begin{navygame}
\ship{4}{5}{\ShipR}
\shipH{3,2,2,1,3}
\shipV{3,1,4,0,3}
\shipbox{3,3,2,2,1}
\end{navygame}
\hspace{1.2cm}
\begin{navygame}
\ship{1}{5}{\Ship}
\ship{2}{3}{\ShipC}
\ship{5}{2}{\ShipC}
\ship{5}{1}{\ShipB}
\ship{5}{3}{\ShipT}
\ship{1}{1}{\ShipL}
\ship{1}{3}{\ShipL}
\ship{3}{5}{\ShipL}
\ship{2}{1}{\ShipR}
\ship{3}{3}{\ShipR}
\ship{4}{5}{\ShipR}
\shipH{3,2,2,1,3}
\shipV{3,1,4,0,3}
\end{navygame}
\end{lstlisting}
\clearpage
\section{Options}
\subsection[\texttt{rows}]{\styleoption{rows} (\underline{\texttt{5}})}
With the option \styleoption{rows}, you can define the number of rows in the grid.
\subsection[\texttt{columns}]{\styleoption{columns} (\underline{\texttt{5}})}
With the option \styleoption{columns}, you can specify the number of columns in the grid
\subsection[\texttt{shipcolor}]{\styleoption{shipcolor} (\underline{\texttt{green}})}
With the option \styleoption{shipcolor}, you can set the color of the ship parts.
\subsection[\texttt{width}]{\styleoption{width} (\underline{\texttt{6cm}})}
With the option \styleoption{width}, you can set the width of the minipage, in which the grid is typeset.
\subsection[\texttt{scale}]{\styleoption{scale} (\underline{\texttt{1}})}
With the option \styleoption{scale}, you can scale the size of the grid in the minipage.
\subsection[\texttt{fontsize}]{\styleoption{fontsize} (\underline{\texttt{Large}})}
With the option \styleoption{fontsize}, you can specify the size of the numbers next to the grid. Here, the usual LaTeX sizes are used. Possible values: \texttt{tiny}, \texttt{scriptsize}, \texttt{footnotesize}, \texttt{small}, \texttt{normalsize}, \texttt{large}, \underline{\texttt{Large}}, \texttt{LARGE}, \texttt{huge}, \texttt{Huge})
\subsection[\texttt{sbindent}]{\styleoption{sbindent} (\underline{\texttt{0.75cm}})}
With the option \styleoption{sbindent}, you can define the indent of ship box below the grid.
\subsection[\texttt{sbwidth}]{\styleoption{sbwidth} (\underline{\texttt{5.15cm}})}
With the option \styleoption{sbwidth}, you can specify the width of the minipage, in which the ships are typeset.
\subsection[\texttt{sbshipscale}]{\styleoption{sbshipscale} (\underline{\texttt{1}})}
With the option \styleoption{sbshipscale}, you can scale the size of the ships in the ship box.
\section{Environments}
\subsection{navygame}
The \env{navygame} environment\marginnote{\RaggedLeft\scriptsize\envb{navygame}\oarg{options}\\\dots\\\enve{navygame}} is the central core of the stylefile. With the optional argument of the environment, you can reset the options with local scope. Here, a blank grid is created that you can fill with ships using other commands.
\section{Commands}
\subsection{ship}
The command \cs{ship}\margcs{\cmd\ship\{\marg{column}\}\{\marg{row}\}\{\marg{shippart}\}} is used for the placement of ship parts in the grid. In the mandatory argument \marg{shippart}, you can use the following commands:

\begin{center}
\begin{tabular}{lccl}
\cs{Ship} & \scalebox{.5}{\Ship} & \scalebox{.5}{\ShipC} & \cs{ShipC} \\
\cs{ShipL} & \scalebox{.5}{\ShipL} & \scalebox{.5}{\ShipR} & \cs{ShipR} \\
\cs{ShipB} & \scalebox{.5}{\ShipB} & \scalebox{.5}{\ShipT} & \cs{ShipT} \\
\end{tabular}
\end{center}
\subsection{shipH}
The command \cs{shipH}\margcs{\cmd\shipH\{\marg{csv list}\}} typesets the horizontal numbers above the grid. It expects a comma-separated list as an argument.
\subsection{shipV}
The command \cs{shipV}\margcs{\cmd\shipV\{\marg{csv list}\}} typesets the vertical numbers beside the grid. It also expects a comma separated list.
\subsection{shipbox}
The command \cs{shipbox}\margcs{\cmd\shipbox\{\marg{csv list}\}} defines the number and size of the ships, which are typeset under the grid.
\clearpage
\section{Puzzles}
\begin{center}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{11}{6}{\Ship}
\shipH{4,0,2,2,4,0,0,0,3,3,3}
\shipV{4,2,0,4,2,1,5,3}
\shipbox{3,3,3,2,2,2,2,1,1,1,1}
\end{navygame}
\hspace{1cm}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{10}{6}{\ShipC}
\shipH{4,0,0,0,5,0,5,1,2,3,2}
\shipV{2,3,6,2,2,1,4,2}
\shipbox{3,3,3,3,2,2,2,1,1,1,1}
\end{navygame}
\end{center}

\begin{center}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{1}{6}{\Ship}
\shipH{1,0,4,1,2,0,0,6,0,1,6}
\shipV{2,5,0,2,4,4,0,4}
\shipbox{3,3,3,2,2,2,2,1,1,1,1}
\end{navygame}
\hspace{1cm}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{6}{6}{\ShipC}
\shipH{1,1,2,3,2,4,3,3,4,1,1}
\shipV{4,3,2,2,6,1,5,2}
\shipbox{4,4,3,3,3,2,2,2,1,1}
\end{navygame}
\end{center}

\begin{center}
\begin{navygame}[width=11cm,rows=13,columns=24,scale=0.43,sbindent=0.4cm,sbwidth=10.5cm,fontsize=normalsize]
\ship{9}{9}{\ShipL}
\ship{22}{3}{\ShipL}
\ship{23}{1}{\ShipL}
\ship{16}{8}{\ShipR}
\ship{21}{11}{\ShipR}
\ship{6}{5}{\ShipC}
\ship{8}{2}{\ShipC}
\ship{18}{12}{\ShipC}
\ship{19}{7}{\ShipC}
\ship{1}{10}{\ShipB}
\ship{2}{4}{\ShipT}
\shipH{4,5,7,1,1,1,7,5,1,1,2,2,1,2,1,1,1,5,3,2,1,1,2,2}
\shipV{4,2,6,1,8,4,3,6,6,4,6,1,8}
\shipbox{6,5,4,4,4,4,4,4,3,3,3,3,2,2,2,2,1,1,1,1}
\end{navygame}
\end{center}
\clearpage
\section{Solutions}
\begin{center}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{1}{2}{\Ship}
\ship{1}{5}{\Ship}
\ship{11}{6}{\Ship}
\ship{11}{8}{\Ship}
\ship{3}{1}{\ShipL}
\ship{3}{7}{\ShipL}
\ship{9}{4}{\ShipL}
\ship{5}{1}{\ShipR}
\ship{5}{7}{\ShipR}
\ship{11}{4}{\ShipR}
\ship{4}{1}{\ShipC}
\ship{4}{7}{\ShipC}
\ship{10}{4}{\ShipC}
\ship{1}{7}{\ShipB}
\ship{5}{4}{\ShipB}
\ship{9}{7}{\ShipB}
\ship{10}{1}{\ShipB}
\ship{1}{8}{\ShipT}
\ship{5}{5}{\ShipT}
\ship{9}{8}{\ShipT}
\ship{10}{2}{\ShipT}
\shipH{4,0,2,2,4,0,0,0,3,3,3}
\shipV{4,2,0,4,2,1,5,3}
\end{navygame}
\hspace{1cm}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{1}{7}{\Ship}
\ship{7}{1}{\Ship}
\ship{7}{5}{\Ship}
\ship{9}{1}{\Ship}
\ship{7}{3}{\ShipL}
\ship{9}{3}{\ShipR}
\ship{1}{3}{\ShipC}
\ship{5}{3}{\ShipC}
\ship{8}{3}{\ShipC}
\ship{10}{6}{\ShipC}
\ship{1}{2}{\ShipB}
\ship{5}{2}{\ShipB}
\ship{5}{7}{\ShipB}
\ship{7}{7}{\ShipB}
\ship{10}{5}{\ShipB}
\ship{11}{2}{\ShipB}
\ship{1}{4}{\ShipT}
\ship{5}{4}{\ShipT}
\ship{5}{8}{\ShipT}
\ship{7}{8}{\ShipT}
\ship{10}{7}{\ShipT}
\ship{11}{3}{\ShipT}
\shipH{4,0,0,0,5,0,5,1,2,3,2}
\shipV{2,3,6,2,2,1,4,2}
\end{navygame}
\end{center}

\begin{center}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{1}{6}{\Ship}
\ship{5}{5}{\Ship}
\ship{3}{8}{\Ship}
\ship{8}{8}{\Ship}
\ship{3}{2}{\ShipL}
\ship{10}{8}{\ShipL}
\ship{5}{2}{\ShipR}
\ship{11}{8}{\ShipR}
\ship{4}{2}{\ShipC}
\ship{8}{5}{\ShipC}
\ship{11}{5}{\ShipC}
\ship{3}{5}{\ShipB}
\ship{8}{1}{\ShipB}
\ship{8}{4}{\ShipB}
\ship{11}{1}{\ShipB}
\ship{11}{4}{\ShipB}
\ship{3}{6}{\ShipT}
\ship{8}{2}{\ShipT}
\ship{8}{6}{\ShipT}
\ship{11}{2}{\ShipT}
\ship{11}{6}{\ShipT}
\shipH{1,0,4,1,2,0,0,6,0,1,6}
\shipV{2,5,0,2,4,4,0,4}
\end{navygame}
\hspace{1cm}
\begin{navygame}[width=5cm,rows=8,columns=11,scale=0.41,sbindent=0.5cm,sbwidth=4.5cm,fontsize=normalsize]
\ship{1}{4}{\Ship}
\ship{3}{1}{\Ship}
\ship{2}{7}{\ShipL}
\ship{8}{5}{\ShipL}
\ship{4}{7}{\ShipR}
\ship{11}{5}{\ShipR}
\ship{3}{7}{\ShipC}
\ship{6}{6}{\ShipC}
\ship{6}{7}{\ShipC}
\ship{7}{2}{\ShipC}
\ship{9}{2}{\ShipC}
\ship{9}{5}{\ShipC}
\ship{10}{5}{\ShipC}
\ship{4}{4}{\ShipB}
\ship{5}{1}{\ShipB}
\ship{6}{5}{\ShipB}
\ship{7}{1}{\ShipB}
\ship{9}{1}{\ShipB}
\ship{8}{7}{\ShipB}
\ship{4}{5}{\ShipT}
\ship{5}{2}{\ShipT}
\ship{6}{8}{\ShipT}
\ship{7}{3}{\ShipT}
\ship{9}{3}{\ShipT}
\ship{8}{8}{\ShipT}
\shipH{1,1,2,3,2,4,3,3,4,1,1}
\shipV{4,3,2,2,6,1,5,2}
\end{navygame}
\end{center}

\begin{center}
\begin{navygame}[width=11cm,rows=13,columns=24,scale=0.43,sbindent=0.4cm,sbwidth=10.5cm,fontsize=normalsize]
\ship{1}{6}{\Ship}
\ship{18}{3}{\Ship}
\ship{17}{6}{\Ship}
\ship{20}{13}{\Ship}
\ship{1}{13}{\ShipL}
\ship{5}{5}{\ShipL}
\ship{7}{13}{\ShipL}
\ship{9}{9}{\ShipL}
\ship{11}{5}{\ShipL}
\ship{14}{8}{\ShipL}
\ship{20}{11}{\ShipL}
\ship{22}{3}{\ShipL}
\ship{23}{1}{\ShipL}
\ship{4}{13}{\ShipR}
\ship{8}{5}{\ShipR}
\ship{8}{13}{\ShipR}
\ship{12}{9}{\ShipR}
\ship{14}{5}{\ShipR}
\ship{16}{8}{\ShipR}
\ship{21}{11}{\ShipR}
\ship{24}{3}{\ShipR}
\ship{24}{1}{\ShipR}
\ship{2}{13}{\ShipC}
\ship{3}{13}{\ShipC}
\ship{2}{2}{\ShipC}
\ship{2}{3}{\ShipC}
\ship{3}{7}{\ShipC}
\ship{3}{8}{\ShipC}
\ship{3}{9}{\ShipC}
\ship{3}{10}{\ShipC}
\ship{6}{5}{\ShipC}
\ship{7}{5}{\ShipC}
\ship{8}{2}{\ShipC}
\ship{7}{8}{\ShipC}
\ship{7}{9}{\ShipC}
\ship{7}{10}{\ShipC}
\ship{11}{9}{\ShipC}
\ship{10}{9}{\ShipC}
\ship{12}{5}{\ShipC}
\ship{13}{5}{\ShipC}
\ship{15}{8}{\ShipC}
\ship{18}{11}{\ShipC}
\ship{18}{12}{\ShipC}
\ship{19}{7}{\ShipC}
\ship{23}{3}{\ShipC}
\ship{1}{10}{\ShipB}
\ship{2}{1}{\ShipB}
\ship{3}{6}{\ShipB}
\ship{7}{7}{\ShipB}
\ship{8}{1}{\ShipB}
\ship{18}{10}{\ShipB}
\ship{19}{6}{\ShipB}
\ship{1}{11}{\ShipT}
\ship{2}{4}{\ShipT}
\ship{3}{11}{\ShipT}
\ship{7}{11}{\ShipT}
\ship{8}{3}{\ShipT}
\ship{18}{13}{\ShipT}
\ship{19}{8}{\ShipT}
\shipH{4,5,7,1,1,1,7,5,1,1,2,2,1,2,1,1,1,5,3,2,1,1,2,2}
\shipV{4,2,6,1,8,4,3,6,6,4,6,1,8}
\end{navygame}
\end{center}
\end{document}