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

% pdflatex --shell-escape logo.tex
% run twice: 1. download qrcode.png 2. include the pic
% or download http://i.imgur.com/KAunnuS.png and rename it to qrcode.png
%
\documentclass[a4paper]{ltxdoc}%
\usepackage[english]{babel}%
\usepackage[latin1]{inputenc}%
\usepackage[T1]{fontenc}%
\usepackage{textcomp}%
\usepackage{lmodern}%
\usepackage{bera}%
\usepackage{ccicons}
\usepackage{microtype}%
\usepackage{ltxdocext}%
\usepackage{listings}
\usepackage{marginnote}%
\usepackage[svgnames,rgb]{xcolor}%
\usepackage[automark,nouppercase]{scrpage2}
\usepackage{kendoku}%
\usepackage{hyperref}
%
\setlength{\headheight}{1.1\baselineskip}%
%
\AtBeginDocument{\IfFileExists{qrcode.png}{}{\write18{wget -O qrcode.png http://i.imgur.com/KAunnuS.png}}}%
\hypersetup{colorlinks=true,urlcolor=NavyBlue,linkcolor=NavyBlue,citecolor=CornflowerBlue,naturalnames=true,hypertexnames=false}%
\lstset{language=[LaTeX]TeX,numbers=left,numberstyle=\tiny,basicstyle=\ttfamily,frame=single,backgroundcolor=\color{LightGoldenrodYellow},keywordstyle=\color{Blue},emph={puzzlebackground,puzzleforeground,center,kendoku,left,shape,fill,inner,sep,draw,rounded,corners,thick}, emphstyle=\color{Tomato},emph={[2]Wheat,HotPink,GreenYellow,LightBlue,LightSalmon,LightYellow,green,sudoku,rows,columns,scale},emphstyle={[2]\color{OliveDrab}},morekeywords={setrule,tikzpath,framearea,fillarea,kendokucell,setrow,LP@cvoffset,titleformat,definecounterstyle,marginnote,tikz,node,puzzlecounter,color,[,]}}
\makeatletter
\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%
            {\usebox\logo};%
          \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{kendoku.sty}%
\def\XeLaTeX{Xe\LaTeX}%
%
\newenvironment{optionlist}
{\begin{trivlist}\setlength\leftskip{2em}}
{\end{trivlist}}
\newcommand\optitem[3]{\item [\texttt{\textbf{\textcolor{DodgerBlue}{#1}} \lbrack\textcolor{Crimson}{#2}\rbrack}] #3}
%
\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.8em}}
%\renewcommand*\l@subsubsection{\@dottedtocline{3}{2.4em}{3.7em}}
\makeatother
%
\setlength\parindent{0pt}%
\hypersetup{pdfauthor={Josef Kleber},pdftitle={A style file for typesetting Kendoku logic puzzles},pdfsubject={Documentation for LaTeX style \filename}}%
%
\begin{document}
\title{\filename}%
\Subtitle{A style file for typesetting Kendoku logic puzzles}%
\author{Josef Kleber}
\Fileversion{v1.0}
\Refline{\href{mailto:josef.kleber@gmx.de}{\texttt{josef.kleber@gmx.de}}\\\href{https://bitbucket.org/kleberj/logicpuzzle/}{\texttt{https://bitbucket.org/kleberj/logicpuzzle/}}}
\newsavebox\logo
\savebox\logo{%
  \begin{kendoku}
    \framearea{black}{\tikzpath{1}{1}{8,8,6,2,6,2,4,4}}
    \framearea{black}{\tikzpath{1}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{1}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{2}{2}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{2}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{1}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{4}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{4}{1}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{2}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{3}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{5}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{4}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{5}{8,6,2,4}}
    \setrule{1}{2}{8\times}
    \setrule{1}{3}{5}
    \setrule{1}{5}{4+}
    \setrule{2}{3}{60\times}
    \setrule{2}{5}{2\div}
    \setrule{3}{2}{2-}
    \setrule{3}{5}{75\times}
    \setrule{4}{1}{8+}
    \setrule{4}{2}{1-}
    \setrule{4}{4}{2\times}
    \setrule{5}{3}{1}
    \setrule{5}{5}{2}
  \end{kendoku}
  \hspace{1.5cm}
  \begin{kendoku}
    \framearea{black}{\tikzpath{1}{1}{8,8,6,2,6,2,4,4}}
    \framearea{black}{\tikzpath{1}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{1}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{2}{2}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{2}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{1}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{4}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{4}{1}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{2}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{3}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{5}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{4}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{5}{8,6,2,4}}
    \setrule{1}{2}{8\times}
    \setrule{1}{3}{5}
    \setrule{1}{5}{4+}
    \setrule{2}{3}{60\times}
    \setrule{2}{5}{2\div}
    \setrule{3}{2}{2-}
    \setrule{3}{5}{75\times}
    \setrule{4}{1}{8+}
    \setrule{4}{2}{1-}
    \setrule{4}{4}{2\times}
    \setrule{5}{3}{1}
    \setrule{5}{5}{2}
    \setrow{5}{1,4,3,5,2}
    \setrow{4}{3,2,5,1,4}
    \setrow{3}{5,3,4,2,1}
    \setrow{2}{2,5,1,4,3}
    \setrow{1}{4,1,2,3,5}
  \end{kendoku}
}
\maketitle
\tableofcontents
\clearpage

\section{The puzzle}
Fill the cells with the numbers from 1 to SIZE of the puzzle. In the top left corner of a framed area, you will find the result of the specified arithmetic function, which is applied on the entered numbers. The numbers may occur only once in each row and column. The numbers of an area may not necessarily be different when they are in different rows or columns. Here's a little self-explanatory example:

\begin{center}
  \usebox\logo
\end{center}

\bigskip
\begin{lstlisting}
\begin{center}
  \begin{kendoku}
    \framearea{black}{\tikzpath{1}{1}{8,8,6,2,6,2,4,4}}
    \framearea{black}{\tikzpath{1}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{1}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{2}{2}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{2}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{1}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{4}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{4}{1}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{2}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{3}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{5}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{4}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{5}{8,6,2,4}}
    \setrule{1}{2}{8\times}
    \setrule{1}{3}{5}
    \setrule{1}{5}{4+}
    \setrule{2}{3}{60\times}
    \setrule{2}{5}{2\div}
    \setrule{3}{2}{2-}
    \setrule{3}{5}{75\times}
    \setrule{4}{1}{8+}
    \setrule{4}{2}{1-}
    \setrule{4}{4}{2\times}
    \setrule{5}{3}{1}
    \setrule{5}{5}{2}
  \end{kendoku}
  \hspace{1.5cm}
  \begin{kendoku}
    \framearea{black}{\tikzpath{1}{1}{8,8,6,2,6,2,4,4}}
    \framearea{black}{\tikzpath{1}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{1}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{2}{2}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{2}{4}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{1}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{3}{4}{8,8,6,6,2,4,2,4}}
    \framearea{black}{\tikzpath{4}{1}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{2}{8,6,6,2,4,4}}
    \framearea{black}{\tikzpath{4}{3}{8,8,6,2,2,4}}
    \framearea{black}{\tikzpath{5}{3}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{4}{8,6,2,4}}
    \framearea{black}{\tikzpath{5}{5}{8,6,2,4}}
    \setrule{1}{2}{8\times}
    \setrule{1}{3}{5}
    \setrule{1}{5}{4+}
    \setrule{2}{3}{60\times}
    \setrule{2}{5}{2\div}
    \setrule{3}{2}{2-}
    \setrule{3}{5}{75\times}
    \setrule{4}{1}{8+}
    \setrule{4}{2}{1-}
    \setrule{4}{4}{2\times}
    \setrule{5}{3}{1}
    \setrule{5}{5}{2}
    \setrow{5}{1,4,3,5,2}
    \setrow{4}{3,2,5,1,4}
    \setrow{3}{5,3,4,2,1}
    \setrow{2}{2,5,1,4,3}
    \setrow{1}{4,1,2,3,5}
  \end{kendoku}
\end{center}
\end{lstlisting}
\lstset{basicstyle=\ttfamily\normalsize}
\clearpage

\section{Options}
\begin{optionlist}
  \optitem{\styleoption{rows}}{5}{defines the number of rows in the grid.}
  \optitem{\styleoption{columns}}{5}{specifies the number of columns in the grid}
  \optitem{\styleoption{width}}{5.1cm}{sets the width of the minipage, in which the grid is typeset.}
  \optitem{\styleoption{scale}}{1}{scales the size of the grid in the minipage.}
  \optitem{\styleoption{fontsize}}{Large}{specifies 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}}
  \optitem{\styleoption{title}}{}{sets the title of a puzzle.}
  \optitem{\styleoption{titleindent}}{0cm}{defines the indent of the title.}
  \optitem{\styleoption{titlewidth}}{5.1cm}{specifies the width of the box the title is set in.}
  \optitem{\styleoption{bgcolor}}{}{sets the background color of the grid.}
  \optitem{\styleoption{counterstyle}}{none}{defines the counter style. Predefined styles: none, left, right}
  \optitem{\styleoption{cvoffset}}{-23pt}{sets the vertical offset of the counters in the margin.}
\end{optionlist}

\section{Environments}
\subsection{\texttt{kendoku}}
The \env{kendoku} environment\marginnote{\hbadness=10000\RaggedLeft\scriptsize\envb{kendoku}\oarg{options}\\\dots\\\enve{kendoku}} is the central core of the style file. With the optional argument of the environment, you can reset the options with local scope. Here, a blank grid is created.
\section{Commands}
\subsection{In the grid and around}
\subsubsection{\texttt{kendokucell}}
The command \cs{kendokucell}\margcs{\cmd\kendokucell\{\marg{column}\}\{\marg{row}\}\\\{\marg{number}\}} sets the \marg{number} of the grid cell \marg{column}\marg{row}.
\subsubsection{\texttt{setrow}}
The command \cs{setrow}\margcs{\cmd\setrow\{\marg{row}\}\{\marg{csv list}\}} sets the contents of \marg{row}. It expects a comma-separated list.
\subsubsection{\texttt{setcolumn}}
The command \cs{setcolumn}\margcs{\cmd\setcolumn\{\marg{column}\}\{\marg{csv list}\}} sets the contents of \marg{column}.
\subsubsection{\texttt{setrule}}
With\margcs{\cmd\setrule\{\{\marg{column}\}\{\marg{row}\}\\\{\marg{rule}\}} the \cmd\setrule\ command, you can set a calculation rule \marg{rule} into the top left corner of cell \marg{column}\marg{row}. The rule is typeset in inline math mode. You might consider using the \cmd\times\ and \cmd\div\ commands.
\subsubsection{\texttt{framearea}}
The command \cs{framearea}\margcs{\cmd\framearea\{\marg{color}\}\{\marg{\cmd\tikz\ path}\}} frames the area given by \marg{\cmd\tikz\ path} with color \marg{color}. The reference for coordinates is the bottom left corner of the cell.

\begin{lstlisting}
\framearea{green}{(2,2)--(2,3)--(3,3)--(3,2)--(2,2)}
\end{lstlisting}

This command will color the frame of the grid cell \texttt{(2,2)} green. You should consider using this command in the \env{puzzleforeground} environment.

\subsubsection{\texttt{tikzpath}}
With\margcs{\cmd\tikzpath\{\oarg{column}\}\{\oarg{row}\}\\\{\oarg{csv list}\}} the \cmd\tikzpath\ command, you can easily construct a \cmd\tikz\ path. You just need to define a starting point \marg{column}\marg{row} (bottom left corner) and a \marg{csv list} with direction indicators relative to the current position.

\begin{center}
\begin{tabular}{rlrlrl}
7: & up left & 8: & up & 9: & up right \\
4: & left & 5: & no change & 6: & right \\
1: & down left & 2: & down & 3: & down right \\
\end{tabular}
\end{center}

\begin{lstlisting}
\framearea{green}{\tikzpath{2}{2}{8,6,2,4}}
\end{lstlisting}

This command will frame grid cell \texttt{(2,2)} green.
\subsection{Presentation}
\subsubsection{\texttt{definecounterstyle}}
The command \cs{definecounterstyle}\margcs{\cmd\definecounterstyle\{\marg{name}\}\\\{\marg{definition}\}} allows you to define your own styles. For example, the style \texttt{left} is defined as follows:

\begin{lstlisting}
\definecounterstyle{left}{
  \begingroup\reversemarginpar\marginnote{
  \tikz\node[shape=rectangle,fill=yellow!40,inner sep=7pt,
             draw,rounded corners=3pt,thick]
  {\Huge\puzzlecounter};}[\LP@cvoffset]\endgroup}
}
\end{lstlisting}

To typeset the counter into the margin we use the command \cmd\marginnote. We need to use the command \cmd\reversemarginpar\ to set the counter into the left margin. Of course, we must use this command in a group for local scope. Finally we use \cmd\puzzlecounter\ in a \cmd\tikz\ node with a vertical offset set with the option \styleoption{cvoffset}.
\subsubsection{\texttt{puzzlecounter}}
The command \cs{puzzlecounter}\margcs{\cmd\puzzlecounter} provides the counter in textual form to use it for example in \cmd\definecounterstyle.
\subsubsection{\texttt{titleformat}}
With the command \cs{titleformat}\margcs{\cmd\titleformat\{\marg{format}\}}, you can define the format of the title. By default, the definition is as follows:

\begin{lstlisting}
\titleformat{\centering\Large\color{blue}}
\end{lstlisting}
\subsection{Miscellaneous}
\subsubsection{\texttt{kendokusetup}}
With the command \cs{kendokusetup}\margcs{\cmd\kendokusetup\{\marg{options}\}} you can reset the options with global scope.
\subsubsection{\texttt{setpuzzlecounter}}
With the command \cs{setpuzzlecounter}\margcs{\cmd\setpuzzlecounter\{\marg{number}\}}, you can reset the puzzle counter, for example before the solutions.

\section{Examples \& Solutions}
You\IfFileExists{qrcode.png}{\marginnote{\href{https://bitbucket.org/kleberj/logicpuzzle/}{\includegraphics[height=2cm]{qrcode.png}}}[-31pt]}{} can download application examples and their solutions from the \href{https://bitbucket.org/kleberj/logicpuzzle/}{project page}. The puzzles are originally licensed under \href{http://creativecommons.org/licenses/by-nc-sa/3.0/}{\ccbyncsa}.
\end{document}